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::secp256k1::PublicKey;
16 use bitcoin_bech32::WitnessProgram;
17 use disk::{INBOUND_PAYMENTS_FNAME, OUTBOUND_PAYMENTS_FNAME};
18 use lightning::chain::{chainmonitor, ChannelMonitorUpdateStatus};
19 use lightning::chain::{Filter, Watch};
20 use lightning::events::bump_transaction::{BumpTransactionEventHandler, Wallet};
21 use lightning::events::{Event, PaymentFailureReason, PaymentPurpose};
22 use lightning::ln::channelmanager::{self, RecentPaymentDetails};
23 use lightning::ln::channelmanager::{
24 ChainParameters, ChannelManagerReadArgs, PaymentId, SimpleArcChannelManager,
26 use lightning::ln::msgs::DecodeError;
27 use lightning::ln::peer_handler::{IgnoringMessageHandler, MessageHandler, SimpleArcPeerManager};
28 use lightning::ln::{ChannelId, PaymentHash, PaymentPreimage, PaymentSecret};
29 use lightning::onion_message::{DefaultMessageRouter, SimpleArcOnionMessenger};
30 use lightning::routing::gossip;
31 use lightning::routing::gossip::{NodeId, P2PGossipSync};
32 use lightning::routing::router::{DefaultRouter, RouteParameters, PaymentParameters, ScorerAccountingForInFlightHtlcs};
33 use lightning::routing::scoring::ProbabilisticScoringFeeParameters;
34 use lightning::routing::scoring::ProbabilisticScorer;
35 use lightning::sign::{EntropySource, InMemorySigner, KeysManager, SpendableOutputDescriptor};
36 use lightning::util::config::UserConfig;
37 use lightning::util::persist::{self, KVStore, MonitorUpdatingPersister};
38 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
39 use lightning::{chain, impl_writeable_tlv_based, impl_writeable_tlv_based_enum};
40 use lightning_background_processor::{process_events_async, GossipSync};
41 use lightning_block_sync::init;
42 use lightning_block_sync::poll;
43 use lightning_block_sync::SpvClient;
44 use lightning_block_sync::UnboundedCache;
45 use lightning_net_tokio::SocketDescriptor;
46 use lightning_persister::fs_store::FilesystemStore;
47 use rand::{thread_rng, Rng};
48 use std::collections::hash_map::Entry;
49 use std::collections::HashMap;
50 use std::convert::TryInto;
57 use std::sync::atomic::{AtomicBool, Ordering};
58 use std::sync::{Arc, Mutex, RwLock};
59 use std::time::{Duration, SystemTime};
61 pub(crate) const PENDING_SPENDABLE_OUTPUT_DIR: &'static str = "pending_spendable_outputs";
63 #[derive(Copy, Clone)]
64 pub(crate) enum HTLCStatus {
70 impl_writeable_tlv_based_enum!(HTLCStatus,
76 pub(crate) struct MillisatAmount(Option<u64>);
78 impl fmt::Display for MillisatAmount {
79 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
81 Some(amt) => write!(f, "{}", amt),
82 None => write!(f, "unknown"),
87 impl Readable for MillisatAmount {
88 fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
89 let amt: Option<u64> = Readable::read(r)?;
90 Ok(MillisatAmount(amt))
94 impl Writeable for MillisatAmount {
95 fn write<W: Writer>(&self, w: &mut W) -> Result<(), std::io::Error> {
100 pub(crate) struct PaymentInfo {
101 preimage: Option<PaymentPreimage>,
102 secret: Option<PaymentSecret>,
104 amt_msat: MillisatAmount,
107 impl_writeable_tlv_based!(PaymentInfo, {
108 (0, preimage, required),
109 (2, secret, required),
110 (4, status, required),
111 (6, amt_msat, required),
114 pub(crate) struct InboundPaymentInfoStorage {
115 payments: HashMap<PaymentHash, PaymentInfo>,
118 impl_writeable_tlv_based!(InboundPaymentInfoStorage, {
119 (0, payments, required),
122 pub(crate) struct OutboundPaymentInfoStorage {
123 payments: HashMap<PaymentId, PaymentInfo>,
126 impl_writeable_tlv_based!(OutboundPaymentInfoStorage, {
127 (0, payments, required),
130 type ChainMonitor = chainmonitor::ChainMonitor<
132 Arc<dyn Filter + Send + Sync>,
135 Arc<FilesystemLogger>,
137 MonitorUpdatingPersister<
138 Arc<FilesystemStore>,
139 Arc<FilesystemLogger>,
146 pub(crate) type GossipVerifier = lightning_block_sync::gossip::GossipVerifier<
147 lightning_block_sync::gossip::TokioSpawner,
148 Arc<lightning_block_sync::rpc::RpcClient>,
149 Arc<FilesystemLogger>,
153 IgnoringMessageHandler,
157 pub(crate) type PeerManager = SimpleArcPeerManager<
166 pub(crate) type ChannelManager =
167 SimpleArcChannelManager<ChainMonitor, BitcoindClient, BitcoindClient, FilesystemLogger>;
169 pub(crate) type NetworkGraph = gossip::NetworkGraph<Arc<FilesystemLogger>>;
171 type OnionMessenger =
172 SimpleArcOnionMessenger<ChainMonitor, BitcoindClient, BitcoindClient, FilesystemLogger>;
174 pub(crate) type BumpTxEventHandler = BumpTransactionEventHandler<
176 Arc<Wallet<Arc<BitcoindClient>, Arc<FilesystemLogger>>>,
178 Arc<FilesystemLogger>,
182 channel_manager: &ChannelManager, graph: &NetworkGraph,
183 logger: &disk::FilesystemLogger,
184 scorer: &RwLock<ProbabilisticScorer<Arc<NetworkGraph>, Arc<disk::FilesystemLogger>>>
187 let lck = graph.read_only();
188 if lck.nodes().is_empty() { return; }
189 let mut it = lck.nodes().unordered_iter().skip(::rand::random::<usize>() % lck.nodes().len());
190 it.next().unwrap().0.clone()
192 let amt = ::rand::random::<u64>() % 500_000_000;
193 if let Ok(pk) = bitcoin::secp256k1::PublicKey::from_slice(rcpt.as_slice()) {
194 send_probe(channel_manager, pk, graph, logger, amt, scorer);
199 channel_manager: &ChannelManager, recipient: PublicKey, graph: &NetworkGraph,
200 logger: &disk::FilesystemLogger, amt_msat: u64,
201 scorer: &RwLock<ProbabilisticScorer<Arc<NetworkGraph>, Arc<disk::FilesystemLogger>>>
203 let chans = channel_manager.list_usable_channels();
204 let chan_refs = chans.iter().map(|a| a).collect::<Vec<_>>();
205 let mut payment_params = PaymentParameters::from_node_id(recipient, 144);
206 payment_params.max_path_count = 1;
207 let in_flight_htlcs = channel_manager.compute_inflight_htlcs();
208 let scorer = scorer.read().unwrap();
209 let inflight_scorer = ScorerAccountingForInFlightHtlcs::new(&scorer, &in_flight_htlcs);
210 let score_params: ProbabilisticScoringFeeParameters = Default::default();
211 let route_res = lightning::routing::router::find_route(
212 &channel_manager.get_our_node_id(),
213 &RouteParameters::from_payment_params_and_value(payment_params, amt_msat),
214 &graph, Some(&chan_refs), logger, &inflight_scorer, &score_params, &[32; 32]
216 if let Ok(route) = route_res {
217 for path in route.paths {
218 let _ = channel_manager.send_probe(path);
223 async fn handle_ldk_events(
224 channel_manager: &Arc<ChannelManager>, bitcoind_client: &BitcoindClient,
225 network_graph: &NetworkGraph, keys_manager: &KeysManager,
226 bump_tx_event_handler: &BumpTxEventHandler,
227 inbound_payments: Arc<Mutex<InboundPaymentInfoStorage>>,
228 outbound_payments: Arc<Mutex<OutboundPaymentInfoStorage>>, fs_store: &Arc<FilesystemStore>,
229 network: Network, event: Event,
232 Event::FundingGenerationReady {
233 temporary_channel_id,
234 counterparty_node_id,
235 channel_value_satoshis,
239 // Construct the raw transaction with one output, that is paid the amount of the
241 let addr = WitnessProgram::from_scriptpubkey(
244 Network::Bitcoin => bitcoin_bech32::constants::Network::Bitcoin,
245 Network::Testnet => bitcoin_bech32::constants::Network::Testnet,
246 Network::Regtest => bitcoin_bech32::constants::Network::Regtest,
247 Network::Signet => bitcoin_bech32::constants::Network::Signet,
250 .expect("Lightning funding tx should always be to a SegWit output")
252 let mut outputs = vec![HashMap::with_capacity(1)];
253 outputs[0].insert(addr, channel_value_satoshis as f64 / 100_000_000.0);
254 let raw_tx = bitcoind_client.create_raw_transaction(outputs).await;
256 // Have your wallet put the inputs into the transaction such that the output is
258 let funded_tx = bitcoind_client.fund_raw_transaction(raw_tx).await;
260 // Sign the final funding transaction and broadcast it.
261 let signed_tx = bitcoind_client.sign_raw_transaction_with_wallet(funded_tx.hex).await;
262 assert_eq!(signed_tx.complete, true);
263 let final_tx: Transaction =
264 encode::deserialize(&hex_utils::to_vec(&signed_tx.hex).unwrap()).unwrap();
265 // Give the funding transaction back to LDK for opening the channel.
267 .funding_transaction_generated(
268 &temporary_channel_id,
269 &counterparty_node_id,
275 "\nERROR: Channel went away before we could fund it. The peer disconnected or refused the channel.");
277 io::stdout().flush().unwrap();
280 Event::PaymentClaimable {
286 via_user_channel_id: _,
289 counterparty_skimmed_fee_msat: _,
292 "\nEVENT: received payment from payment hash {} of {} millisatoshis",
293 payment_hash, amount_msat,
296 io::stdout().flush().unwrap();
297 let payment_preimage = match purpose {
298 PaymentPurpose::InvoicePayment { payment_preimage, .. } => payment_preimage,
299 PaymentPurpose::SpontaneousPayment(preimage) => Some(preimage),
301 channel_manager.claim_funds(payment_preimage.unwrap());
303 Event::PaymentClaimed {
309 sender_intended_total_msat: _,
312 "\nEVENT: claimed payment from payment hash {} of {} millisatoshis",
313 payment_hash, amount_msat,
316 io::stdout().flush().unwrap();
317 let (payment_preimage, payment_secret) = match purpose {
318 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
319 (payment_preimage, Some(payment_secret))
321 PaymentPurpose::SpontaneousPayment(preimage) => (Some(preimage), None),
323 let mut inbound = inbound_payments.lock().unwrap();
324 match inbound.payments.entry(payment_hash) {
325 Entry::Occupied(mut e) => {
326 let payment = e.get_mut();
327 payment.status = HTLCStatus::Succeeded;
328 payment.preimage = payment_preimage;
329 payment.secret = payment_secret;
331 Entry::Vacant(e) => {
332 e.insert(PaymentInfo {
333 preimage: payment_preimage,
334 secret: payment_secret,
335 status: HTLCStatus::Succeeded,
336 amt_msat: MillisatAmount(Some(amount_msat)),
340 fs_store.write("", "", INBOUND_PAYMENTS_FNAME, &inbound.encode()).unwrap();
343 payment_preimage, payment_hash, fee_paid_msat, payment_id, ..
345 let mut outbound = outbound_payments.lock().unwrap();
346 for (id, payment) in outbound.payments.iter_mut() {
347 if *id == payment_id.unwrap() {
348 payment.preimage = Some(payment_preimage);
349 payment.status = HTLCStatus::Succeeded;
351 "\nEVENT: successfully sent payment of {} millisatoshis{} from \
352 payment hash {} with preimage {}",
354 if let Some(fee) = fee_paid_msat {
355 format!(" (fee {} msat)", fee)
363 io::stdout().flush().unwrap();
366 fs_store.write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound.encode()).unwrap();
368 Event::OpenChannelRequest {
369 ref temporary_channel_id, ref counterparty_node_id, ..
371 let mut random_bytes = [0u8; 16];
372 random_bytes.copy_from_slice(&keys_manager.get_secure_random_bytes()[..16]);
373 let user_channel_id = u128::from_be_bytes(random_bytes);
374 let res = channel_manager.accept_inbound_channel(
375 temporary_channel_id,
376 counterparty_node_id,
380 if let Err(e) = res {
382 "\nEVENT: Failed to accept inbound channel ({}) from {}: {:?}",
383 temporary_channel_id,
384 hex_utils::hex_str(&counterparty_node_id.serialize()),
389 "\nEVENT: Accepted inbound channel ({}) from {}",
390 temporary_channel_id,
391 hex_utils::hex_str(&counterparty_node_id.serialize()),
395 io::stdout().flush().unwrap();
397 Event::PaymentPathSuccessful { .. } => {}
398 Event::PaymentPathFailed { .. } => {}
399 Event::ProbeSuccessful { .. } => {}
400 Event::ProbeFailed { .. } => {}
401 Event::PaymentFailed { payment_hash, reason, payment_id, .. } => {
403 "\nEVENT: Failed to send payment to payment hash {}: {:?}",
405 if let Some(r) = reason { r } else { PaymentFailureReason::RetriesExhausted }
408 io::stdout().flush().unwrap();
410 let mut outbound = outbound_payments.lock().unwrap();
411 if outbound.payments.contains_key(&payment_id) {
412 let payment = outbound.payments.get_mut(&payment_id).unwrap();
413 payment.status = HTLCStatus::Failed;
415 fs_store.write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound.encode()).unwrap();
417 Event::InvoiceRequestFailed { payment_id } => {
418 print!("\nEVENT: Failed to request invoice to send payment with id {}", payment_id);
420 io::stdout().flush().unwrap();
422 let mut outbound = outbound_payments.lock().unwrap();
423 if outbound.payments.contains_key(&payment_id) {
424 let payment = outbound.payments.get_mut(&payment_id).unwrap();
425 payment.status = HTLCStatus::Failed;
427 fs_store.write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound.encode()).unwrap();
429 Event::PaymentForwarded {
433 claim_from_onchain_tx,
434 outbound_amount_forwarded_msat,
436 let read_only_network_graph = network_graph.read_only();
437 let nodes = read_only_network_graph.nodes();
438 let channels = channel_manager.list_channels();
440 let node_str = |channel_id: &Option<ChannelId>| match channel_id {
441 None => String::new(),
442 Some(channel_id) => match channels.iter().find(|c| c.channel_id == *channel_id) {
443 None => String::new(),
445 match nodes.get(&NodeId::from_pubkey(&channel.counterparty.node_id)) {
446 None => "private node".to_string(),
447 Some(node) => match &node.announcement_info {
448 None => "unnamed node".to_string(),
449 Some(announcement) => {
450 format!("node {}", announcement.alias)
457 let channel_str = |channel_id: &Option<ChannelId>| {
459 .map(|channel_id| format!(" with channel {}", channel_id))
463 format!(" from {}{}", node_str(&prev_channel_id), channel_str(&prev_channel_id));
465 format!(" to {}{}", node_str(&next_channel_id), channel_str(&next_channel_id));
467 let from_onchain_str = if claim_from_onchain_tx {
468 "from onchain downstream claim"
470 "from HTLC fulfill message"
472 let amt_args = if let Some(v) = outbound_amount_forwarded_msat {
477 if let Some(fee_earned) = fee_earned_msat {
479 "\nEVENT: Forwarded payment for {} msat{}{}, earning {} msat {}",
480 amt_args, from_prev_str, to_next_str, fee_earned, from_onchain_str
484 "\nEVENT: Forwarded payment for {} msat{}{}, claiming onchain {}",
485 amt_args, from_prev_str, to_next_str, from_onchain_str
489 io::stdout().flush().unwrap();
491 Event::HTLCHandlingFailed { .. } => {}
492 Event::PendingHTLCsForwardable { time_forwardable } => {
493 let forwarding_channel_manager = channel_manager.clone();
494 let min = time_forwardable.as_millis() as u64;
495 tokio::spawn(async move {
496 let millis_to_sleep = thread_rng().gen_range(min, min * 5) as u64;
497 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
498 forwarding_channel_manager.process_pending_htlc_forwards();
501 Event::SpendableOutputs { outputs, channel_id: _ } => {
502 // SpendableOutputDescriptors, of which outputs is a vec of, are critical to keep track
503 // of! While a `StaticOutput` descriptor is just an output to a static, well-known key,
504 // other descriptors are not currently ever regenerated for you by LDK. Once we return
505 // from this method, the descriptor will be gone, and you may lose track of some funds.
507 // Here we simply persist them to disk, with a background task running which will try
508 // to spend them regularly (possibly duplicatively/RBF'ing them). These can just be
509 // treated as normal funds where possible - they are only spendable by us and there is
510 // no rush to claim them.
511 for output in outputs {
512 let key = hex_utils::hex_str(&keys_manager.get_secure_random_bytes());
513 // Note that if the type here changes our read code needs to change as well.
514 let output: SpendableOutputDescriptor = output;
515 fs_store.write(PENDING_SPENDABLE_OUTPUT_DIR, "", &key, &output.encode()).unwrap();
518 Event::ChannelPending { channel_id, counterparty_node_id, .. } => {
520 "\nEVENT: Channel {} with peer {} is pending awaiting funding lock-in!",
522 hex_utils::hex_str(&counterparty_node_id.serialize()),
525 io::stdout().flush().unwrap();
527 Event::ChannelReady {
530 ref counterparty_node_id,
534 "\nEVENT: Channel {} with peer {} is ready to be used!",
536 hex_utils::hex_str(&counterparty_node_id.serialize()),
539 io::stdout().flush().unwrap();
541 Event::ChannelClosed {
545 counterparty_node_id,
546 channel_capacity_sats: _,
549 "\nEVENT: Channel {} with counterparty {} closed due to: {:?}",
551 counterparty_node_id.map(|id| format!("{}", id)).unwrap_or("".to_owned()),
555 io::stdout().flush().unwrap();
557 Event::DiscardFunding { .. } => {
558 // A "real" node should probably "lock" the UTXOs spent in funding transactions until
559 // the funding transaction either confirms, or this event is generated.
561 Event::HTLCIntercepted { .. } => {}
562 Event::BumpTransaction(event) => bump_tx_event_handler.handle_event(&event),
566 async fn start_ldk() {
567 let args = match args::parse_startup_args() {
568 Ok(user_args) => user_args,
572 // Initialize the LDK data directory if necessary.
573 let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
574 fs::create_dir_all(ldk_data_dir.clone()).unwrap();
577 // Step 1: Initialize the Logger
578 let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
580 // Initialize our bitcoind client.
581 let bitcoind_client = match BitcoindClient::new(
582 args.bitcoind_rpc_host.clone(),
583 args.bitcoind_rpc_port,
584 args.bitcoind_rpc_username.clone(),
585 args.bitcoind_rpc_password.clone(),
586 tokio::runtime::Handle::current(),
591 Ok(client) => Arc::new(client),
593 println!("Failed to connect to bitcoind client: {}", e);
598 // Check that the bitcoind we've connected to is running the network we expect
599 let bitcoind_chain = bitcoind_client.get_blockchain_info().await.chain;
601 != match args.network {
602 bitcoin::Network::Bitcoin => "main",
603 bitcoin::Network::Testnet => "test",
604 bitcoin::Network::Regtest => "regtest",
605 bitcoin::Network::Signet => "signet",
608 "Chain argument ({}) didn't match bitcoind chain ({})",
609 args.network, bitcoind_chain
614 // Step 2: Initialize the FeeEstimator
616 // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
617 let fee_estimator = bitcoind_client.clone();
619 // Step 3: Initialize the BroadcasterInterface
621 // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
623 let broadcaster = bitcoind_client.clone();
625 // Step 4: Initialize the KeysManager
627 // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
628 // other secret key material.
629 let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
630 let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
631 assert_eq!(seed.len(), 32);
632 let mut key = [0; 32];
633 key.copy_from_slice(&seed);
636 let mut key = [0; 32];
637 thread_rng().fill_bytes(&mut key);
638 match File::create(keys_seed_path.clone()) {
640 Write::write_all(&mut f, &key).expect("Failed to write node keys seed to disk");
641 f.sync_all().expect("Failed to sync node keys seed to disk");
644 println!("ERROR: Unable to create keys seed file {}: {}", keys_seed_path, e);
650 let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
651 let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
653 let bump_tx_event_handler = Arc::new(BumpTransactionEventHandler::new(
654 Arc::clone(&broadcaster),
655 Arc::new(Wallet::new(Arc::clone(&bitcoind_client), Arc::clone(&logger))),
656 Arc::clone(&keys_manager),
660 // Step 5: Initialize Persistence
661 let fs_store = Arc::new(FilesystemStore::new(ldk_data_dir.clone().into()));
662 let persister = Arc::new(MonitorUpdatingPersister::new(
663 Arc::clone(&fs_store),
666 Arc::clone(&keys_manager),
667 Arc::clone(&keys_manager),
669 // Alternatively, you can use the `FilesystemStore` as a `Persist` directly, at the cost of
670 // larger `ChannelMonitor` update writes (but no deletion or cleanup):
671 //let persister = Arc::clone(&fs_store);
673 // Step 6: Initialize the ChainMonitor
674 let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
676 Arc::clone(&broadcaster),
678 Arc::clone(&fee_estimator),
679 Arc::clone(&persister),
682 // Step 7: Read ChannelMonitor state from disk
683 let mut channelmonitors = persister
684 .read_all_channel_monitors_with_updates(&bitcoind_client, &bitcoind_client)
686 // If you are using the `FilesystemStore` as a `Persist` directly, use
687 // `lightning::util::persist::read_channel_monitors` like this:
688 //read_channel_monitors(Arc::clone(&persister), Arc::clone(&keys_manager), Arc::clone(&keys_manager)).unwrap();
690 // Step 8: Poll for the best chain tip, which may be used by the channel manager & spv client
691 let polled_chain_tip = init::validate_best_block_header(bitcoind_client.as_ref())
693 .expect("Failed to fetch best block header and best block");
695 // Step 9: Initialize routing ProbabilisticScorer
696 let network_graph_path = format!("{}/network_graph", ldk_data_dir.clone());
698 Arc::new(disk::read_network(Path::new(&network_graph_path), args.network, logger.clone()));
700 let scorer_path = format!("{}/scorer", ldk_data_dir.clone());
701 let scorer = Arc::new(RwLock::new(disk::read_scorer(
702 Path::new(&scorer_path),
703 Arc::clone(&network_graph),
707 // Step 10: Create Router
708 let scoring_fee_params = ProbabilisticScoringFeeParameters::default();
709 let router = Arc::new(DefaultRouter::new(
710 network_graph.clone(),
712 keys_manager.get_secure_random_bytes(),
717 // Step 11: Initialize the ChannelManager
718 let mut user_config = UserConfig::default();
719 user_config.channel_handshake_limits.force_announced_channel_preference = false;
720 user_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
721 user_config.manually_accept_inbound_channels = true;
722 let mut restarting_node = true;
723 let (channel_manager_blockhash, channel_manager) = {
724 if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
725 let mut channel_monitor_mut_references = Vec::new();
726 for (_, channel_monitor) in channelmonitors.iter_mut() {
727 channel_monitor_mut_references.push(channel_monitor);
729 let read_args = ChannelManagerReadArgs::new(
730 keys_manager.clone(),
731 keys_manager.clone(),
732 keys_manager.clone(),
733 fee_estimator.clone(),
734 chain_monitor.clone(),
739 channel_monitor_mut_references,
741 <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
743 // We're starting a fresh node.
744 restarting_node = false;
746 let polled_best_block = polled_chain_tip.to_best_block();
747 let polled_best_block_hash = polled_best_block.block_hash();
749 ChainParameters { network: args.network, best_block: polled_best_block };
750 let fresh_channel_manager = channelmanager::ChannelManager::new(
751 fee_estimator.clone(),
752 chain_monitor.clone(),
756 keys_manager.clone(),
757 keys_manager.clone(),
758 keys_manager.clone(),
761 cur.as_secs() as u32,
763 (polled_best_block_hash, fresh_channel_manager)
767 // Step 12: Sync ChannelMonitors and ChannelManager to chain tip
768 let mut chain_listener_channel_monitors = Vec::new();
769 let mut cache = UnboundedCache::new();
770 let chain_tip = if restarting_node {
771 let mut chain_listeners = vec![(
772 channel_manager_blockhash,
773 &channel_manager as &(dyn chain::Listen + Send + Sync),
776 for (blockhash, channel_monitor) in channelmonitors.drain(..) {
777 let outpoint = channel_monitor.get_funding_txo().0;
778 chain_listener_channel_monitors.push((
780 (channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()),
785 for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
786 chain_listeners.push((
787 monitor_listener_info.0,
788 &monitor_listener_info.1 as &(dyn chain::Listen + Send + Sync),
792 init::synchronize_listeners(
793 bitcoind_client.as_ref(),
804 // Step 13: Give ChannelMonitors to ChainMonitor
805 for item in chain_listener_channel_monitors.drain(..) {
806 let channel_monitor = item.1 .0;
807 let funding_outpoint = item.2;
809 chain_monitor.watch_channel(funding_outpoint, channel_monitor),
810 Ok(ChannelMonitorUpdateStatus::Completed)
814 // Step 14: Optional: Initialize the P2PGossipSync
816 Arc::new(P2PGossipSync::new(Arc::clone(&network_graph), None, Arc::clone(&logger)));
818 // Step 15: Initialize the PeerManager
819 let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
820 let onion_messenger: Arc<OnionMessenger> = Arc::new(OnionMessenger::new(
821 Arc::clone(&keys_manager),
822 Arc::clone(&keys_manager),
824 Arc::new(DefaultMessageRouter {}),
825 Arc::clone(&channel_manager),
826 IgnoringMessageHandler {},
828 let mut ephemeral_bytes = [0; 32];
829 let current_time = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs();
830 rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
831 let lightning_msg_handler = MessageHandler {
832 chan_handler: channel_manager.clone(),
833 route_handler: gossip_sync.clone(),
834 onion_message_handler: onion_messenger.clone(),
835 custom_message_handler: IgnoringMessageHandler {},
837 let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
838 lightning_msg_handler,
839 current_time.try_into().unwrap(),
842 Arc::clone(&keys_manager),
845 // Install a GossipVerifier in in the P2PGossipSync
846 let utxo_lookup = GossipVerifier::new(
847 Arc::clone(&bitcoind_client.bitcoind_rpc_client),
848 lightning_block_sync::gossip::TokioSpawner,
849 Arc::clone(&gossip_sync),
850 Arc::clone(&peer_manager),
852 gossip_sync.add_utxo_lookup(Some(utxo_lookup));
855 // Step 16: Initialize networking
857 let peer_manager_connection_handler = peer_manager.clone();
858 let listening_port = args.ldk_peer_listening_port;
859 let stop_listen_connect = Arc::new(AtomicBool::new(false));
860 let stop_listen = Arc::clone(&stop_listen_connect);
861 tokio::spawn(async move {
862 let listener = tokio::net::TcpListener::bind(format!("[::]:{}", listening_port))
864 .expect("Failed to bind to listen port - is something else already listening on it?");
866 let peer_mgr = peer_manager_connection_handler.clone();
867 let tcp_stream = listener.accept().await.unwrap().0;
868 if stop_listen.load(Ordering::Acquire) {
871 tokio::spawn(async move {
872 lightning_net_tokio::setup_inbound(
874 tcp_stream.into_std().unwrap(),
881 // Step 17: Connect and Disconnect Blocks
882 let channel_manager_listener = channel_manager.clone();
883 let chain_monitor_listener = chain_monitor.clone();
884 let bitcoind_block_source = bitcoind_client.clone();
885 let network = args.network;
886 tokio::spawn(async move {
887 let chain_poller = poll::ChainPoller::new(bitcoind_block_source.as_ref(), network);
888 let chain_listener = (chain_monitor_listener, channel_manager_listener);
889 let mut spv_client = SpvClient::new(chain_tip, chain_poller, &mut cache, &chain_listener);
891 spv_client.poll_best_tip().await.unwrap();
892 tokio::time::sleep(Duration::from_secs(1)).await;
896 let inbound_payments = Arc::new(Mutex::new(disk::read_inbound_payment_info(Path::new(
897 &format!("{}/{}", ldk_data_dir, INBOUND_PAYMENTS_FNAME),
899 let outbound_payments = Arc::new(Mutex::new(disk::read_outbound_payment_info(Path::new(
900 &format!("{}/{}", ldk_data_dir, OUTBOUND_PAYMENTS_FNAME),
902 let recent_payments_payment_ids = channel_manager
903 .list_recent_payments()
905 .filter_map(|p| match p {
906 RecentPaymentDetails::Pending { payment_id, .. } => Some(payment_id),
907 RecentPaymentDetails::Fulfilled { payment_id, .. } => Some(payment_id),
908 RecentPaymentDetails::Abandoned { payment_id, .. } => Some(payment_id),
909 RecentPaymentDetails::AwaitingInvoice { payment_id } => Some(payment_id),
911 .collect::<Vec<PaymentId>>();
912 for (payment_id, payment_info) in outbound_payments
917 .filter(|(_, i)| matches!(i.status, HTLCStatus::Pending))
919 if !recent_payments_payment_ids.contains(payment_id) {
920 payment_info.status = HTLCStatus::Failed;
924 .write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound_payments.lock().unwrap().encode())
927 // Step 18: Handle LDK Events
928 let channel_manager_event_listener = Arc::clone(&channel_manager);
929 let bitcoind_client_event_listener = Arc::clone(&bitcoind_client);
930 let network_graph_event_listener = Arc::clone(&network_graph);
931 let keys_manager_event_listener = Arc::clone(&keys_manager);
932 let inbound_payments_event_listener = Arc::clone(&inbound_payments);
933 let outbound_payments_event_listener = Arc::clone(&outbound_payments);
934 let fs_store_event_listener = Arc::clone(&fs_store);
935 let network = args.network;
936 let event_handler = move |event: Event| {
937 let channel_manager_event_listener = Arc::clone(&channel_manager_event_listener);
938 let bitcoind_client_event_listener = Arc::clone(&bitcoind_client_event_listener);
939 let network_graph_event_listener = Arc::clone(&network_graph_event_listener);
940 let keys_manager_event_listener = Arc::clone(&keys_manager_event_listener);
941 let bump_tx_event_handler = Arc::clone(&bump_tx_event_handler);
942 let inbound_payments_event_listener = Arc::clone(&inbound_payments_event_listener);
943 let outbound_payments_event_listener = Arc::clone(&outbound_payments_event_listener);
944 let fs_store_event_listener = Arc::clone(&fs_store_event_listener);
947 &channel_manager_event_listener,
948 &bitcoind_client_event_listener,
949 &network_graph_event_listener,
950 &keys_manager_event_listener,
951 &bump_tx_event_handler,
952 inbound_payments_event_listener,
953 outbound_payments_event_listener,
954 &fs_store_event_listener,
962 // Step 19: Persist ChannelManager and NetworkGraph
963 let persister = Arc::new(FilesystemStore::new(ldk_data_dir.clone().into()));
965 // Step 20: Background Processing
966 let (bp_exit, bp_exit_check) = tokio::sync::watch::channel(());
967 let mut background_processor = tokio::spawn(process_events_async(
968 Arc::clone(&persister),
970 chain_monitor.clone(),
971 channel_manager.clone(),
972 GossipSync::p2p(gossip_sync.clone()),
973 peer_manager.clone(),
975 Some(scorer.clone()),
977 let mut bp_exit_fut_check = bp_exit_check.clone();
978 Box::pin(async move {
980 _ = tokio::time::sleep(t) => false,
981 _ = bp_exit_fut_check.changed() => true,
988 // Regularly reconnect to channel peers.
989 let connect_cm = Arc::clone(&channel_manager);
990 let connect_pm = Arc::clone(&peer_manager);
991 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir);
992 let stop_connect = Arc::clone(&stop_listen_connect);
993 tokio::spawn(async move {
994 let mut interval = tokio::time::interval(Duration::from_secs(1));
995 interval.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Delay);
997 interval.tick().await;
998 match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
1000 let peers = connect_pm.get_peer_node_ids();
1001 for node_id in connect_cm
1004 .map(|chan| chan.counterparty.node_id)
1005 .filter(|id| !peers.iter().any(|(pk, _)| id == pk))
1007 if stop_connect.load(Ordering::Acquire) {
1010 for (pubkey, peer_addr) in info.iter() {
1011 if *pubkey == node_id {
1012 let _ = cli::do_connect_peer(
1015 Arc::clone(&connect_pm),
1022 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
1027 // Regularly broadcast our node_announcement. This is only required (or possible) if we have
1028 // some public channels.
1029 let peer_man = Arc::clone(&peer_manager);
1030 let chan_man = Arc::clone(&channel_manager);
1031 let network = args.network;
1032 tokio::spawn(async move {
1033 // First wait a minute until we have some peers and maybe have opened a channel.
1034 tokio::time::sleep(Duration::from_secs(60)).await;
1035 // Then, update our announcement once an hour to keep it fresh but avoid unnecessary churn
1036 // in the global gossip network.
1037 let mut interval = tokio::time::interval(Duration::from_secs(3600));
1039 interval.tick().await;
1040 // Don't bother trying to announce if we don't have any public channls, though our
1041 // peers should drop such an announcement anyway. Note that announcement may not
1042 // propagate until we have a channel with 6+ confirmations.
1043 if chan_man.list_channels().iter().any(|chan| chan.is_public) {
1044 peer_man.broadcast_node_announcement(
1046 args.ldk_announced_node_name,
1047 args.ldk_announced_listen_addr.clone(),
1053 tokio::spawn(sweep::periodic_sweep(
1054 ldk_data_dir.clone(),
1055 Arc::clone(&keys_manager),
1056 Arc::clone(&logger),
1057 Arc::clone(&persister),
1058 Arc::clone(&bitcoind_client),
1059 Arc::clone(&channel_manager),
1063 let probing_cm = Arc::clone(&channel_manager);
1064 let probing_graph = Arc::clone(&network_graph);
1065 let probing_logger = Arc::clone(&logger);
1066 let probing_scorer = Arc::clone(&scorer);
1067 tokio::spawn(async move {
1068 let mut interval = tokio::time::interval(Duration::from_secs(1));
1070 interval.tick().await;
1071 send_rand_probe(&*probing_cm, &*probing_graph, &*probing_logger, &*probing_scorer);
1076 let cli_channel_manager = Arc::clone(&channel_manager);
1077 let cli_persister = Arc::clone(&persister);
1078 let cli_logger = Arc::clone(&logger);
1079 let cli_peer_manager = Arc::clone(&peer_manager);
1080 let cli_poll = tokio::task::spawn_blocking(move || {
1081 cli::poll_for_user_input(
1083 cli_channel_manager,
1096 // Exit if either CLI polling exits or the background processor exits (which shouldn't happen
1097 // unless we fail to write to the filesystem).
1098 let mut bg_res = Ok(Ok(()));
1101 bg_exit = &mut background_processor => {
1106 // Disconnect our peers and stop accepting new connections. This ensures we don't continue
1107 // updating our channel data after we've stopped the background processor.
1108 stop_listen_connect.store(true, Ordering::Release);
1109 peer_manager.disconnect_all_peers();
1111 if let Err(e) = bg_res {
1112 let persist_res = persister
1114 persist::CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
1115 persist::CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
1116 persist::CHANNEL_MANAGER_PERSISTENCE_KEY,
1117 &channel_manager.encode(),
1120 use lightning::util::logger::Logger;
1121 lightning::log_error!(
1123 "Last-ditch ChannelManager persistence result: {:?}",
1127 "ERR: background processing stopped with result {:?}, exiting.\n\
1128 Last-ditch ChannelManager persistence result {:?}",
1133 // Stop the background processor.
1134 if !bp_exit.is_closed() {
1135 bp_exit.send(()).unwrap();
1136 background_processor.await.unwrap().unwrap();
1141 pub async fn main() {
1142 #[cfg(not(target_os = "windows"))]
1144 // Catch Ctrl-C with a dummy signal handler.
1146 let mut new_action: libc::sigaction = core::mem::zeroed();
1147 let mut old_action: libc::sigaction = core::mem::zeroed();
1149 extern "C" fn dummy_handler(
1150 _: libc::c_int, _: *const libc::siginfo_t, _: *const libc::c_void,
1154 new_action.sa_sigaction = dummy_handler as libc::sighandler_t;
1155 new_action.sa_flags = libc::SA_SIGINFO;
1159 &new_action as *const libc::sigaction,
1160 &mut old_action as *mut libc::sigaction,