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::{Event, PaymentFailureReason, PaymentPurpose};
20 use lightning::ln::channelmanager::{self, RecentPaymentDetails};
21 use lightning::ln::channelmanager::{
22 ChainParameters, ChannelManagerReadArgs, SimpleArcChannelManager,
24 use lightning::ln::msgs::DecodeError;
25 use lightning::ln::peer_handler::{IgnoringMessageHandler, MessageHandler, SimpleArcPeerManager};
26 use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
27 use lightning::onion_message::{DefaultMessageRouter, SimpleArcOnionMessenger};
28 use lightning::routing::gossip;
29 use lightning::routing::gossip::{NodeId, P2PGossipSync};
30 use lightning::routing::router::DefaultRouter;
31 use lightning::routing::scoring::ProbabilisticScoringFeeParameters;
32 use lightning::sign::{EntropySource, InMemorySigner, KeysManager, SpendableOutputDescriptor};
33 use lightning::util::config::UserConfig;
34 use lightning::util::persist::KVStorePersister;
35 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
36 use lightning::{chain, impl_writeable_tlv_based, impl_writeable_tlv_based_enum};
37 use lightning_background_processor::{process_events_async, GossipSync};
38 use lightning_block_sync::init;
39 use lightning_block_sync::poll;
40 use lightning_block_sync::SpvClient;
41 use lightning_block_sync::UnboundedCache;
42 use lightning_net_tokio::SocketDescriptor;
43 use lightning_persister::FilesystemPersister;
44 use rand::{thread_rng, Rng};
45 use std::collections::hash_map::Entry;
46 use std::collections::HashMap;
47 use std::convert::TryInto;
54 use std::sync::atomic::{AtomicBool, Ordering};
55 use std::sync::{Arc, Mutex};
56 use std::time::{Duration, SystemTime};
58 pub(crate) const PENDING_SPENDABLE_OUTPUT_DIR: &'static str = "pending_spendable_outputs";
60 #[derive(Copy, Clone)]
61 pub(crate) enum HTLCStatus {
67 impl_writeable_tlv_based_enum!(HTLCStatus,
73 pub(crate) struct MillisatAmount(Option<u64>);
75 impl fmt::Display for MillisatAmount {
76 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
78 Some(amt) => write!(f, "{}", amt),
79 None => write!(f, "unknown"),
84 impl Readable for MillisatAmount {
85 fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
86 let amt: Option<u64> = Readable::read(r)?;
87 Ok(MillisatAmount(amt))
91 impl Writeable for MillisatAmount {
92 fn write<W: Writer>(&self, w: &mut W) -> Result<(), std::io::Error> {
97 pub(crate) struct PaymentInfo {
98 preimage: Option<PaymentPreimage>,
99 secret: Option<PaymentSecret>,
101 amt_msat: MillisatAmount,
104 impl_writeable_tlv_based!(PaymentInfo, {
105 (0, preimage, required),
106 (2, secret, required),
107 (4, status, required),
108 (6, amt_msat, required),
111 pub(crate) struct PaymentInfoStorage {
112 payments: HashMap<PaymentHash, PaymentInfo>,
115 impl_writeable_tlv_based!(PaymentInfoStorage, {
116 (0, payments, required),
119 type ChainMonitor = chainmonitor::ChainMonitor<
121 Arc<dyn Filter + Send + Sync>,
124 Arc<FilesystemLogger>,
125 Arc<FilesystemPersister>,
128 pub(crate) type PeerManager = SimpleArcPeerManager<
137 pub(crate) type ChannelManager =
138 SimpleArcChannelManager<ChainMonitor, BitcoindClient, BitcoindClient, FilesystemLogger>;
140 pub(crate) type NetworkGraph = gossip::NetworkGraph<Arc<FilesystemLogger>>;
142 type OnionMessenger = SimpleArcOnionMessenger<FilesystemLogger>;
144 async fn handle_ldk_events(
145 channel_manager: &Arc<ChannelManager>, bitcoind_client: &BitcoindClient,
146 network_graph: &NetworkGraph, keys_manager: &KeysManager,
147 inbound_payments: Arc<Mutex<PaymentInfoStorage>>,
148 outbound_payments: Arc<Mutex<PaymentInfoStorage>>, persister: &Arc<FilesystemPersister>,
149 network: Network, event: Event,
152 Event::FundingGenerationReady {
153 temporary_channel_id,
154 counterparty_node_id,
155 channel_value_satoshis,
159 // Construct the raw transaction with one output, that is paid the amount of the
161 let addr = WitnessProgram::from_scriptpubkey(
164 Network::Bitcoin => bitcoin_bech32::constants::Network::Bitcoin,
165 Network::Testnet => bitcoin_bech32::constants::Network::Testnet,
166 Network::Regtest => bitcoin_bech32::constants::Network::Regtest,
167 Network::Signet => bitcoin_bech32::constants::Network::Signet,
170 .expect("Lightning funding tx should always be to a SegWit output")
172 let mut outputs = vec![HashMap::with_capacity(1)];
173 outputs[0].insert(addr, channel_value_satoshis as f64 / 100_000_000.0);
174 let raw_tx = bitcoind_client.create_raw_transaction(outputs).await;
176 // Have your wallet put the inputs into the transaction such that the output is
178 let funded_tx = bitcoind_client.fund_raw_transaction(raw_tx).await;
180 // Sign the final funding transaction and broadcast it.
181 let signed_tx = bitcoind_client.sign_raw_transaction_with_wallet(funded_tx.hex).await;
182 assert_eq!(signed_tx.complete, true);
183 let final_tx: Transaction =
184 encode::deserialize(&hex_utils::to_vec(&signed_tx.hex).unwrap()).unwrap();
185 // Give the funding transaction back to LDK for opening the channel.
187 .funding_transaction_generated(
188 &temporary_channel_id,
189 &counterparty_node_id,
195 "\nERROR: Channel went away before we could fund it. The peer disconnected or refused the channel.");
197 io::stdout().flush().unwrap();
200 Event::PaymentClaimable {
206 via_user_channel_id: _,
209 counterparty_skimmed_fee_msat: _,
212 "\nEVENT: received payment from payment hash {} of {} millisatoshis",
213 hex_utils::hex_str(&payment_hash.0),
217 io::stdout().flush().unwrap();
218 let payment_preimage = match purpose {
219 PaymentPurpose::InvoicePayment { payment_preimage, .. } => payment_preimage,
220 PaymentPurpose::SpontaneousPayment(preimage) => Some(preimage),
222 channel_manager.claim_funds(payment_preimage.unwrap());
224 Event::PaymentClaimed { payment_hash, purpose, amount_msat, receiver_node_id: _ } => {
226 "\nEVENT: claimed payment from payment hash {} of {} millisatoshis",
227 hex_utils::hex_str(&payment_hash.0),
231 io::stdout().flush().unwrap();
232 let (payment_preimage, payment_secret) = match purpose {
233 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
234 (payment_preimage, Some(payment_secret))
236 PaymentPurpose::SpontaneousPayment(preimage) => (Some(preimage), None),
238 let mut inbound = inbound_payments.lock().unwrap();
239 match inbound.payments.entry(payment_hash) {
240 Entry::Occupied(mut e) => {
241 let payment = e.get_mut();
242 payment.status = HTLCStatus::Succeeded;
243 payment.preimage = payment_preimage;
244 payment.secret = payment_secret;
246 Entry::Vacant(e) => {
247 e.insert(PaymentInfo {
248 preimage: payment_preimage,
249 secret: payment_secret,
250 status: HTLCStatus::Succeeded,
251 amt_msat: MillisatAmount(Some(amount_msat)),
255 persister.persist(INBOUND_PAYMENTS_FNAME, &*inbound).unwrap();
257 Event::PaymentSent { payment_preimage, payment_hash, fee_paid_msat, .. } => {
258 let mut outbound = outbound_payments.lock().unwrap();
259 for (hash, payment) in outbound.payments.iter_mut() {
260 if *hash == payment_hash {
261 payment.preimage = Some(payment_preimage);
262 payment.status = HTLCStatus::Succeeded;
264 "\nEVENT: successfully sent payment of {} millisatoshis{} from \
265 payment hash {:?} with preimage {:?}",
267 if let Some(fee) = fee_paid_msat {
268 format!(" (fee {} msat)", fee)
272 hex_utils::hex_str(&payment_hash.0),
273 hex_utils::hex_str(&payment_preimage.0)
276 io::stdout().flush().unwrap();
279 persister.persist(OUTBOUND_PAYMENTS_FNAME, &*outbound).unwrap();
281 Event::OpenChannelRequest { .. } => {
282 // Unreachable, we don't set manually_accept_inbound_channels
284 Event::PaymentPathSuccessful { .. } => {}
285 Event::PaymentPathFailed { .. } => {}
286 Event::ProbeSuccessful { .. } => {}
287 Event::ProbeFailed { .. } => {}
288 Event::PaymentFailed { payment_hash, reason, .. } => {
290 "\nEVENT: Failed to send payment to payment hash {:?}: {:?}",
291 hex_utils::hex_str(&payment_hash.0),
292 if let Some(r) = reason { r } else { PaymentFailureReason::RetriesExhausted }
295 io::stdout().flush().unwrap();
297 let mut outbound = outbound_payments.lock().unwrap();
298 if outbound.payments.contains_key(&payment_hash) {
299 let payment = outbound.payments.get_mut(&payment_hash).unwrap();
300 payment.status = HTLCStatus::Failed;
302 persister.persist(OUTBOUND_PAYMENTS_FNAME, &*outbound).unwrap();
304 Event::PaymentForwarded {
308 claim_from_onchain_tx,
309 outbound_amount_forwarded_msat,
311 let read_only_network_graph = network_graph.read_only();
312 let nodes = read_only_network_graph.nodes();
313 let channels = channel_manager.list_channels();
315 let node_str = |channel_id: &Option<[u8; 32]>| match channel_id {
316 None => String::new(),
317 Some(channel_id) => match channels.iter().find(|c| c.channel_id == *channel_id) {
318 None => String::new(),
320 match nodes.get(&NodeId::from_pubkey(&channel.counterparty.node_id)) {
321 None => "private node".to_string(),
322 Some(node) => match &node.announcement_info {
323 None => "unnamed node".to_string(),
324 Some(announcement) => {
325 format!("node {}", announcement.alias)
332 let channel_str = |channel_id: &Option<[u8; 32]>| {
334 .map(|channel_id| format!(" with channel {}", hex_utils::hex_str(&channel_id)))
338 format!(" from {}{}", node_str(&prev_channel_id), channel_str(&prev_channel_id));
340 format!(" to {}{}", node_str(&next_channel_id), channel_str(&next_channel_id));
342 let from_onchain_str = if claim_from_onchain_tx {
343 "from onchain downstream claim"
345 "from HTLC fulfill message"
347 let amt_args = if let Some(v) = outbound_amount_forwarded_msat {
352 if let Some(fee_earned) = fee_earned_msat {
354 "\nEVENT: Forwarded payment for {} msat{}{}, earning {} msat {}",
355 amt_args, from_prev_str, to_next_str, fee_earned, from_onchain_str
359 "\nEVENT: Forwarded payment for {} msat{}{}, claiming onchain {}",
360 amt_args, from_prev_str, to_next_str, from_onchain_str
364 io::stdout().flush().unwrap();
366 Event::HTLCHandlingFailed { .. } => {}
367 Event::PendingHTLCsForwardable { time_forwardable } => {
368 let forwarding_channel_manager = channel_manager.clone();
369 let min = time_forwardable.as_millis() as u64;
370 tokio::spawn(async move {
371 let millis_to_sleep = thread_rng().gen_range(min, min * 5) as u64;
372 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
373 forwarding_channel_manager.process_pending_htlc_forwards();
376 Event::SpendableOutputs { outputs } => {
377 // SpendableOutputDescriptors, of which outputs is a vec of, are critical to keep track
378 // of! While a `StaticOutput` descriptor is just an output to a static, well-known key,
379 // other descriptors are not currently ever regenerated for you by LDK. Once we return
380 // from this method, the descriptor will be gone, and you may lose track of some funds.
382 // Here we simply persist them to disk, with a background task running which will try
383 // to spend them regularly (possibly duplicatively/RBF'ing them). These can just be
384 // treated as normal funds where possible - they are only spendable by us and there is
385 // no rush to claim them.
386 for output in outputs {
387 let key = hex_utils::hex_str(&keys_manager.get_secure_random_bytes());
388 // Note that if the type here changes our read code needs to change as well.
389 let output: SpendableOutputDescriptor = output;
391 .persist(&format!("{}/{}", PENDING_SPENDABLE_OUTPUT_DIR, key), &output)
395 Event::ChannelPending { channel_id, counterparty_node_id, .. } => {
397 "\nEVENT: Channel {} with peer {} is pending awaiting funding lock-in!",
398 hex_utils::hex_str(&channel_id),
399 hex_utils::hex_str(&counterparty_node_id.serialize()),
402 io::stdout().flush().unwrap();
404 Event::ChannelReady {
407 ref counterparty_node_id,
411 "\nEVENT: Channel {} with peer {} is ready to be used!",
412 hex_utils::hex_str(channel_id),
413 hex_utils::hex_str(&counterparty_node_id.serialize()),
416 io::stdout().flush().unwrap();
418 Event::ChannelClosed { channel_id, reason, user_channel_id: _ } => {
420 "\nEVENT: Channel {} closed due to: {:?}",
421 hex_utils::hex_str(&channel_id),
425 io::stdout().flush().unwrap();
427 Event::DiscardFunding { .. } => {
428 // A "real" node should probably "lock" the UTXOs spent in funding transactions until
429 // the funding transaction either confirms, or this event is generated.
431 Event::HTLCIntercepted { .. } => {}
432 Event::BumpTransaction(_) => {}
436 async fn start_ldk() {
437 let args = match args::parse_startup_args() {
438 Ok(user_args) => user_args,
442 // Initialize the LDK data directory if necessary.
443 let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
444 fs::create_dir_all(ldk_data_dir.clone()).unwrap();
447 // Step 1: Initialize the Logger
448 let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
450 // Initialize our bitcoind client.
451 let bitcoind_client = match BitcoindClient::new(
452 args.bitcoind_rpc_host.clone(),
453 args.bitcoind_rpc_port,
454 args.bitcoind_rpc_username.clone(),
455 args.bitcoind_rpc_password.clone(),
456 tokio::runtime::Handle::current(),
461 Ok(client) => Arc::new(client),
463 println!("Failed to connect to bitcoind client: {}", e);
468 // Check that the bitcoind we've connected to is running the network we expect
469 let bitcoind_chain = bitcoind_client.get_blockchain_info().await.chain;
471 != match args.network {
472 bitcoin::Network::Bitcoin => "main",
473 bitcoin::Network::Testnet => "test",
474 bitcoin::Network::Regtest => "regtest",
475 bitcoin::Network::Signet => "signet",
478 "Chain argument ({}) didn't match bitcoind chain ({})",
479 args.network, bitcoind_chain
484 // Step 2: Initialize the FeeEstimator
486 // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
487 let fee_estimator = bitcoind_client.clone();
489 // Step 3: Initialize the BroadcasterInterface
491 // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
493 let broadcaster = bitcoind_client.clone();
495 // Step 4: Initialize Persist
496 let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
498 // Step 5: Initialize the ChainMonitor
499 let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
503 fee_estimator.clone(),
507 // Step 6: Initialize the KeysManager
509 // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
510 // other secret key material.
511 let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
512 let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
513 assert_eq!(seed.len(), 32);
514 let mut key = [0; 32];
515 key.copy_from_slice(&seed);
518 let mut key = [0; 32];
519 thread_rng().fill_bytes(&mut key);
520 match File::create(keys_seed_path.clone()) {
522 Write::write_all(&mut f, &key).expect("Failed to write node keys seed to disk");
523 f.sync_all().expect("Failed to sync node keys seed to disk");
526 println!("ERROR: Unable to create keys seed file {}: {}", keys_seed_path, e);
532 let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
533 let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
535 // Step 7: Read ChannelMonitor state from disk
536 let mut channelmonitors =
537 persister.read_channelmonitors(keys_manager.clone(), keys_manager.clone()).unwrap();
539 // Step 8: Poll for the best chain tip, which may be used by the channel manager & spv client
540 let polled_chain_tip = init::validate_best_block_header(bitcoind_client.as_ref())
542 .expect("Failed to fetch best block header and best block");
544 // Step 9: Initialize routing ProbabilisticScorer
545 let network_graph_path = format!("{}/network_graph", ldk_data_dir.clone());
547 Arc::new(disk::read_network(Path::new(&network_graph_path), args.network, logger.clone()));
549 let scorer_path = format!("{}/scorer", ldk_data_dir.clone());
550 let scorer = Arc::new(Mutex::new(disk::read_scorer(
551 Path::new(&scorer_path),
552 Arc::clone(&network_graph),
556 // Step 10: Create Router
557 let scoring_fee_params = ProbabilisticScoringFeeParameters::default();
558 let router = Arc::new(DefaultRouter::new(
559 network_graph.clone(),
561 keys_manager.get_secure_random_bytes(),
566 // Step 11: Initialize the ChannelManager
567 let mut user_config = UserConfig::default();
568 user_config.channel_handshake_limits.force_announced_channel_preference = false;
569 let mut restarting_node = true;
570 let (channel_manager_blockhash, channel_manager) = {
571 if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
572 let mut channel_monitor_mut_references = Vec::new();
573 for (_, channel_monitor) in channelmonitors.iter_mut() {
574 channel_monitor_mut_references.push(channel_monitor);
576 let read_args = ChannelManagerReadArgs::new(
577 keys_manager.clone(),
578 keys_manager.clone(),
579 keys_manager.clone(),
580 fee_estimator.clone(),
581 chain_monitor.clone(),
586 channel_monitor_mut_references,
588 <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
590 // We're starting a fresh node.
591 restarting_node = false;
593 let polled_best_block = polled_chain_tip.to_best_block();
594 let polled_best_block_hash = polled_best_block.block_hash();
596 ChainParameters { network: args.network, best_block: polled_best_block };
597 let fresh_channel_manager = channelmanager::ChannelManager::new(
598 fee_estimator.clone(),
599 chain_monitor.clone(),
603 keys_manager.clone(),
604 keys_manager.clone(),
605 keys_manager.clone(),
608 cur.as_secs() as u32,
610 (polled_best_block_hash, fresh_channel_manager)
614 // Step 12: Sync ChannelMonitors and ChannelManager to chain tip
615 let mut chain_listener_channel_monitors = Vec::new();
616 let mut cache = UnboundedCache::new();
617 let chain_tip = if restarting_node {
618 let mut chain_listeners = vec![(
619 channel_manager_blockhash,
620 &channel_manager as &(dyn chain::Listen + Send + Sync),
623 for (blockhash, channel_monitor) in channelmonitors.drain(..) {
624 let outpoint = channel_monitor.get_funding_txo().0;
625 chain_listener_channel_monitors.push((
627 (channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()),
632 for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
633 chain_listeners.push((
634 monitor_listener_info.0,
635 &monitor_listener_info.1 as &(dyn chain::Listen + Send + Sync),
639 init::synchronize_listeners(
640 bitcoind_client.as_ref(),
651 // Step 13: Give ChannelMonitors to ChainMonitor
652 for item in chain_listener_channel_monitors.drain(..) {
653 let channel_monitor = item.1 .0;
654 let funding_outpoint = item.2;
656 chain_monitor.watch_channel(funding_outpoint, channel_monitor),
657 ChannelMonitorUpdateStatus::Completed
661 // Step 14: Optional: Initialize the P2PGossipSync
662 let gossip_sync = Arc::new(P2PGossipSync::new(
663 Arc::clone(&network_graph),
664 None::<Arc<BitcoindClient>>,
668 // Step 15: Initialize the PeerManager
669 let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
670 let onion_messenger: Arc<OnionMessenger> = Arc::new(OnionMessenger::new(
671 Arc::clone(&keys_manager),
672 Arc::clone(&keys_manager),
674 Arc::new(DefaultMessageRouter {}),
675 IgnoringMessageHandler {},
676 IgnoringMessageHandler {},
678 let mut ephemeral_bytes = [0; 32];
679 let current_time = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs();
680 rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
681 let lightning_msg_handler = MessageHandler {
682 chan_handler: channel_manager.clone(),
683 route_handler: gossip_sync.clone(),
684 onion_message_handler: onion_messenger.clone(),
685 custom_message_handler: IgnoringMessageHandler {},
687 let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
688 lightning_msg_handler,
689 current_time.try_into().unwrap(),
692 Arc::clone(&keys_manager),
696 // Step 16: Initialize networking
698 let peer_manager_connection_handler = peer_manager.clone();
699 let listening_port = args.ldk_peer_listening_port;
700 let stop_listen_connect = Arc::new(AtomicBool::new(false));
701 let stop_listen = Arc::clone(&stop_listen_connect);
702 tokio::spawn(async move {
703 let listener = tokio::net::TcpListener::bind(format!("[::]:{}", listening_port))
705 .expect("Failed to bind to listen port - is something else already listening on it?");
707 let peer_mgr = peer_manager_connection_handler.clone();
708 let tcp_stream = listener.accept().await.unwrap().0;
709 if stop_listen.load(Ordering::Acquire) {
712 tokio::spawn(async move {
713 lightning_net_tokio::setup_inbound(
715 tcp_stream.into_std().unwrap(),
722 // Step 17: Connect and Disconnect Blocks
723 let channel_manager_listener = channel_manager.clone();
724 let chain_monitor_listener = chain_monitor.clone();
725 let bitcoind_block_source = bitcoind_client.clone();
726 let network = args.network;
727 tokio::spawn(async move {
728 let chain_poller = poll::ChainPoller::new(bitcoind_block_source.as_ref(), network);
729 let chain_listener = (chain_monitor_listener, channel_manager_listener);
730 let mut spv_client = SpvClient::new(chain_tip, chain_poller, &mut cache, &chain_listener);
732 spv_client.poll_best_tip().await.unwrap();
733 tokio::time::sleep(Duration::from_secs(1)).await;
737 let inbound_payments = Arc::new(Mutex::new(disk::read_payment_info(Path::new(&format!(
739 ldk_data_dir, INBOUND_PAYMENTS_FNAME
741 let outbound_payments = Arc::new(Mutex::new(disk::read_payment_info(Path::new(&format!(
743 ldk_data_dir, OUTBOUND_PAYMENTS_FNAME
745 let recent_payments_payment_hashes = channel_manager
746 .list_recent_payments()
748 .filter_map(|p| match p {
749 RecentPaymentDetails::Pending { payment_hash, .. } => Some(payment_hash),
750 RecentPaymentDetails::Fulfilled { payment_hash } => payment_hash,
751 RecentPaymentDetails::Abandoned { payment_hash } => Some(payment_hash),
753 .collect::<Vec<PaymentHash>>();
754 for (payment_hash, payment_info) in outbound_payments
759 .filter(|(_, i)| matches!(i.status, HTLCStatus::Pending))
761 if !recent_payments_payment_hashes.contains(payment_hash) {
762 payment_info.status = HTLCStatus::Failed;
765 persister.persist(OUTBOUND_PAYMENTS_FNAME, &*outbound_payments.lock().unwrap()).unwrap();
767 // Step 18: Handle LDK Events
768 let channel_manager_event_listener = Arc::clone(&channel_manager);
769 let bitcoind_client_event_listener = Arc::clone(&bitcoind_client);
770 let network_graph_event_listener = Arc::clone(&network_graph);
771 let keys_manager_event_listener = Arc::clone(&keys_manager);
772 let inbound_payments_event_listener = Arc::clone(&inbound_payments);
773 let outbound_payments_event_listener = Arc::clone(&outbound_payments);
774 let persister_event_listener = Arc::clone(&persister);
775 let network = args.network;
776 let event_handler = move |event: Event| {
777 let channel_manager_event_listener = Arc::clone(&channel_manager_event_listener);
778 let bitcoind_client_event_listener = Arc::clone(&bitcoind_client_event_listener);
779 let network_graph_event_listener = Arc::clone(&network_graph_event_listener);
780 let keys_manager_event_listener = Arc::clone(&keys_manager_event_listener);
781 let inbound_payments_event_listener = Arc::clone(&inbound_payments_event_listener);
782 let outbound_payments_event_listener = Arc::clone(&outbound_payments_event_listener);
783 let persister_event_listener = Arc::clone(&persister_event_listener);
786 &channel_manager_event_listener,
787 &bitcoind_client_event_listener,
788 &network_graph_event_listener,
789 &keys_manager_event_listener,
790 inbound_payments_event_listener,
791 outbound_payments_event_listener,
792 &persister_event_listener,
800 // Step 19: Persist ChannelManager and NetworkGraph
801 let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
803 // Step 20: Background Processing
804 let (bp_exit, bp_exit_check) = tokio::sync::watch::channel(());
805 let mut background_processor = tokio::spawn(process_events_async(
806 Arc::clone(&persister),
808 chain_monitor.clone(),
809 channel_manager.clone(),
810 GossipSync::p2p(gossip_sync.clone()),
811 peer_manager.clone(),
813 Some(scorer.clone()),
815 let mut bp_exit_fut_check = bp_exit_check.clone();
816 Box::pin(async move {
818 _ = tokio::time::sleep(t) => false,
819 _ = bp_exit_fut_check.changed() => true,
826 // Regularly reconnect to channel peers.
827 let connect_cm = Arc::clone(&channel_manager);
828 let connect_pm = Arc::clone(&peer_manager);
829 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
830 let stop_connect = Arc::clone(&stop_listen_connect);
831 tokio::spawn(async move {
832 let mut interval = tokio::time::interval(Duration::from_secs(1));
833 interval.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Delay);
835 interval.tick().await;
836 match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
838 let peers = connect_pm.get_peer_node_ids();
839 for node_id in connect_cm
842 .map(|chan| chan.counterparty.node_id)
843 .filter(|id| !peers.iter().any(|(pk, _)| id == pk))
845 if stop_connect.load(Ordering::Acquire) {
848 for (pubkey, peer_addr) in info.iter() {
849 if *pubkey == node_id {
850 let _ = cli::do_connect_peer(
853 Arc::clone(&connect_pm),
860 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
865 // Regularly broadcast our node_announcement. This is only required (or possible) if we have
866 // some public channels.
867 let peer_man = Arc::clone(&peer_manager);
868 let chan_man = Arc::clone(&channel_manager);
869 let network = args.network;
870 tokio::spawn(async move {
871 // First wait a minute until we have some peers and maybe have opened a channel.
872 tokio::time::sleep(Duration::from_secs(60)).await;
873 // Then, update our announcement once an hour to keep it fresh but avoid unnecessary churn
874 // in the global gossip network.
875 let mut interval = tokio::time::interval(Duration::from_secs(3600));
877 interval.tick().await;
878 // Don't bother trying to announce if we don't have any public channls, though our
879 // peers should drop such an announcement anyway. Note that announcement may not
880 // propagate until we have a channel with 6+ confirmations.
881 if chan_man.list_channels().iter().any(|chan| chan.is_public) {
882 peer_man.broadcast_node_announcement(
884 args.ldk_announced_node_name,
885 args.ldk_announced_listen_addr.clone(),
891 tokio::spawn(sweep::periodic_sweep(
892 ldk_data_dir.clone(),
893 Arc::clone(&keys_manager),
895 Arc::clone(&persister),
896 Arc::clone(&bitcoind_client),
897 Arc::clone(&channel_manager),
901 let cli_poll = tokio::spawn(cli::poll_for_user_input(
902 Arc::clone(&peer_manager),
903 Arc::clone(&channel_manager),
904 Arc::clone(&keys_manager),
905 Arc::clone(&network_graph),
906 Arc::clone(&onion_messenger),
912 Arc::clone(&persister),
915 // Exit if either CLI polling exits or the background processor exits (which shouldn't happen
916 // unless we fail to write to the filesystem).
919 bg_res = &mut background_processor => {
920 stop_listen_connect.store(true, Ordering::Release);
921 peer_manager.disconnect_all_peers();
922 panic!("ERR: background processing stopped with result {:?}, exiting", bg_res);
926 // Disconnect our peers and stop accepting new connections. This ensures we don't continue
927 // updating our channel data after we've stopped the background processor.
928 stop_listen_connect.store(true, Ordering::Release);
929 peer_manager.disconnect_all_peers();
931 // Stop the background processor.
932 if !bp_exit.is_closed() {
933 bp_exit.send(()).unwrap();
934 background_processor.await.unwrap().unwrap();
939 pub async fn main() {
940 #[cfg(not(target_os = "windows"))]
942 // Catch Ctrl-C with a dummy signal handler.
944 let mut new_action: libc::sigaction = core::mem::zeroed();
945 let mut old_action: libc::sigaction = core::mem::zeroed();
947 extern "C" fn dummy_handler(
948 _: libc::c_int, _: *const libc::siginfo_t, _: *const libc::c_void,
952 new_action.sa_sigaction = dummy_handler as libc::sighandler_t;
953 new_action.sa_flags = libc::SA_SIGINFO;
957 &new_action as *const libc::sigaction,
958 &mut old_action as *mut libc::sigaction,