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};
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::scorer::Scorer;
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;
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<
105 Arc<FilesystemLogger>,
109 type Router = DefaultRouter<Arc<NetworkGraph>, Arc<FilesystemLogger>>;
111 async fn handle_ldk_events(
112 channel_manager: Arc<ChannelManager>, bitcoind_client: Arc<BitcoindClient>,
113 keys_manager: Arc<KeysManager>, inbound_payments: PaymentInfoStorage,
114 outbound_payments: PaymentInfoStorage, network: Network, event: &Event,
117 Event::FundingGenerationReady {
118 temporary_channel_id,
119 channel_value_satoshis,
123 // Construct the raw transaction with one output, that is paid the amount of the
125 let addr = WitnessProgram::from_scriptpubkey(
128 Network::Bitcoin => bitcoin_bech32::constants::Network::Bitcoin,
129 Network::Testnet => bitcoin_bech32::constants::Network::Testnet,
130 Network::Regtest => bitcoin_bech32::constants::Network::Regtest,
131 Network::Signet => bitcoin_bech32::constants::Network::Signet,
134 .expect("Lightning funding tx should always be to a SegWit output")
136 let mut outputs = vec![HashMap::with_capacity(1)];
137 outputs[0].insert(addr, *channel_value_satoshis as f64 / 100_000_000.0);
138 let raw_tx = bitcoind_client.create_raw_transaction(outputs).await;
140 // Have your wallet put the inputs into the transaction such that the output is
142 let funded_tx = bitcoind_client.fund_raw_transaction(raw_tx).await;
144 // Sign the final funding transaction and broadcast it.
145 let signed_tx = bitcoind_client.sign_raw_transaction_with_wallet(funded_tx.hex).await;
146 assert_eq!(signed_tx.complete, true);
147 let final_tx: Transaction =
148 encode::deserialize(&hex_utils::to_vec(&signed_tx.hex).unwrap()).unwrap();
149 // Give the funding transaction back to LDK for opening the channel.
151 .funding_transaction_generated(&temporary_channel_id, final_tx)
155 "\nERROR: Channel went away before we could fund it. The peer disconnected or refused the channel.");
157 io::stdout().flush().unwrap();
160 Event::PaymentReceived { payment_hash, purpose, amt, .. } => {
161 let mut payments = inbound_payments.lock().unwrap();
162 let (payment_preimage, payment_secret) = match purpose {
163 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
164 (*payment_preimage, Some(*payment_secret))
166 PaymentPurpose::SpontaneousPayment(preimage) => (Some(*preimage), None),
168 let status = match channel_manager.claim_funds(payment_preimage.unwrap()) {
171 "\nEVENT: received payment from payment hash {} of {} millisatoshis",
172 hex_utils::hex_str(&payment_hash.0),
176 io::stdout().flush().unwrap();
177 HTLCStatus::Succeeded
179 _ => HTLCStatus::Failed,
181 match payments.entry(*payment_hash) {
182 Entry::Occupied(mut e) => {
183 let payment = e.get_mut();
184 payment.status = status;
185 payment.preimage = payment_preimage;
186 payment.secret = payment_secret;
188 Entry::Vacant(e) => {
189 e.insert(PaymentInfo {
190 preimage: payment_preimage,
191 secret: payment_secret,
193 amt_msat: MillisatAmount(Some(*amt)),
198 Event::PaymentSent { payment_preimage, payment_hash, .. } => {
199 let mut payments = outbound_payments.lock().unwrap();
200 for (hash, payment) in payments.iter_mut() {
201 if *hash == *payment_hash {
202 payment.preimage = Some(*payment_preimage);
203 payment.status = HTLCStatus::Succeeded;
205 "\nEVENT: successfully sent payment of {} millisatoshis from \
206 payment hash {:?} with preimage {:?}",
208 hex_utils::hex_str(&payment_hash.0),
209 hex_utils::hex_str(&payment_preimage.0)
212 io::stdout().flush().unwrap();
216 Event::PaymentPathFailed {
224 "\nEVENT: Failed to send payment{} to payment hash {:?}",
225 if *all_paths_failed { "" } else { " along MPP path" },
226 hex_utils::hex_str(&payment_hash.0)
228 if let Some(scid) = short_channel_id {
229 print!(" because of failure at channel {}", scid);
231 if *rejected_by_dest {
232 println!(": re-attempting the payment will not succeed");
234 println!(": exhausted payment retry attempts");
237 io::stdout().flush().unwrap();
239 let mut payments = outbound_payments.lock().unwrap();
240 if payments.contains_key(&payment_hash) {
241 let payment = payments.get_mut(&payment_hash).unwrap();
242 payment.status = HTLCStatus::Failed;
245 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
246 let from_onchain_str = if *claim_from_onchain_tx {
247 "from onchain downstream claim"
249 "from HTLC fulfill message"
251 if let Some(fee_earned) = fee_earned_msat {
253 "\nEVENT: Forwarded payment, earning {} msat {}",
254 fee_earned, from_onchain_str
257 println!("\nEVENT: Forwarded payment, claiming onchain {}", from_onchain_str);
260 io::stdout().flush().unwrap();
262 Event::PendingHTLCsForwardable { time_forwardable } => {
263 let forwarding_channel_manager = channel_manager.clone();
264 let min = time_forwardable.as_millis() as u64;
265 tokio::spawn(async move {
266 let millis_to_sleep = thread_rng().gen_range(min, min * 5) as u64;
267 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
268 forwarding_channel_manager.process_pending_htlc_forwards();
271 Event::SpendableOutputs { outputs } => {
272 let destination_address = bitcoind_client.get_new_address().await;
273 let output_descriptors = &outputs.iter().map(|a| a).collect::<Vec<_>>();
275 bitcoind_client.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
276 let spending_tx = keys_manager
277 .spend_spendable_outputs(
280 destination_address.script_pubkey(),
285 bitcoind_client.broadcast_transaction(&spending_tx);
287 Event::ChannelClosed { channel_id, reason, user_channel_id: _ } => {
289 "\nEVENT: Channel {} closed due to: {:?}",
290 hex_utils::hex_str(channel_id),
294 io::stdout().flush().unwrap();
296 Event::DiscardFunding { .. } => {
297 // A "real" node should probably "lock" the UTXOs spent in funding transactions until
298 // the funding transaction either confirms, or this event is generated.
303 async fn start_ldk() {
304 let args = match cli::parse_startup_args() {
305 Ok(user_args) => user_args,
309 // Initialize the LDK data directory if necessary.
310 let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
311 fs::create_dir_all(ldk_data_dir.clone()).unwrap();
313 // Initialize our bitcoind client.
314 let bitcoind_client = match BitcoindClient::new(
315 args.bitcoind_rpc_host.clone(),
316 args.bitcoind_rpc_port,
317 args.bitcoind_rpc_username.clone(),
318 args.bitcoind_rpc_password.clone(),
319 tokio::runtime::Handle::current(),
323 Ok(client) => Arc::new(client),
325 println!("Failed to connect to bitcoind client: {}", e);
330 // Check that the bitcoind we've connected to is running the network we expect
331 let bitcoind_chain = bitcoind_client.get_blockchain_info().await.chain;
333 != match args.network {
334 bitcoin::Network::Bitcoin => "main",
335 bitcoin::Network::Testnet => "test",
336 bitcoin::Network::Regtest => "regtest",
337 bitcoin::Network::Signet => "signet",
340 "Chain argument ({}) didn't match bitcoind chain ({})",
341 args.network, bitcoind_chain
347 // Step 1: Initialize the FeeEstimator
349 // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
350 let fee_estimator = bitcoind_client.clone();
352 // Step 2: Initialize the Logger
353 let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
355 // Step 3: Initialize the BroadcasterInterface
357 // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
359 let broadcaster = bitcoind_client.clone();
361 // Step 4: Initialize Persist
362 let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
364 // Step 5: Initialize the ChainMonitor
365 let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
369 fee_estimator.clone(),
373 // Step 6: Initialize the KeysManager
375 // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
376 // other secret key material.
377 let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
378 let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
379 assert_eq!(seed.len(), 32);
380 let mut key = [0; 32];
381 key.copy_from_slice(&seed);
384 let mut key = [0; 32];
385 thread_rng().fill_bytes(&mut key);
386 match File::create(keys_seed_path.clone()) {
388 f.write_all(&key).expect("Failed to write node keys seed to disk");
389 f.sync_all().expect("Failed to sync node keys seed to disk");
392 println!("ERROR: Unable to create keys seed file {}: {}", keys_seed_path, e);
398 let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
399 let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
401 // Step 7: Read ChannelMonitor state from disk
402 let mut channelmonitors = persister.read_channelmonitors(keys_manager.clone()).unwrap();
404 // Step 8: Initialize the ChannelManager
405 let mut user_config = UserConfig::default();
406 user_config.peer_channel_config_limits.force_announced_channel_preference = false;
407 let mut restarting_node = true;
408 let (channel_manager_blockhash, mut channel_manager) = {
409 if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
410 let mut channel_monitor_mut_references = Vec::new();
411 for (_, channel_monitor) in channelmonitors.iter_mut() {
412 channel_monitor_mut_references.push(channel_monitor);
414 let read_args = ChannelManagerReadArgs::new(
415 keys_manager.clone(),
416 fee_estimator.clone(),
417 chain_monitor.clone(),
421 channel_monitor_mut_references,
423 <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
425 // We're starting a fresh node.
426 restarting_node = false;
427 let getinfo_resp = bitcoind_client.get_blockchain_info().await;
429 let chain_params = ChainParameters {
430 network: args.network,
431 best_block: BestBlock::new(
432 getinfo_resp.latest_blockhash,
433 getinfo_resp.latest_height as u32,
436 let fresh_channel_manager = channelmanager::ChannelManager::new(
437 fee_estimator.clone(),
438 chain_monitor.clone(),
441 keys_manager.clone(),
445 (getinfo_resp.latest_blockhash, fresh_channel_manager)
449 // Step 9: Sync ChannelMonitors and ChannelManager to chain tip
450 let mut chain_listener_channel_monitors = Vec::new();
451 let mut cache = UnboundedCache::new();
452 let mut chain_tip: Option<poll::ValidatedBlockHeader> = None;
454 let mut chain_listeners =
455 vec![(channel_manager_blockhash, &mut channel_manager as &mut dyn chain::Listen)];
457 for (blockhash, channel_monitor) in channelmonitors.drain(..) {
458 let outpoint = channel_monitor.get_funding_txo().0;
459 chain_listener_channel_monitors.push((
461 (channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()),
466 for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
467 chain_listeners.push((
468 monitor_listener_info.0,
469 &mut monitor_listener_info.1 as &mut dyn chain::Listen,
473 init::synchronize_listeners(
474 &mut bitcoind_client.deref(),
484 // Step 10: Give ChannelMonitors to ChainMonitor
485 for item in chain_listener_channel_monitors.drain(..) {
486 let channel_monitor = item.1 .0;
487 let funding_outpoint = item.2;
488 chain_monitor.watch_channel(funding_outpoint, channel_monitor).unwrap();
491 // Step 11: Optional: Initialize the NetGraphMsgHandler
492 let genesis = genesis_block(args.network).header.block_hash();
493 let network_graph_path = format!("{}/network_graph", ldk_data_dir.clone());
494 let network_graph = Arc::new(disk::read_network(Path::new(&network_graph_path), genesis));
495 let network_gossip = Arc::new(NetGraphMsgHandler::new(
496 Arc::clone(&network_graph),
497 None::<Arc<dyn chain::Access + Send + Sync>>,
500 let network_graph_persist = Arc::clone(&network_graph);
501 tokio::spawn(async move {
502 let mut interval = tokio::time::interval(Duration::from_secs(600));
504 interval.tick().await;
505 if disk::persist_network(Path::new(&network_graph_path), &network_graph_persist)
508 // Persistence errors here are non-fatal as we can just fetch the routing graph
509 // again later, but they may indicate a disk error which could be fatal elsewhere.
511 "Warning: Failed to persist network graph, check your disk and permissions"
517 // Step 12: Initialize the PeerManager
518 let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
519 let mut ephemeral_bytes = [0; 32];
520 rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
521 let lightning_msg_handler = MessageHandler {
522 chan_handler: channel_manager.clone(),
523 route_handler: network_gossip.clone(),
525 let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
526 lightning_msg_handler,
527 keys_manager.get_node_secret(),
530 Arc::new(IgnoringMessageHandler {}),
534 // Step 13: Initialize networking
536 let peer_manager_connection_handler = peer_manager.clone();
537 let listening_port = args.ldk_peer_listening_port;
538 tokio::spawn(async move {
539 let listener = tokio::net::TcpListener::bind(format!("0.0.0.0:{}", listening_port))
541 .expect("Failed to bind to listen port - is something else already listening on it?");
543 let peer_mgr = peer_manager_connection_handler.clone();
544 let tcp_stream = listener.accept().await.unwrap().0;
545 tokio::spawn(async move {
546 lightning_net_tokio::setup_inbound(
548 tcp_stream.into_std().unwrap(),
555 // Step 14: Connect and Disconnect Blocks
556 if chain_tip.is_none() {
558 Some(init::validate_best_block_header(&mut bitcoind_client.deref()).await.unwrap());
560 let channel_manager_listener = channel_manager.clone();
561 let chain_monitor_listener = chain_monitor.clone();
562 let bitcoind_block_source = bitcoind_client.clone();
563 let network = args.network;
564 tokio::spawn(async move {
565 let mut derefed = bitcoind_block_source.deref();
566 let chain_poller = poll::ChainPoller::new(&mut derefed, network);
567 let chain_listener = (chain_monitor_listener, channel_manager_listener);
569 SpvClient::new(chain_tip.unwrap(), chain_poller, &mut cache, &chain_listener);
571 spv_client.poll_best_tip().await.unwrap();
572 tokio::time::sleep(Duration::from_secs(1)).await;
576 // Step 15: Handle LDK Events
577 let channel_manager_event_listener = channel_manager.clone();
578 let keys_manager_listener = keys_manager.clone();
579 // TODO: persist payment info to disk
580 let inbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
581 let outbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
582 let inbound_pmts_for_events = inbound_payments.clone();
583 let outbound_pmts_for_events = outbound_payments.clone();
584 let network = args.network;
585 let bitcoind_rpc = bitcoind_client.clone();
586 let handle = tokio::runtime::Handle::current();
587 let event_handler = move |event: &Event| {
588 handle.block_on(handle_ldk_events(
589 channel_manager_event_listener.clone(),
590 bitcoind_rpc.clone(),
591 keys_manager_listener.clone(),
592 inbound_pmts_for_events.clone(),
593 outbound_pmts_for_events.clone(),
599 // Step 16: Initialize routing Scorer
600 let scorer_path = format!("{}/scorer", ldk_data_dir.clone());
601 let scorer = Arc::new(Mutex::new(disk::read_scorer(Path::new(&scorer_path))));
602 let scorer_persist = Arc::clone(&scorer);
603 tokio::spawn(async move {
604 let mut interval = tokio::time::interval(Duration::from_secs(600));
606 interval.tick().await;
607 if disk::persist_scorer(Path::new(&scorer_path), &scorer_persist.lock().unwrap())
610 // Persistence errors here are non-fatal as channels will be re-scored as payments
611 // fail, but they may indicate a disk error which could be fatal elsewhere.
612 eprintln!("Warning: Failed to persist scorer, check your disk and permissions");
617 // Step 17: Create InvoicePayer
618 let router = DefaultRouter::new(network_graph.clone(), logger.clone());
619 let invoice_payer = Arc::new(InvoicePayer::new(
620 channel_manager.clone(),
625 payment::RetryAttempts(5),
628 // Step 18: Persist ChannelManager
629 let data_dir = ldk_data_dir.clone();
630 let persist_channel_manager_callback =
631 move |node: &ChannelManager| FilesystemPersister::persist_manager(data_dir.clone(), &*node);
633 // Step 19: Background Processing
634 let background_processor = BackgroundProcessor::start(
635 persist_channel_manager_callback,
636 invoice_payer.clone(),
637 chain_monitor.clone(),
638 channel_manager.clone(),
639 Some(network_gossip.clone()),
640 peer_manager.clone(),
644 // Reconnect to channel peers if possible.
645 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
646 match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
648 for (pubkey, peer_addr) in info.drain() {
649 for chan_info in channel_manager.list_channels() {
650 if pubkey == chan_info.counterparty.node_id {
652 cli::connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
658 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
661 // Regularly broadcast our node_announcement. This is only required (or possible) if we have
662 // some public channels, and is only useful if we have public listen address(es) to announce.
663 // In a production environment, this should occur only after the announcement of new channels
664 // to avoid churn in the global network graph.
665 let chan_manager = Arc::clone(&channel_manager);
666 let network = args.network;
667 if !args.ldk_announced_listen_addr.is_empty() {
668 tokio::spawn(async move {
669 let mut interval = tokio::time::interval(Duration::from_secs(60));
671 interval.tick().await;
672 chan_manager.broadcast_node_announcement(
674 args.ldk_announced_node_name,
675 args.ldk_announced_listen_addr.clone(),
682 cli::poll_for_user_input(
683 invoice_payer.clone(),
684 peer_manager.clone(),
685 channel_manager.clone(),
686 keys_manager.clone(),
687 network_graph.clone(),
691 ldk_data_dir.clone(),
697 // Stop the background processor.
698 background_processor.stop().unwrap();
702 pub async fn main() {