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::{BestBlock, Filter, Watch};
23 use lightning::ln::channelmanager;
24 use lightning::ln::channelmanager::{
25 ChainParameters, ChannelManagerReadArgs, SimpleArcChannelManager,
27 use lightning::ln::peer_handler::{MessageHandler, SimpleArcPeerManager};
28 use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
29 use lightning::routing::network_graph::NetGraphMsgHandler;
30 use lightning::util::config::UserConfig;
31 use lightning::util::events::{Event, PaymentPurpose};
32 use lightning::util::ser::ReadableArgs;
33 use lightning_background_processor::BackgroundProcessor;
34 use lightning_block_sync::init;
35 use lightning_block_sync::poll;
36 use lightning_block_sync::SpvClient;
37 use lightning_block_sync::UnboundedCache;
38 use lightning_net_tokio::SocketDescriptor;
39 use lightning_persister::FilesystemPersister;
40 use rand::{thread_rng, Rng};
41 use std::collections::hash_map::Entry;
42 use std::collections::HashMap;
50 use std::sync::{Arc, Mutex};
51 use std::time::{Duration, SystemTime};
53 pub(crate) enum HTLCStatus {
59 pub(crate) struct MillisatAmount(Option<u64>);
61 impl fmt::Display for MillisatAmount {
62 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
64 Some(amt) => write!(f, "{}", amt),
65 None => write!(f, "unknown"),
70 pub(crate) struct PaymentInfo {
71 preimage: Option<PaymentPreimage>,
72 secret: Option<PaymentSecret>,
74 amt_msat: MillisatAmount,
77 pub(crate) type PaymentInfoStorage = Arc<Mutex<HashMap<PaymentHash, PaymentInfo>>>;
79 type ChainMonitor = chainmonitor::ChainMonitor<
81 Arc<dyn Filter + Send + Sync>,
84 Arc<FilesystemLogger>,
85 Arc<FilesystemPersister>,
88 pub(crate) type PeerManager = SimpleArcPeerManager<
93 dyn chain::Access + Send + Sync,
97 pub(crate) type ChannelManager =
98 SimpleArcChannelManager<ChainMonitor, BitcoindClient, BitcoindClient, FilesystemLogger>;
100 async fn handle_ldk_events(
101 channel_manager: Arc<ChannelManager>, bitcoind_client: Arc<BitcoindClient>,
102 keys_manager: Arc<KeysManager>, inbound_payments: PaymentInfoStorage,
103 outbound_payments: PaymentInfoStorage, network: Network, event: Event,
106 Event::FundingGenerationReady {
107 temporary_channel_id,
108 channel_value_satoshis,
112 // Construct the raw transaction with one output, that is paid the amount of the
114 let addr = WitnessProgram::from_scriptpubkey(
117 Network::Bitcoin => bitcoin_bech32::constants::Network::Bitcoin,
118 Network::Testnet => bitcoin_bech32::constants::Network::Testnet,
119 Network::Regtest => bitcoin_bech32::constants::Network::Regtest,
120 Network::Signet => panic!("Signet unsupported"),
123 .expect("Lightning funding tx should always be to a SegWit output")
125 let mut outputs = vec![HashMap::with_capacity(1)];
126 outputs[0].insert(addr, channel_value_satoshis as f64 / 100_000_000.0);
127 let raw_tx = bitcoind_client.create_raw_transaction(outputs).await;
129 // Have your wallet put the inputs into the transaction such that the output is
131 let funded_tx = bitcoind_client.fund_raw_transaction(raw_tx).await;
133 // Sign the final funding transaction and broadcast it.
134 let signed_tx = bitcoind_client.sign_raw_transaction_with_wallet(funded_tx.hex).await;
135 assert_eq!(signed_tx.complete, true);
136 let final_tx: Transaction =
137 encode::deserialize(&hex_utils::to_vec(&signed_tx.hex).unwrap()).unwrap();
138 // Give the funding transaction back to LDK for opening the channel.
140 .funding_transaction_generated(&temporary_channel_id, final_tx)
144 "\nERROR: Channel went away before we could fund it. The peer disconnected or refused the channel.");
146 io::stdout().flush().unwrap();
149 Event::PaymentReceived { payment_hash, purpose, amt, .. } => {
150 let mut payments = inbound_payments.lock().unwrap();
151 let (payment_preimage, payment_secret) = match purpose {
152 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
153 (payment_preimage, Some(payment_secret))
155 PaymentPurpose::SpontaneousPayment(preimage) => (Some(preimage), None),
157 let status = match channel_manager.claim_funds(payment_preimage.unwrap()) {
160 "\nEVENT: received payment from payment hash {} of {} millisatoshis",
161 hex_utils::hex_str(&payment_hash.0),
165 io::stdout().flush().unwrap();
166 HTLCStatus::Succeeded
168 _ => HTLCStatus::Failed,
170 match payments.entry(payment_hash) {
171 Entry::Occupied(mut e) => {
172 let payment = e.get_mut();
173 payment.status = status;
174 payment.preimage = payment_preimage;
175 payment.secret = payment_secret;
177 Entry::Vacant(e) => {
178 e.insert(PaymentInfo {
179 preimage: payment_preimage,
180 secret: payment_secret,
182 amt_msat: MillisatAmount(Some(amt)),
187 Event::PaymentSent { payment_preimage } => {
188 let hashed = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
189 let mut payments = outbound_payments.lock().unwrap();
190 for (payment_hash, payment) in payments.iter_mut() {
191 if *payment_hash == hashed {
192 payment.preimage = Some(payment_preimage);
193 payment.status = HTLCStatus::Succeeded;
195 "\nEVENT: successfully sent payment of {} millisatoshis from \
196 payment hash {:?} with preimage {:?}",
198 hex_utils::hex_str(&payment_hash.0),
199 hex_utils::hex_str(&payment_preimage.0)
202 io::stdout().flush().unwrap();
206 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
208 "\nEVENT: Failed to send payment to payment hash {:?}: ",
209 hex_utils::hex_str(&payment_hash.0)
211 if rejected_by_dest {
212 println!("re-attempting the payment will not succeed");
214 println!("payment may be retried");
217 io::stdout().flush().unwrap();
219 let mut payments = outbound_payments.lock().unwrap();
220 if payments.contains_key(&payment_hash) {
221 let payment = payments.get_mut(&payment_hash).unwrap();
222 payment.status = HTLCStatus::Failed;
225 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
226 let from_onchain_str = if claim_from_onchain_tx {
227 "from onchain downstream claim"
229 "from HTLC fulfill message"
231 if let Some(fee_earned) = fee_earned_msat {
233 "\nEVENT: Forwarded payment, earning {} msat {}",
234 fee_earned, from_onchain_str
237 println!("\nEVENT: Forwarded payment, claiming onchain {}", from_onchain_str);
240 io::stdout().flush().unwrap();
242 Event::PendingHTLCsForwardable { time_forwardable } => {
243 let forwarding_channel_manager = channel_manager.clone();
244 tokio::spawn(async move {
245 let min = time_forwardable.as_millis() as u64;
246 let millis_to_sleep = thread_rng().gen_range(min, min * 5) as u64;
247 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
248 forwarding_channel_manager.process_pending_htlc_forwards();
251 Event::SpendableOutputs { outputs } => {
252 let destination_address = bitcoind_client.get_new_address().await;
253 let output_descriptors = &outputs.iter().map(|a| a).collect::<Vec<_>>();
255 bitcoind_client.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
256 let spending_tx = keys_manager
257 .spend_spendable_outputs(
260 destination_address.script_pubkey(),
265 bitcoind_client.broadcast_transaction(&spending_tx);
270 async fn start_ldk() {
271 let args = match cli::parse_startup_args() {
272 Ok(user_args) => user_args,
276 // Initialize the LDK data directory if necessary.
277 let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
278 fs::create_dir_all(ldk_data_dir.clone()).unwrap();
280 // Initialize our bitcoind client.
281 let bitcoind_client = match BitcoindClient::new(
282 args.bitcoind_rpc_host.clone(),
283 args.bitcoind_rpc_port,
284 args.bitcoind_rpc_username.clone(),
285 args.bitcoind_rpc_password.clone(),
289 Ok(client) => Arc::new(client),
291 println!("Failed to connect to bitcoind client: {}", e);
296 // Check that the bitcoind we've connected to is running the network we expect
297 let bitcoind_chain = bitcoind_client.get_blockchain_info().await.chain;
299 != match args.network {
300 bitcoin::Network::Bitcoin => "main",
301 bitcoin::Network::Testnet => "test",
302 bitcoin::Network::Regtest => "regtest",
303 bitcoin::Network::Signet => "signet",
306 "Chain argument ({}) didn't match bitcoind chain ({})",
307 args.network, bitcoind_chain
313 // Step 1: Initialize the FeeEstimator
315 // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
316 let fee_estimator = bitcoind_client.clone();
318 // Step 2: Initialize the Logger
319 let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
321 // Step 3: Initialize the BroadcasterInterface
323 // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
325 let broadcaster = bitcoind_client.clone();
327 // Step 4: Initialize Persist
328 let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
330 // Step 5: Initialize the ChainMonitor
331 let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
335 fee_estimator.clone(),
339 // Step 6: Initialize the KeysManager
341 // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
342 // other secret key material.
343 let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
344 let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
345 assert_eq!(seed.len(), 32);
346 let mut key = [0; 32];
347 key.copy_from_slice(&seed);
350 let mut key = [0; 32];
351 thread_rng().fill_bytes(&mut key);
352 match File::create(keys_seed_path.clone()) {
354 f.write_all(&key).expect("Failed to write node keys seed to disk");
355 f.sync_all().expect("Failed to sync node keys seed to disk");
358 println!("ERROR: Unable to create keys seed file {}: {}", keys_seed_path, e);
364 let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
365 let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
367 // Step 7: Read ChannelMonitor state from disk
368 let mut channelmonitors = persister.read_channelmonitors(keys_manager.clone()).unwrap();
370 // Step 8: Initialize the ChannelManager
371 let mut user_config = UserConfig::default();
372 user_config.peer_channel_config_limits.force_announced_channel_preference = false;
373 let mut restarting_node = true;
374 let (channel_manager_blockhash, mut channel_manager) = {
375 if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
376 let mut channel_monitor_mut_references = Vec::new();
377 for (_, channel_monitor) in channelmonitors.iter_mut() {
378 channel_monitor_mut_references.push(channel_monitor);
380 let read_args = ChannelManagerReadArgs::new(
381 keys_manager.clone(),
382 fee_estimator.clone(),
383 chain_monitor.clone(),
387 channel_monitor_mut_references,
389 <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
391 // We're starting a fresh node.
392 restarting_node = false;
393 let getinfo_resp = bitcoind_client.get_blockchain_info().await;
395 let chain_params = ChainParameters {
396 network: args.network,
397 best_block: BestBlock::new(
398 getinfo_resp.latest_blockhash,
399 getinfo_resp.latest_height as u32,
402 let fresh_channel_manager = channelmanager::ChannelManager::new(
403 fee_estimator.clone(),
404 chain_monitor.clone(),
407 keys_manager.clone(),
411 (getinfo_resp.latest_blockhash, fresh_channel_manager)
415 // Step 9: Sync ChannelMonitors and ChannelManager to chain tip
416 let mut chain_listener_channel_monitors = Vec::new();
417 let mut cache = UnboundedCache::new();
418 let mut chain_tip: Option<poll::ValidatedBlockHeader> = None;
420 let mut chain_listeners =
421 vec![(channel_manager_blockhash, &mut channel_manager as &mut dyn chain::Listen)];
423 for (blockhash, channel_monitor) in channelmonitors.drain(..) {
424 let outpoint = channel_monitor.get_funding_txo().0;
425 chain_listener_channel_monitors.push((
427 (channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()),
432 for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
433 chain_listeners.push((
434 monitor_listener_info.0,
435 &mut monitor_listener_info.1 as &mut dyn chain::Listen,
439 init::synchronize_listeners(
440 &mut bitcoind_client.deref(),
450 // Step 10: Give ChannelMonitors to ChainMonitor
451 for item in chain_listener_channel_monitors.drain(..) {
452 let channel_monitor = item.1 .0;
453 let funding_outpoint = item.2;
454 chain_monitor.watch_channel(funding_outpoint, channel_monitor).unwrap();
457 // Step 11: Optional: Initialize the NetGraphMsgHandler
458 let genesis = genesis_block(args.network).header.block_hash();
459 let network_graph_path = format!("{}/network_graph", ldk_data_dir.clone());
460 let network_graph = disk::read_network(Path::new(&network_graph_path), genesis);
461 let router = Arc::new(NetGraphMsgHandler::from_net_graph(
462 None::<Arc<dyn chain::Access + Send + Sync>>,
466 let router_persist = Arc::clone(&router);
467 tokio::spawn(async move {
468 let mut interval = tokio::time::interval(Duration::from_secs(600));
470 interval.tick().await;
471 if disk::persist_network(
472 Path::new(&network_graph_path),
473 &*router_persist.network_graph.read().unwrap(),
477 // Persistence errors here are non-fatal as we can just fetch the routing graph
478 // again later, but they may indicate a disk error which could be fatal elsewhere.
480 "Warning: Failed to persist network graph, check your disk and permissions"
486 // Step 12: Initialize the PeerManager
487 let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
488 let mut ephemeral_bytes = [0; 32];
489 rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
490 let lightning_msg_handler =
491 MessageHandler { chan_handler: channel_manager.clone(), route_handler: router.clone() };
492 let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
493 lightning_msg_handler,
494 keys_manager.get_node_secret(),
500 // Step 13: Initialize networking
502 let peer_manager_connection_handler = peer_manager.clone();
503 let listening_port = args.ldk_peer_listening_port;
504 tokio::spawn(async move {
505 let listener = tokio::net::TcpListener::bind(format!("0.0.0.0:{}", listening_port))
507 .expect("Failed to bind to listen port - is something else already listening on it?");
509 let peer_mgr = peer_manager_connection_handler.clone();
510 let tcp_stream = listener.accept().await.unwrap().0;
511 tokio::spawn(async move {
512 lightning_net_tokio::setup_inbound(
514 tcp_stream.into_std().unwrap(),
521 // Step 14: Connect and Disconnect Blocks
522 if chain_tip.is_none() {
524 Some(init::validate_best_block_header(&mut bitcoind_client.deref()).await.unwrap());
526 let channel_manager_listener = channel_manager.clone();
527 let chain_monitor_listener = chain_monitor.clone();
528 let bitcoind_block_source = bitcoind_client.clone();
529 let network = args.network;
530 tokio::spawn(async move {
531 let mut derefed = bitcoind_block_source.deref();
532 let chain_poller = poll::ChainPoller::new(&mut derefed, network);
533 let chain_listener = (chain_monitor_listener, channel_manager_listener);
535 SpvClient::new(chain_tip.unwrap(), chain_poller, &mut cache, &chain_listener);
537 spv_client.poll_best_tip().await.unwrap();
538 tokio::time::sleep(Duration::from_secs(1)).await;
542 // Step 15: Handle LDK Events
543 let channel_manager_event_listener = channel_manager.clone();
544 let keys_manager_listener = keys_manager.clone();
545 // TODO: persist payment info to disk
546 let inbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
547 let outbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
548 let inbound_pmts_for_events = inbound_payments.clone();
549 let outbound_pmts_for_events = outbound_payments.clone();
550 let network = args.network;
551 let bitcoind_rpc = bitcoind_client.clone();
552 let handle = tokio::runtime::Handle::current();
553 let event_handler = move |event| {
554 handle.block_on(handle_ldk_events(
555 channel_manager_event_listener.clone(),
556 bitcoind_rpc.clone(),
557 keys_manager_listener.clone(),
558 inbound_pmts_for_events.clone(),
559 outbound_pmts_for_events.clone(),
564 // Step 16: Persist ChannelManager
565 let data_dir = ldk_data_dir.clone();
566 let persist_channel_manager_callback =
567 move |node: &ChannelManager| FilesystemPersister::persist_manager(data_dir.clone(), &*node);
568 // Step 17: Background Processing
569 let background_processor = BackgroundProcessor::start(
570 persist_channel_manager_callback,
572 chain_monitor.clone(),
573 channel_manager.clone(),
574 peer_manager.clone(),
578 // Reconnect to channel peers if possible.
579 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
580 match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
582 for (pubkey, peer_addr) in info.drain() {
583 for chan_info in channel_manager.list_channels() {
584 if pubkey == chan_info.counterparty.node_id {
586 cli::connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
592 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
595 // Regularly broadcast our node_announcement. This is only required (or possible) if we have
596 // some public channels, and is only useful if we have public listen address(es) to announce.
597 // In a production environment, this should occur only after the announcement of new channels
598 // to avoid churn in the global network graph.
599 let chan_manager = Arc::clone(&channel_manager);
600 let network = args.network;
601 if !args.ldk_announced_listen_addr.is_empty() {
602 tokio::spawn(async move {
603 let mut interval = tokio::time::interval(Duration::from_secs(60));
605 interval.tick().await;
606 chan_manager.broadcast_node_announcement(
608 args.ldk_announced_node_name,
609 args.ldk_announced_listen_addr.clone(),
616 cli::poll_for_user_input(
617 peer_manager.clone(),
618 channel_manager.clone(),
619 keys_manager.clone(),
623 ldk_data_dir.clone(),
629 // Stop the background processor.
630 background_processor.stop().unwrap();
634 pub async fn main() {