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 ChainParameters, ChannelManagerReadArgs, PaymentHash, PaymentPreimage, SimpleArcChannelManager,
28 use lightning::ln::peer_handler::{MessageHandler, SimpleArcPeerManager};
29 use lightning::routing::network_graph::NetGraphMsgHandler;
30 use lightning::util::config::UserConfig;
31 use lightning::util::events::{Event, EventsProvider};
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::HashMap;
49 use std::sync::{Arc, Mutex};
50 use std::time::{Duration, SystemTime};
51 use tokio::sync::mpsc;
54 pub(crate) enum HTLCDirection {
59 pub(crate) enum HTLCStatus {
65 pub(crate) struct SatoshiAmount(Option<u64>);
67 impl fmt::Display for SatoshiAmount {
68 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
70 Some(amt) => write!(f, "{}", amt),
71 None => write!(f, "unknown"),
76 pub(crate) type PaymentInfoStorage = Arc<
78 HashMap<PaymentHash, (Option<PaymentPreimage>, HTLCDirection, HTLCStatus, SatoshiAmount)>,
82 type ChainMonitor = chainmonitor::ChainMonitor<
87 Arc<FilesystemLogger>,
88 Arc<FilesystemPersister>,
91 pub(crate) type PeerManager = SimpleArcPeerManager<
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 payment_storage: PaymentInfoStorage, network: Network,
109 let loop_channel_manager = channel_manager.clone();
110 let mut events = channel_manager.get_and_clear_pending_events();
111 events.append(&mut chain_monitor.get_and_clear_pending_events());
112 for event in events {
114 Event::FundingGenerationReady {
115 temporary_channel_id,
116 channel_value_satoshis,
120 // Construct the raw transaction with one output, that is paid the amount of the
122 let addr = WitnessProgram::from_scriptpubkey(
125 Network::Bitcoin => bitcoin_bech32::constants::Network::Bitcoin,
126 Network::Testnet => bitcoin_bech32::constants::Network::Testnet,
127 Network::Regtest => bitcoin_bech32::constants::Network::Regtest,
128 Network::Signet => panic!("Signet unsupported"),
131 .expect("Lightning funding tx should always be to a SegWit output")
133 let mut outputs = vec![HashMap::with_capacity(1)];
134 outputs[0].insert(addr, channel_value_satoshis as f64 / 100_000_000.0);
135 let raw_tx = bitcoind_client.create_raw_transaction(outputs).await;
137 // Have your wallet put the inputs into the transaction such that the output is
139 let funded_tx = bitcoind_client.fund_raw_transaction(raw_tx).await;
140 let change_output_position = funded_tx.changepos;
141 assert!(change_output_position == 0 || change_output_position == 1);
143 // Sign the final funding transaction and broadcast it.
145 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)
154 Event::FundingBroadcastSafe { funding_txo, .. } => {
155 Event::PaymentReceived { payment_hash, payment_secret, amt: amt_msat } => {
156 let mut payments = payment_storage.lock().unwrap();
157 if let Some((Some(preimage), _, _, _)) = payments.get(&payment_hash) {
158 assert!(loop_channel_manager.claim_funds(
164 "\nEVENT: received payment from payment_hash {} of {} satoshis",
165 hex_utils::hex_str(&payment_hash.0),
169 io::stdout().flush().unwrap();
170 let (_, _, ref mut status, _) = payments.get_mut(&payment_hash).unwrap();
171 *status = HTLCStatus::Succeeded;
173 println!("\nERROR: we received a payment but didn't know the preimage");
175 io::stdout().flush().unwrap();
176 loop_channel_manager.fail_htlc_backwards(&payment_hash, &payment_secret);
179 (None, HTLCDirection::Inbound, HTLCStatus::Failed, SatoshiAmount(None)),
183 Event::PaymentSent { payment_preimage } => {
184 let hashed = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
185 let mut payments = payment_storage.lock().unwrap();
186 for (payment_hash, (preimage_option, _, status, amt_sat)) in payments.iter_mut()
188 if *payment_hash == hashed {
189 *preimage_option = Some(payment_preimage);
190 *status = HTLCStatus::Succeeded;
192 "\nEVENT: successfully sent payment of {} satoshis from \
193 payment hash {:?} with preimage {:?}",
195 hex_utils::hex_str(&payment_hash.0),
196 hex_utils::hex_str(&payment_preimage.0)
199 io::stdout().flush().unwrap();
203 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
205 "\nEVENT: Failed to send payment to payment hash {:?}: ",
206 hex_utils::hex_str(&payment_hash.0)
208 if rejected_by_dest {
209 println!("rejected by destination node");
211 println!("route failed");
214 io::stdout().flush().unwrap();
216 let mut payments = payment_storage.lock().unwrap();
217 if payments.contains_key(&payment_hash) {
218 let (_, _, ref mut status, _) = payments.get_mut(&payment_hash).unwrap();
219 *status = HTLCStatus::Failed;
222 Event::PendingHTLCsForwardable { time_forwardable } => {
223 let forwarding_channel_manager = loop_channel_manager.clone();
224 tokio::spawn(async move {
225 let min = time_forwardable.as_millis() as u64;
226 let millis_to_sleep = thread_rng().gen_range(min, min * 5) as u64;
227 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
228 forwarding_channel_manager.process_pending_htlc_forwards();
231 Event::SpendableOutputs { outputs } => {
232 let destination_address = bitcoind_client.get_new_address().await;
233 let output_descriptors = &outputs.iter().map(|a| a).collect::<Vec<_>>();
235 bitcoind_client.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
236 let spending_tx = keys_manager
237 .spend_spendable_outputs(
240 destination_address.script_pubkey(),
245 bitcoind_client.broadcast_transaction(&spending_tx);
249 tokio::time::sleep(Duration::from_secs(1)).await;
253 async fn start_ldk() {
254 let args = match cli::parse_startup_args() {
255 Ok(user_args) => user_args,
259 // Initialize the LDK data directory if necessary.
260 let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
261 fs::create_dir_all(ldk_data_dir.clone()).unwrap();
263 // Initialize our bitcoind client.
264 let bitcoind_client = match BitcoindClient::new(
265 args.bitcoind_rpc_host.clone(),
266 args.bitcoind_rpc_port,
267 args.bitcoind_rpc_username.clone(),
268 args.bitcoind_rpc_password.clone(),
272 Ok(client) => Arc::new(client),
274 println!("Failed to connect to bitcoind client: {}", e);
280 // Step 1: Initialize the FeeEstimator
282 // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
283 let fee_estimator = bitcoind_client.clone();
285 // Step 2: Initialize the Logger
286 let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
288 // Step 3: Initialize the BroadcasterInterface
290 // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
292 let broadcaster = bitcoind_client.clone();
294 // Step 4: Initialize Persist
295 let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
297 // Step 5: Initialize the ChainMonitor
298 let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
302 fee_estimator.clone(),
306 // Step 6: Initialize the KeysManager
308 // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
309 // other secret key material.
310 let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
311 let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
312 assert_eq!(seed.len(), 32);
313 let mut key = [0; 32];
314 key.copy_from_slice(&seed);
317 let mut key = [0; 32];
318 thread_rng().fill_bytes(&mut key);
319 match File::create(keys_seed_path.clone()) {
321 f.write_all(&key).expect("Failed to write node keys seed to disk");
322 f.sync_all().expect("Failed to sync node keys seed to disk");
325 println!("ERROR: Unable to create keys seed file {}: {}", keys_seed_path, e);
331 let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
332 let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
334 // Step 7: Read ChannelMonitor state from disk
335 let mut channelmonitors = persister.read_channelmonitors(keys_manager.clone()).unwrap();
337 // Step 9: Initialize the ChannelManager
338 let user_config = UserConfig::default();
339 let mut restarting_node = true;
340 let (channel_manager_blockhash, mut channel_manager) = {
341 if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
342 let mut channel_monitor_mut_references = Vec::new();
343 for (_, channel_monitor) in channelmonitors.iter_mut() {
344 channel_monitor_mut_references.push(channel_monitor);
346 let read_args = ChannelManagerReadArgs::new(
347 keys_manager.clone(),
348 fee_estimator.clone(),
349 chain_monitor.clone(),
353 channel_monitor_mut_references,
355 <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
357 // We're starting a fresh node.
358 restarting_node = false;
359 let getinfo_resp = bitcoind_client.get_blockchain_info().await;
361 let chain_params = ChainParameters {
362 network: args.network,
363 latest_hash: getinfo_resp.latest_blockhash,
364 latest_height: getinfo_resp.latest_height,
366 let fresh_channel_manager = channelmanager::ChannelManager::new(
367 fee_estimator.clone(),
368 chain_monitor.clone(),
371 keys_manager.clone(),
375 (getinfo_resp.latest_blockhash, fresh_channel_manager)
379 // Step 10: Sync ChannelMonitors and ChannelManager to chain tip
380 let mut chain_listener_channel_monitors = Vec::new();
381 let mut cache = UnboundedCache::new();
382 let mut chain_tip: Option<poll::ValidatedBlockHeader> = None;
384 let mut chain_listeners =
385 vec![(channel_manager_blockhash, &mut channel_manager as &mut dyn chain::Listen)];
387 for (blockhash, channel_monitor) in channelmonitors.drain(..) {
388 let outpoint = channel_monitor.get_funding_txo().0;
389 chain_listener_channel_monitors.push((
391 (channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()),
396 for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
397 chain_listeners.push((
398 monitor_listener_info.0,
399 &mut monitor_listener_info.1 as &mut dyn chain::Listen,
403 init::synchronize_listeners(
404 &mut bitcoind_client.deref(),
414 // Step 11: Give ChannelMonitors to ChainMonitor
415 for item in chain_listener_channel_monitors.drain(..) {
416 let channel_monitor = item.1 .0;
417 let funding_outpoint = item.2;
418 chain_monitor.watch_channel(funding_outpoint, channel_monitor).unwrap();
421 // Step 13: Optional: Initialize the NetGraphMsgHandler
422 // XXX persist routing data
423 let genesis = genesis_block(args.network).header.block_hash();
425 Arc::new(NetGraphMsgHandler::new(genesis, None::<Arc<dyn chain::Access>>, logger.clone()));
427 // Step 14: Initialize the PeerManager
428 let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
429 let mut ephemeral_bytes = [0; 32];
430 rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
431 let lightning_msg_handler =
432 MessageHandler { chan_handler: channel_manager.clone(), route_handler: router.clone() };
433 let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
434 lightning_msg_handler,
435 keys_manager.get_node_secret(),
441 // Step 16: Initialize Peer Connection Handling
443 // We poll for events in handle_ldk_events(..) rather than waiting for them over the
444 // mpsc::channel, so we can leave the event receiver as unused.
445 let (event_ntfn_sender, _event_ntfn_receiver) = mpsc::channel(2);
446 let peer_manager_connection_handler = peer_manager.clone();
447 let event_notifier = event_ntfn_sender.clone();
448 let listening_port = args.ldk_peer_listening_port;
449 tokio::spawn(async move {
450 let listener = std::net::TcpListener::bind(format!("0.0.0.0:{}", listening_port)).unwrap();
452 let tcp_stream = listener.accept().unwrap().0;
453 lightning_net_tokio::setup_inbound(
454 peer_manager_connection_handler.clone(),
455 event_notifier.clone(),
462 // Step 17: Connect and Disconnect Blocks
463 if chain_tip.is_none() {
465 Some(init::validate_best_block_header(&mut bitcoind_client.deref()).await.unwrap());
467 let channel_manager_listener = channel_manager.clone();
468 let chain_monitor_listener = chain_monitor.clone();
469 let bitcoind_block_source = bitcoind_client.clone();
470 let network = args.network;
471 tokio::spawn(async move {
472 let mut derefed = bitcoind_block_source.deref();
473 let chain_poller = poll::ChainPoller::new(&mut derefed, network);
474 let chain_listener = (chain_monitor_listener, channel_manager_listener);
476 SpvClient::new(chain_tip.unwrap(), chain_poller, &mut cache, &chain_listener);
478 spv_client.poll_best_tip().await.unwrap();
479 tokio::time::sleep(Duration::from_secs(1)).await;
483 // Step 17 & 18: Initialize ChannelManager persistence & Once Per Minute: ChannelManager's
484 // timer_chan_freshness_every_min() and PeerManager's timer_tick_occurred
485 let data_dir = ldk_data_dir.clone();
486 let persist_channel_manager_callback =
487 move |node: &ChannelManager| FilesystemPersister::persist_manager(data_dir.clone(), &*node);
488 BackgroundProcessor::start(
489 persist_channel_manager_callback,
490 channel_manager.clone(),
491 peer_manager.clone(),
495 let peer_manager_processor = peer_manager.clone();
496 tokio::spawn(async move {
498 peer_manager_processor.timer_tick_occurred();
499 tokio::time::sleep(Duration::from_secs(60)).await;
503 // Step 15: Initialize LDK Event Handling
504 let channel_manager_event_listener = channel_manager.clone();
505 let chain_monitor_event_listener = chain_monitor.clone();
506 let keys_manager_listener = keys_manager.clone();
507 let payment_info: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
508 let payment_info_for_events = payment_info.clone();
509 let network = args.network;
510 let bitcoind_rpc = bitcoind_client.clone();
511 tokio::spawn(async move {
513 channel_manager_event_listener,
514 chain_monitor_event_listener,
516 keys_manager_listener,
517 payment_info_for_events,
523 // Reconnect to channel peers if possible.
524 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
525 match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
527 for (pubkey, peer_addr) in info.drain() {
528 for chan_info in channel_manager.list_channels() {
529 if pubkey == chan_info.remote_network_id {
530 let _ = cli::connect_peer_if_necessary(
533 peer_manager.clone(),
534 event_ntfn_sender.clone(),
540 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
544 cli::poll_for_user_input(
545 peer_manager.clone(),
546 channel_manager.clone(),
549 keys_manager.get_node_secret(),
551 ldk_data_dir.clone(),
559 pub async fn main() {