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::hashes::sha256::Hash as Sha256;
13 use bitcoin::hashes::Hash;
14 use bitcoin::network::constants::Network;
15 use bitcoin::secp256k1::Secp256k1;
16 use bitcoin::BlockHash;
17 use bitcoin_bech32::WitnessProgram;
19 use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
20 use lightning::chain::chainmonitor;
21 use lightning::chain::keysinterface::{InMemorySigner, KeysInterface, KeysManager};
22 use lightning::chain::Filter;
23 use lightning::chain::Watch;
24 use lightning::ln::channelmanager;
25 use lightning::ln::channelmanager::{
26 BestBlock, ChainParameters, ChannelManagerReadArgs, SimpleArcChannelManager,
28 use lightning::ln::peer_handler::{MessageHandler, SimpleArcPeerManager};
29 use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
30 use lightning::routing::network_graph::NetGraphMsgHandler;
31 use lightning::util::config::UserConfig;
32 use lightning::util::events::{Event, EventsProvider};
33 use lightning::util::ser::ReadableArgs;
34 use lightning_background_processor::BackgroundProcessor;
35 use lightning_block_sync::init;
36 use lightning_block_sync::poll;
37 use lightning_block_sync::SpvClient;
38 use lightning_block_sync::UnboundedCache;
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};
53 use tokio::sync::mpsc;
54 use tokio::sync::mpsc::Receiver;
56 pub(crate) enum HTLCStatus {
62 pub(crate) struct MillisatAmount(Option<u64>);
64 impl fmt::Display for MillisatAmount {
65 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
67 Some(amt) => write!(f, "{}", amt),
68 None => write!(f, "unknown"),
73 pub(crate) struct PaymentInfo {
74 preimage: Option<PaymentPreimage>,
75 secret: Option<PaymentSecret>,
77 amt_msat: MillisatAmount,
80 pub(crate) type PaymentInfoStorage = Arc<Mutex<HashMap<PaymentHash, PaymentInfo>>>;
82 type ChainMonitor = chainmonitor::ChainMonitor<
84 Arc<dyn Filter + Send + Sync>,
87 Arc<FilesystemLogger>,
88 Arc<FilesystemPersister>,
91 pub(crate) type PeerManager = SimpleArcPeerManager<
96 dyn chain::Access + Send + Sync,
100 pub(crate) type ChannelManager =
101 SimpleArcChannelManager<ChainMonitor, BitcoindClient, BitcoindClient, FilesystemLogger>;
103 async fn handle_ldk_events(
104 channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
105 bitcoind_client: Arc<BitcoindClient>, keys_manager: Arc<KeysManager>,
106 inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage, network: Network,
107 mut event_receiver: Receiver<()>,
110 let received = event_receiver.recv();
111 if received.await.is_none() {
112 println!("LDK Event channel closed!");
115 let loop_channel_manager = channel_manager.clone();
116 let mut events = channel_manager.get_and_clear_pending_events();
117 events.append(&mut chain_monitor.get_and_clear_pending_events());
118 for event in events {
120 Event::FundingGenerationReady {
121 temporary_channel_id,
122 channel_value_satoshis,
126 // Construct the raw transaction with one output, that is paid the amount of the
128 let addr = WitnessProgram::from_scriptpubkey(
131 Network::Bitcoin => bitcoin_bech32::constants::Network::Bitcoin,
132 Network::Testnet => bitcoin_bech32::constants::Network::Testnet,
133 Network::Regtest => bitcoin_bech32::constants::Network::Regtest,
134 Network::Signet => panic!("Signet unsupported"),
137 .expect("Lightning funding tx should always be to a SegWit output")
139 let mut outputs = vec![HashMap::with_capacity(1)];
140 outputs[0].insert(addr, channel_value_satoshis as f64 / 100_000_000.0);
141 let raw_tx = bitcoind_client.create_raw_transaction(outputs).await;
143 // Have your wallet put the inputs into the transaction such that the output is
145 let funded_tx = bitcoind_client.fund_raw_transaction(raw_tx).await;
146 let change_output_position = funded_tx.changepos;
147 assert!(change_output_position == 0 || change_output_position == 1);
149 // Sign the final funding transaction and broadcast it.
151 bitcoind_client.sign_raw_transaction_with_wallet(funded_tx.hex).await;
152 assert_eq!(signed_tx.complete, true);
153 let final_tx: Transaction =
154 encode::deserialize(&hex_utils::to_vec(&signed_tx.hex).unwrap()).unwrap();
155 // Give the funding transaction back to LDK for opening the channel.
157 .funding_transaction_generated(&temporary_channel_id, final_tx)
160 Event::PaymentReceived {
167 let mut payments = inbound_payments.lock().unwrap();
168 let status = match loop_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 = Some(payment_preimage.unwrap());
186 payment.secret = Some(payment_secret);
188 Entry::Vacant(e) => {
189 e.insert(PaymentInfo {
190 preimage: Some(payment_preimage.unwrap()),
191 secret: Some(payment_secret),
193 amt_msat: MillisatAmount(Some(amt)),
198 Event::PaymentSent { payment_preimage } => {
199 let hashed = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
200 let mut payments = outbound_payments.lock().unwrap();
201 for (payment_hash, payment) in payments.iter_mut() {
202 if *payment_hash == hashed {
203 payment.preimage = Some(payment_preimage);
204 payment.status = HTLCStatus::Succeeded;
206 "\nEVENT: successfully sent payment of {} millisatoshis from \
207 payment hash {:?} with preimage {:?}",
209 hex_utils::hex_str(&payment_hash.0),
210 hex_utils::hex_str(&payment_preimage.0)
213 io::stdout().flush().unwrap();
217 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
219 "\nEVENT: Failed to send payment to payment hash {:?}: ",
220 hex_utils::hex_str(&payment_hash.0)
222 if rejected_by_dest {
223 println!("re-attempting the payment will not succeed");
225 println!("payment may be retried");
228 io::stdout().flush().unwrap();
230 let mut payments = outbound_payments.lock().unwrap();
231 if payments.contains_key(&payment_hash) {
232 let payment = payments.get_mut(&payment_hash).unwrap();
233 payment.status = HTLCStatus::Failed;
236 Event::PendingHTLCsForwardable { time_forwardable } => {
237 let forwarding_channel_manager = loop_channel_manager.clone();
238 tokio::spawn(async move {
239 let min = time_forwardable.as_millis() as u64;
240 let millis_to_sleep = thread_rng().gen_range(min, min * 5) as u64;
241 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
242 forwarding_channel_manager.process_pending_htlc_forwards();
245 Event::SpendableOutputs { outputs } => {
246 let destination_address = bitcoind_client.get_new_address().await;
247 let output_descriptors = &outputs.iter().map(|a| a).collect::<Vec<_>>();
249 bitcoind_client.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
250 let spending_tx = keys_manager
251 .spend_spendable_outputs(
254 destination_address.script_pubkey(),
259 bitcoind_client.broadcast_transaction(&spending_tx);
263 tokio::time::sleep(Duration::from_secs(1)).await;
267 async fn start_ldk() {
268 let args = match cli::parse_startup_args() {
269 Ok(user_args) => user_args,
273 // Initialize the LDK data directory if necessary.
274 let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
275 fs::create_dir_all(ldk_data_dir.clone()).unwrap();
277 // Initialize our bitcoind client.
278 let bitcoind_client = match BitcoindClient::new(
279 args.bitcoind_rpc_host.clone(),
280 args.bitcoind_rpc_port,
281 args.bitcoind_rpc_username.clone(),
282 args.bitcoind_rpc_password.clone(),
286 Ok(client) => Arc::new(client),
288 println!("Failed to connect to bitcoind client: {}", e);
293 // Check that the bitcoind we've connected to is running the network we expect
294 let bitcoind_chain = bitcoind_client.get_blockchain_info().await.chain;
296 != match args.network {
297 bitcoin::Network::Bitcoin => "main",
298 bitcoin::Network::Testnet => "test",
299 bitcoin::Network::Regtest => "regtest",
300 bitcoin::Network::Signet => "signet",
303 "Chain argument ({}) didn't match bitcoind chain ({})",
304 args.network, bitcoind_chain
310 // Step 1: Initialize the FeeEstimator
312 // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
313 let fee_estimator = bitcoind_client.clone();
315 // Step 2: Initialize the Logger
316 let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
318 // Step 3: Initialize the BroadcasterInterface
320 // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
322 let broadcaster = bitcoind_client.clone();
324 // Step 4: Initialize Persist
325 let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
327 // Step 5: Initialize the ChainMonitor
328 let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
332 fee_estimator.clone(),
336 // Step 6: Initialize the KeysManager
338 // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
339 // other secret key material.
340 let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
341 let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
342 assert_eq!(seed.len(), 32);
343 let mut key = [0; 32];
344 key.copy_from_slice(&seed);
347 let mut key = [0; 32];
348 thread_rng().fill_bytes(&mut key);
349 match File::create(keys_seed_path.clone()) {
351 f.write_all(&key).expect("Failed to write node keys seed to disk");
352 f.sync_all().expect("Failed to sync node keys seed to disk");
355 println!("ERROR: Unable to create keys seed file {}: {}", keys_seed_path, e);
361 let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
362 let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
364 // Step 7: Read ChannelMonitor state from disk
365 let mut channelmonitors = persister.read_channelmonitors(keys_manager.clone()).unwrap();
367 // Step 8: Initialize the ChannelManager
368 let user_config = UserConfig::default();
369 let mut restarting_node = true;
370 let (channel_manager_blockhash, mut channel_manager) = {
371 if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
372 let mut channel_monitor_mut_references = Vec::new();
373 for (_, channel_monitor) in channelmonitors.iter_mut() {
374 channel_monitor_mut_references.push(channel_monitor);
376 let read_args = ChannelManagerReadArgs::new(
377 keys_manager.clone(),
378 fee_estimator.clone(),
379 chain_monitor.clone(),
383 channel_monitor_mut_references,
385 <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
387 // We're starting a fresh node.
388 restarting_node = false;
389 let getinfo_resp = bitcoind_client.get_blockchain_info().await;
391 let chain_params = ChainParameters {
392 network: args.network,
393 best_block: BestBlock::new(
394 getinfo_resp.latest_blockhash,
395 getinfo_resp.latest_height as u32,
398 let fresh_channel_manager = channelmanager::ChannelManager::new(
399 fee_estimator.clone(),
400 chain_monitor.clone(),
403 keys_manager.clone(),
407 (getinfo_resp.latest_blockhash, fresh_channel_manager)
411 // Step 9: Sync ChannelMonitors and ChannelManager to chain tip
412 let mut chain_listener_channel_monitors = Vec::new();
413 let mut cache = UnboundedCache::new();
414 let mut chain_tip: Option<poll::ValidatedBlockHeader> = None;
416 let mut chain_listeners =
417 vec![(channel_manager_blockhash, &mut channel_manager as &mut dyn chain::Listen)];
419 for (blockhash, channel_monitor) in channelmonitors.drain(..) {
420 let outpoint = channel_monitor.get_funding_txo().0;
421 chain_listener_channel_monitors.push((
423 (channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()),
428 for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
429 chain_listeners.push((
430 monitor_listener_info.0,
431 &mut monitor_listener_info.1 as &mut dyn chain::Listen,
435 init::synchronize_listeners(
436 &mut bitcoind_client.deref(),
446 // Step 10: Give ChannelMonitors to ChainMonitor
447 for item in chain_listener_channel_monitors.drain(..) {
448 let channel_monitor = item.1 .0;
449 let funding_outpoint = item.2;
450 chain_monitor.watch_channel(funding_outpoint, channel_monitor).unwrap();
453 // Step 11: Optional: Initialize the NetGraphMsgHandler
454 // XXX persist routing data
455 let genesis = genesis_block(args.network).header.block_hash();
456 let router = Arc::new(NetGraphMsgHandler::new(
458 None::<Arc<dyn chain::Access + Send + Sync>>,
462 // Step 12: Initialize the PeerManager
463 let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
464 let mut ephemeral_bytes = [0; 32];
465 rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
466 let lightning_msg_handler =
467 MessageHandler { chan_handler: channel_manager.clone(), route_handler: router.clone() };
468 let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
469 lightning_msg_handler,
470 keys_manager.get_node_secret(),
476 // Step 13: Initialize networking
478 // We poll for events in handle_ldk_events(..) rather than waiting for them over the
479 // mpsc::channel, so we can leave the event receiver as unused.
480 let (event_ntfn_sender, event_ntfn_receiver) = mpsc::channel(2);
481 let peer_manager_connection_handler = peer_manager.clone();
482 let event_notifier = event_ntfn_sender.clone();
483 let listening_port = args.ldk_peer_listening_port;
484 tokio::spawn(async move {
485 let listener = tokio::net::TcpListener::bind(format!("0.0.0.0:{}", listening_port))
487 .expect("Failed to bind to listen port - is something else already listening on it?");
489 let peer_mgr = peer_manager_connection_handler.clone();
490 let notifier = event_notifier.clone();
491 let tcp_stream = listener.accept().await.unwrap().0;
492 tokio::spawn(async move {
493 lightning_net_tokio::setup_inbound(
496 tcp_stream.into_std().unwrap(),
503 // Step 14: Connect and Disconnect Blocks
504 if chain_tip.is_none() {
506 Some(init::validate_best_block_header(&mut bitcoind_client.deref()).await.unwrap());
508 let channel_manager_listener = channel_manager.clone();
509 let chain_monitor_listener = chain_monitor.clone();
510 let bitcoind_block_source = bitcoind_client.clone();
511 let network = args.network;
512 tokio::spawn(async move {
513 let mut derefed = bitcoind_block_source.deref();
514 let chain_poller = poll::ChainPoller::new(&mut derefed, network);
515 let chain_listener = (chain_monitor_listener, channel_manager_listener);
517 SpvClient::new(chain_tip.unwrap(), chain_poller, &mut cache, &chain_listener);
519 spv_client.poll_best_tip().await.unwrap();
520 tokio::time::sleep(Duration::from_secs(1)).await;
524 // Step 15: Initialize LDK Event Handling
525 let channel_manager_event_listener = channel_manager.clone();
526 let chain_monitor_event_listener = chain_monitor.clone();
527 let keys_manager_listener = keys_manager.clone();
528 // TODO: persist payment info to disk
529 let inbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
530 let outbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
531 let inbound_pmts_for_events = inbound_payments.clone();
532 let outbound_pmts_for_events = outbound_payments.clone();
533 let network = args.network;
534 let bitcoind_rpc = bitcoind_client.clone();
535 tokio::spawn(async move {
537 channel_manager_event_listener,
538 chain_monitor_event_listener,
540 keys_manager_listener,
541 inbound_pmts_for_events,
542 outbound_pmts_for_events,
549 // Step 16 & 17: Persist ChannelManager & Background Processing
550 let data_dir = ldk_data_dir.clone();
551 let persist_channel_manager_callback =
552 move |node: &ChannelManager| FilesystemPersister::persist_manager(data_dir.clone(), &*node);
553 BackgroundProcessor::start(
554 persist_channel_manager_callback,
555 channel_manager.clone(),
556 peer_manager.clone(),
560 // Reconnect to channel peers if possible.
561 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
562 match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
564 for (pubkey, peer_addr) in info.drain() {
565 for chan_info in channel_manager.list_channels() {
566 if pubkey == chan_info.remote_network_id {
567 let _ = cli::connect_peer_if_necessary(
570 peer_manager.clone(),
571 event_ntfn_sender.clone(),
578 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
581 // Regularly broadcast our node_announcement. This is only required (or possible) if we have
582 // some public channels, and is only useful if we have public listen address(es) to announce.
583 // In a production environment, this should occur only after the announcement of new channels
584 // to avoid churn in the global network graph.
585 let chan_manager = Arc::clone(&channel_manager);
586 let network = args.network;
587 if args.ldk_announced_listen_addr.is_some() {
588 tokio::spawn(async move {
589 let mut interval = tokio::time::interval(Duration::from_secs(60));
591 interval.tick().await;
592 chan_manager.broadcast_node_announcement(
594 args.ldk_announced_node_name,
595 vec![args.ldk_announced_listen_addr.as_ref().unwrap().clone()],
602 cli::poll_for_user_input(
603 peer_manager.clone(),
604 channel_manager.clone(),
605 keys_manager.clone(),
610 ldk_data_dir.clone(),
618 pub async fn main() {