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, KVStore, MonitorUpdatingPersister};
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>,
127 MonitorUpdatingPersister<
128 Arc<FilesystemStore>,
129 Arc<FilesystemLogger>,
136 pub(crate) type GossipVerifier = lightning_block_sync::gossip::GossipVerifier<
137 lightning_block_sync::gossip::TokioSpawner,
138 Arc<lightning_block_sync::rpc::RpcClient>,
139 Arc<FilesystemLogger>,
143 IgnoringMessageHandler,
147 pub(crate) type PeerManager = SimpleArcPeerManager<
156 pub(crate) type ChannelManager =
157 SimpleArcChannelManager<ChainMonitor, BitcoindClient, BitcoindClient, FilesystemLogger>;
159 pub(crate) type NetworkGraph = gossip::NetworkGraph<Arc<FilesystemLogger>>;
161 type OnionMessenger =
162 SimpleArcOnionMessenger<ChainMonitor, BitcoindClient, BitcoindClient, FilesystemLogger>;
164 pub(crate) type BumpTxEventHandler = BumpTransactionEventHandler<
166 Arc<Wallet<Arc<BitcoindClient>, Arc<FilesystemLogger>>>,
168 Arc<FilesystemLogger>,
171 async fn handle_ldk_events(
172 channel_manager: &Arc<ChannelManager>, bitcoind_client: &BitcoindClient,
173 network_graph: &NetworkGraph, keys_manager: &KeysManager,
174 bump_tx_event_handler: &BumpTxEventHandler, inbound_payments: Arc<Mutex<PaymentInfoStorage>>,
175 outbound_payments: Arc<Mutex<PaymentInfoStorage>>, fs_store: &Arc<FilesystemStore>,
176 network: Network, event: Event,
179 Event::FundingGenerationReady {
180 temporary_channel_id,
181 counterparty_node_id,
182 channel_value_satoshis,
186 // Construct the raw transaction with one output, that is paid the amount of the
188 let addr = WitnessProgram::from_scriptpubkey(
191 Network::Bitcoin => bitcoin_bech32::constants::Network::Bitcoin,
192 Network::Testnet => bitcoin_bech32::constants::Network::Testnet,
193 Network::Regtest => bitcoin_bech32::constants::Network::Regtest,
194 Network::Signet => bitcoin_bech32::constants::Network::Signet,
197 .expect("Lightning funding tx should always be to a SegWit output")
199 let mut outputs = vec![HashMap::with_capacity(1)];
200 outputs[0].insert(addr, channel_value_satoshis as f64 / 100_000_000.0);
201 let raw_tx = bitcoind_client.create_raw_transaction(outputs).await;
203 // Have your wallet put the inputs into the transaction such that the output is
205 let funded_tx = bitcoind_client.fund_raw_transaction(raw_tx).await;
207 // Sign the final funding transaction and broadcast it.
208 let signed_tx = bitcoind_client.sign_raw_transaction_with_wallet(funded_tx.hex).await;
209 assert_eq!(signed_tx.complete, true);
210 let final_tx: Transaction =
211 encode::deserialize(&hex_utils::to_vec(&signed_tx.hex).unwrap()).unwrap();
212 // Give the funding transaction back to LDK for opening the channel.
214 .funding_transaction_generated(
215 &temporary_channel_id,
216 &counterparty_node_id,
222 "\nERROR: Channel went away before we could fund it. The peer disconnected or refused the channel.");
224 io::stdout().flush().unwrap();
227 Event::PaymentClaimable {
233 via_user_channel_id: _,
236 counterparty_skimmed_fee_msat: _,
239 "\nEVENT: received payment from payment hash {} of {} millisatoshis",
240 payment_hash, amount_msat,
243 io::stdout().flush().unwrap();
244 let payment_preimage = match purpose {
245 PaymentPurpose::InvoicePayment { payment_preimage, .. } => payment_preimage,
246 PaymentPurpose::SpontaneousPayment(preimage) => Some(preimage),
248 channel_manager.claim_funds(payment_preimage.unwrap());
250 Event::PaymentClaimed {
256 sender_intended_total_msat: _,
259 "\nEVENT: claimed payment from payment hash {} of {} millisatoshis",
260 payment_hash, amount_msat,
263 io::stdout().flush().unwrap();
264 let (payment_preimage, payment_secret) = match purpose {
265 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
266 (payment_preimage, Some(payment_secret))
268 PaymentPurpose::SpontaneousPayment(preimage) => (Some(preimage), None),
270 let mut inbound = inbound_payments.lock().unwrap();
271 match inbound.payments.entry(payment_hash) {
272 Entry::Occupied(mut e) => {
273 let payment = e.get_mut();
274 payment.status = HTLCStatus::Succeeded;
275 payment.preimage = payment_preimage;
276 payment.secret = payment_secret;
278 Entry::Vacant(e) => {
279 e.insert(PaymentInfo {
280 preimage: payment_preimage,
281 secret: payment_secret,
282 status: HTLCStatus::Succeeded,
283 amt_msat: MillisatAmount(Some(amount_msat)),
287 fs_store.write("", "", INBOUND_PAYMENTS_FNAME, &inbound.encode()).unwrap();
289 Event::PaymentSent { payment_preimage, payment_hash, fee_paid_msat, .. } => {
290 let mut outbound = outbound_payments.lock().unwrap();
291 for (hash, payment) in outbound.payments.iter_mut() {
292 if *hash == payment_hash {
293 payment.preimage = Some(payment_preimage);
294 payment.status = HTLCStatus::Succeeded;
296 "\nEVENT: successfully sent payment of {} millisatoshis{} from \
297 payment hash {} with preimage {}",
299 if let Some(fee) = fee_paid_msat {
300 format!(" (fee {} msat)", fee)
308 io::stdout().flush().unwrap();
311 fs_store.write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound.encode()).unwrap();
313 Event::OpenChannelRequest {
314 ref temporary_channel_id, ref counterparty_node_id, ..
316 let mut random_bytes = [0u8; 16];
317 random_bytes.copy_from_slice(&keys_manager.get_secure_random_bytes()[..16]);
318 let user_channel_id = u128::from_be_bytes(random_bytes);
319 let res = channel_manager.accept_inbound_channel(
320 temporary_channel_id,
321 counterparty_node_id,
325 if let Err(e) = res {
327 "\nEVENT: Failed to accept inbound channel ({}) from {}: {:?}",
328 temporary_channel_id,
329 hex_utils::hex_str(&counterparty_node_id.serialize()),
334 "\nEVENT: Accepted inbound channel ({}) from {}",
335 temporary_channel_id,
336 hex_utils::hex_str(&counterparty_node_id.serialize()),
340 io::stdout().flush().unwrap();
342 Event::PaymentPathSuccessful { .. } => {}
343 Event::PaymentPathFailed { .. } => {}
344 Event::ProbeSuccessful { .. } => {}
345 Event::ProbeFailed { .. } => {}
346 Event::PaymentFailed { payment_hash, reason, .. } => {
348 "\nEVENT: Failed to send payment to payment hash {}: {:?}",
350 if let Some(r) = reason { r } else { PaymentFailureReason::RetriesExhausted }
353 io::stdout().flush().unwrap();
355 let mut outbound = outbound_payments.lock().unwrap();
356 if outbound.payments.contains_key(&payment_hash) {
357 let payment = outbound.payments.get_mut(&payment_hash).unwrap();
358 payment.status = HTLCStatus::Failed;
360 fs_store.write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound.encode()).unwrap();
362 Event::InvoiceRequestFailed { payment_id } => {
363 print!("\nEVENT: Failed to request invoice to send payment with id {}", payment_id);
365 io::stdout().flush().unwrap();
367 // TODO: mark the payment as failed
369 Event::PaymentForwarded {
373 claim_from_onchain_tx,
374 outbound_amount_forwarded_msat,
376 let read_only_network_graph = network_graph.read_only();
377 let nodes = read_only_network_graph.nodes();
378 let channels = channel_manager.list_channels();
380 let node_str = |channel_id: &Option<ChannelId>| match channel_id {
381 None => String::new(),
382 Some(channel_id) => match channels.iter().find(|c| c.channel_id == *channel_id) {
383 None => String::new(),
385 match nodes.get(&NodeId::from_pubkey(&channel.counterparty.node_id)) {
386 None => "private node".to_string(),
387 Some(node) => match &node.announcement_info {
388 None => "unnamed node".to_string(),
389 Some(announcement) => {
390 format!("node {}", announcement.alias)
397 let channel_str = |channel_id: &Option<ChannelId>| {
399 .map(|channel_id| format!(" with channel {}", channel_id))
403 format!(" from {}{}", node_str(&prev_channel_id), channel_str(&prev_channel_id));
405 format!(" to {}{}", node_str(&next_channel_id), channel_str(&next_channel_id));
407 let from_onchain_str = if claim_from_onchain_tx {
408 "from onchain downstream claim"
410 "from HTLC fulfill message"
412 let amt_args = if let Some(v) = outbound_amount_forwarded_msat {
417 if let Some(fee_earned) = fee_earned_msat {
419 "\nEVENT: Forwarded payment for {} msat{}{}, earning {} msat {}",
420 amt_args, from_prev_str, to_next_str, fee_earned, from_onchain_str
424 "\nEVENT: Forwarded payment for {} msat{}{}, claiming onchain {}",
425 amt_args, from_prev_str, to_next_str, from_onchain_str
429 io::stdout().flush().unwrap();
431 Event::HTLCHandlingFailed { .. } => {}
432 Event::PendingHTLCsForwardable { time_forwardable } => {
433 let forwarding_channel_manager = channel_manager.clone();
434 let min = time_forwardable.as_millis() as u64;
435 tokio::spawn(async move {
436 let millis_to_sleep = thread_rng().gen_range(min, min * 5) as u64;
437 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
438 forwarding_channel_manager.process_pending_htlc_forwards();
441 Event::SpendableOutputs { outputs, channel_id: _ } => {
442 // SpendableOutputDescriptors, of which outputs is a vec of, are critical to keep track
443 // of! While a `StaticOutput` descriptor is just an output to a static, well-known key,
444 // other descriptors are not currently ever regenerated for you by LDK. Once we return
445 // from this method, the descriptor will be gone, and you may lose track of some funds.
447 // Here we simply persist them to disk, with a background task running which will try
448 // to spend them regularly (possibly duplicatively/RBF'ing them). These can just be
449 // treated as normal funds where possible - they are only spendable by us and there is
450 // no rush to claim them.
451 for output in outputs {
452 let key = hex_utils::hex_str(&keys_manager.get_secure_random_bytes());
453 // Note that if the type here changes our read code needs to change as well.
454 let output: SpendableOutputDescriptor = output;
455 fs_store.write(PENDING_SPENDABLE_OUTPUT_DIR, "", &key, &output.encode()).unwrap();
458 Event::ChannelPending { channel_id, counterparty_node_id, .. } => {
460 "\nEVENT: Channel {} with peer {} is pending awaiting funding lock-in!",
462 hex_utils::hex_str(&counterparty_node_id.serialize()),
465 io::stdout().flush().unwrap();
467 Event::ChannelReady {
470 ref counterparty_node_id,
474 "\nEVENT: Channel {} with peer {} is ready to be used!",
476 hex_utils::hex_str(&counterparty_node_id.serialize()),
479 io::stdout().flush().unwrap();
481 Event::ChannelClosed {
485 counterparty_node_id,
486 channel_capacity_sats: _,
489 "\nEVENT: Channel {} with counterparty {} closed due to: {:?}",
491 counterparty_node_id.map(|id| format!("{}", id)).unwrap_or("".to_owned()),
495 io::stdout().flush().unwrap();
497 Event::DiscardFunding { .. } => {
498 // A "real" node should probably "lock" the UTXOs spent in funding transactions until
499 // the funding transaction either confirms, or this event is generated.
501 Event::HTLCIntercepted { .. } => {}
502 Event::BumpTransaction(event) => bump_tx_event_handler.handle_event(&event),
506 async fn start_ldk() {
507 let args = match args::parse_startup_args() {
508 Ok(user_args) => user_args,
512 // Initialize the LDK data directory if necessary.
513 let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
514 fs::create_dir_all(ldk_data_dir.clone()).unwrap();
517 // Step 1: Initialize the Logger
518 let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
520 // Initialize our bitcoind client.
521 let bitcoind_client = match BitcoindClient::new(
522 args.bitcoind_rpc_host.clone(),
523 args.bitcoind_rpc_port,
524 args.bitcoind_rpc_username.clone(),
525 args.bitcoind_rpc_password.clone(),
526 tokio::runtime::Handle::current(),
531 Ok(client) => Arc::new(client),
533 println!("Failed to connect to bitcoind client: {}", e);
538 // Check that the bitcoind we've connected to is running the network we expect
539 let bitcoind_chain = bitcoind_client.get_blockchain_info().await.chain;
541 != match args.network {
542 bitcoin::Network::Bitcoin => "main",
543 bitcoin::Network::Testnet => "test",
544 bitcoin::Network::Regtest => "regtest",
545 bitcoin::Network::Signet => "signet",
548 "Chain argument ({}) didn't match bitcoind chain ({})",
549 args.network, bitcoind_chain
554 // Step 2: Initialize the FeeEstimator
556 // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
557 let fee_estimator = bitcoind_client.clone();
559 // Step 3: Initialize the BroadcasterInterface
561 // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
563 let broadcaster = bitcoind_client.clone();
565 // Step 4: Initialize the KeysManager
567 // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
568 // other secret key material.
569 let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
570 let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
571 assert_eq!(seed.len(), 32);
572 let mut key = [0; 32];
573 key.copy_from_slice(&seed);
576 let mut key = [0; 32];
577 thread_rng().fill_bytes(&mut key);
578 match File::create(keys_seed_path.clone()) {
580 Write::write_all(&mut f, &key).expect("Failed to write node keys seed to disk");
581 f.sync_all().expect("Failed to sync node keys seed to disk");
584 println!("ERROR: Unable to create keys seed file {}: {}", keys_seed_path, e);
590 let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
591 let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
593 let bump_tx_event_handler = Arc::new(BumpTransactionEventHandler::new(
594 Arc::clone(&broadcaster),
595 Arc::new(Wallet::new(Arc::clone(&bitcoind_client), Arc::clone(&logger))),
596 Arc::clone(&keys_manager),
600 // Step 5: Initialize Persistence
601 let fs_store = Arc::new(FilesystemStore::new(ldk_data_dir.clone().into()));
602 let persister = Arc::new(MonitorUpdatingPersister::new(
603 Arc::clone(&fs_store),
606 Arc::clone(&keys_manager),
607 Arc::clone(&keys_manager),
609 // Alternatively, you can use the `FilesystemStore` as a `Persist` directly, at the cost of
610 // larger `ChannelMonitor` update writes (but no deletion or cleanup):
611 //let persister = Arc::clone(&fs_store);
613 // Step 6: Initialize the ChainMonitor
614 let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
616 Arc::clone(&broadcaster),
618 Arc::clone(&fee_estimator),
619 Arc::clone(&persister),
622 // Step 7: Read ChannelMonitor state from disk
623 let mut channelmonitors = persister
624 .read_all_channel_monitors_with_updates(&bitcoind_client, &bitcoind_client)
626 // If you are using the `FilesystemStore` as a `Persist` directly, use
627 // `lightning::util::persist::read_channel_monitors` like this:
628 //read_channel_monitors(Arc::clone(&persister), Arc::clone(&keys_manager), Arc::clone(&keys_manager)).unwrap();
630 // Step 8: Poll for the best chain tip, which may be used by the channel manager & spv client
631 let polled_chain_tip = init::validate_best_block_header(bitcoind_client.as_ref())
633 .expect("Failed to fetch best block header and best block");
635 // Step 9: Initialize routing ProbabilisticScorer
636 let network_graph_path = format!("{}/network_graph", ldk_data_dir.clone());
638 Arc::new(disk::read_network(Path::new(&network_graph_path), args.network, logger.clone()));
640 let scorer_path = format!("{}/scorer", ldk_data_dir.clone());
641 let scorer = Arc::new(RwLock::new(disk::read_scorer(
642 Path::new(&scorer_path),
643 Arc::clone(&network_graph),
647 // Step 10: Create Router
648 let scoring_fee_params = ProbabilisticScoringFeeParameters::default();
649 let router = Arc::new(DefaultRouter::new(
650 network_graph.clone(),
652 keys_manager.get_secure_random_bytes(),
657 // Step 11: Initialize the ChannelManager
658 let mut user_config = UserConfig::default();
659 user_config.channel_handshake_limits.force_announced_channel_preference = false;
660 user_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
661 user_config.manually_accept_inbound_channels = true;
662 let mut restarting_node = true;
663 let (channel_manager_blockhash, channel_manager) = {
664 if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
665 let mut channel_monitor_mut_references = Vec::new();
666 for (_, channel_monitor) in channelmonitors.iter_mut() {
667 channel_monitor_mut_references.push(channel_monitor);
669 let read_args = ChannelManagerReadArgs::new(
670 keys_manager.clone(),
671 keys_manager.clone(),
672 keys_manager.clone(),
673 fee_estimator.clone(),
674 chain_monitor.clone(),
679 channel_monitor_mut_references,
681 <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
683 // We're starting a fresh node.
684 restarting_node = false;
686 let polled_best_block = polled_chain_tip.to_best_block();
687 let polled_best_block_hash = polled_best_block.block_hash();
689 ChainParameters { network: args.network, best_block: polled_best_block };
690 let fresh_channel_manager = channelmanager::ChannelManager::new(
691 fee_estimator.clone(),
692 chain_monitor.clone(),
696 keys_manager.clone(),
697 keys_manager.clone(),
698 keys_manager.clone(),
701 cur.as_secs() as u32,
703 (polled_best_block_hash, fresh_channel_manager)
707 // Step 12: Sync ChannelMonitors and ChannelManager to chain tip
708 let mut chain_listener_channel_monitors = Vec::new();
709 let mut cache = UnboundedCache::new();
710 let chain_tip = if restarting_node {
711 let mut chain_listeners = vec![(
712 channel_manager_blockhash,
713 &channel_manager as &(dyn chain::Listen + Send + Sync),
716 for (blockhash, channel_monitor) in channelmonitors.drain(..) {
717 let outpoint = channel_monitor.get_funding_txo().0;
718 chain_listener_channel_monitors.push((
720 (channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()),
725 for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
726 chain_listeners.push((
727 monitor_listener_info.0,
728 &monitor_listener_info.1 as &(dyn chain::Listen + Send + Sync),
732 init::synchronize_listeners(
733 bitcoind_client.as_ref(),
744 // Step 13: Give ChannelMonitors to ChainMonitor
745 for item in chain_listener_channel_monitors.drain(..) {
746 let channel_monitor = item.1 .0;
747 let funding_outpoint = item.2;
749 chain_monitor.watch_channel(funding_outpoint, channel_monitor),
750 Ok(ChannelMonitorUpdateStatus::Completed)
754 // Step 14: Optional: Initialize the P2PGossipSync
756 Arc::new(P2PGossipSync::new(Arc::clone(&network_graph), None, Arc::clone(&logger)));
758 // Step 15: Initialize the PeerManager
759 let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
760 let onion_messenger: Arc<OnionMessenger> = Arc::new(OnionMessenger::new(
761 Arc::clone(&keys_manager),
762 Arc::clone(&keys_manager),
764 Arc::new(DefaultMessageRouter {}),
765 Arc::clone(&channel_manager),
766 IgnoringMessageHandler {},
768 let mut ephemeral_bytes = [0; 32];
769 let current_time = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs();
770 rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
771 let lightning_msg_handler = MessageHandler {
772 chan_handler: channel_manager.clone(),
773 route_handler: gossip_sync.clone(),
774 onion_message_handler: onion_messenger.clone(),
775 custom_message_handler: IgnoringMessageHandler {},
777 let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
778 lightning_msg_handler,
779 current_time.try_into().unwrap(),
782 Arc::clone(&keys_manager),
785 // Install a GossipVerifier in in the P2PGossipSync
786 let utxo_lookup = GossipVerifier::new(
787 Arc::clone(&bitcoind_client.bitcoind_rpc_client),
788 lightning_block_sync::gossip::TokioSpawner,
789 Arc::clone(&gossip_sync),
790 Arc::clone(&peer_manager),
792 gossip_sync.add_utxo_lookup(Some(utxo_lookup));
795 // Step 16: Initialize networking
797 let peer_manager_connection_handler = peer_manager.clone();
798 let listening_port = args.ldk_peer_listening_port;
799 let stop_listen_connect = Arc::new(AtomicBool::new(false));
800 let stop_listen = Arc::clone(&stop_listen_connect);
801 tokio::spawn(async move {
802 let listener = tokio::net::TcpListener::bind(format!("[::]:{}", listening_port))
804 .expect("Failed to bind to listen port - is something else already listening on it?");
806 let peer_mgr = peer_manager_connection_handler.clone();
807 let tcp_stream = listener.accept().await.unwrap().0;
808 if stop_listen.load(Ordering::Acquire) {
811 tokio::spawn(async move {
812 lightning_net_tokio::setup_inbound(
814 tcp_stream.into_std().unwrap(),
821 // Step 17: Connect and Disconnect Blocks
822 let channel_manager_listener = channel_manager.clone();
823 let chain_monitor_listener = chain_monitor.clone();
824 let bitcoind_block_source = bitcoind_client.clone();
825 let network = args.network;
826 tokio::spawn(async move {
827 let chain_poller = poll::ChainPoller::new(bitcoind_block_source.as_ref(), network);
828 let chain_listener = (chain_monitor_listener, channel_manager_listener);
829 let mut spv_client = SpvClient::new(chain_tip, chain_poller, &mut cache, &chain_listener);
831 spv_client.poll_best_tip().await.unwrap();
832 tokio::time::sleep(Duration::from_secs(1)).await;
836 let inbound_payments = Arc::new(Mutex::new(disk::read_payment_info(Path::new(&format!(
838 ldk_data_dir, INBOUND_PAYMENTS_FNAME
840 let outbound_payments = Arc::new(Mutex::new(disk::read_payment_info(Path::new(&format!(
842 ldk_data_dir, OUTBOUND_PAYMENTS_FNAME
844 let recent_payments_payment_hashes = channel_manager
845 .list_recent_payments()
847 .filter_map(|p| match p {
848 RecentPaymentDetails::Pending { payment_hash, .. } => Some(payment_hash),
849 RecentPaymentDetails::Fulfilled { payment_hash, .. } => payment_hash,
850 RecentPaymentDetails::Abandoned { payment_hash, .. } => Some(payment_hash),
851 RecentPaymentDetails::AwaitingInvoice { payment_id: _ } => todo!(),
853 .collect::<Vec<PaymentHash>>();
854 for (payment_hash, payment_info) in outbound_payments
859 .filter(|(_, i)| matches!(i.status, HTLCStatus::Pending))
861 if !recent_payments_payment_hashes.contains(payment_hash) {
862 payment_info.status = HTLCStatus::Failed;
866 .write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound_payments.lock().unwrap().encode())
869 // Step 18: Handle LDK Events
870 let channel_manager_event_listener = Arc::clone(&channel_manager);
871 let bitcoind_client_event_listener = Arc::clone(&bitcoind_client);
872 let network_graph_event_listener = Arc::clone(&network_graph);
873 let keys_manager_event_listener = Arc::clone(&keys_manager);
874 let inbound_payments_event_listener = Arc::clone(&inbound_payments);
875 let outbound_payments_event_listener = Arc::clone(&outbound_payments);
876 let fs_store_event_listener = Arc::clone(&fs_store);
877 let network = args.network;
878 let event_handler = move |event: Event| {
879 let channel_manager_event_listener = Arc::clone(&channel_manager_event_listener);
880 let bitcoind_client_event_listener = Arc::clone(&bitcoind_client_event_listener);
881 let network_graph_event_listener = Arc::clone(&network_graph_event_listener);
882 let keys_manager_event_listener = Arc::clone(&keys_manager_event_listener);
883 let bump_tx_event_handler = Arc::clone(&bump_tx_event_handler);
884 let inbound_payments_event_listener = Arc::clone(&inbound_payments_event_listener);
885 let outbound_payments_event_listener = Arc::clone(&outbound_payments_event_listener);
886 let fs_store_event_listener = Arc::clone(&fs_store_event_listener);
889 &channel_manager_event_listener,
890 &bitcoind_client_event_listener,
891 &network_graph_event_listener,
892 &keys_manager_event_listener,
893 &bump_tx_event_handler,
894 inbound_payments_event_listener,
895 outbound_payments_event_listener,
896 &fs_store_event_listener,
904 // Step 19: Persist ChannelManager and NetworkGraph
905 let persister = Arc::new(FilesystemStore::new(ldk_data_dir.clone().into()));
907 // Step 20: Background Processing
908 let (bp_exit, bp_exit_check) = tokio::sync::watch::channel(());
909 let mut background_processor = tokio::spawn(process_events_async(
910 Arc::clone(&persister),
912 chain_monitor.clone(),
913 channel_manager.clone(),
914 GossipSync::p2p(gossip_sync.clone()),
915 peer_manager.clone(),
917 Some(scorer.clone()),
919 let mut bp_exit_fut_check = bp_exit_check.clone();
920 Box::pin(async move {
922 _ = tokio::time::sleep(t) => false,
923 _ = bp_exit_fut_check.changed() => true,
930 // Regularly reconnect to channel peers.
931 let connect_cm = Arc::clone(&channel_manager);
932 let connect_pm = Arc::clone(&peer_manager);
933 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir);
934 let stop_connect = Arc::clone(&stop_listen_connect);
935 tokio::spawn(async move {
936 let mut interval = tokio::time::interval(Duration::from_secs(1));
937 interval.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Delay);
939 interval.tick().await;
940 match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
942 let peers = connect_pm.get_peer_node_ids();
943 for node_id in connect_cm
946 .map(|chan| chan.counterparty.node_id)
947 .filter(|id| !peers.iter().any(|(pk, _)| id == pk))
949 if stop_connect.load(Ordering::Acquire) {
952 for (pubkey, peer_addr) in info.iter() {
953 if *pubkey == node_id {
954 let _ = cli::do_connect_peer(
957 Arc::clone(&connect_pm),
964 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
969 // Regularly broadcast our node_announcement. This is only required (or possible) if we have
970 // some public channels.
971 let peer_man = Arc::clone(&peer_manager);
972 let chan_man = Arc::clone(&channel_manager);
973 let network = args.network;
974 tokio::spawn(async move {
975 // First wait a minute until we have some peers and maybe have opened a channel.
976 tokio::time::sleep(Duration::from_secs(60)).await;
977 // Then, update our announcement once an hour to keep it fresh but avoid unnecessary churn
978 // in the global gossip network.
979 let mut interval = tokio::time::interval(Duration::from_secs(3600));
981 interval.tick().await;
982 // Don't bother trying to announce if we don't have any public channls, though our
983 // peers should drop such an announcement anyway. Note that announcement may not
984 // propagate until we have a channel with 6+ confirmations.
985 if chan_man.list_channels().iter().any(|chan| chan.is_public) {
986 peer_man.broadcast_node_announcement(
988 args.ldk_announced_node_name,
989 args.ldk_announced_listen_addr.clone(),
995 tokio::spawn(sweep::periodic_sweep(
996 ldk_data_dir.clone(),
997 Arc::clone(&keys_manager),
999 Arc::clone(&persister),
1000 Arc::clone(&bitcoind_client),
1001 Arc::clone(&channel_manager),
1005 let cli_channel_manager = Arc::clone(&channel_manager);
1006 let cli_persister = Arc::clone(&persister);
1007 let cli_logger = Arc::clone(&logger);
1008 let cli_peer_manager = Arc::clone(&peer_manager);
1009 let cli_poll = tokio::task::spawn_blocking(move || {
1010 cli::poll_for_user_input(
1012 cli_channel_manager,
1025 // Exit if either CLI polling exits or the background processor exits (which shouldn't happen
1026 // unless we fail to write to the filesystem).
1027 let mut bg_res = Ok(Ok(()));
1030 bg_exit = &mut background_processor => {
1035 // Disconnect our peers and stop accepting new connections. This ensures we don't continue
1036 // updating our channel data after we've stopped the background processor.
1037 stop_listen_connect.store(true, Ordering::Release);
1038 peer_manager.disconnect_all_peers();
1040 if let Err(e) = bg_res {
1041 let persist_res = persister
1043 persist::CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
1044 persist::CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
1045 persist::CHANNEL_MANAGER_PERSISTENCE_KEY,
1046 &channel_manager.encode(),
1049 use lightning::util::logger::Logger;
1050 lightning::log_error!(
1052 "Last-ditch ChannelManager persistence result: {:?}",
1056 "ERR: background processing stopped with result {:?}, exiting.\n\
1057 Last-ditch ChannelManager persistence result {:?}",
1062 // Stop the background processor.
1063 if !bp_exit.is_closed() {
1064 bp_exit.send(()).unwrap();
1065 background_processor.await.unwrap().unwrap();
1070 pub async fn main() {
1071 #[cfg(not(target_os = "windows"))]
1073 // Catch Ctrl-C with a dummy signal handler.
1075 let mut new_action: libc::sigaction = core::mem::zeroed();
1076 let mut old_action: libc::sigaction = core::mem::zeroed();
1078 extern "C" fn dummy_handler(
1079 _: libc::c_int, _: *const libc::siginfo_t, _: *const libc::c_void,
1083 new_action.sa_sigaction = dummy_handler as libc::sighandler_t;
1084 new_action.sa_flags = libc::SA_SIGINFO;
1088 &new_action as *const libc::sigaction,
1089 &mut old_action as *mut libc::sigaction,