1 pub mod bitcoind_client;
7 use crate::bitcoind_client::BitcoindClient;
8 use crate::disk::FilesystemLogger;
9 use bitcoin::blockdata::constants::genesis_block;
10 use bitcoin::blockdata::transaction::Transaction;
11 use bitcoin::consensus::encode;
12 use bitcoin::network::constants::Network;
13 use bitcoin::secp256k1::Secp256k1;
14 use bitcoin::BlockHash;
15 use bitcoin_bech32::WitnessProgram;
17 use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
18 use lightning::chain::chainmonitor;
19 use lightning::chain::keysinterface::{InMemorySigner, KeysInterface, KeysManager, Recipient};
20 use lightning::chain::{BestBlock, Filter, Watch};
21 use lightning::ln::channelmanager;
22 use lightning::ln::channelmanager::{
23 ChainParameters, ChannelManagerReadArgs, SimpleArcChannelManager,
25 use lightning::ln::peer_handler::{IgnoringMessageHandler, MessageHandler, SimpleArcPeerManager};
26 use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
27 use lightning::routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
28 use lightning::routing::scoring::ProbabilisticScorer;
29 use lightning::util::config::UserConfig;
30 use lightning::util::events::{Event, PaymentPurpose};
31 use lightning::util::ser::ReadableArgs;
32 use lightning_background_processor::{BackgroundProcessor, Persister};
33 use lightning_block_sync::init;
34 use lightning_block_sync::poll;
35 use lightning_block_sync::SpvClient;
36 use lightning_block_sync::UnboundedCache;
37 use lightning_invoice::payment;
38 use lightning_invoice::utils::DefaultRouter;
39 use lightning_net_tokio::SocketDescriptor;
40 use lightning_persister::FilesystemPersister;
41 use rand::{thread_rng, Rng};
42 use std::collections::hash_map::Entry;
43 use std::collections::HashMap;
51 use std::sync::{Arc, Mutex};
52 use std::time::{Duration, SystemTime};
54 pub(crate) enum HTLCStatus {
60 pub(crate) struct MillisatAmount(Option<u64>);
62 impl fmt::Display for MillisatAmount {
63 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
65 Some(amt) => write!(f, "{}", amt),
66 None => write!(f, "unknown"),
71 pub(crate) struct PaymentInfo {
72 preimage: Option<PaymentPreimage>,
73 secret: Option<PaymentSecret>,
75 amt_msat: MillisatAmount,
78 pub(crate) type PaymentInfoStorage = Arc<Mutex<HashMap<PaymentHash, PaymentInfo>>>;
80 type ChainMonitor = chainmonitor::ChainMonitor<
82 Arc<dyn Filter + Send + Sync>,
85 Arc<FilesystemLogger>,
86 Arc<FilesystemPersister>,
89 pub(crate) type PeerManager = SimpleArcPeerManager<
94 dyn chain::Access + Send + Sync,
98 pub(crate) type ChannelManager =
99 SimpleArcChannelManager<ChainMonitor, BitcoindClient, BitcoindClient, FilesystemLogger>;
101 pub(crate) type InvoicePayer<E> = payment::InvoicePayer<
104 Arc<Mutex<ProbabilisticScorer<Arc<NetworkGraph>>>>,
105 Arc<FilesystemLogger>,
109 type Router = DefaultRouter<Arc<NetworkGraph>, Arc<FilesystemLogger>>;
111 struct DataPersister {
122 Arc<FilesystemLogger>,
125 fn persist_manager(&self, channel_manager: &ChannelManager) -> Result<(), std::io::Error> {
126 FilesystemPersister::persist_manager(self.data_dir.clone(), channel_manager)
129 fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), std::io::Error> {
130 if FilesystemPersister::persist_network_graph(self.data_dir.clone(), network_graph).is_err()
132 // Persistence errors here are non-fatal as we can just fetch the routing graph
133 // again later, but they may indicate a disk error which could be fatal elsewhere.
134 eprintln!("Warning: Failed to persist network graph, check your disk and permissions");
141 async fn handle_ldk_events(
142 channel_manager: Arc<ChannelManager>, bitcoind_client: Arc<BitcoindClient>,
143 keys_manager: Arc<KeysManager>, inbound_payments: PaymentInfoStorage,
144 outbound_payments: PaymentInfoStorage, network: Network, event: &Event,
147 Event::FundingGenerationReady {
148 temporary_channel_id,
149 channel_value_satoshis,
153 // Construct the raw transaction with one output, that is paid the amount of the
155 let addr = WitnessProgram::from_scriptpubkey(
158 Network::Bitcoin => bitcoin_bech32::constants::Network::Bitcoin,
159 Network::Testnet => bitcoin_bech32::constants::Network::Testnet,
160 Network::Regtest => bitcoin_bech32::constants::Network::Regtest,
161 Network::Signet => bitcoin_bech32::constants::Network::Signet,
164 .expect("Lightning funding tx should always be to a SegWit output")
166 let mut outputs = vec![HashMap::with_capacity(1)];
167 outputs[0].insert(addr, *channel_value_satoshis as f64 / 100_000_000.0);
168 let raw_tx = bitcoind_client.create_raw_transaction(outputs).await;
170 // Have your wallet put the inputs into the transaction such that the output is
172 let funded_tx = bitcoind_client.fund_raw_transaction(raw_tx).await;
174 // Sign the final funding transaction and broadcast it.
175 let signed_tx = bitcoind_client.sign_raw_transaction_with_wallet(funded_tx.hex).await;
176 assert_eq!(signed_tx.complete, true);
177 let final_tx: Transaction =
178 encode::deserialize(&hex_utils::to_vec(&signed_tx.hex).unwrap()).unwrap();
179 // Give the funding transaction back to LDK for opening the channel.
181 .funding_transaction_generated(&temporary_channel_id, final_tx)
185 "\nERROR: Channel went away before we could fund it. The peer disconnected or refused the channel.");
187 io::stdout().flush().unwrap();
190 Event::PaymentReceived { payment_hash, purpose, amt, .. } => {
191 let mut payments = inbound_payments.lock().unwrap();
192 let (payment_preimage, payment_secret) = match purpose {
193 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
194 (*payment_preimage, Some(*payment_secret))
196 PaymentPurpose::SpontaneousPayment(preimage) => (Some(*preimage), None),
198 let status = match channel_manager.claim_funds(payment_preimage.unwrap()) {
201 "\nEVENT: received payment from payment hash {} of {} millisatoshis",
202 hex_utils::hex_str(&payment_hash.0),
206 io::stdout().flush().unwrap();
207 HTLCStatus::Succeeded
209 _ => HTLCStatus::Failed,
211 match payments.entry(*payment_hash) {
212 Entry::Occupied(mut e) => {
213 let payment = e.get_mut();
214 payment.status = status;
215 payment.preimage = payment_preimage;
216 payment.secret = payment_secret;
218 Entry::Vacant(e) => {
219 e.insert(PaymentInfo {
220 preimage: payment_preimage,
221 secret: payment_secret,
223 amt_msat: MillisatAmount(Some(*amt)),
228 Event::PaymentSent { payment_preimage, payment_hash, fee_paid_msat, .. } => {
229 let mut payments = outbound_payments.lock().unwrap();
230 for (hash, payment) in payments.iter_mut() {
231 if *hash == *payment_hash {
232 payment.preimage = Some(*payment_preimage);
233 payment.status = HTLCStatus::Succeeded;
235 "\nEVENT: successfully sent payment of {} millisatoshis{} from \
236 payment hash {:?} with preimage {:?}",
238 if let Some(fee) = fee_paid_msat {
239 format!(" (fee {} msat)", fee)
243 hex_utils::hex_str(&payment_hash.0),
244 hex_utils::hex_str(&payment_preimage.0)
247 io::stdout().flush().unwrap();
251 Event::OpenChannelRequest { .. } => {
252 // Unreachable, we don't set manually_accept_inbound_channels
254 Event::PaymentPathSuccessful { .. } => {}
255 Event::PaymentPathFailed { .. } => {}
256 Event::PaymentFailed { payment_hash, .. } => {
258 "\nEVENT: Failed to send payment to payment hash {:?}: exhausted payment retry attempts",
259 hex_utils::hex_str(&payment_hash.0)
262 io::stdout().flush().unwrap();
264 let mut payments = outbound_payments.lock().unwrap();
265 if payments.contains_key(&payment_hash) {
266 let payment = payments.get_mut(&payment_hash).unwrap();
267 payment.status = HTLCStatus::Failed;
270 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
271 let from_onchain_str = if *claim_from_onchain_tx {
272 "from onchain downstream claim"
274 "from HTLC fulfill message"
276 if let Some(fee_earned) = fee_earned_msat {
278 "\nEVENT: Forwarded payment, earning {} msat {}",
279 fee_earned, from_onchain_str
282 println!("\nEVENT: Forwarded payment, claiming onchain {}", from_onchain_str);
285 io::stdout().flush().unwrap();
287 Event::PendingHTLCsForwardable { time_forwardable } => {
288 let forwarding_channel_manager = channel_manager.clone();
289 let min = time_forwardable.as_millis() as u64;
290 tokio::spawn(async move {
291 let millis_to_sleep = thread_rng().gen_range(min, min * 5) as u64;
292 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
293 forwarding_channel_manager.process_pending_htlc_forwards();
296 Event::SpendableOutputs { outputs } => {
297 let destination_address = bitcoind_client.get_new_address().await;
298 let output_descriptors = &outputs.iter().map(|a| a).collect::<Vec<_>>();
300 bitcoind_client.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
301 let spending_tx = keys_manager
302 .spend_spendable_outputs(
305 destination_address.script_pubkey(),
310 bitcoind_client.broadcast_transaction(&spending_tx);
312 Event::ChannelClosed { channel_id, reason, user_channel_id: _ } => {
314 "\nEVENT: Channel {} closed due to: {:?}",
315 hex_utils::hex_str(channel_id),
319 io::stdout().flush().unwrap();
321 Event::DiscardFunding { .. } => {
322 // A "real" node should probably "lock" the UTXOs spent in funding transactions until
323 // the funding transaction either confirms, or this event is generated.
328 async fn start_ldk() {
329 let args = match cli::parse_startup_args() {
330 Ok(user_args) => user_args,
334 // Initialize the LDK data directory if necessary.
335 let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
336 fs::create_dir_all(ldk_data_dir.clone()).unwrap();
338 // Initialize our bitcoind client.
339 let bitcoind_client = match BitcoindClient::new(
340 args.bitcoind_rpc_host.clone(),
341 args.bitcoind_rpc_port,
342 args.bitcoind_rpc_username.clone(),
343 args.bitcoind_rpc_password.clone(),
344 tokio::runtime::Handle::current(),
348 Ok(client) => Arc::new(client),
350 println!("Failed to connect to bitcoind client: {}", e);
355 // Check that the bitcoind we've connected to is running the network we expect
356 let bitcoind_chain = bitcoind_client.get_blockchain_info().await.chain;
358 != match args.network {
359 bitcoin::Network::Bitcoin => "main",
360 bitcoin::Network::Testnet => "test",
361 bitcoin::Network::Regtest => "regtest",
362 bitcoin::Network::Signet => "signet",
365 "Chain argument ({}) didn't match bitcoind chain ({})",
366 args.network, bitcoind_chain
372 // Step 1: Initialize the FeeEstimator
374 // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
375 let fee_estimator = bitcoind_client.clone();
377 // Step 2: Initialize the Logger
378 let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
380 // Step 3: Initialize the BroadcasterInterface
382 // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
384 let broadcaster = bitcoind_client.clone();
386 // Step 4: Initialize Persist
387 let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
389 // Step 5: Initialize the ChainMonitor
390 let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
394 fee_estimator.clone(),
398 // Step 6: Initialize the KeysManager
400 // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
401 // other secret key material.
402 let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
403 let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
404 assert_eq!(seed.len(), 32);
405 let mut key = [0; 32];
406 key.copy_from_slice(&seed);
409 let mut key = [0; 32];
410 thread_rng().fill_bytes(&mut key);
411 match File::create(keys_seed_path.clone()) {
413 f.write_all(&key).expect("Failed to write node keys seed to disk");
414 f.sync_all().expect("Failed to sync node keys seed to disk");
417 println!("ERROR: Unable to create keys seed file {}: {}", keys_seed_path, e);
423 let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
424 let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
426 // Step 7: Read ChannelMonitor state from disk
427 let mut channelmonitors = persister.read_channelmonitors(keys_manager.clone()).unwrap();
429 // Step 8: Initialize the ChannelManager
430 let mut user_config = UserConfig::default();
431 user_config.peer_channel_config_limits.force_announced_channel_preference = false;
432 let mut restarting_node = true;
433 let (channel_manager_blockhash, channel_manager) = {
434 if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
435 let mut channel_monitor_mut_references = Vec::new();
436 for (_, channel_monitor) in channelmonitors.iter_mut() {
437 channel_monitor_mut_references.push(channel_monitor);
439 let read_args = ChannelManagerReadArgs::new(
440 keys_manager.clone(),
441 fee_estimator.clone(),
442 chain_monitor.clone(),
446 channel_monitor_mut_references,
448 <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
450 // We're starting a fresh node.
451 restarting_node = false;
452 let getinfo_resp = bitcoind_client.get_blockchain_info().await;
454 let chain_params = ChainParameters {
455 network: args.network,
456 best_block: BestBlock::new(
457 getinfo_resp.latest_blockhash,
458 getinfo_resp.latest_height as u32,
461 let fresh_channel_manager = channelmanager::ChannelManager::new(
462 fee_estimator.clone(),
463 chain_monitor.clone(),
466 keys_manager.clone(),
470 (getinfo_resp.latest_blockhash, fresh_channel_manager)
474 // Step 9: Sync ChannelMonitors and ChannelManager to chain tip
475 let mut chain_listener_channel_monitors = Vec::new();
476 let mut cache = UnboundedCache::new();
477 let mut chain_tip: Option<poll::ValidatedBlockHeader> = None;
479 let mut chain_listeners =
480 vec![(channel_manager_blockhash, &channel_manager as &dyn chain::Listen)];
482 for (blockhash, channel_monitor) in channelmonitors.drain(..) {
483 let outpoint = channel_monitor.get_funding_txo().0;
484 chain_listener_channel_monitors.push((
486 (channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()),
491 for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
493 .push((monitor_listener_info.0, &monitor_listener_info.1 as &dyn chain::Listen));
496 init::synchronize_listeners(
497 &mut bitcoind_client.deref(),
507 // Step 10: Give ChannelMonitors to ChainMonitor
508 for item in chain_listener_channel_monitors.drain(..) {
509 let channel_monitor = item.1 .0;
510 let funding_outpoint = item.2;
511 chain_monitor.watch_channel(funding_outpoint, channel_monitor).unwrap();
514 // Step 11: Optional: Initialize the NetGraphMsgHandler
515 let genesis = genesis_block(args.network).header.block_hash();
516 let network_graph_path = format!("{}/network_graph", ldk_data_dir.clone());
517 let network_graph = Arc::new(disk::read_network(Path::new(&network_graph_path), genesis));
518 let network_gossip = Arc::new(NetGraphMsgHandler::new(
519 Arc::clone(&network_graph),
520 None::<Arc<dyn chain::Access + Send + Sync>>,
524 // Step 12: Initialize the PeerManager
525 let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
526 let mut ephemeral_bytes = [0; 32];
527 rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
528 let lightning_msg_handler = MessageHandler {
529 chan_handler: channel_manager.clone(),
530 route_handler: network_gossip.clone(),
532 let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
533 lightning_msg_handler,
534 keys_manager.get_node_secret(Recipient::Node).unwrap(),
537 Arc::new(IgnoringMessageHandler {}),
541 // Step 13: Initialize networking
543 let peer_manager_connection_handler = peer_manager.clone();
544 let listening_port = args.ldk_peer_listening_port;
545 tokio::spawn(async move {
546 let listener = tokio::net::TcpListener::bind(format!("0.0.0.0:{}", listening_port))
548 .expect("Failed to bind to listen port - is something else already listening on it?");
550 let peer_mgr = peer_manager_connection_handler.clone();
551 let tcp_stream = listener.accept().await.unwrap().0;
552 tokio::spawn(async move {
553 lightning_net_tokio::setup_inbound(
555 tcp_stream.into_std().unwrap(),
562 // Step 14: Connect and Disconnect Blocks
563 if chain_tip.is_none() {
565 Some(init::validate_best_block_header(&mut bitcoind_client.deref()).await.unwrap());
567 let channel_manager_listener = channel_manager.clone();
568 let chain_monitor_listener = chain_monitor.clone();
569 let bitcoind_block_source = bitcoind_client.clone();
570 let network = args.network;
571 tokio::spawn(async move {
572 let mut derefed = bitcoind_block_source.deref();
573 let chain_poller = poll::ChainPoller::new(&mut derefed, network);
574 let chain_listener = (chain_monitor_listener, channel_manager_listener);
576 SpvClient::new(chain_tip.unwrap(), chain_poller, &mut cache, &chain_listener);
578 spv_client.poll_best_tip().await.unwrap();
579 tokio::time::sleep(Duration::from_secs(1)).await;
583 // Step 15: Handle LDK Events
584 let channel_manager_event_listener = channel_manager.clone();
585 let keys_manager_listener = keys_manager.clone();
586 // TODO: persist payment info to disk
587 let inbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
588 let outbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
589 let inbound_pmts_for_events = inbound_payments.clone();
590 let outbound_pmts_for_events = outbound_payments.clone();
591 let network = args.network;
592 let bitcoind_rpc = bitcoind_client.clone();
593 let handle = tokio::runtime::Handle::current();
594 let event_handler = move |event: &Event| {
595 handle.block_on(handle_ldk_events(
596 channel_manager_event_listener.clone(),
597 bitcoind_rpc.clone(),
598 keys_manager_listener.clone(),
599 inbound_pmts_for_events.clone(),
600 outbound_pmts_for_events.clone(),
606 // Step 16: Initialize routing ProbabilisticScorer
607 let scorer_path = format!("{}/prob_scorer", ldk_data_dir.clone());
608 let scorer = Arc::new(Mutex::new(disk::read_scorer(
609 Path::new(&scorer_path),
610 Arc::clone(&network_graph),
612 let scorer_persist = Arc::clone(&scorer);
613 tokio::spawn(async move {
614 let mut interval = tokio::time::interval(Duration::from_secs(600));
616 interval.tick().await;
617 if disk::persist_scorer(Path::new(&scorer_path), &scorer_persist.lock().unwrap())
620 // Persistence errors here are non-fatal as channels will be re-scored as payments
621 // fail, but they may indicate a disk error which could be fatal elsewhere.
622 eprintln!("Warning: Failed to persist scorer, check your disk and permissions");
627 // Step 17: Create InvoicePayer
628 let router = DefaultRouter::new(
629 network_graph.clone(),
631 keys_manager.get_secure_random_bytes(),
633 let invoice_payer = Arc::new(InvoicePayer::new(
634 channel_manager.clone(),
639 payment::RetryAttempts(5),
642 // Step 18: Persist ChannelManager and NetworkGraph
643 let persister = DataPersister { data_dir: ldk_data_dir.clone() };
645 // Step 19: Background Processing
646 let background_processor = BackgroundProcessor::start(
648 invoice_payer.clone(),
649 chain_monitor.clone(),
650 channel_manager.clone(),
651 Some(network_gossip.clone()),
652 peer_manager.clone(),
656 // Regularly reconnect to channel peers.
657 let connect_cm = Arc::clone(&channel_manager);
658 let connect_pm = Arc::clone(&peer_manager);
659 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
660 tokio::spawn(async move {
661 let mut interval = tokio::time::interval(Duration::from_secs(1));
663 interval.tick().await;
664 match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
666 let peers = connect_pm.get_peer_node_ids();
667 for node_id in connect_cm
670 .map(|chan| chan.counterparty.node_id)
671 .filter(|id| !peers.contains(id))
673 for (pubkey, peer_addr) in info.iter() {
674 if *pubkey == node_id {
675 let _ = cli::do_connect_peer(
678 Arc::clone(&connect_pm),
685 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
690 // Regularly broadcast our node_announcement. This is only required (or possible) if we have
691 // some public channels, and is only useful if we have public listen address(es) to announce.
692 // In a production environment, this should occur only after the announcement of new channels
693 // to avoid churn in the global network graph.
694 let chan_manager = Arc::clone(&channel_manager);
695 let network = args.network;
696 if !args.ldk_announced_listen_addr.is_empty() {
697 tokio::spawn(async move {
698 let mut interval = tokio::time::interval(Duration::from_secs(60));
700 interval.tick().await;
701 chan_manager.broadcast_node_announcement(
703 args.ldk_announced_node_name,
704 args.ldk_announced_listen_addr.clone(),
711 cli::poll_for_user_input(
712 invoice_payer.clone(),
713 peer_manager.clone(),
714 channel_manager.clone(),
715 keys_manager.clone(),
718 ldk_data_dir.clone(),
723 // Stop the background processor.
724 background_processor.stop().unwrap();
728 pub async fn main() {