2 pub mod bitcoind_client;
9 use crate::bitcoind_client::BitcoindClient;
10 use crate::disk::FilesystemLogger;
11 use bitcoin::blockdata::transaction::Transaction;
12 use bitcoin::consensus::encode;
13 use bitcoin::network::constants::Network;
14 use bitcoin::BlockHash;
15 use bitcoin_bech32::WitnessProgram;
16 use disk::{INBOUND_PAYMENTS_FNAME, OUTBOUND_PAYMENTS_FNAME};
17 use lightning::chain::{chainmonitor, ChannelMonitorUpdateStatus};
18 use lightning::chain::{Filter, Watch};
19 use lightning::events::bump_transaction::{BumpTransactionEventHandler, Wallet};
20 use lightning::events::{Event, PaymentFailureReason, PaymentPurpose};
21 use lightning::ln::channelmanager::{self, RecentPaymentDetails};
22 use lightning::ln::channelmanager::{
23 ChainParameters, ChannelManagerReadArgs, SimpleArcChannelManager,
25 use lightning::ln::msgs::DecodeError;
26 use lightning::ln::peer_handler::{IgnoringMessageHandler, MessageHandler, SimpleArcPeerManager};
27 use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
28 use lightning::onion_message::{DefaultMessageRouter, SimpleArcOnionMessenger};
29 use lightning::routing::gossip;
30 use lightning::routing::gossip::{NodeId, P2PGossipSync};
31 use lightning::routing::router::DefaultRouter;
32 use lightning::routing::scoring::ProbabilisticScoringFeeParameters;
33 use lightning::sign::{EntropySource, InMemorySigner, KeysManager, SpendableOutputDescriptor};
34 use lightning::util::config::UserConfig;
35 use lightning::util::persist::KVStorePersister;
36 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
37 use lightning::{chain, impl_writeable_tlv_based, impl_writeable_tlv_based_enum};
38 use lightning_background_processor::{process_events_async, GossipSync};
39 use lightning_block_sync::init;
40 use lightning_block_sync::poll;
41 use lightning_block_sync::SpvClient;
42 use lightning_block_sync::UnboundedCache;
43 use lightning_net_tokio::SocketDescriptor;
44 use lightning_persister::FilesystemPersister;
45 use rand::{thread_rng, Rng};
46 use std::collections::hash_map::Entry;
47 use std::collections::HashMap;
48 use std::convert::TryInto;
55 use std::sync::atomic::{AtomicBool, Ordering};
56 use std::sync::{Arc, Mutex};
57 use std::time::{Duration, SystemTime};
59 pub(crate) const PENDING_SPENDABLE_OUTPUT_DIR: &'static str = "pending_spendable_outputs";
61 #[derive(Copy, Clone)]
62 pub(crate) enum HTLCStatus {
68 impl_writeable_tlv_based_enum!(HTLCStatus,
74 pub(crate) struct MillisatAmount(Option<u64>);
76 impl fmt::Display for MillisatAmount {
77 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
79 Some(amt) => write!(f, "{}", amt),
80 None => write!(f, "unknown"),
85 impl Readable for MillisatAmount {
86 fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
87 let amt: Option<u64> = Readable::read(r)?;
88 Ok(MillisatAmount(amt))
92 impl Writeable for MillisatAmount {
93 fn write<W: Writer>(&self, w: &mut W) -> Result<(), std::io::Error> {
98 pub(crate) struct PaymentInfo {
99 preimage: Option<PaymentPreimage>,
100 secret: Option<PaymentSecret>,
102 amt_msat: MillisatAmount,
105 impl_writeable_tlv_based!(PaymentInfo, {
106 (0, preimage, required),
107 (2, secret, required),
108 (4, status, required),
109 (6, amt_msat, required),
112 pub(crate) struct PaymentInfoStorage {
113 payments: HashMap<PaymentHash, PaymentInfo>,
116 impl_writeable_tlv_based!(PaymentInfoStorage, {
117 (0, payments, required),
120 type ChainMonitor = chainmonitor::ChainMonitor<
122 Arc<dyn Filter + Send + Sync>,
125 Arc<FilesystemLogger>,
126 Arc<FilesystemPersister>,
129 pub(crate) type PeerManager = SimpleArcPeerManager<
138 pub(crate) type ChannelManager =
139 SimpleArcChannelManager<ChainMonitor, BitcoindClient, BitcoindClient, FilesystemLogger>;
141 pub(crate) type NetworkGraph = gossip::NetworkGraph<Arc<FilesystemLogger>>;
143 type OnionMessenger = SimpleArcOnionMessenger<FilesystemLogger>;
145 pub(crate) type BumpTxEventHandler = BumpTransactionEventHandler<
147 Arc<Wallet<Arc<BitcoindClient>, Arc<FilesystemLogger>>>,
149 Arc<FilesystemLogger>,
152 async fn handle_ldk_events(
153 channel_manager: &Arc<ChannelManager>, bitcoind_client: &BitcoindClient,
154 network_graph: &NetworkGraph, keys_manager: &KeysManager,
155 bump_tx_event_handler: &BumpTxEventHandler, inbound_payments: Arc<Mutex<PaymentInfoStorage>>,
156 outbound_payments: Arc<Mutex<PaymentInfoStorage>>, persister: &Arc<FilesystemPersister>,
157 network: Network, event: Event,
160 Event::FundingGenerationReady {
161 temporary_channel_id,
162 counterparty_node_id,
163 channel_value_satoshis,
167 // Construct the raw transaction with one output, that is paid the amount of the
169 let addr = WitnessProgram::from_scriptpubkey(
172 Network::Bitcoin => bitcoin_bech32::constants::Network::Bitcoin,
173 Network::Testnet => bitcoin_bech32::constants::Network::Testnet,
174 Network::Regtest => bitcoin_bech32::constants::Network::Regtest,
175 Network::Signet => bitcoin_bech32::constants::Network::Signet,
178 .expect("Lightning funding tx should always be to a SegWit output")
180 let mut outputs = vec![HashMap::with_capacity(1)];
181 outputs[0].insert(addr, channel_value_satoshis as f64 / 100_000_000.0);
182 let raw_tx = bitcoind_client.create_raw_transaction(outputs).await;
184 // Have your wallet put the inputs into the transaction such that the output is
186 let funded_tx = bitcoind_client.fund_raw_transaction(raw_tx).await;
188 // Sign the final funding transaction and broadcast it.
189 let signed_tx = bitcoind_client.sign_raw_transaction_with_wallet(funded_tx.hex).await;
190 assert_eq!(signed_tx.complete, true);
191 let final_tx: Transaction =
192 encode::deserialize(&hex_utils::to_vec(&signed_tx.hex).unwrap()).unwrap();
193 // Give the funding transaction back to LDK for opening the channel.
195 .funding_transaction_generated(
196 &temporary_channel_id,
197 &counterparty_node_id,
203 "\nERROR: Channel went away before we could fund it. The peer disconnected or refused the channel.");
205 io::stdout().flush().unwrap();
208 Event::PaymentClaimable {
214 via_user_channel_id: _,
217 counterparty_skimmed_fee_msat: _,
220 "\nEVENT: received payment from payment hash {} of {} millisatoshis",
221 hex_utils::hex_str(&payment_hash.0),
225 io::stdout().flush().unwrap();
226 let payment_preimage = match purpose {
227 PaymentPurpose::InvoicePayment { payment_preimage, .. } => payment_preimage,
228 PaymentPurpose::SpontaneousPayment(preimage) => Some(preimage),
230 channel_manager.claim_funds(payment_preimage.unwrap());
232 Event::PaymentClaimed { payment_hash, purpose, amount_msat, receiver_node_id: _ } => {
234 "\nEVENT: claimed payment from payment hash {} of {} millisatoshis",
235 hex_utils::hex_str(&payment_hash.0),
239 io::stdout().flush().unwrap();
240 let (payment_preimage, payment_secret) = match purpose {
241 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
242 (payment_preimage, Some(payment_secret))
244 PaymentPurpose::SpontaneousPayment(preimage) => (Some(preimage), None),
246 let mut inbound = inbound_payments.lock().unwrap();
247 match inbound.payments.entry(payment_hash) {
248 Entry::Occupied(mut e) => {
249 let payment = e.get_mut();
250 payment.status = HTLCStatus::Succeeded;
251 payment.preimage = payment_preimage;
252 payment.secret = payment_secret;
254 Entry::Vacant(e) => {
255 e.insert(PaymentInfo {
256 preimage: payment_preimage,
257 secret: payment_secret,
258 status: HTLCStatus::Succeeded,
259 amt_msat: MillisatAmount(Some(amount_msat)),
263 persister.persist(INBOUND_PAYMENTS_FNAME, &*inbound).unwrap();
265 Event::PaymentSent { payment_preimage, payment_hash, fee_paid_msat, .. } => {
266 let mut outbound = outbound_payments.lock().unwrap();
267 for (hash, payment) in outbound.payments.iter_mut() {
268 if *hash == payment_hash {
269 payment.preimage = Some(payment_preimage);
270 payment.status = HTLCStatus::Succeeded;
272 "\nEVENT: successfully sent payment of {} millisatoshis{} from \
273 payment hash {:?} with preimage {:?}",
275 if let Some(fee) = fee_paid_msat {
276 format!(" (fee {} msat)", fee)
280 hex_utils::hex_str(&payment_hash.0),
281 hex_utils::hex_str(&payment_preimage.0)
284 io::stdout().flush().unwrap();
287 persister.persist(OUTBOUND_PAYMENTS_FNAME, &*outbound).unwrap();
289 Event::OpenChannelRequest {
290 ref temporary_channel_id, ref counterparty_node_id, ..
292 let mut random_bytes = [0u8; 16];
293 random_bytes.copy_from_slice(&keys_manager.get_secure_random_bytes()[..16]);
294 let user_channel_id = u128::from_be_bytes(random_bytes);
295 let res = channel_manager.accept_inbound_channel(
296 temporary_channel_id,
297 counterparty_node_id,
301 if let Err(e) = res {
303 "\nEVENT: Failed to accept inbound channel ({}) from {}: {:?}",
304 hex_utils::hex_str(&temporary_channel_id[..]),
305 hex_utils::hex_str(&counterparty_node_id.serialize()),
310 "\nEVENT: Accepted inbound channel ({}) from {}",
311 hex_utils::hex_str(&temporary_channel_id[..]),
312 hex_utils::hex_str(&counterparty_node_id.serialize()),
316 io::stdout().flush().unwrap();
318 Event::PaymentPathSuccessful { .. } => {}
319 Event::PaymentPathFailed { .. } => {}
320 Event::ProbeSuccessful { .. } => {}
321 Event::ProbeFailed { .. } => {}
322 Event::PaymentFailed { payment_hash, reason, .. } => {
324 "\nEVENT: Failed to send payment to payment hash {:?}: {:?}",
325 hex_utils::hex_str(&payment_hash.0),
326 if let Some(r) = reason { r } else { PaymentFailureReason::RetriesExhausted }
329 io::stdout().flush().unwrap();
331 let mut outbound = outbound_payments.lock().unwrap();
332 if outbound.payments.contains_key(&payment_hash) {
333 let payment = outbound.payments.get_mut(&payment_hash).unwrap();
334 payment.status = HTLCStatus::Failed;
336 persister.persist(OUTBOUND_PAYMENTS_FNAME, &*outbound).unwrap();
338 Event::PaymentForwarded {
342 claim_from_onchain_tx,
343 outbound_amount_forwarded_msat,
345 let read_only_network_graph = network_graph.read_only();
346 let nodes = read_only_network_graph.nodes();
347 let channels = channel_manager.list_channels();
349 let node_str = |channel_id: &Option<[u8; 32]>| match channel_id {
350 None => String::new(),
351 Some(channel_id) => match channels.iter().find(|c| c.channel_id == *channel_id) {
352 None => String::new(),
354 match nodes.get(&NodeId::from_pubkey(&channel.counterparty.node_id)) {
355 None => "private node".to_string(),
356 Some(node) => match &node.announcement_info {
357 None => "unnamed node".to_string(),
358 Some(announcement) => {
359 format!("node {}", announcement.alias)
366 let channel_str = |channel_id: &Option<[u8; 32]>| {
368 .map(|channel_id| format!(" with channel {}", hex_utils::hex_str(&channel_id)))
372 format!(" from {}{}", node_str(&prev_channel_id), channel_str(&prev_channel_id));
374 format!(" to {}{}", node_str(&next_channel_id), channel_str(&next_channel_id));
376 let from_onchain_str = if claim_from_onchain_tx {
377 "from onchain downstream claim"
379 "from HTLC fulfill message"
381 let amt_args = if let Some(v) = outbound_amount_forwarded_msat {
386 if let Some(fee_earned) = fee_earned_msat {
388 "\nEVENT: Forwarded payment for {} msat{}{}, earning {} msat {}",
389 amt_args, from_prev_str, to_next_str, fee_earned, from_onchain_str
393 "\nEVENT: Forwarded payment for {} msat{}{}, claiming onchain {}",
394 amt_args, from_prev_str, to_next_str, from_onchain_str
398 io::stdout().flush().unwrap();
400 Event::HTLCHandlingFailed { .. } => {}
401 Event::PendingHTLCsForwardable { time_forwardable } => {
402 let forwarding_channel_manager = channel_manager.clone();
403 let min = time_forwardable.as_millis() as u64;
404 tokio::spawn(async move {
405 let millis_to_sleep = thread_rng().gen_range(min, min * 5) as u64;
406 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
407 forwarding_channel_manager.process_pending_htlc_forwards();
410 Event::SpendableOutputs { outputs } => {
411 // SpendableOutputDescriptors, of which outputs is a vec of, are critical to keep track
412 // of! While a `StaticOutput` descriptor is just an output to a static, well-known key,
413 // other descriptors are not currently ever regenerated for you by LDK. Once we return
414 // from this method, the descriptor will be gone, and you may lose track of some funds.
416 // Here we simply persist them to disk, with a background task running which will try
417 // to spend them regularly (possibly duplicatively/RBF'ing them). These can just be
418 // treated as normal funds where possible - they are only spendable by us and there is
419 // no rush to claim them.
420 for output in outputs {
421 let key = hex_utils::hex_str(&keys_manager.get_secure_random_bytes());
422 // Note that if the type here changes our read code needs to change as well.
423 let output: SpendableOutputDescriptor = output;
425 .persist(&format!("{}/{}", PENDING_SPENDABLE_OUTPUT_DIR, key), &output)
429 Event::ChannelPending { channel_id, counterparty_node_id, .. } => {
431 "\nEVENT: Channel {} with peer {} is pending awaiting funding lock-in!",
432 hex_utils::hex_str(&channel_id),
433 hex_utils::hex_str(&counterparty_node_id.serialize()),
436 io::stdout().flush().unwrap();
438 Event::ChannelReady {
441 ref counterparty_node_id,
445 "\nEVENT: Channel {} with peer {} is ready to be used!",
446 hex_utils::hex_str(channel_id),
447 hex_utils::hex_str(&counterparty_node_id.serialize()),
450 io::stdout().flush().unwrap();
452 Event::ChannelClosed { channel_id, reason, user_channel_id: _ } => {
454 "\nEVENT: Channel {} closed due to: {:?}",
455 hex_utils::hex_str(&channel_id),
459 io::stdout().flush().unwrap();
461 Event::DiscardFunding { .. } => {
462 // A "real" node should probably "lock" the UTXOs spent in funding transactions until
463 // the funding transaction either confirms, or this event is generated.
465 Event::HTLCIntercepted { .. } => {}
466 Event::BumpTransaction(event) => bump_tx_event_handler.handle_event(&event),
470 async fn start_ldk() {
471 let args = match args::parse_startup_args() {
472 Ok(user_args) => user_args,
476 // Initialize the LDK data directory if necessary.
477 let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
478 fs::create_dir_all(ldk_data_dir.clone()).unwrap();
481 // Step 1: Initialize the Logger
482 let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
484 // Initialize our bitcoind client.
485 let bitcoind_client = match BitcoindClient::new(
486 args.bitcoind_rpc_host.clone(),
487 args.bitcoind_rpc_port,
488 args.bitcoind_rpc_username.clone(),
489 args.bitcoind_rpc_password.clone(),
490 tokio::runtime::Handle::current(),
495 Ok(client) => Arc::new(client),
497 println!("Failed to connect to bitcoind client: {}", e);
502 // Check that the bitcoind we've connected to is running the network we expect
503 let bitcoind_chain = bitcoind_client.get_blockchain_info().await.chain;
505 != match args.network {
506 bitcoin::Network::Bitcoin => "main",
507 bitcoin::Network::Testnet => "test",
508 bitcoin::Network::Regtest => "regtest",
509 bitcoin::Network::Signet => "signet",
512 "Chain argument ({}) didn't match bitcoind chain ({})",
513 args.network, bitcoind_chain
518 // Step 2: Initialize the FeeEstimator
520 // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
521 let fee_estimator = bitcoind_client.clone();
523 // Step 3: Initialize the BroadcasterInterface
525 // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
527 let broadcaster = bitcoind_client.clone();
529 // Step 4: Initialize Persist
530 let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
532 // Step 5: Initialize the ChainMonitor
533 let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
537 fee_estimator.clone(),
541 // Step 6: Initialize the KeysManager
543 // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
544 // other secret key material.
545 let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
546 let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
547 assert_eq!(seed.len(), 32);
548 let mut key = [0; 32];
549 key.copy_from_slice(&seed);
552 let mut key = [0; 32];
553 thread_rng().fill_bytes(&mut key);
554 match File::create(keys_seed_path.clone()) {
556 Write::write_all(&mut f, &key).expect("Failed to write node keys seed to disk");
557 f.sync_all().expect("Failed to sync node keys seed to disk");
560 println!("ERROR: Unable to create keys seed file {}: {}", keys_seed_path, e);
566 let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
567 let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
569 let bump_tx_event_handler = Arc::new(BumpTransactionEventHandler::new(
570 Arc::clone(&broadcaster),
571 Arc::new(Wallet::new(Arc::clone(&bitcoind_client), Arc::clone(&logger))),
572 Arc::clone(&keys_manager),
576 // Step 7: Read ChannelMonitor state from disk
577 let mut channelmonitors =
578 persister.read_channelmonitors(keys_manager.clone(), keys_manager.clone()).unwrap();
580 // Step 8: Poll for the best chain tip, which may be used by the channel manager & spv client
581 let polled_chain_tip = init::validate_best_block_header(bitcoind_client.as_ref())
583 .expect("Failed to fetch best block header and best block");
585 // Step 9: Initialize routing ProbabilisticScorer
586 let network_graph_path = format!("{}/network_graph", ldk_data_dir.clone());
588 Arc::new(disk::read_network(Path::new(&network_graph_path), args.network, logger.clone()));
590 let scorer_path = format!("{}/scorer", ldk_data_dir.clone());
591 let scorer = Arc::new(Mutex::new(disk::read_scorer(
592 Path::new(&scorer_path),
593 Arc::clone(&network_graph),
597 // Step 10: Create Router
598 let scoring_fee_params = ProbabilisticScoringFeeParameters::default();
599 let router = Arc::new(DefaultRouter::new(
600 network_graph.clone(),
602 keys_manager.get_secure_random_bytes(),
607 // Step 11: Initialize the ChannelManager
608 let mut user_config = UserConfig::default();
609 user_config.channel_handshake_limits.force_announced_channel_preference = false;
610 user_config.manually_accept_inbound_channels = true;
611 let mut restarting_node = true;
612 let (channel_manager_blockhash, channel_manager) = {
613 if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
614 let mut channel_monitor_mut_references = Vec::new();
615 for (_, channel_monitor) in channelmonitors.iter_mut() {
616 channel_monitor_mut_references.push(channel_monitor);
618 let read_args = ChannelManagerReadArgs::new(
619 keys_manager.clone(),
620 keys_manager.clone(),
621 keys_manager.clone(),
622 fee_estimator.clone(),
623 chain_monitor.clone(),
628 channel_monitor_mut_references,
630 <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
632 // We're starting a fresh node.
633 restarting_node = false;
635 let polled_best_block = polled_chain_tip.to_best_block();
636 let polled_best_block_hash = polled_best_block.block_hash();
638 ChainParameters { network: args.network, best_block: polled_best_block };
639 let fresh_channel_manager = channelmanager::ChannelManager::new(
640 fee_estimator.clone(),
641 chain_monitor.clone(),
645 keys_manager.clone(),
646 keys_manager.clone(),
647 keys_manager.clone(),
650 cur.as_secs() as u32,
652 (polled_best_block_hash, fresh_channel_manager)
656 // Step 12: Sync ChannelMonitors and ChannelManager to chain tip
657 let mut chain_listener_channel_monitors = Vec::new();
658 let mut cache = UnboundedCache::new();
659 let chain_tip = if restarting_node {
660 let mut chain_listeners = vec![(
661 channel_manager_blockhash,
662 &channel_manager as &(dyn chain::Listen + Send + Sync),
665 for (blockhash, channel_monitor) in channelmonitors.drain(..) {
666 let outpoint = channel_monitor.get_funding_txo().0;
667 chain_listener_channel_monitors.push((
669 (channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()),
674 for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
675 chain_listeners.push((
676 monitor_listener_info.0,
677 &monitor_listener_info.1 as &(dyn chain::Listen + Send + Sync),
681 init::synchronize_listeners(
682 bitcoind_client.as_ref(),
693 // Step 13: Give ChannelMonitors to ChainMonitor
694 for item in chain_listener_channel_monitors.drain(..) {
695 let channel_monitor = item.1 .0;
696 let funding_outpoint = item.2;
698 chain_monitor.watch_channel(funding_outpoint, channel_monitor),
699 ChannelMonitorUpdateStatus::Completed
703 // Step 14: Optional: Initialize the P2PGossipSync
704 let gossip_sync = Arc::new(P2PGossipSync::new(
705 Arc::clone(&network_graph),
706 None::<Arc<BitcoindClient>>,
710 // Step 15: Initialize the PeerManager
711 let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
712 let onion_messenger: Arc<OnionMessenger> = Arc::new(OnionMessenger::new(
713 Arc::clone(&keys_manager),
714 Arc::clone(&keys_manager),
716 Arc::new(DefaultMessageRouter {}),
717 IgnoringMessageHandler {},
718 IgnoringMessageHandler {},
720 let mut ephemeral_bytes = [0; 32];
721 let current_time = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs();
722 rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
723 let lightning_msg_handler = MessageHandler {
724 chan_handler: channel_manager.clone(),
725 route_handler: gossip_sync.clone(),
726 onion_message_handler: onion_messenger.clone(),
727 custom_message_handler: IgnoringMessageHandler {},
729 let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
730 lightning_msg_handler,
731 current_time.try_into().unwrap(),
734 Arc::clone(&keys_manager),
738 // Step 16: Initialize networking
740 let peer_manager_connection_handler = peer_manager.clone();
741 let listening_port = args.ldk_peer_listening_port;
742 let stop_listen_connect = Arc::new(AtomicBool::new(false));
743 let stop_listen = Arc::clone(&stop_listen_connect);
744 tokio::spawn(async move {
745 let listener = tokio::net::TcpListener::bind(format!("[::]:{}", listening_port))
747 .expect("Failed to bind to listen port - is something else already listening on it?");
749 let peer_mgr = peer_manager_connection_handler.clone();
750 let tcp_stream = listener.accept().await.unwrap().0;
751 if stop_listen.load(Ordering::Acquire) {
754 tokio::spawn(async move {
755 lightning_net_tokio::setup_inbound(
757 tcp_stream.into_std().unwrap(),
764 // Step 17: Connect and Disconnect Blocks
765 let channel_manager_listener = channel_manager.clone();
766 let chain_monitor_listener = chain_monitor.clone();
767 let bitcoind_block_source = bitcoind_client.clone();
768 let network = args.network;
769 tokio::spawn(async move {
770 let chain_poller = poll::ChainPoller::new(bitcoind_block_source.as_ref(), network);
771 let chain_listener = (chain_monitor_listener, channel_manager_listener);
772 let mut spv_client = SpvClient::new(chain_tip, chain_poller, &mut cache, &chain_listener);
774 spv_client.poll_best_tip().await.unwrap();
775 tokio::time::sleep(Duration::from_secs(1)).await;
779 let inbound_payments = Arc::new(Mutex::new(disk::read_payment_info(Path::new(&format!(
781 ldk_data_dir, INBOUND_PAYMENTS_FNAME
783 let outbound_payments = Arc::new(Mutex::new(disk::read_payment_info(Path::new(&format!(
785 ldk_data_dir, OUTBOUND_PAYMENTS_FNAME
787 let recent_payments_payment_hashes = channel_manager
788 .list_recent_payments()
790 .filter_map(|p| match p {
791 RecentPaymentDetails::Pending { payment_hash, .. } => Some(payment_hash),
792 RecentPaymentDetails::Fulfilled { payment_hash } => payment_hash,
793 RecentPaymentDetails::Abandoned { payment_hash } => Some(payment_hash),
795 .collect::<Vec<PaymentHash>>();
796 for (payment_hash, payment_info) in outbound_payments
801 .filter(|(_, i)| matches!(i.status, HTLCStatus::Pending))
803 if !recent_payments_payment_hashes.contains(payment_hash) {
804 payment_info.status = HTLCStatus::Failed;
807 persister.persist(OUTBOUND_PAYMENTS_FNAME, &*outbound_payments.lock().unwrap()).unwrap();
809 // Step 18: Handle LDK Events
810 let channel_manager_event_listener = Arc::clone(&channel_manager);
811 let bitcoind_client_event_listener = Arc::clone(&bitcoind_client);
812 let network_graph_event_listener = Arc::clone(&network_graph);
813 let keys_manager_event_listener = Arc::clone(&keys_manager);
814 let inbound_payments_event_listener = Arc::clone(&inbound_payments);
815 let outbound_payments_event_listener = Arc::clone(&outbound_payments);
816 let persister_event_listener = Arc::clone(&persister);
817 let network = args.network;
818 let event_handler = move |event: Event| {
819 let channel_manager_event_listener = Arc::clone(&channel_manager_event_listener);
820 let bitcoind_client_event_listener = Arc::clone(&bitcoind_client_event_listener);
821 let network_graph_event_listener = Arc::clone(&network_graph_event_listener);
822 let keys_manager_event_listener = Arc::clone(&keys_manager_event_listener);
823 let bump_tx_event_handler = Arc::clone(&bump_tx_event_handler);
824 let inbound_payments_event_listener = Arc::clone(&inbound_payments_event_listener);
825 let outbound_payments_event_listener = Arc::clone(&outbound_payments_event_listener);
826 let persister_event_listener = Arc::clone(&persister_event_listener);
829 &channel_manager_event_listener,
830 &bitcoind_client_event_listener,
831 &network_graph_event_listener,
832 &keys_manager_event_listener,
833 &bump_tx_event_handler,
834 inbound_payments_event_listener,
835 outbound_payments_event_listener,
836 &persister_event_listener,
844 // Step 19: Persist ChannelManager and NetworkGraph
845 let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
847 // Step 20: Background Processing
848 let (bp_exit, bp_exit_check) = tokio::sync::watch::channel(());
849 let mut background_processor = tokio::spawn(process_events_async(
850 Arc::clone(&persister),
852 chain_monitor.clone(),
853 channel_manager.clone(),
854 GossipSync::p2p(gossip_sync.clone()),
855 peer_manager.clone(),
857 Some(scorer.clone()),
859 let mut bp_exit_fut_check = bp_exit_check.clone();
860 Box::pin(async move {
862 _ = tokio::time::sleep(t) => false,
863 _ = bp_exit_fut_check.changed() => true,
870 // Regularly reconnect to channel peers.
871 let connect_cm = Arc::clone(&channel_manager);
872 let connect_pm = Arc::clone(&peer_manager);
873 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
874 let stop_connect = Arc::clone(&stop_listen_connect);
875 tokio::spawn(async move {
876 let mut interval = tokio::time::interval(Duration::from_secs(1));
877 interval.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Delay);
879 interval.tick().await;
880 match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
882 let peers = connect_pm.get_peer_node_ids();
883 for node_id in connect_cm
886 .map(|chan| chan.counterparty.node_id)
887 .filter(|id| !peers.iter().any(|(pk, _)| id == pk))
889 if stop_connect.load(Ordering::Acquire) {
892 for (pubkey, peer_addr) in info.iter() {
893 if *pubkey == node_id {
894 let _ = cli::do_connect_peer(
897 Arc::clone(&connect_pm),
904 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
909 // Regularly broadcast our node_announcement. This is only required (or possible) if we have
910 // some public channels.
911 let peer_man = Arc::clone(&peer_manager);
912 let chan_man = Arc::clone(&channel_manager);
913 let network = args.network;
914 tokio::spawn(async move {
915 // First wait a minute until we have some peers and maybe have opened a channel.
916 tokio::time::sleep(Duration::from_secs(60)).await;
917 // Then, update our announcement once an hour to keep it fresh but avoid unnecessary churn
918 // in the global gossip network.
919 let mut interval = tokio::time::interval(Duration::from_secs(3600));
921 interval.tick().await;
922 // Don't bother trying to announce if we don't have any public channls, though our
923 // peers should drop such an announcement anyway. Note that announcement may not
924 // propagate until we have a channel with 6+ confirmations.
925 if chan_man.list_channels().iter().any(|chan| chan.is_public) {
926 peer_man.broadcast_node_announcement(
928 args.ldk_announced_node_name,
929 args.ldk_announced_listen_addr.clone(),
935 tokio::spawn(sweep::periodic_sweep(
936 ldk_data_dir.clone(),
937 Arc::clone(&keys_manager),
939 Arc::clone(&persister),
940 Arc::clone(&bitcoind_client),
941 Arc::clone(&channel_manager),
945 let cli_poll = tokio::spawn(cli::poll_for_user_input(
946 Arc::clone(&peer_manager),
947 Arc::clone(&channel_manager),
948 Arc::clone(&keys_manager),
949 Arc::clone(&network_graph),
950 Arc::clone(&onion_messenger),
956 Arc::clone(&persister),
959 // Exit if either CLI polling exits or the background processor exits (which shouldn't happen
960 // unless we fail to write to the filesystem).
963 bg_res = &mut background_processor => {
964 stop_listen_connect.store(true, Ordering::Release);
965 peer_manager.disconnect_all_peers();
966 panic!("ERR: background processing stopped with result {:?}, exiting", bg_res);
970 // Disconnect our peers and stop accepting new connections. This ensures we don't continue
971 // updating our channel data after we've stopped the background processor.
972 stop_listen_connect.store(true, Ordering::Release);
973 peer_manager.disconnect_all_peers();
975 // Stop the background processor.
976 if !bp_exit.is_closed() {
977 bp_exit.send(()).unwrap();
978 background_processor.await.unwrap().unwrap();
983 pub async fn main() {
984 #[cfg(not(target_os = "windows"))]
986 // Catch Ctrl-C with a dummy signal handler.
988 let mut new_action: libc::sigaction = core::mem::zeroed();
989 let mut old_action: libc::sigaction = core::mem::zeroed();
991 extern "C" fn dummy_handler(
992 _: libc::c_int, _: *const libc::siginfo_t, _: *const libc::c_void,
996 new_action.sa_sigaction = dummy_handler as libc::sighandler_t;
997 new_action.sa_flags = libc::SA_SIGINFO;
1001 &new_action as *const libc::sigaction,
1002 &mut old_action as *mut libc::sigaction,