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::{ChannelId, 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::{self, read_channel_monitors, KVStore};
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::fs_store::FilesystemStore;
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, RwLock};
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<FilesystemStore>,
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<FilesystemStore>,
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 {
238 sender_intended_total_msat: _,
241 "\nEVENT: claimed payment from payment hash {} of {} millisatoshis",
242 hex_utils::hex_str(&payment_hash.0),
246 io::stdout().flush().unwrap();
247 let (payment_preimage, payment_secret) = match purpose {
248 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
249 (payment_preimage, Some(payment_secret))
251 PaymentPurpose::SpontaneousPayment(preimage) => (Some(preimage), None),
253 let mut inbound = inbound_payments.lock().unwrap();
254 match inbound.payments.entry(payment_hash) {
255 Entry::Occupied(mut e) => {
256 let payment = e.get_mut();
257 payment.status = HTLCStatus::Succeeded;
258 payment.preimage = payment_preimage;
259 payment.secret = payment_secret;
261 Entry::Vacant(e) => {
262 e.insert(PaymentInfo {
263 preimage: payment_preimage,
264 secret: payment_secret,
265 status: HTLCStatus::Succeeded,
266 amt_msat: MillisatAmount(Some(amount_msat)),
270 persister.write("", "", INBOUND_PAYMENTS_FNAME, &inbound.encode()).unwrap();
272 Event::PaymentSent { payment_preimage, payment_hash, fee_paid_msat, .. } => {
273 let mut outbound = outbound_payments.lock().unwrap();
274 for (hash, payment) in outbound.payments.iter_mut() {
275 if *hash == payment_hash {
276 payment.preimage = Some(payment_preimage);
277 payment.status = HTLCStatus::Succeeded;
279 "\nEVENT: successfully sent payment of {} millisatoshis{} from \
280 payment hash {:?} with preimage {:?}",
282 if let Some(fee) = fee_paid_msat {
283 format!(" (fee {} msat)", fee)
287 hex_utils::hex_str(&payment_hash.0),
288 hex_utils::hex_str(&payment_preimage.0)
291 io::stdout().flush().unwrap();
294 persister.write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound.encode()).unwrap();
296 Event::OpenChannelRequest {
297 ref temporary_channel_id, ref counterparty_node_id, ..
299 let mut random_bytes = [0u8; 16];
300 random_bytes.copy_from_slice(&keys_manager.get_secure_random_bytes()[..16]);
301 let user_channel_id = u128::from_be_bytes(random_bytes);
302 let res = channel_manager.accept_inbound_channel(
303 temporary_channel_id,
304 counterparty_node_id,
308 if let Err(e) = res {
310 "\nEVENT: Failed to accept inbound channel ({}) from {}: {:?}",
311 temporary_channel_id,
312 hex_utils::hex_str(&counterparty_node_id.serialize()),
317 "\nEVENT: Accepted inbound channel ({}) from {}",
318 temporary_channel_id,
319 hex_utils::hex_str(&counterparty_node_id.serialize()),
323 io::stdout().flush().unwrap();
325 Event::PaymentPathSuccessful { .. } => {}
326 Event::PaymentPathFailed { .. } => {}
327 Event::ProbeSuccessful { .. } => {}
328 Event::ProbeFailed { .. } => {}
329 Event::PaymentFailed { payment_hash, reason, .. } => {
331 "\nEVENT: Failed to send payment to payment hash {:?}: {:?}",
332 hex_utils::hex_str(&payment_hash.0),
333 if let Some(r) = reason { r } else { PaymentFailureReason::RetriesExhausted }
336 io::stdout().flush().unwrap();
338 let mut outbound = outbound_payments.lock().unwrap();
339 if outbound.payments.contains_key(&payment_hash) {
340 let payment = outbound.payments.get_mut(&payment_hash).unwrap();
341 payment.status = HTLCStatus::Failed;
343 persister.write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound.encode()).unwrap();
345 Event::PaymentForwarded {
349 claim_from_onchain_tx,
350 outbound_amount_forwarded_msat,
352 let read_only_network_graph = network_graph.read_only();
353 let nodes = read_only_network_graph.nodes();
354 let channels = channel_manager.list_channels();
356 let node_str = |channel_id: &Option<ChannelId>| match channel_id {
357 None => String::new(),
358 Some(channel_id) => match channels.iter().find(|c| c.channel_id == *channel_id) {
359 None => String::new(),
361 match nodes.get(&NodeId::from_pubkey(&channel.counterparty.node_id)) {
362 None => "private node".to_string(),
363 Some(node) => match &node.announcement_info {
364 None => "unnamed node".to_string(),
365 Some(announcement) => {
366 format!("node {}", announcement.alias)
373 let channel_str = |channel_id: &Option<ChannelId>| {
375 .map(|channel_id| format!(" with channel {}", channel_id))
379 format!(" from {}{}", node_str(&prev_channel_id), channel_str(&prev_channel_id));
381 format!(" to {}{}", node_str(&next_channel_id), channel_str(&next_channel_id));
383 let from_onchain_str = if claim_from_onchain_tx {
384 "from onchain downstream claim"
386 "from HTLC fulfill message"
388 let amt_args = if let Some(v) = outbound_amount_forwarded_msat {
393 if let Some(fee_earned) = fee_earned_msat {
395 "\nEVENT: Forwarded payment for {} msat{}{}, earning {} msat {}",
396 amt_args, from_prev_str, to_next_str, fee_earned, from_onchain_str
400 "\nEVENT: Forwarded payment for {} msat{}{}, claiming onchain {}",
401 amt_args, from_prev_str, to_next_str, from_onchain_str
405 io::stdout().flush().unwrap();
407 Event::HTLCHandlingFailed { .. } => {}
408 Event::PendingHTLCsForwardable { time_forwardable } => {
409 let forwarding_channel_manager = channel_manager.clone();
410 let min = time_forwardable.as_millis() as u64;
411 tokio::spawn(async move {
412 let millis_to_sleep = thread_rng().gen_range(min, min * 5) as u64;
413 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
414 forwarding_channel_manager.process_pending_htlc_forwards();
417 Event::SpendableOutputs { outputs, channel_id: _ } => {
418 // SpendableOutputDescriptors, of which outputs is a vec of, are critical to keep track
419 // of! While a `StaticOutput` descriptor is just an output to a static, well-known key,
420 // other descriptors are not currently ever regenerated for you by LDK. Once we return
421 // from this method, the descriptor will be gone, and you may lose track of some funds.
423 // Here we simply persist them to disk, with a background task running which will try
424 // to spend them regularly (possibly duplicatively/RBF'ing them). These can just be
425 // treated as normal funds where possible - they are only spendable by us and there is
426 // no rush to claim them.
427 for output in outputs {
428 let key = hex_utils::hex_str(&keys_manager.get_secure_random_bytes());
429 // Note that if the type here changes our read code needs to change as well.
430 let output: SpendableOutputDescriptor = output;
431 persister.write(PENDING_SPENDABLE_OUTPUT_DIR, "", &key, &output.encode()).unwrap();
434 Event::ChannelPending { channel_id, counterparty_node_id, .. } => {
436 "\nEVENT: Channel {} with peer {} is pending awaiting funding lock-in!",
438 hex_utils::hex_str(&counterparty_node_id.serialize()),
441 io::stdout().flush().unwrap();
443 Event::ChannelReady {
446 ref counterparty_node_id,
450 "\nEVENT: Channel {} with peer {} is ready to be used!",
452 hex_utils::hex_str(&counterparty_node_id.serialize()),
455 io::stdout().flush().unwrap();
457 Event::ChannelClosed {
461 counterparty_node_id,
462 channel_capacity_sats: _,
465 "\nEVENT: Channel {} with counterparty {} closed due to: {:?}",
467 counterparty_node_id.map(|id| format!("{}", id)).unwrap_or("".to_owned()),
471 io::stdout().flush().unwrap();
473 Event::DiscardFunding { .. } => {
474 // A "real" node should probably "lock" the UTXOs spent in funding transactions until
475 // the funding transaction either confirms, or this event is generated.
477 Event::HTLCIntercepted { .. } => {}
478 Event::BumpTransaction(event) => bump_tx_event_handler.handle_event(&event),
482 async fn start_ldk() {
483 let args = match args::parse_startup_args() {
484 Ok(user_args) => user_args,
488 // Initialize the LDK data directory if necessary.
489 let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
490 fs::create_dir_all(ldk_data_dir.clone()).unwrap();
493 // Step 1: Initialize the Logger
494 let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
496 // Initialize our bitcoind client.
497 let bitcoind_client = match BitcoindClient::new(
498 args.bitcoind_rpc_host.clone(),
499 args.bitcoind_rpc_port,
500 args.bitcoind_rpc_username.clone(),
501 args.bitcoind_rpc_password.clone(),
502 tokio::runtime::Handle::current(),
507 Ok(client) => Arc::new(client),
509 println!("Failed to connect to bitcoind client: {}", e);
514 // Check that the bitcoind we've connected to is running the network we expect
515 let bitcoind_chain = bitcoind_client.get_blockchain_info().await.chain;
517 != match args.network {
518 bitcoin::Network::Bitcoin => "main",
519 bitcoin::Network::Testnet => "test",
520 bitcoin::Network::Regtest => "regtest",
521 bitcoin::Network::Signet => "signet",
524 "Chain argument ({}) didn't match bitcoind chain ({})",
525 args.network, bitcoind_chain
530 // Step 2: Initialize the FeeEstimator
532 // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
533 let fee_estimator = bitcoind_client.clone();
535 // Step 3: Initialize the BroadcasterInterface
537 // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
539 let broadcaster = bitcoind_client.clone();
541 // Step 4: Initialize Persist
542 let persister = Arc::new(FilesystemStore::new(ldk_data_dir.clone().into()));
544 // Step 5: Initialize the ChainMonitor
545 let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
549 fee_estimator.clone(),
553 // Step 6: Initialize the KeysManager
555 // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
556 // other secret key material.
557 let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
558 let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
559 assert_eq!(seed.len(), 32);
560 let mut key = [0; 32];
561 key.copy_from_slice(&seed);
564 let mut key = [0; 32];
565 thread_rng().fill_bytes(&mut key);
566 match File::create(keys_seed_path.clone()) {
568 Write::write_all(&mut f, &key).expect("Failed to write node keys seed to disk");
569 f.sync_all().expect("Failed to sync node keys seed to disk");
572 println!("ERROR: Unable to create keys seed file {}: {}", keys_seed_path, e);
578 let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
579 let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
581 let bump_tx_event_handler = Arc::new(BumpTransactionEventHandler::new(
582 Arc::clone(&broadcaster),
583 Arc::new(Wallet::new(Arc::clone(&bitcoind_client), Arc::clone(&logger))),
584 Arc::clone(&keys_manager),
588 // Step 7: Read ChannelMonitor state from disk
589 let mut channelmonitors =
590 read_channel_monitors(Arc::clone(&persister), keys_manager.clone(), keys_manager.clone())
593 // Step 8: Poll for the best chain tip, which may be used by the channel manager & spv client
594 let polled_chain_tip = init::validate_best_block_header(bitcoind_client.as_ref())
596 .expect("Failed to fetch best block header and best block");
598 // Step 9: Initialize routing ProbabilisticScorer
599 let network_graph_path = format!("{}/network_graph", ldk_data_dir.clone());
601 Arc::new(disk::read_network(Path::new(&network_graph_path), args.network, logger.clone()));
603 let scorer_path = format!("{}/scorer", ldk_data_dir.clone());
604 let scorer = Arc::new(RwLock::new(disk::read_scorer(
605 Path::new(&scorer_path),
606 Arc::clone(&network_graph),
610 // Step 10: Create Router
611 let scoring_fee_params = ProbabilisticScoringFeeParameters::default();
612 let router = Arc::new(DefaultRouter::new(
613 network_graph.clone(),
615 keys_manager.get_secure_random_bytes(),
620 // Step 11: Initialize the ChannelManager
621 let mut user_config = UserConfig::default();
622 user_config.channel_handshake_limits.force_announced_channel_preference = false;
623 user_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
624 user_config.manually_accept_inbound_channels = true;
625 let mut restarting_node = true;
626 let (channel_manager_blockhash, channel_manager) = {
627 if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
628 let mut channel_monitor_mut_references = Vec::new();
629 for (_, channel_monitor) in channelmonitors.iter_mut() {
630 channel_monitor_mut_references.push(channel_monitor);
632 let read_args = ChannelManagerReadArgs::new(
633 keys_manager.clone(),
634 keys_manager.clone(),
635 keys_manager.clone(),
636 fee_estimator.clone(),
637 chain_monitor.clone(),
642 channel_monitor_mut_references,
644 <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
646 // We're starting a fresh node.
647 restarting_node = false;
649 let polled_best_block = polled_chain_tip.to_best_block();
650 let polled_best_block_hash = polled_best_block.block_hash();
652 ChainParameters { network: args.network, best_block: polled_best_block };
653 let fresh_channel_manager = channelmanager::ChannelManager::new(
654 fee_estimator.clone(),
655 chain_monitor.clone(),
659 keys_manager.clone(),
660 keys_manager.clone(),
661 keys_manager.clone(),
664 cur.as_secs() as u32,
666 (polled_best_block_hash, fresh_channel_manager)
670 // Step 12: Sync ChannelMonitors and ChannelManager to chain tip
671 let mut chain_listener_channel_monitors = Vec::new();
672 let mut cache = UnboundedCache::new();
673 let chain_tip = if restarting_node {
674 let mut chain_listeners = vec![(
675 channel_manager_blockhash,
676 &channel_manager as &(dyn chain::Listen + Send + Sync),
679 for (blockhash, channel_monitor) in channelmonitors.drain(..) {
680 let outpoint = channel_monitor.get_funding_txo().0;
681 chain_listener_channel_monitors.push((
683 (channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()),
688 for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
689 chain_listeners.push((
690 monitor_listener_info.0,
691 &monitor_listener_info.1 as &(dyn chain::Listen + Send + Sync),
695 init::synchronize_listeners(
696 bitcoind_client.as_ref(),
707 // Step 13: Give ChannelMonitors to ChainMonitor
708 for item in chain_listener_channel_monitors.drain(..) {
709 let channel_monitor = item.1 .0;
710 let funding_outpoint = item.2;
712 chain_monitor.watch_channel(funding_outpoint, channel_monitor),
713 Ok(ChannelMonitorUpdateStatus::Completed)
717 // Step 14: Optional: Initialize the P2PGossipSync
718 let gossip_sync = Arc::new(P2PGossipSync::new(
719 Arc::clone(&network_graph),
720 None::<Arc<BitcoindClient>>,
724 // Step 15: Initialize the PeerManager
725 let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
726 let onion_messenger: Arc<OnionMessenger> = Arc::new(OnionMessenger::new(
727 Arc::clone(&keys_manager),
728 Arc::clone(&keys_manager),
730 Arc::new(DefaultMessageRouter {}),
731 IgnoringMessageHandler {},
732 IgnoringMessageHandler {},
734 let mut ephemeral_bytes = [0; 32];
735 let current_time = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs();
736 rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
737 let lightning_msg_handler = MessageHandler {
738 chan_handler: channel_manager.clone(),
739 route_handler: gossip_sync.clone(),
740 onion_message_handler: onion_messenger.clone(),
741 custom_message_handler: IgnoringMessageHandler {},
743 let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
744 lightning_msg_handler,
745 current_time.try_into().unwrap(),
748 Arc::clone(&keys_manager),
752 // Step 16: Initialize networking
754 let peer_manager_connection_handler = peer_manager.clone();
755 let listening_port = args.ldk_peer_listening_port;
756 let stop_listen_connect = Arc::new(AtomicBool::new(false));
757 let stop_listen = Arc::clone(&stop_listen_connect);
758 tokio::spawn(async move {
759 let listener = tokio::net::TcpListener::bind(format!("[::]:{}", listening_port))
761 .expect("Failed to bind to listen port - is something else already listening on it?");
763 let peer_mgr = peer_manager_connection_handler.clone();
764 let tcp_stream = listener.accept().await.unwrap().0;
765 if stop_listen.load(Ordering::Acquire) {
768 tokio::spawn(async move {
769 lightning_net_tokio::setup_inbound(
771 tcp_stream.into_std().unwrap(),
778 // Step 17: Connect and Disconnect Blocks
779 let channel_manager_listener = channel_manager.clone();
780 let chain_monitor_listener = chain_monitor.clone();
781 let bitcoind_block_source = bitcoind_client.clone();
782 let network = args.network;
783 tokio::spawn(async move {
784 let chain_poller = poll::ChainPoller::new(bitcoind_block_source.as_ref(), network);
785 let chain_listener = (chain_monitor_listener, channel_manager_listener);
786 let mut spv_client = SpvClient::new(chain_tip, chain_poller, &mut cache, &chain_listener);
788 spv_client.poll_best_tip().await.unwrap();
789 tokio::time::sleep(Duration::from_secs(1)).await;
793 let inbound_payments = Arc::new(Mutex::new(disk::read_payment_info(Path::new(&format!(
795 ldk_data_dir, INBOUND_PAYMENTS_FNAME
797 let outbound_payments = Arc::new(Mutex::new(disk::read_payment_info(Path::new(&format!(
799 ldk_data_dir, OUTBOUND_PAYMENTS_FNAME
801 let recent_payments_payment_hashes = channel_manager
802 .list_recent_payments()
804 .filter_map(|p| match p {
805 RecentPaymentDetails::Pending { payment_hash, .. } => Some(payment_hash),
806 RecentPaymentDetails::Fulfilled { payment_hash, .. } => payment_hash,
807 RecentPaymentDetails::Abandoned { payment_hash, .. } => Some(payment_hash),
808 RecentPaymentDetails::AwaitingInvoice { payment_id: _ } => todo!(),
810 .collect::<Vec<PaymentHash>>();
811 for (payment_hash, payment_info) in outbound_payments
816 .filter(|(_, i)| matches!(i.status, HTLCStatus::Pending))
818 if !recent_payments_payment_hashes.contains(payment_hash) {
819 payment_info.status = HTLCStatus::Failed;
823 .write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound_payments.lock().unwrap().encode())
826 // Step 18: Handle LDK Events
827 let channel_manager_event_listener = Arc::clone(&channel_manager);
828 let bitcoind_client_event_listener = Arc::clone(&bitcoind_client);
829 let network_graph_event_listener = Arc::clone(&network_graph);
830 let keys_manager_event_listener = Arc::clone(&keys_manager);
831 let inbound_payments_event_listener = Arc::clone(&inbound_payments);
832 let outbound_payments_event_listener = Arc::clone(&outbound_payments);
833 let persister_event_listener = Arc::clone(&persister);
834 let network = args.network;
835 let event_handler = move |event: Event| {
836 let channel_manager_event_listener = Arc::clone(&channel_manager_event_listener);
837 let bitcoind_client_event_listener = Arc::clone(&bitcoind_client_event_listener);
838 let network_graph_event_listener = Arc::clone(&network_graph_event_listener);
839 let keys_manager_event_listener = Arc::clone(&keys_manager_event_listener);
840 let bump_tx_event_handler = Arc::clone(&bump_tx_event_handler);
841 let inbound_payments_event_listener = Arc::clone(&inbound_payments_event_listener);
842 let outbound_payments_event_listener = Arc::clone(&outbound_payments_event_listener);
843 let persister_event_listener = Arc::clone(&persister_event_listener);
846 &channel_manager_event_listener,
847 &bitcoind_client_event_listener,
848 &network_graph_event_listener,
849 &keys_manager_event_listener,
850 &bump_tx_event_handler,
851 inbound_payments_event_listener,
852 outbound_payments_event_listener,
853 &persister_event_listener,
861 // Step 19: Persist ChannelManager and NetworkGraph
862 let persister = Arc::new(FilesystemStore::new(ldk_data_dir.clone().into()));
864 // Step 20: Background Processing
865 let (bp_exit, bp_exit_check) = tokio::sync::watch::channel(());
866 let mut background_processor = tokio::spawn(process_events_async(
867 Arc::clone(&persister),
869 chain_monitor.clone(),
870 channel_manager.clone(),
871 GossipSync::p2p(gossip_sync.clone()),
872 peer_manager.clone(),
874 Some(scorer.clone()),
876 let mut bp_exit_fut_check = bp_exit_check.clone();
877 Box::pin(async move {
879 _ = tokio::time::sleep(t) => false,
880 _ = bp_exit_fut_check.changed() => true,
887 // Regularly reconnect to channel peers.
888 let connect_cm = Arc::clone(&channel_manager);
889 let connect_pm = Arc::clone(&peer_manager);
890 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir);
891 let stop_connect = Arc::clone(&stop_listen_connect);
892 tokio::spawn(async move {
893 let mut interval = tokio::time::interval(Duration::from_secs(1));
894 interval.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Delay);
896 interval.tick().await;
897 match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
899 let peers = connect_pm.get_peer_node_ids();
900 for node_id in connect_cm
903 .map(|chan| chan.counterparty.node_id)
904 .filter(|id| !peers.iter().any(|(pk, _)| id == pk))
906 if stop_connect.load(Ordering::Acquire) {
909 for (pubkey, peer_addr) in info.iter() {
910 if *pubkey == node_id {
911 let _ = cli::do_connect_peer(
914 Arc::clone(&connect_pm),
921 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
926 // Regularly broadcast our node_announcement. This is only required (or possible) if we have
927 // some public channels.
928 let peer_man = Arc::clone(&peer_manager);
929 let chan_man = Arc::clone(&channel_manager);
930 let network = args.network;
931 tokio::spawn(async move {
932 // First wait a minute until we have some peers and maybe have opened a channel.
933 tokio::time::sleep(Duration::from_secs(60)).await;
934 // Then, update our announcement once an hour to keep it fresh but avoid unnecessary churn
935 // in the global gossip network.
936 let mut interval = tokio::time::interval(Duration::from_secs(3600));
938 interval.tick().await;
939 // Don't bother trying to announce if we don't have any public channls, though our
940 // peers should drop such an announcement anyway. Note that announcement may not
941 // propagate until we have a channel with 6+ confirmations.
942 if chan_man.list_channels().iter().any(|chan| chan.is_public) {
943 peer_man.broadcast_node_announcement(
945 args.ldk_announced_node_name,
946 args.ldk_announced_listen_addr.clone(),
952 tokio::spawn(sweep::periodic_sweep(
953 ldk_data_dir.clone(),
954 Arc::clone(&keys_manager),
956 Arc::clone(&persister),
957 Arc::clone(&bitcoind_client),
958 Arc::clone(&channel_manager),
962 let cli_channel_manager = Arc::clone(&channel_manager);
963 let cli_persister = Arc::clone(&persister);
964 let cli_logger = Arc::clone(&logger);
965 let cli_peer_manager = Arc::clone(&peer_manager);
966 let cli_poll = tokio::task::spawn_blocking(move || {
967 cli::poll_for_user_input(
982 // Exit if either CLI polling exits or the background processor exits (which shouldn't happen
983 // unless we fail to write to the filesystem).
984 let mut bg_res = Ok(Ok(()));
987 bg_exit = &mut background_processor => {
992 // Disconnect our peers and stop accepting new connections. This ensures we don't continue
993 // updating our channel data after we've stopped the background processor.
994 stop_listen_connect.store(true, Ordering::Release);
995 peer_manager.disconnect_all_peers();
997 if let Err(e) = bg_res {
998 let persist_res = persister
1000 persist::CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
1001 persist::CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
1002 persist::CHANNEL_MANAGER_PERSISTENCE_KEY,
1003 &channel_manager.encode(),
1006 use lightning::util::logger::Logger;
1007 lightning::log_error!(
1009 "Last-ditch ChannelManager persistence result: {:?}",
1013 "ERR: background processing stopped with result {:?}, exiting.\n\
1014 Last-ditch ChannelManager persistence result {:?}",
1019 // Stop the background processor.
1020 if !bp_exit.is_closed() {
1021 bp_exit.send(()).unwrap();
1022 background_processor.await.unwrap().unwrap();
1027 pub async fn main() {
1028 #[cfg(not(target_os = "windows"))]
1030 // Catch Ctrl-C with a dummy signal handler.
1032 let mut new_action: libc::sigaction = core::mem::zeroed();
1033 let mut old_action: libc::sigaction = core::mem::zeroed();
1035 extern "C" fn dummy_handler(
1036 _: libc::c_int, _: *const libc::siginfo_t, _: *const libc::c_void,
1040 new_action.sa_sigaction = dummy_handler as libc::sighandler_t;
1041 new_action.sa_flags = libc::SA_SIGINFO;
1045 &new_action as *const libc::sigaction,
1046 &mut old_action as *mut libc::sigaction,