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;
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};
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 async fn handle_ldk_events(
102 channel_manager: Arc<ChannelManager>, bitcoind_client: Arc<BitcoindClient>,
103 keys_manager: Arc<KeysManager>, inbound_payments: PaymentInfoStorage,
104 outbound_payments: PaymentInfoStorage, network: Network, event: Event,
107 Event::FundingGenerationReady {
108 temporary_channel_id,
109 channel_value_satoshis,
113 // Construct the raw transaction with one output, that is paid the amount of the
115 let addr = WitnessProgram::from_scriptpubkey(
118 Network::Bitcoin => bitcoin_bech32::constants::Network::Bitcoin,
119 Network::Testnet => bitcoin_bech32::constants::Network::Testnet,
120 Network::Regtest => bitcoin_bech32::constants::Network::Regtest,
121 Network::Signet => panic!("Signet unsupported"),
124 .expect("Lightning funding tx should always be to a SegWit output")
126 let mut outputs = vec![HashMap::with_capacity(1)];
127 outputs[0].insert(addr, channel_value_satoshis as f64 / 100_000_000.0);
128 let raw_tx = bitcoind_client.create_raw_transaction(outputs).await;
130 // Have your wallet put the inputs into the transaction such that the output is
132 let funded_tx = bitcoind_client.fund_raw_transaction(raw_tx).await;
133 let change_output_position = funded_tx.changepos;
134 assert!(change_output_position == 0 || change_output_position == 1);
136 // Sign the final funding transaction and broadcast it.
137 let signed_tx = bitcoind_client.sign_raw_transaction_with_wallet(funded_tx.hex).await;
138 assert_eq!(signed_tx.complete, true);
139 let final_tx: Transaction =
140 encode::deserialize(&hex_utils::to_vec(&signed_tx.hex).unwrap()).unwrap();
141 // Give the funding transaction back to LDK for opening the channel.
142 channel_manager.funding_transaction_generated(&temporary_channel_id, final_tx).unwrap();
144 Event::PaymentReceived { payment_hash, payment_preimage, payment_secret, amt, .. } => {
145 let mut payments = inbound_payments.lock().unwrap();
146 let status = match channel_manager.claim_funds(payment_preimage.unwrap()) {
149 "\nEVENT: received payment from payment hash {} of {} millisatoshis",
150 hex_utils::hex_str(&payment_hash.0),
154 io::stdout().flush().unwrap();
155 HTLCStatus::Succeeded
157 _ => HTLCStatus::Failed,
159 match payments.entry(payment_hash) {
160 Entry::Occupied(mut e) => {
161 let payment = e.get_mut();
162 payment.status = status;
163 payment.preimage = Some(payment_preimage.unwrap());
164 payment.secret = Some(payment_secret);
166 Entry::Vacant(e) => {
167 e.insert(PaymentInfo {
168 preimage: Some(payment_preimage.unwrap()),
169 secret: Some(payment_secret),
171 amt_msat: MillisatAmount(Some(amt)),
176 Event::PaymentSent { payment_preimage } => {
177 let hashed = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
178 let mut payments = outbound_payments.lock().unwrap();
179 for (payment_hash, payment) in payments.iter_mut() {
180 if *payment_hash == hashed {
181 payment.preimage = Some(payment_preimage);
182 payment.status = HTLCStatus::Succeeded;
184 "\nEVENT: successfully sent payment of {} millisatoshis from \
185 payment hash {:?} with preimage {:?}",
187 hex_utils::hex_str(&payment_hash.0),
188 hex_utils::hex_str(&payment_preimage.0)
191 io::stdout().flush().unwrap();
195 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
197 "\nEVENT: Failed to send payment to payment hash {:?}: ",
198 hex_utils::hex_str(&payment_hash.0)
200 if rejected_by_dest {
201 println!("re-attempting the payment will not succeed");
203 println!("payment may be retried");
206 io::stdout().flush().unwrap();
208 let mut payments = outbound_payments.lock().unwrap();
209 if payments.contains_key(&payment_hash) {
210 let payment = payments.get_mut(&payment_hash).unwrap();
211 payment.status = HTLCStatus::Failed;
214 Event::PendingHTLCsForwardable { time_forwardable } => {
215 let forwarding_channel_manager = channel_manager.clone();
216 tokio::spawn(async move {
217 let min = time_forwardable.as_millis() as u64;
218 let millis_to_sleep = thread_rng().gen_range(min, min * 5) as u64;
219 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
220 forwarding_channel_manager.process_pending_htlc_forwards();
223 Event::SpendableOutputs { outputs } => {
224 let destination_address = bitcoind_client.get_new_address().await;
225 let output_descriptors = &outputs.iter().map(|a| a).collect::<Vec<_>>();
227 bitcoind_client.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
228 let spending_tx = keys_manager
229 .spend_spendable_outputs(
232 destination_address.script_pubkey(),
237 bitcoind_client.broadcast_transaction(&spending_tx);
242 async fn start_ldk() {
243 let args = match cli::parse_startup_args() {
244 Ok(user_args) => user_args,
248 // Initialize the LDK data directory if necessary.
249 let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
250 fs::create_dir_all(ldk_data_dir.clone()).unwrap();
252 // Initialize our bitcoind client.
253 let bitcoind_client = match BitcoindClient::new(
254 args.bitcoind_rpc_host.clone(),
255 args.bitcoind_rpc_port,
256 args.bitcoind_rpc_username.clone(),
257 args.bitcoind_rpc_password.clone(),
261 Ok(client) => Arc::new(client),
263 println!("Failed to connect to bitcoind client: {}", e);
268 // Check that the bitcoind we've connected to is running the network we expect
269 let bitcoind_chain = bitcoind_client.get_blockchain_info().await.chain;
271 != match args.network {
272 bitcoin::Network::Bitcoin => "main",
273 bitcoin::Network::Testnet => "test",
274 bitcoin::Network::Regtest => "regtest",
275 bitcoin::Network::Signet => "signet",
278 "Chain argument ({}) didn't match bitcoind chain ({})",
279 args.network, bitcoind_chain
285 // Step 1: Initialize the FeeEstimator
287 // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
288 let fee_estimator = bitcoind_client.clone();
290 // Step 2: Initialize the Logger
291 let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
293 // Step 3: Initialize the BroadcasterInterface
295 // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
297 let broadcaster = bitcoind_client.clone();
299 // Step 4: Initialize Persist
300 let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
302 // Step 5: Initialize the ChainMonitor
303 let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
307 fee_estimator.clone(),
311 // Step 6: Initialize the KeysManager
313 // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
314 // other secret key material.
315 let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
316 let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
317 assert_eq!(seed.len(), 32);
318 let mut key = [0; 32];
319 key.copy_from_slice(&seed);
322 let mut key = [0; 32];
323 thread_rng().fill_bytes(&mut key);
324 match File::create(keys_seed_path.clone()) {
326 f.write_all(&key).expect("Failed to write node keys seed to disk");
327 f.sync_all().expect("Failed to sync node keys seed to disk");
330 println!("ERROR: Unable to create keys seed file {}: {}", keys_seed_path, e);
336 let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
337 let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
339 // Step 7: Read ChannelMonitor state from disk
340 let mut channelmonitors = persister.read_channelmonitors(keys_manager.clone()).unwrap();
342 // Step 8: Initialize the ChannelManager
343 let user_config = UserConfig::default();
344 let mut restarting_node = true;
345 let (channel_manager_blockhash, mut channel_manager) = {
346 if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
347 let mut channel_monitor_mut_references = Vec::new();
348 for (_, channel_monitor) in channelmonitors.iter_mut() {
349 channel_monitor_mut_references.push(channel_monitor);
351 let read_args = ChannelManagerReadArgs::new(
352 keys_manager.clone(),
353 fee_estimator.clone(),
354 chain_monitor.clone(),
358 channel_monitor_mut_references,
360 <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
362 // We're starting a fresh node.
363 restarting_node = false;
364 let getinfo_resp = bitcoind_client.get_blockchain_info().await;
366 let chain_params = ChainParameters {
367 network: args.network,
368 best_block: BestBlock::new(
369 getinfo_resp.latest_blockhash,
370 getinfo_resp.latest_height as u32,
373 let fresh_channel_manager = channelmanager::ChannelManager::new(
374 fee_estimator.clone(),
375 chain_monitor.clone(),
378 keys_manager.clone(),
382 (getinfo_resp.latest_blockhash, fresh_channel_manager)
386 // Step 9: Sync ChannelMonitors and ChannelManager to chain tip
387 let mut chain_listener_channel_monitors = Vec::new();
388 let mut cache = UnboundedCache::new();
389 let mut chain_tip: Option<poll::ValidatedBlockHeader> = None;
391 let mut chain_listeners =
392 vec![(channel_manager_blockhash, &mut channel_manager as &mut dyn chain::Listen)];
394 for (blockhash, channel_monitor) in channelmonitors.drain(..) {
395 let outpoint = channel_monitor.get_funding_txo().0;
396 chain_listener_channel_monitors.push((
398 (channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()),
403 for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
404 chain_listeners.push((
405 monitor_listener_info.0,
406 &mut monitor_listener_info.1 as &mut dyn chain::Listen,
410 init::synchronize_listeners(
411 &mut bitcoind_client.deref(),
421 // Step 10: Give ChannelMonitors to ChainMonitor
422 for item in chain_listener_channel_monitors.drain(..) {
423 let channel_monitor = item.1 .0;
424 let funding_outpoint = item.2;
425 chain_monitor.watch_channel(funding_outpoint, channel_monitor).unwrap();
428 // Step 11: Optional: Initialize the NetGraphMsgHandler
429 let genesis = genesis_block(args.network).header.block_hash();
430 let network_graph_path = format!("{}/network_graph", ldk_data_dir.clone());
431 let network_graph = disk::read_network(Path::new(&network_graph_path), genesis);
432 let router = Arc::new(NetGraphMsgHandler::from_net_graph(
433 None::<Arc<dyn chain::Access + Send + Sync>>,
437 let router_persist = Arc::clone(&router);
438 tokio::spawn(async move {
439 let mut interval = tokio::time::interval(Duration::from_secs(600));
441 interval.tick().await;
442 if disk::persist_network(
443 Path::new(&network_graph_path),
444 &*router_persist.network_graph.read().unwrap(),
448 // Persistence errors here are non-fatal as we can just fetch the routing graph
449 // again later, but they may indicate a disk error which could be fatal elsewhere.
451 "Warning: Failed to persist network graph, check your disk and permissions"
457 // Step 12: Initialize the PeerManager
458 let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
459 let mut ephemeral_bytes = [0; 32];
460 rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
461 let lightning_msg_handler =
462 MessageHandler { chan_handler: channel_manager.clone(), route_handler: router.clone() };
463 let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
464 lightning_msg_handler,
465 keys_manager.get_node_secret(),
471 // Step 13: Initialize networking
473 let peer_manager_connection_handler = peer_manager.clone();
474 let listening_port = args.ldk_peer_listening_port;
475 tokio::spawn(async move {
476 let listener = tokio::net::TcpListener::bind(format!("0.0.0.0:{}", listening_port))
478 .expect("Failed to bind to listen port - is something else already listening on it?");
480 let peer_mgr = peer_manager_connection_handler.clone();
481 let tcp_stream = listener.accept().await.unwrap().0;
482 tokio::spawn(async move {
483 lightning_net_tokio::setup_inbound(
485 tcp_stream.into_std().unwrap(),
492 // Step 14: Connect and Disconnect Blocks
493 if chain_tip.is_none() {
495 Some(init::validate_best_block_header(&mut bitcoind_client.deref()).await.unwrap());
497 let channel_manager_listener = channel_manager.clone();
498 let chain_monitor_listener = chain_monitor.clone();
499 let bitcoind_block_source = bitcoind_client.clone();
500 let network = args.network;
501 tokio::spawn(async move {
502 let mut derefed = bitcoind_block_source.deref();
503 let chain_poller = poll::ChainPoller::new(&mut derefed, network);
504 let chain_listener = (chain_monitor_listener, channel_manager_listener);
506 SpvClient::new(chain_tip.unwrap(), chain_poller, &mut cache, &chain_listener);
508 spv_client.poll_best_tip().await.unwrap();
509 tokio::time::sleep(Duration::from_secs(1)).await;
513 // Step 15: Handle LDK Events
514 let channel_manager_event_listener = channel_manager.clone();
515 let keys_manager_listener = keys_manager.clone();
516 // TODO: persist payment info to disk
517 let inbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
518 let outbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
519 let inbound_pmts_for_events = inbound_payments.clone();
520 let outbound_pmts_for_events = outbound_payments.clone();
521 let network = args.network;
522 let bitcoind_rpc = bitcoind_client.clone();
523 let handle = tokio::runtime::Handle::current();
524 let event_handler = move |event| {
525 handle.block_on(handle_ldk_events(
526 channel_manager_event_listener.clone(),
527 bitcoind_rpc.clone(),
528 keys_manager_listener.clone(),
529 inbound_pmts_for_events.clone(),
530 outbound_pmts_for_events.clone(),
535 // Step 16: Persist ChannelManager
536 let data_dir = ldk_data_dir.clone();
537 let persist_channel_manager_callback =
538 move |node: &ChannelManager| FilesystemPersister::persist_manager(data_dir.clone(), &*node);
539 // Step 17: Background Processing
540 BackgroundProcessor::start(
541 persist_channel_manager_callback,
543 chain_monitor.clone(),
544 channel_manager.clone(),
545 peer_manager.clone(),
549 // Reconnect to channel peers if possible.
550 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
551 match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
553 for (pubkey, peer_addr) in info.drain() {
554 for chan_info in channel_manager.list_channels() {
555 if pubkey == chan_info.remote_network_id {
557 cli::connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
563 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
566 // Regularly broadcast our node_announcement. This is only required (or possible) if we have
567 // some public channels, and is only useful if we have public listen address(es) to announce.
568 // In a production environment, this should occur only after the announcement of new channels
569 // to avoid churn in the global network graph.
570 let chan_manager = Arc::clone(&channel_manager);
571 let network = args.network;
572 if args.ldk_announced_listen_addr.is_some() {
573 tokio::spawn(async move {
574 let mut interval = tokio::time::interval(Duration::from_secs(60));
576 interval.tick().await;
577 chan_manager.broadcast_node_announcement(
579 args.ldk_announced_node_name,
580 vec![args.ldk_announced_listen_addr.as_ref().unwrap().clone()],
587 cli::poll_for_user_input(
588 peer_manager.clone(),
589 channel_manager.clone(),
590 keys_manager.clone(),
594 ldk_data_dir.clone(),
602 pub async fn main() {