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, PaymentSecret,
27 SimpleArcChannelManager,
29 use lightning::ln::peer_handler::{MessageHandler, SimpleArcPeerManager};
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::HashMap;
50 use std::sync::{Arc, Mutex};
51 use std::time::{Duration, SystemTime};
52 use tokio::sync::mpsc;
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<
85 Arc<FilesystemLogger>,
86 Arc<FilesystemPersister>,
89 pub(crate) type PeerManager = SimpleArcPeerManager<
98 pub(crate) type ChannelManager =
99 SimpleArcChannelManager<ChainMonitor, BitcoindClient, BitcoindClient, FilesystemLogger>;
101 async fn handle_ldk_events(
102 channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
103 bitcoind_client: Arc<BitcoindClient>, keys_manager: Arc<KeysManager>,
104 inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage, network: Network,
107 let loop_channel_manager = channel_manager.clone();
108 let mut events = channel_manager.get_and_clear_pending_events();
109 events.append(&mut chain_monitor.get_and_clear_pending_events());
110 for event in events {
112 Event::FundingGenerationReady {
113 temporary_channel_id,
114 channel_value_satoshis,
118 // Construct the raw transaction with one output, that is paid the amount of the
120 let addr = WitnessProgram::from_scriptpubkey(
123 Network::Bitcoin => bitcoin_bech32::constants::Network::Bitcoin,
124 Network::Testnet => bitcoin_bech32::constants::Network::Testnet,
125 Network::Regtest => bitcoin_bech32::constants::Network::Regtest,
126 Network::Signet => panic!("Signet unsupported"),
129 .expect("Lightning funding tx should always be to a SegWit output")
131 let mut outputs = vec![HashMap::with_capacity(1)];
132 outputs[0].insert(addr, channel_value_satoshis as f64 / 100_000_000.0);
133 let raw_tx = bitcoind_client.create_raw_transaction(outputs).await;
135 // Have your wallet put the inputs into the transaction such that the output is
137 let funded_tx = bitcoind_client.fund_raw_transaction(raw_tx).await;
138 let change_output_position = funded_tx.changepos;
139 assert!(change_output_position == 0 || change_output_position == 1);
141 // Sign the final funding transaction and broadcast it.
143 bitcoind_client.sign_raw_transaction_with_wallet(funded_tx.hex).await;
144 assert_eq!(signed_tx.complete, true);
145 let final_tx: Transaction =
146 encode::deserialize(&hex_utils::to_vec(&signed_tx.hex).unwrap()).unwrap();
147 // Give the funding transaction back to LDK for opening the channel.
149 .funding_transaction_generated(&temporary_channel_id, final_tx)
152 Event::PaymentReceived { payment_hash, payment_secret, amt } => {
153 let mut payments = inbound_payments.lock().unwrap();
154 if let Some(payment) = payments.get_mut(&payment_hash) {
155 if payment.secret == payment_secret {
156 assert!(loop_channel_manager.claim_funds(
157 payment.preimage.unwrap().clone(),
159 payment.amt_msat.0.unwrap(),
162 "\nEVENT: received payment from payment hash {} of {} millisatoshis",
163 hex_utils::hex_str(&payment_hash.0),
167 io::stdout().flush().unwrap();
168 payment.status = HTLCStatus::Succeeded;
171 .fail_htlc_backwards(&payment_hash, &payment.secret);
172 println!("\nERROR: we received a payment from payment hash {} but the payment secret didn't match", hex_utils::hex_str(&payment_hash.0));
174 io::stdout().flush().unwrap();
175 payment.status = HTLCStatus::Failed;
178 loop_channel_manager.fail_htlc_backwards(&payment_hash, &payment_secret);
179 println!("\nERROR: we received a payment for payment hash {} but didn't know the preimage", hex_utils::hex_str(&payment_hash.0));
181 io::stdout().flush().unwrap();
186 secret: payment_secret,
187 status: HTLCStatus::Failed,
188 amt_msat: MillisatAmount(Some(amt)),
193 Event::PaymentSent { payment_preimage } => {
194 let hashed = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
195 let mut payments = outbound_payments.lock().unwrap();
196 for (payment_hash, payment) in payments.iter_mut() {
197 if *payment_hash == hashed {
198 payment.preimage = Some(payment_preimage);
199 payment.status = HTLCStatus::Succeeded;
201 "\nEVENT: successfully sent payment of {} millisatoshis from \
202 payment hash {:?} with preimage {:?}",
204 hex_utils::hex_str(&payment_hash.0),
205 hex_utils::hex_str(&payment_preimage.0)
208 io::stdout().flush().unwrap();
212 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
214 "\nEVENT: Failed to send payment to payment hash {:?}: ",
215 hex_utils::hex_str(&payment_hash.0)
217 if rejected_by_dest {
218 println!("rejected by destination node");
220 println!("route failed");
223 io::stdout().flush().unwrap();
225 let mut payments = outbound_payments.lock().unwrap();
226 if payments.contains_key(&payment_hash) {
227 let payment = payments.get_mut(&payment_hash).unwrap();
228 payment.status = HTLCStatus::Failed;
231 Event::PendingHTLCsForwardable { time_forwardable } => {
232 let forwarding_channel_manager = loop_channel_manager.clone();
233 tokio::spawn(async move {
234 let min = time_forwardable.as_millis() as u64;
235 let millis_to_sleep = thread_rng().gen_range(min, min * 5) as u64;
236 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
237 forwarding_channel_manager.process_pending_htlc_forwards();
240 Event::SpendableOutputs { outputs } => {
241 let destination_address = bitcoind_client.get_new_address().await;
242 let output_descriptors = &outputs.iter().map(|a| a).collect::<Vec<_>>();
244 bitcoind_client.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
245 let spending_tx = keys_manager
246 .spend_spendable_outputs(
249 destination_address.script_pubkey(),
254 bitcoind_client.broadcast_transaction(&spending_tx);
258 tokio::time::sleep(Duration::from_secs(1)).await;
262 async fn start_ldk() {
263 let args = match cli::parse_startup_args() {
264 Ok(user_args) => user_args,
268 // Initialize the LDK data directory if necessary.
269 let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
270 fs::create_dir_all(ldk_data_dir.clone()).unwrap();
272 // Initialize our bitcoind client.
273 let bitcoind_client = match BitcoindClient::new(
274 args.bitcoind_rpc_host.clone(),
275 args.bitcoind_rpc_port,
276 args.bitcoind_rpc_username.clone(),
277 args.bitcoind_rpc_password.clone(),
281 Ok(client) => Arc::new(client),
283 println!("Failed to connect to bitcoind client: {}", e);
289 // Step 1: Initialize the FeeEstimator
291 // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
292 let fee_estimator = bitcoind_client.clone();
294 // Step 2: Initialize the Logger
295 let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
297 // Step 3: Initialize the BroadcasterInterface
299 // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
301 let broadcaster = bitcoind_client.clone();
303 // Step 4: Initialize Persist
304 let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
306 // Step 5: Initialize the ChainMonitor
307 let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
311 fee_estimator.clone(),
315 // Step 6: Initialize the KeysManager
317 // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
318 // other secret key material.
319 let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
320 let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
321 assert_eq!(seed.len(), 32);
322 let mut key = [0; 32];
323 key.copy_from_slice(&seed);
326 let mut key = [0; 32];
327 thread_rng().fill_bytes(&mut key);
328 match File::create(keys_seed_path.clone()) {
330 f.write_all(&key).expect("Failed to write node keys seed to disk");
331 f.sync_all().expect("Failed to sync node keys seed to disk");
334 println!("ERROR: Unable to create keys seed file {}: {}", keys_seed_path, e);
340 let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
341 let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
343 // Step 7: Read ChannelMonitor state from disk
344 let mut channelmonitors = persister.read_channelmonitors(keys_manager.clone()).unwrap();
346 // Step 9: Initialize the ChannelManager
347 let user_config = UserConfig::default();
348 let mut restarting_node = true;
349 let (channel_manager_blockhash, mut channel_manager) = {
350 if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
351 let mut channel_monitor_mut_references = Vec::new();
352 for (_, channel_monitor) in channelmonitors.iter_mut() {
353 channel_monitor_mut_references.push(channel_monitor);
355 let read_args = ChannelManagerReadArgs::new(
356 keys_manager.clone(),
357 fee_estimator.clone(),
358 chain_monitor.clone(),
362 channel_monitor_mut_references,
364 <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
366 // We're starting a fresh node.
367 restarting_node = false;
368 let getinfo_resp = bitcoind_client.get_blockchain_info().await;
370 let chain_params = ChainParameters {
371 network: args.network,
372 latest_hash: getinfo_resp.latest_blockhash,
373 latest_height: getinfo_resp.latest_height,
375 let fresh_channel_manager = channelmanager::ChannelManager::new(
376 fee_estimator.clone(),
377 chain_monitor.clone(),
380 keys_manager.clone(),
384 (getinfo_resp.latest_blockhash, fresh_channel_manager)
388 // Step 10: Sync ChannelMonitors and ChannelManager to chain tip
389 let mut chain_listener_channel_monitors = Vec::new();
390 let mut cache = UnboundedCache::new();
391 let mut chain_tip: Option<poll::ValidatedBlockHeader> = None;
393 let mut chain_listeners =
394 vec![(channel_manager_blockhash, &mut channel_manager as &mut dyn chain::Listen)];
396 for (blockhash, channel_monitor) in channelmonitors.drain(..) {
397 let outpoint = channel_monitor.get_funding_txo().0;
398 chain_listener_channel_monitors.push((
400 (channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()),
405 for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
406 chain_listeners.push((
407 monitor_listener_info.0,
408 &mut monitor_listener_info.1 as &mut dyn chain::Listen,
412 init::synchronize_listeners(
413 &mut bitcoind_client.deref(),
423 // Step 11: Give ChannelMonitors to ChainMonitor
424 for item in chain_listener_channel_monitors.drain(..) {
425 let channel_monitor = item.1 .0;
426 let funding_outpoint = item.2;
427 chain_monitor.watch_channel(funding_outpoint, channel_monitor).unwrap();
430 // Step 13: Optional: Initialize the NetGraphMsgHandler
431 // XXX persist routing data
432 let genesis = genesis_block(args.network).header.block_hash();
434 Arc::new(NetGraphMsgHandler::new(genesis, None::<Arc<dyn chain::Access>>, logger.clone()));
436 // Step 14: Initialize the PeerManager
437 let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
438 let mut ephemeral_bytes = [0; 32];
439 rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
440 let lightning_msg_handler =
441 MessageHandler { chan_handler: channel_manager.clone(), route_handler: router.clone() };
442 let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
443 lightning_msg_handler,
444 keys_manager.get_node_secret(),
450 // Step 16: Initialize Peer Connection Handling
452 // We poll for events in handle_ldk_events(..) rather than waiting for them over the
453 // mpsc::channel, so we can leave the event receiver as unused.
454 let (event_ntfn_sender, _event_ntfn_receiver) = mpsc::channel(2);
455 let peer_manager_connection_handler = peer_manager.clone();
456 let event_notifier = event_ntfn_sender.clone();
457 let listening_port = args.ldk_peer_listening_port;
458 tokio::spawn(async move {
459 let listener = std::net::TcpListener::bind(format!("0.0.0.0:{}", listening_port)).unwrap();
461 let tcp_stream = listener.accept().unwrap().0;
462 lightning_net_tokio::setup_inbound(
463 peer_manager_connection_handler.clone(),
464 event_notifier.clone(),
471 // Step 17: Connect and Disconnect Blocks
472 if chain_tip.is_none() {
474 Some(init::validate_best_block_header(&mut bitcoind_client.deref()).await.unwrap());
476 let channel_manager_listener = channel_manager.clone();
477 let chain_monitor_listener = chain_monitor.clone();
478 let bitcoind_block_source = bitcoind_client.clone();
479 let network = args.network;
480 tokio::spawn(async move {
481 let mut derefed = bitcoind_block_source.deref();
482 let chain_poller = poll::ChainPoller::new(&mut derefed, network);
483 let chain_listener = (chain_monitor_listener, channel_manager_listener);
485 SpvClient::new(chain_tip.unwrap(), chain_poller, &mut cache, &chain_listener);
487 spv_client.poll_best_tip().await.unwrap();
488 tokio::time::sleep(Duration::from_secs(1)).await;
492 // Step 17 & 18: Initialize ChannelManager persistence & Once Per Minute: ChannelManager's
493 // timer_chan_freshness_every_min() and PeerManager's timer_tick_occurred
494 let data_dir = ldk_data_dir.clone();
495 let persist_channel_manager_callback =
496 move |node: &ChannelManager| FilesystemPersister::persist_manager(data_dir.clone(), &*node);
497 BackgroundProcessor::start(
498 persist_channel_manager_callback,
499 channel_manager.clone(),
500 peer_manager.clone(),
504 // Step 15: Initialize LDK Event Handling
505 let channel_manager_event_listener = channel_manager.clone();
506 let chain_monitor_event_listener = chain_monitor.clone();
507 let keys_manager_listener = keys_manager.clone();
508 // TODO: persist payment info to disk
509 let inbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
510 let outbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
511 let inbound_pmts_for_events = inbound_payments.clone();
512 let outbound_pmts_for_events = outbound_payments.clone();
513 let network = args.network;
514 let bitcoind_rpc = bitcoind_client.clone();
515 tokio::spawn(async move {
517 channel_manager_event_listener,
518 chain_monitor_event_listener,
520 keys_manager_listener,
521 inbound_pmts_for_events,
522 outbound_pmts_for_events,
528 // Reconnect to channel peers if possible.
529 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
530 match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
532 for (pubkey, peer_addr) in info.drain() {
533 for chan_info in channel_manager.list_channels() {
534 if pubkey == chan_info.remote_network_id {
535 let _ = cli::connect_peer_if_necessary(
538 peer_manager.clone(),
539 event_ntfn_sender.clone(),
545 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
549 cli::poll_for_user_input(
550 peer_manager.clone(),
551 channel_manager.clone(),
555 keys_manager.get_node_secret(),
557 ldk_data_dir.clone(),
565 pub async fn main() {