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::scoring::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 => panic!("Signet unsupported"),
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, fee_paid_msat, .. } => {
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 if let Some(fee) = fee_paid_msat {
209 format!(" (fee {} msat)", fee)
213 hex_utils::hex_str(&payment_hash.0),
214 hex_utils::hex_str(&payment_preimage.0)
217 io::stdout().flush().unwrap();
221 Event::PaymentPathSuccessful { .. } => {}
222 Event::PaymentPathFailed { .. } => {}
223 Event::PaymentFailed { payment_hash, .. } => {
225 "\nEVENT: Failed to send payment to payment hash {:?}: exhausted payment retry attempts",
226 hex_utils::hex_str(&payment_hash.0)
229 io::stdout().flush().unwrap();
231 let mut payments = outbound_payments.lock().unwrap();
232 if payments.contains_key(&payment_hash) {
233 let payment = payments.get_mut(&payment_hash).unwrap();
234 payment.status = HTLCStatus::Failed;
237 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
238 let from_onchain_str = if *claim_from_onchain_tx {
239 "from onchain downstream claim"
241 "from HTLC fulfill message"
243 if let Some(fee_earned) = fee_earned_msat {
245 "\nEVENT: Forwarded payment, earning {} msat {}",
246 fee_earned, from_onchain_str
249 println!("\nEVENT: Forwarded payment, claiming onchain {}", from_onchain_str);
252 io::stdout().flush().unwrap();
254 Event::PendingHTLCsForwardable { time_forwardable } => {
255 let forwarding_channel_manager = channel_manager.clone();
256 let min = time_forwardable.as_millis() as u64;
257 tokio::spawn(async move {
258 let millis_to_sleep = thread_rng().gen_range(min, min * 5) as u64;
259 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
260 forwarding_channel_manager.process_pending_htlc_forwards();
263 Event::SpendableOutputs { outputs } => {
264 let destination_address = bitcoind_client.get_new_address().await;
265 let output_descriptors = &outputs.iter().map(|a| a).collect::<Vec<_>>();
267 bitcoind_client.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
268 let spending_tx = keys_manager
269 .spend_spendable_outputs(
272 destination_address.script_pubkey(),
277 bitcoind_client.broadcast_transaction(&spending_tx);
279 Event::ChannelClosed { channel_id, reason, user_channel_id: _ } => {
281 "\nEVENT: Channel {} closed due to: {:?}",
282 hex_utils::hex_str(channel_id),
286 io::stdout().flush().unwrap();
288 Event::DiscardFunding { .. } => {
289 // A "real" node should probably "lock" the UTXOs spent in funding transactions until
290 // the funding transaction either confirms, or this event is generated.
295 async fn start_ldk() {
296 let args = match cli::parse_startup_args() {
297 Ok(user_args) => user_args,
301 // Initialize the LDK data directory if necessary.
302 let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
303 fs::create_dir_all(ldk_data_dir.clone()).unwrap();
305 // Initialize our bitcoind client.
306 let bitcoind_client = match BitcoindClient::new(
307 args.bitcoind_rpc_host.clone(),
308 args.bitcoind_rpc_port,
309 args.bitcoind_rpc_username.clone(),
310 args.bitcoind_rpc_password.clone(),
311 tokio::runtime::Handle::current(),
315 Ok(client) => Arc::new(client),
317 println!("Failed to connect to bitcoind client: {}", e);
322 // Check that the bitcoind we've connected to is running the network we expect
323 let bitcoind_chain = bitcoind_client.get_blockchain_info().await.chain;
325 != match args.network {
326 bitcoin::Network::Bitcoin => "main",
327 bitcoin::Network::Testnet => "test",
328 bitcoin::Network::Regtest => "regtest",
329 bitcoin::Network::Signet => "signet",
332 "Chain argument ({}) didn't match bitcoind chain ({})",
333 args.network, bitcoind_chain
339 // Step 1: Initialize the FeeEstimator
341 // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
342 let fee_estimator = bitcoind_client.clone();
344 // Step 2: Initialize the Logger
345 let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
347 // Step 3: Initialize the BroadcasterInterface
349 // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
351 let broadcaster = bitcoind_client.clone();
353 // Step 4: Initialize Persist
354 let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
356 // Step 5: Initialize the ChainMonitor
357 let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
361 fee_estimator.clone(),
365 // Step 6: Initialize the KeysManager
367 // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
368 // other secret key material.
369 let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
370 let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
371 assert_eq!(seed.len(), 32);
372 let mut key = [0; 32];
373 key.copy_from_slice(&seed);
376 let mut key = [0; 32];
377 thread_rng().fill_bytes(&mut key);
378 match File::create(keys_seed_path.clone()) {
380 f.write_all(&key).expect("Failed to write node keys seed to disk");
381 f.sync_all().expect("Failed to sync node keys seed to disk");
384 println!("ERROR: Unable to create keys seed file {}: {}", keys_seed_path, e);
390 let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
391 let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
393 // Step 7: Read ChannelMonitor state from disk
394 let mut channelmonitors = persister.read_channelmonitors(keys_manager.clone()).unwrap();
396 // Step 8: Initialize the ChannelManager
397 let mut user_config = UserConfig::default();
398 user_config.peer_channel_config_limits.force_announced_channel_preference = false;
399 let mut restarting_node = true;
400 let (channel_manager_blockhash, mut channel_manager) = {
401 if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
402 let mut channel_monitor_mut_references = Vec::new();
403 for (_, channel_monitor) in channelmonitors.iter_mut() {
404 channel_monitor_mut_references.push(channel_monitor);
406 let read_args = ChannelManagerReadArgs::new(
407 keys_manager.clone(),
408 fee_estimator.clone(),
409 chain_monitor.clone(),
413 channel_monitor_mut_references,
415 <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
417 // We're starting a fresh node.
418 restarting_node = false;
419 let getinfo_resp = bitcoind_client.get_blockchain_info().await;
421 let chain_params = ChainParameters {
422 network: args.network,
423 best_block: BestBlock::new(
424 getinfo_resp.latest_blockhash,
425 getinfo_resp.latest_height as u32,
428 let fresh_channel_manager = channelmanager::ChannelManager::new(
429 fee_estimator.clone(),
430 chain_monitor.clone(),
433 keys_manager.clone(),
437 (getinfo_resp.latest_blockhash, fresh_channel_manager)
441 // Step 9: Sync ChannelMonitors and ChannelManager to chain tip
442 let mut chain_listener_channel_monitors = Vec::new();
443 let mut cache = UnboundedCache::new();
444 let mut chain_tip: Option<poll::ValidatedBlockHeader> = None;
446 let mut chain_listeners =
447 vec![(channel_manager_blockhash, &mut channel_manager as &mut dyn chain::Listen)];
449 for (blockhash, channel_monitor) in channelmonitors.drain(..) {
450 let outpoint = channel_monitor.get_funding_txo().0;
451 chain_listener_channel_monitors.push((
453 (channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()),
458 for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
459 chain_listeners.push((
460 monitor_listener_info.0,
461 &mut monitor_listener_info.1 as &mut dyn chain::Listen,
465 init::synchronize_listeners(
466 &mut bitcoind_client.deref(),
476 // Step 10: Give ChannelMonitors to ChainMonitor
477 for item in chain_listener_channel_monitors.drain(..) {
478 let channel_monitor = item.1 .0;
479 let funding_outpoint = item.2;
480 chain_monitor.watch_channel(funding_outpoint, channel_monitor).unwrap();
483 // Step 11: Optional: Initialize the NetGraphMsgHandler
484 let genesis = genesis_block(args.network).header.block_hash();
485 let network_graph_path = format!("{}/network_graph", ldk_data_dir.clone());
486 let network_graph = Arc::new(disk::read_network(Path::new(&network_graph_path), genesis));
487 let network_gossip = Arc::new(NetGraphMsgHandler::new(
488 Arc::clone(&network_graph),
489 None::<Arc<dyn chain::Access + Send + Sync>>,
492 let network_graph_persist = Arc::clone(&network_graph);
493 tokio::spawn(async move {
494 let mut interval = tokio::time::interval(Duration::from_secs(600));
496 interval.tick().await;
497 if disk::persist_network(Path::new(&network_graph_path), &network_graph_persist)
500 // Persistence errors here are non-fatal as we can just fetch the routing graph
501 // again later, but they may indicate a disk error which could be fatal elsewhere.
503 "Warning: Failed to persist network graph, check your disk and permissions"
509 // Step 12: Initialize the PeerManager
510 let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
511 let mut ephemeral_bytes = [0; 32];
512 rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
513 let lightning_msg_handler = MessageHandler {
514 chan_handler: channel_manager.clone(),
515 route_handler: network_gossip.clone(),
517 let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
518 lightning_msg_handler,
519 keys_manager.get_node_secret(),
522 Arc::new(IgnoringMessageHandler {}),
526 // Step 13: Initialize networking
528 let peer_manager_connection_handler = peer_manager.clone();
529 let listening_port = args.ldk_peer_listening_port;
530 tokio::spawn(async move {
531 let listener = tokio::net::TcpListener::bind(format!("0.0.0.0:{}", listening_port))
533 .expect("Failed to bind to listen port - is something else already listening on it?");
535 let peer_mgr = peer_manager_connection_handler.clone();
536 let tcp_stream = listener.accept().await.unwrap().0;
537 tokio::spawn(async move {
538 lightning_net_tokio::setup_inbound(
540 tcp_stream.into_std().unwrap(),
547 // Step 14: Connect and Disconnect Blocks
548 if chain_tip.is_none() {
550 Some(init::validate_best_block_header(&mut bitcoind_client.deref()).await.unwrap());
552 let channel_manager_listener = channel_manager.clone();
553 let chain_monitor_listener = chain_monitor.clone();
554 let bitcoind_block_source = bitcoind_client.clone();
555 let network = args.network;
556 tokio::spawn(async move {
557 let mut derefed = bitcoind_block_source.deref();
558 let chain_poller = poll::ChainPoller::new(&mut derefed, network);
559 let chain_listener = (chain_monitor_listener, channel_manager_listener);
561 SpvClient::new(chain_tip.unwrap(), chain_poller, &mut cache, &chain_listener);
563 spv_client.poll_best_tip().await.unwrap();
564 tokio::time::sleep(Duration::from_secs(1)).await;
568 // Step 15: Handle LDK Events
569 let channel_manager_event_listener = channel_manager.clone();
570 let keys_manager_listener = keys_manager.clone();
571 // TODO: persist payment info to disk
572 let inbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
573 let outbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
574 let inbound_pmts_for_events = inbound_payments.clone();
575 let outbound_pmts_for_events = outbound_payments.clone();
576 let network = args.network;
577 let bitcoind_rpc = bitcoind_client.clone();
578 let handle = tokio::runtime::Handle::current();
579 let event_handler = move |event: &Event| {
580 handle.block_on(handle_ldk_events(
581 channel_manager_event_listener.clone(),
582 bitcoind_rpc.clone(),
583 keys_manager_listener.clone(),
584 inbound_pmts_for_events.clone(),
585 outbound_pmts_for_events.clone(),
591 // Step 16: Initialize routing Scorer
592 let scorer_path = format!("{}/scorer", ldk_data_dir.clone());
593 let scorer = Arc::new(Mutex::new(disk::read_scorer(Path::new(&scorer_path))));
594 let scorer_persist = Arc::clone(&scorer);
595 tokio::spawn(async move {
596 let mut interval = tokio::time::interval(Duration::from_secs(600));
598 interval.tick().await;
599 if disk::persist_scorer(Path::new(&scorer_path), &scorer_persist.lock().unwrap())
602 // Persistence errors here are non-fatal as channels will be re-scored as payments
603 // fail, but they may indicate a disk error which could be fatal elsewhere.
604 eprintln!("Warning: Failed to persist scorer, check your disk and permissions");
609 // Step 17: Create InvoicePayer
610 let router = DefaultRouter::new(network_graph.clone(), logger.clone());
611 let invoice_payer = Arc::new(InvoicePayer::new(
612 channel_manager.clone(),
617 payment::RetryAttempts(5),
620 // Step 18: Persist ChannelManager
621 let data_dir = ldk_data_dir.clone();
622 let persist_channel_manager_callback =
623 move |node: &ChannelManager| FilesystemPersister::persist_manager(data_dir.clone(), &*node);
625 // Step 19: Background Processing
626 let background_processor = BackgroundProcessor::start(
627 persist_channel_manager_callback,
628 invoice_payer.clone(),
629 chain_monitor.clone(),
630 channel_manager.clone(),
631 Some(network_gossip.clone()),
632 peer_manager.clone(),
636 // Regularly reconnect to channel peers.
637 let connect_cm = Arc::clone(&channel_manager);
638 let connect_pm = Arc::clone(&peer_manager);
639 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
640 tokio::spawn(async move {
641 let mut interval = tokio::time::interval(Duration::from_secs(1));
643 interval.tick().await;
644 match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
646 let peers = connect_pm.get_peer_node_ids();
647 for node_id in connect_cm
650 .map(|chan| chan.counterparty.node_id)
651 .filter(|id| !peers.contains(id))
653 for (pubkey, peer_addr) in info.iter() {
654 if *pubkey == node_id {
655 let _ = cli::do_connect_peer(
658 Arc::clone(&connect_pm),
665 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
670 // Regularly broadcast our node_announcement. This is only required (or possible) if we have
671 // some public channels, and is only useful if we have public listen address(es) to announce.
672 // In a production environment, this should occur only after the announcement of new channels
673 // to avoid churn in the global network graph.
674 let chan_manager = Arc::clone(&channel_manager);
675 let network = args.network;
676 if !args.ldk_announced_listen_addr.is_empty() {
677 tokio::spawn(async move {
678 let mut interval = tokio::time::interval(Duration::from_secs(60));
680 interval.tick().await;
681 chan_manager.broadcast_node_announcement(
683 args.ldk_announced_node_name,
684 args.ldk_announced_listen_addr.clone(),
691 cli::poll_for_user_input(
692 invoice_payer.clone(),
693 peer_manager.clone(),
694 channel_manager.clone(),
695 keys_manager.clone(),
698 ldk_data_dir.clone(),
703 // Stop the background processor.
704 background_processor.stop().unwrap();
708 pub async fn main() {