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 payment_hash, amount_msat,
224 io::stdout().flush().unwrap();
225 let payment_preimage = match purpose {
226 PaymentPurpose::InvoicePayment { payment_preimage, .. } => payment_preimage,
227 PaymentPurpose::SpontaneousPayment(preimage) => Some(preimage),
229 channel_manager.claim_funds(payment_preimage.unwrap());
231 Event::PaymentClaimed {
237 sender_intended_total_msat: _,
240 "\nEVENT: claimed payment from payment hash {} of {} millisatoshis",
241 payment_hash, amount_msat,
244 io::stdout().flush().unwrap();
245 let (payment_preimage, payment_secret) = match purpose {
246 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
247 (payment_preimage, Some(payment_secret))
249 PaymentPurpose::SpontaneousPayment(preimage) => (Some(preimage), None),
251 let mut inbound = inbound_payments.lock().unwrap();
252 match inbound.payments.entry(payment_hash) {
253 Entry::Occupied(mut e) => {
254 let payment = e.get_mut();
255 payment.status = HTLCStatus::Succeeded;
256 payment.preimage = payment_preimage;
257 payment.secret = payment_secret;
259 Entry::Vacant(e) => {
260 e.insert(PaymentInfo {
261 preimage: payment_preimage,
262 secret: payment_secret,
263 status: HTLCStatus::Succeeded,
264 amt_msat: MillisatAmount(Some(amount_msat)),
268 persister.write("", "", INBOUND_PAYMENTS_FNAME, &inbound.encode()).unwrap();
270 Event::PaymentSent { payment_preimage, payment_hash, fee_paid_msat, .. } => {
271 let mut outbound = outbound_payments.lock().unwrap();
272 for (hash, payment) in outbound.payments.iter_mut() {
273 if *hash == payment_hash {
274 payment.preimage = Some(payment_preimage);
275 payment.status = HTLCStatus::Succeeded;
277 "\nEVENT: successfully sent payment of {} millisatoshis{} from \
278 payment hash {} with preimage {}",
280 if let Some(fee) = fee_paid_msat {
281 format!(" (fee {} msat)", fee)
289 io::stdout().flush().unwrap();
292 persister.write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound.encode()).unwrap();
294 Event::OpenChannelRequest {
295 ref temporary_channel_id, ref counterparty_node_id, ..
297 let mut random_bytes = [0u8; 16];
298 random_bytes.copy_from_slice(&keys_manager.get_secure_random_bytes()[..16]);
299 let user_channel_id = u128::from_be_bytes(random_bytes);
300 let res = channel_manager.accept_inbound_channel(
301 temporary_channel_id,
302 counterparty_node_id,
306 if let Err(e) = res {
308 "\nEVENT: Failed to accept inbound channel ({}) from {}: {:?}",
309 temporary_channel_id,
310 hex_utils::hex_str(&counterparty_node_id.serialize()),
315 "\nEVENT: Accepted inbound channel ({}) from {}",
316 temporary_channel_id,
317 hex_utils::hex_str(&counterparty_node_id.serialize()),
321 io::stdout().flush().unwrap();
323 Event::PaymentPathSuccessful { .. } => {}
324 Event::PaymentPathFailed { .. } => {}
325 Event::ProbeSuccessful { .. } => {}
326 Event::ProbeFailed { .. } => {}
327 Event::PaymentFailed { payment_hash, reason, .. } => {
329 "\nEVENT: Failed to send payment to payment hash {}: {:?}",
331 if let Some(r) = reason { r } else { PaymentFailureReason::RetriesExhausted }
334 io::stdout().flush().unwrap();
336 let mut outbound = outbound_payments.lock().unwrap();
337 if outbound.payments.contains_key(&payment_hash) {
338 let payment = outbound.payments.get_mut(&payment_hash).unwrap();
339 payment.status = HTLCStatus::Failed;
341 persister.write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound.encode()).unwrap();
343 Event::PaymentForwarded {
347 claim_from_onchain_tx,
348 outbound_amount_forwarded_msat,
350 let read_only_network_graph = network_graph.read_only();
351 let nodes = read_only_network_graph.nodes();
352 let channels = channel_manager.list_channels();
354 let node_str = |channel_id: &Option<ChannelId>| match channel_id {
355 None => String::new(),
356 Some(channel_id) => match channels.iter().find(|c| c.channel_id == *channel_id) {
357 None => String::new(),
359 match nodes.get(&NodeId::from_pubkey(&channel.counterparty.node_id)) {
360 None => "private node".to_string(),
361 Some(node) => match &node.announcement_info {
362 None => "unnamed node".to_string(),
363 Some(announcement) => {
364 format!("node {}", announcement.alias)
371 let channel_str = |channel_id: &Option<ChannelId>| {
373 .map(|channel_id| format!(" with channel {}", channel_id))
377 format!(" from {}{}", node_str(&prev_channel_id), channel_str(&prev_channel_id));
379 format!(" to {}{}", node_str(&next_channel_id), channel_str(&next_channel_id));
381 let from_onchain_str = if claim_from_onchain_tx {
382 "from onchain downstream claim"
384 "from HTLC fulfill message"
386 let amt_args = if let Some(v) = outbound_amount_forwarded_msat {
391 if let Some(fee_earned) = fee_earned_msat {
393 "\nEVENT: Forwarded payment for {} msat{}{}, earning {} msat {}",
394 amt_args, from_prev_str, to_next_str, fee_earned, from_onchain_str
398 "\nEVENT: Forwarded payment for {} msat{}{}, claiming onchain {}",
399 amt_args, from_prev_str, to_next_str, from_onchain_str
403 io::stdout().flush().unwrap();
405 Event::HTLCHandlingFailed { .. } => {}
406 Event::PendingHTLCsForwardable { time_forwardable } => {
407 let forwarding_channel_manager = channel_manager.clone();
408 let min = time_forwardable.as_millis() as u64;
409 tokio::spawn(async move {
410 let millis_to_sleep = thread_rng().gen_range(min, min * 5) as u64;
411 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
412 forwarding_channel_manager.process_pending_htlc_forwards();
415 Event::SpendableOutputs { outputs, channel_id: _ } => {
416 // SpendableOutputDescriptors, of which outputs is a vec of, are critical to keep track
417 // of! While a `StaticOutput` descriptor is just an output to a static, well-known key,
418 // other descriptors are not currently ever regenerated for you by LDK. Once we return
419 // from this method, the descriptor will be gone, and you may lose track of some funds.
421 // Here we simply persist them to disk, with a background task running which will try
422 // to spend them regularly (possibly duplicatively/RBF'ing them). These can just be
423 // treated as normal funds where possible - they are only spendable by us and there is
424 // no rush to claim them.
425 for output in outputs {
426 let key = hex_utils::hex_str(&keys_manager.get_secure_random_bytes());
427 // Note that if the type here changes our read code needs to change as well.
428 let output: SpendableOutputDescriptor = output;
429 persister.write(PENDING_SPENDABLE_OUTPUT_DIR, "", &key, &output.encode()).unwrap();
432 Event::ChannelPending { channel_id, counterparty_node_id, .. } => {
434 "\nEVENT: Channel {} with peer {} is pending awaiting funding lock-in!",
436 hex_utils::hex_str(&counterparty_node_id.serialize()),
439 io::stdout().flush().unwrap();
441 Event::ChannelReady {
444 ref counterparty_node_id,
448 "\nEVENT: Channel {} with peer {} is ready to be used!",
450 hex_utils::hex_str(&counterparty_node_id.serialize()),
453 io::stdout().flush().unwrap();
455 Event::ChannelClosed {
459 counterparty_node_id,
460 channel_capacity_sats: _,
463 "\nEVENT: Channel {} with counterparty {} closed due to: {:?}",
465 counterparty_node_id.map(|id| format!("{}", id)).unwrap_or("".to_owned()),
469 io::stdout().flush().unwrap();
471 Event::DiscardFunding { .. } => {
472 // A "real" node should probably "lock" the UTXOs spent in funding transactions until
473 // the funding transaction either confirms, or this event is generated.
475 Event::HTLCIntercepted { .. } => {}
476 Event::BumpTransaction(event) => bump_tx_event_handler.handle_event(&event),
480 async fn start_ldk() {
481 let args = match args::parse_startup_args() {
482 Ok(user_args) => user_args,
486 // Initialize the LDK data directory if necessary.
487 let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
488 fs::create_dir_all(ldk_data_dir.clone()).unwrap();
491 // Step 1: Initialize the Logger
492 let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
494 // Initialize our bitcoind client.
495 let bitcoind_client = match BitcoindClient::new(
496 args.bitcoind_rpc_host.clone(),
497 args.bitcoind_rpc_port,
498 args.bitcoind_rpc_username.clone(),
499 args.bitcoind_rpc_password.clone(),
500 tokio::runtime::Handle::current(),
505 Ok(client) => Arc::new(client),
507 println!("Failed to connect to bitcoind client: {}", e);
512 // Check that the bitcoind we've connected to is running the network we expect
513 let bitcoind_chain = bitcoind_client.get_blockchain_info().await.chain;
515 != match args.network {
516 bitcoin::Network::Bitcoin => "main",
517 bitcoin::Network::Testnet => "test",
518 bitcoin::Network::Regtest => "regtest",
519 bitcoin::Network::Signet => "signet",
522 "Chain argument ({}) didn't match bitcoind chain ({})",
523 args.network, bitcoind_chain
528 // Step 2: Initialize the FeeEstimator
530 // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
531 let fee_estimator = bitcoind_client.clone();
533 // Step 3: Initialize the BroadcasterInterface
535 // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
537 let broadcaster = bitcoind_client.clone();
539 // Step 4: Initialize Persist
540 let persister = Arc::new(FilesystemStore::new(ldk_data_dir.clone().into()));
542 // Step 5: Initialize the ChainMonitor
543 let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
547 fee_estimator.clone(),
551 // Step 6: Initialize the KeysManager
553 // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
554 // other secret key material.
555 let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
556 let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
557 assert_eq!(seed.len(), 32);
558 let mut key = [0; 32];
559 key.copy_from_slice(&seed);
562 let mut key = [0; 32];
563 thread_rng().fill_bytes(&mut key);
564 match File::create(keys_seed_path.clone()) {
566 Write::write_all(&mut f, &key).expect("Failed to write node keys seed to disk");
567 f.sync_all().expect("Failed to sync node keys seed to disk");
570 println!("ERROR: Unable to create keys seed file {}: {}", keys_seed_path, e);
576 let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
577 let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
579 let bump_tx_event_handler = Arc::new(BumpTransactionEventHandler::new(
580 Arc::clone(&broadcaster),
581 Arc::new(Wallet::new(Arc::clone(&bitcoind_client), Arc::clone(&logger))),
582 Arc::clone(&keys_manager),
586 // Step 7: Read ChannelMonitor state from disk
587 let mut channelmonitors =
588 read_channel_monitors(Arc::clone(&persister), keys_manager.clone(), keys_manager.clone())
591 // Step 8: Poll for the best chain tip, which may be used by the channel manager & spv client
592 let polled_chain_tip = init::validate_best_block_header(bitcoind_client.as_ref())
594 .expect("Failed to fetch best block header and best block");
596 // Step 9: Initialize routing ProbabilisticScorer
597 let network_graph_path = format!("{}/network_graph", ldk_data_dir.clone());
599 Arc::new(disk::read_network(Path::new(&network_graph_path), args.network, logger.clone()));
601 let scorer_path = format!("{}/scorer", ldk_data_dir.clone());
602 let scorer = Arc::new(RwLock::new(disk::read_scorer(
603 Path::new(&scorer_path),
604 Arc::clone(&network_graph),
608 // Step 10: Create Router
609 let scoring_fee_params = ProbabilisticScoringFeeParameters::default();
610 let router = Arc::new(DefaultRouter::new(
611 network_graph.clone(),
613 keys_manager.get_secure_random_bytes(),
618 // Step 11: Initialize the ChannelManager
619 let mut user_config = UserConfig::default();
620 user_config.channel_handshake_limits.force_announced_channel_preference = false;
621 user_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
622 user_config.manually_accept_inbound_channels = true;
623 let mut restarting_node = true;
624 let (channel_manager_blockhash, channel_manager) = {
625 if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
626 let mut channel_monitor_mut_references = Vec::new();
627 for (_, channel_monitor) in channelmonitors.iter_mut() {
628 channel_monitor_mut_references.push(channel_monitor);
630 let read_args = ChannelManagerReadArgs::new(
631 keys_manager.clone(),
632 keys_manager.clone(),
633 keys_manager.clone(),
634 fee_estimator.clone(),
635 chain_monitor.clone(),
640 channel_monitor_mut_references,
642 <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
644 // We're starting a fresh node.
645 restarting_node = false;
647 let polled_best_block = polled_chain_tip.to_best_block();
648 let polled_best_block_hash = polled_best_block.block_hash();
650 ChainParameters { network: args.network, best_block: polled_best_block };
651 let fresh_channel_manager = channelmanager::ChannelManager::new(
652 fee_estimator.clone(),
653 chain_monitor.clone(),
657 keys_manager.clone(),
658 keys_manager.clone(),
659 keys_manager.clone(),
662 cur.as_secs() as u32,
664 (polled_best_block_hash, fresh_channel_manager)
668 // Step 12: Sync ChannelMonitors and ChannelManager to chain tip
669 let mut chain_listener_channel_monitors = Vec::new();
670 let mut cache = UnboundedCache::new();
671 let chain_tip = if restarting_node {
672 let mut chain_listeners = vec![(
673 channel_manager_blockhash,
674 &channel_manager as &(dyn chain::Listen + Send + Sync),
677 for (blockhash, channel_monitor) in channelmonitors.drain(..) {
678 let outpoint = channel_monitor.get_funding_txo().0;
679 chain_listener_channel_monitors.push((
681 (channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()),
686 for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
687 chain_listeners.push((
688 monitor_listener_info.0,
689 &monitor_listener_info.1 as &(dyn chain::Listen + Send + Sync),
693 init::synchronize_listeners(
694 bitcoind_client.as_ref(),
705 // Step 13: Give ChannelMonitors to ChainMonitor
706 for item in chain_listener_channel_monitors.drain(..) {
707 let channel_monitor = item.1 .0;
708 let funding_outpoint = item.2;
710 chain_monitor.watch_channel(funding_outpoint, channel_monitor),
711 Ok(ChannelMonitorUpdateStatus::Completed)
715 // Step 14: Optional: Initialize the P2PGossipSync
716 let gossip_sync = Arc::new(P2PGossipSync::new(
717 Arc::clone(&network_graph),
718 None::<Arc<BitcoindClient>>,
722 // Step 15: Initialize the PeerManager
723 let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
724 let onion_messenger: Arc<OnionMessenger> = Arc::new(OnionMessenger::new(
725 Arc::clone(&keys_manager),
726 Arc::clone(&keys_manager),
728 Arc::new(DefaultMessageRouter {}),
729 IgnoringMessageHandler {},
730 IgnoringMessageHandler {},
732 let mut ephemeral_bytes = [0; 32];
733 let current_time = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs();
734 rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
735 let lightning_msg_handler = MessageHandler {
736 chan_handler: channel_manager.clone(),
737 route_handler: gossip_sync.clone(),
738 onion_message_handler: onion_messenger.clone(),
739 custom_message_handler: IgnoringMessageHandler {},
741 let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
742 lightning_msg_handler,
743 current_time.try_into().unwrap(),
746 Arc::clone(&keys_manager),
750 // Step 16: Initialize networking
752 let peer_manager_connection_handler = peer_manager.clone();
753 let listening_port = args.ldk_peer_listening_port;
754 let stop_listen_connect = Arc::new(AtomicBool::new(false));
755 let stop_listen = Arc::clone(&stop_listen_connect);
756 tokio::spawn(async move {
757 let listener = tokio::net::TcpListener::bind(format!("[::]:{}", listening_port))
759 .expect("Failed to bind to listen port - is something else already listening on it?");
761 let peer_mgr = peer_manager_connection_handler.clone();
762 let tcp_stream = listener.accept().await.unwrap().0;
763 if stop_listen.load(Ordering::Acquire) {
766 tokio::spawn(async move {
767 lightning_net_tokio::setup_inbound(
769 tcp_stream.into_std().unwrap(),
776 // Step 17: Connect and Disconnect Blocks
777 let channel_manager_listener = channel_manager.clone();
778 let chain_monitor_listener = chain_monitor.clone();
779 let bitcoind_block_source = bitcoind_client.clone();
780 let network = args.network;
781 tokio::spawn(async move {
782 let chain_poller = poll::ChainPoller::new(bitcoind_block_source.as_ref(), network);
783 let chain_listener = (chain_monitor_listener, channel_manager_listener);
784 let mut spv_client = SpvClient::new(chain_tip, chain_poller, &mut cache, &chain_listener);
786 spv_client.poll_best_tip().await.unwrap();
787 tokio::time::sleep(Duration::from_secs(1)).await;
791 let inbound_payments = Arc::new(Mutex::new(disk::read_payment_info(Path::new(&format!(
793 ldk_data_dir, INBOUND_PAYMENTS_FNAME
795 let outbound_payments = Arc::new(Mutex::new(disk::read_payment_info(Path::new(&format!(
797 ldk_data_dir, OUTBOUND_PAYMENTS_FNAME
799 let recent_payments_payment_hashes = channel_manager
800 .list_recent_payments()
802 .filter_map(|p| match p {
803 RecentPaymentDetails::Pending { payment_hash, .. } => Some(payment_hash),
804 RecentPaymentDetails::Fulfilled { payment_hash, .. } => payment_hash,
805 RecentPaymentDetails::Abandoned { payment_hash, .. } => Some(payment_hash),
806 RecentPaymentDetails::AwaitingInvoice { payment_id: _ } => todo!(),
808 .collect::<Vec<PaymentHash>>();
809 for (payment_hash, payment_info) in outbound_payments
814 .filter(|(_, i)| matches!(i.status, HTLCStatus::Pending))
816 if !recent_payments_payment_hashes.contains(payment_hash) {
817 payment_info.status = HTLCStatus::Failed;
821 .write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound_payments.lock().unwrap().encode())
824 // Step 18: Handle LDK Events
825 let channel_manager_event_listener = Arc::clone(&channel_manager);
826 let bitcoind_client_event_listener = Arc::clone(&bitcoind_client);
827 let network_graph_event_listener = Arc::clone(&network_graph);
828 let keys_manager_event_listener = Arc::clone(&keys_manager);
829 let inbound_payments_event_listener = Arc::clone(&inbound_payments);
830 let outbound_payments_event_listener = Arc::clone(&outbound_payments);
831 let persister_event_listener = Arc::clone(&persister);
832 let network = args.network;
833 let event_handler = move |event: Event| {
834 let channel_manager_event_listener = Arc::clone(&channel_manager_event_listener);
835 let bitcoind_client_event_listener = Arc::clone(&bitcoind_client_event_listener);
836 let network_graph_event_listener = Arc::clone(&network_graph_event_listener);
837 let keys_manager_event_listener = Arc::clone(&keys_manager_event_listener);
838 let bump_tx_event_handler = Arc::clone(&bump_tx_event_handler);
839 let inbound_payments_event_listener = Arc::clone(&inbound_payments_event_listener);
840 let outbound_payments_event_listener = Arc::clone(&outbound_payments_event_listener);
841 let persister_event_listener = Arc::clone(&persister_event_listener);
844 &channel_manager_event_listener,
845 &bitcoind_client_event_listener,
846 &network_graph_event_listener,
847 &keys_manager_event_listener,
848 &bump_tx_event_handler,
849 inbound_payments_event_listener,
850 outbound_payments_event_listener,
851 &persister_event_listener,
859 // Step 19: Persist ChannelManager and NetworkGraph
860 let persister = Arc::new(FilesystemStore::new(ldk_data_dir.clone().into()));
862 // Step 20: Background Processing
863 let (bp_exit, bp_exit_check) = tokio::sync::watch::channel(());
864 let mut background_processor = tokio::spawn(process_events_async(
865 Arc::clone(&persister),
867 chain_monitor.clone(),
868 channel_manager.clone(),
869 GossipSync::p2p(gossip_sync.clone()),
870 peer_manager.clone(),
872 Some(scorer.clone()),
874 let mut bp_exit_fut_check = bp_exit_check.clone();
875 Box::pin(async move {
877 _ = tokio::time::sleep(t) => false,
878 _ = bp_exit_fut_check.changed() => true,
885 // Regularly reconnect to channel peers.
886 let connect_cm = Arc::clone(&channel_manager);
887 let connect_pm = Arc::clone(&peer_manager);
888 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir);
889 let stop_connect = Arc::clone(&stop_listen_connect);
890 tokio::spawn(async move {
891 let mut interval = tokio::time::interval(Duration::from_secs(1));
892 interval.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Delay);
894 interval.tick().await;
895 match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
897 let peers = connect_pm.get_peer_node_ids();
898 for node_id in connect_cm
901 .map(|chan| chan.counterparty.node_id)
902 .filter(|id| !peers.iter().any(|(pk, _)| id == pk))
904 if stop_connect.load(Ordering::Acquire) {
907 for (pubkey, peer_addr) in info.iter() {
908 if *pubkey == node_id {
909 let _ = cli::do_connect_peer(
912 Arc::clone(&connect_pm),
919 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
924 // Regularly broadcast our node_announcement. This is only required (or possible) if we have
925 // some public channels.
926 let peer_man = Arc::clone(&peer_manager);
927 let chan_man = Arc::clone(&channel_manager);
928 let network = args.network;
929 tokio::spawn(async move {
930 // First wait a minute until we have some peers and maybe have opened a channel.
931 tokio::time::sleep(Duration::from_secs(60)).await;
932 // Then, update our announcement once an hour to keep it fresh but avoid unnecessary churn
933 // in the global gossip network.
934 let mut interval = tokio::time::interval(Duration::from_secs(3600));
936 interval.tick().await;
937 // Don't bother trying to announce if we don't have any public channls, though our
938 // peers should drop such an announcement anyway. Note that announcement may not
939 // propagate until we have a channel with 6+ confirmations.
940 if chan_man.list_channels().iter().any(|chan| chan.is_public) {
941 peer_man.broadcast_node_announcement(
943 args.ldk_announced_node_name,
944 args.ldk_announced_listen_addr.clone(),
950 tokio::spawn(sweep::periodic_sweep(
951 ldk_data_dir.clone(),
952 Arc::clone(&keys_manager),
954 Arc::clone(&persister),
955 Arc::clone(&bitcoind_client),
956 Arc::clone(&channel_manager),
960 let cli_channel_manager = Arc::clone(&channel_manager);
961 let cli_persister = Arc::clone(&persister);
962 let cli_logger = Arc::clone(&logger);
963 let cli_peer_manager = Arc::clone(&peer_manager);
964 let cli_poll = tokio::task::spawn_blocking(move || {
965 cli::poll_for_user_input(
980 // Exit if either CLI polling exits or the background processor exits (which shouldn't happen
981 // unless we fail to write to the filesystem).
982 let mut bg_res = Ok(Ok(()));
985 bg_exit = &mut background_processor => {
990 // Disconnect our peers and stop accepting new connections. This ensures we don't continue
991 // updating our channel data after we've stopped the background processor.
992 stop_listen_connect.store(true, Ordering::Release);
993 peer_manager.disconnect_all_peers();
995 if let Err(e) = bg_res {
996 let persist_res = persister
998 persist::CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
999 persist::CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
1000 persist::CHANNEL_MANAGER_PERSISTENCE_KEY,
1001 &channel_manager.encode(),
1004 use lightning::util::logger::Logger;
1005 lightning::log_error!(
1007 "Last-ditch ChannelManager persistence result: {:?}",
1011 "ERR: background processing stopped with result {:?}, exiting.\n\
1012 Last-ditch ChannelManager persistence result {:?}",
1017 // Stop the background processor.
1018 if !bp_exit.is_closed() {
1019 bp_exit.send(()).unwrap();
1020 background_processor.await.unwrap().unwrap();
1025 pub async fn main() {
1026 #[cfg(not(target_os = "windows"))]
1028 // Catch Ctrl-C with a dummy signal handler.
1030 let mut new_action: libc::sigaction = core::mem::zeroed();
1031 let mut old_action: libc::sigaction = core::mem::zeroed();
1033 extern "C" fn dummy_handler(
1034 _: libc::c_int, _: *const libc::siginfo_t, _: *const libc::c_void,
1038 new_action.sa_sigaction = dummy_handler as libc::sighandler_t;
1039 new_action.sa_flags = libc::SA_SIGINFO;
1043 &new_action as *const libc::sigaction,
1044 &mut old_action as *mut libc::sigaction,