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::transaction::OutPoint;
23 use lightning::chain::Filter;
24 use lightning::chain::Watch;
25 use lightning::ln::channelmanager;
26 use lightning::ln::channelmanager::{
27 ChainParameters, ChannelManagerReadArgs, PaymentHash, PaymentPreimage, 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;
55 pub(crate) enum HTLCDirection {
60 pub(crate) enum HTLCStatus {
66 pub(crate) struct SatoshiAmount(Option<u64>);
68 impl fmt::Display for SatoshiAmount {
69 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
71 Some(amt) => write!(f, "{}", amt),
72 None => write!(f, "unknown"),
77 pub(crate) type PaymentInfoStorage = Arc<
79 HashMap<PaymentHash, (Option<PaymentPreimage>, HTLCDirection, HTLCStatus, SatoshiAmount)>,
83 type ChainMonitor = chainmonitor::ChainMonitor<
88 Arc<FilesystemLogger>,
89 Arc<FilesystemPersister>,
92 pub(crate) type PeerManager = SimpleArcPeerManager<
101 pub(crate) type ChannelManager =
102 SimpleArcChannelManager<ChainMonitor, BitcoindClient, BitcoindClient, FilesystemLogger>;
104 async fn handle_ldk_events(
105 peer_manager: Arc<PeerManager>, channel_manager: Arc<ChannelManager>,
106 chain_monitor: Arc<ChainMonitor>, bitcoind_client: Arc<BitcoindClient>,
107 keys_manager: Arc<KeysManager>, payment_storage: PaymentInfoStorage, network: Network,
109 let mut pending_txs: HashMap<OutPoint, Transaction> = HashMap::new();
111 peer_manager.process_events();
112 let loop_channel_manager = channel_manager.clone();
113 let mut events = channel_manager.get_and_clear_pending_events();
114 events.append(&mut chain_monitor.get_and_clear_pending_events());
115 for event in events {
117 Event::FundingGenerationReady {
118 temporary_channel_id,
119 channel_value_satoshis,
123 // Construct the raw transaction with one output, that is paid the amount of the
125 let addr = WitnessProgram::from_scriptpubkey(
128 Network::Bitcoin => bitcoin_bech32::constants::Network::Bitcoin,
129 Network::Testnet => bitcoin_bech32::constants::Network::Testnet,
130 Network::Regtest => bitcoin_bech32::constants::Network::Regtest,
131 Network::Signet => panic!("Signet unsupported"),
134 .expect("Lightning funding tx should always be to a SegWit output")
136 let mut outputs = vec![HashMap::with_capacity(1)];
137 outputs[0].insert(addr, channel_value_satoshis as f64 / 100_000_000.0);
138 let raw_tx = bitcoind_client.create_raw_transaction(outputs).await;
140 // Have your wallet put the inputs into the transaction such that the output is
142 let funded_tx = bitcoind_client.fund_raw_transaction(raw_tx).await;
143 let change_output_position = funded_tx.changepos;
144 assert!(change_output_position == 0 || change_output_position == 1);
146 // Sign the final funding transaction and broadcast it.
148 bitcoind_client.sign_raw_transaction_with_wallet(funded_tx.hex).await;
149 assert_eq!(signed_tx.complete, true);
150 let final_tx: Transaction =
151 encode::deserialize(&hex_utils::to_vec(&signed_tx.hex).unwrap()).unwrap();
152 let outpoint = OutPoint {
153 txid: final_tx.txid(),
154 index: if change_output_position == 0 { 1 } else { 0 },
156 // Give the funding transaction back to LDK for opening the channel.
158 .funding_transaction_generated(&temporary_channel_id, outpoint);
159 pending_txs.insert(outpoint, final_tx);
161 Event::FundingBroadcastSafe { funding_txo, .. } => {
162 let funding_tx = pending_txs.remove(&funding_txo).unwrap();
163 bitcoind_client.broadcast_transaction(&funding_tx);
164 println!("\nEVENT: broadcasted funding transaction");
166 io::stdout().flush().unwrap();
168 Event::PaymentReceived { payment_hash, payment_secret, amt: amt_msat } => {
169 let mut payments = payment_storage.lock().unwrap();
170 if let Some((Some(preimage), _, _, _)) = payments.get(&payment_hash) {
171 assert!(loop_channel_manager.claim_funds(
177 "\nEVENT: received payment from payment_hash {} of {} satoshis",
178 hex_utils::hex_str(&payment_hash.0),
182 io::stdout().flush().unwrap();
183 let (_, _, ref mut status, _) = payments.get_mut(&payment_hash).unwrap();
184 *status = HTLCStatus::Succeeded;
186 println!("\nERROR: we received a payment but didn't know the preimage");
188 io::stdout().flush().unwrap();
189 loop_channel_manager.fail_htlc_backwards(&payment_hash, &payment_secret);
192 (None, HTLCDirection::Inbound, HTLCStatus::Failed, SatoshiAmount(None)),
196 Event::PaymentSent { payment_preimage } => {
197 let hashed = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
198 let mut payments = payment_storage.lock().unwrap();
199 for (payment_hash, (preimage_option, _, status, amt_sat)) in payments.iter_mut()
201 if *payment_hash == hashed {
202 *preimage_option = Some(payment_preimage);
203 *status = HTLCStatus::Succeeded;
205 "\nEVENT: successfully sent payment of {} satoshis from \
206 payment hash {:?} with preimage {:?}",
208 hex_utils::hex_str(&payment_hash.0),
209 hex_utils::hex_str(&payment_preimage.0)
212 io::stdout().flush().unwrap();
216 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
218 "\nEVENT: Failed to send payment to payment hash {:?}: ",
219 hex_utils::hex_str(&payment_hash.0)
221 if rejected_by_dest {
222 println!("rejected by destination node");
224 println!("route failed");
227 io::stdout().flush().unwrap();
229 let mut payments = payment_storage.lock().unwrap();
230 if payments.contains_key(&payment_hash) {
231 let (_, _, ref mut status, _) = payments.get_mut(&payment_hash).unwrap();
232 *status = HTLCStatus::Failed;
235 Event::PendingHTLCsForwardable { time_forwardable } => {
236 let forwarding_channel_manager = loop_channel_manager.clone();
237 tokio::spawn(async move {
238 let min = time_forwardable.as_secs();
239 let seconds_to_sleep = thread_rng().gen_range(min, min * 5);
240 tokio::time::sleep(Duration::from_secs(seconds_to_sleep)).await;
241 forwarding_channel_manager.process_pending_htlc_forwards();
244 Event::SpendableOutputs { outputs } => {
245 let destination_address = bitcoind_client.get_new_address().await;
246 let output_descriptors = &outputs.iter().map(|a| a).collect::<Vec<_>>();
248 bitcoind_client.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
249 let spending_tx = keys_manager
250 .spend_spendable_outputs(
253 destination_address.script_pubkey(),
258 bitcoind_client.broadcast_transaction(&spending_tx);
259 // XXX maybe need to rescan and blah?
263 tokio::time::sleep(Duration::from_secs(1)).await;
268 pub async fn main() {
269 let args = match cli::parse_startup_args() {
270 Ok(user_args) => user_args,
274 // Initialize the LDK data directory if necessary.
275 let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
276 fs::create_dir_all(ldk_data_dir.clone()).unwrap();
278 // Initialize our bitcoind client.
279 let bitcoind_client = match BitcoindClient::new(
280 args.bitcoind_rpc_host.clone(),
281 args.bitcoind_rpc_port,
282 args.bitcoind_rpc_username.clone(),
283 args.bitcoind_rpc_password.clone(),
287 Ok(client) => Arc::new(client),
289 println!("Failed to connect to bitcoind client: {}", e);
295 // Step 1: Initialize the FeeEstimator
297 // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
298 let fee_estimator = bitcoind_client.clone();
300 // Step 2: Initialize the Logger
301 let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
303 // Step 3: Initialize the BroadcasterInterface
305 // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
307 let broadcaster = bitcoind_client.clone();
309 // Step 4: Initialize Persist
310 let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
312 // Step 5: Initialize the ChainMonitor
313 let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
317 fee_estimator.clone(),
321 // Step 6: Initialize the KeysManager
323 // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
324 // other secret key material.
325 let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
326 let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
327 assert_eq!(seed.len(), 32);
328 let mut key = [0; 32];
329 key.copy_from_slice(&seed);
332 let mut key = [0; 32];
333 thread_rng().fill_bytes(&mut key);
334 match File::create(keys_seed_path.clone()) {
336 f.write_all(&key).expect("Failed to write node keys seed to disk");
337 f.sync_all().expect("Failed to sync node keys seed to disk");
340 println!("ERROR: Unable to create keys seed file {}: {}", keys_seed_path, e);
346 let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
347 let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
349 // Step 7: Read ChannelMonitor state from disk
350 let monitors_path = format!("{}/monitors", ldk_data_dir.clone());
351 let mut outpoint_to_channelmonitor =
352 disk::read_channelmonitors(monitors_path.to_string(), keys_manager.clone()).unwrap();
354 // Step 9: Initialize the ChannelManager
355 let user_config = UserConfig::default();
356 let mut restarting_node = true;
357 let (channel_manager_blockhash, mut channel_manager) = {
358 if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
359 let mut channel_monitor_mut_references = Vec::new();
360 for (_, channel_monitor) in outpoint_to_channelmonitor.iter_mut() {
361 channel_monitor_mut_references.push(&mut channel_monitor.1);
363 let read_args = ChannelManagerReadArgs::new(
364 keys_manager.clone(),
365 fee_estimator.clone(),
366 chain_monitor.clone(),
370 channel_monitor_mut_references,
372 <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
374 // We're starting a fresh node.
375 restarting_node = false;
376 let getinfo_resp = bitcoind_client.get_blockchain_info().await;
378 let chain_params = ChainParameters {
379 network: args.network,
380 latest_hash: getinfo_resp.latest_blockhash,
381 latest_height: getinfo_resp.latest_height,
383 let fresh_channel_manager = channelmanager::ChannelManager::new(
384 fee_estimator.clone(),
385 chain_monitor.clone(),
388 keys_manager.clone(),
392 (getinfo_resp.latest_blockhash, fresh_channel_manager)
396 // Step 10: Sync ChannelMonitors and ChannelManager to chain tip
397 let mut chain_listener_channel_monitors = Vec::new();
398 let mut cache = UnboundedCache::new();
399 let mut chain_tip: Option<poll::ValidatedBlockHeader> = None;
401 let mut chain_listeners =
402 vec![(channel_manager_blockhash, &mut channel_manager as &mut dyn chain::Listen)];
404 for (outpoint, blockhash_and_monitor) in outpoint_to_channelmonitor.drain() {
405 let blockhash = blockhash_and_monitor.0;
406 let channel_monitor = blockhash_and_monitor.1;
407 chain_listener_channel_monitors.push((
409 (channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()),
414 for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
415 chain_listeners.push((
416 monitor_listener_info.0,
417 &mut monitor_listener_info.1 as &mut dyn chain::Listen,
421 init::synchronize_listeners(
422 &mut bitcoind_client.deref(),
432 // Step 11: Give ChannelMonitors to ChainMonitor
433 for item in chain_listener_channel_monitors.drain(..) {
434 let channel_monitor = item.1 .0;
435 let funding_outpoint = item.2;
436 chain_monitor.watch_channel(funding_outpoint, channel_monitor).unwrap();
439 // Step 13: Optional: Initialize the NetGraphMsgHandler
440 // XXX persist routing data
441 let genesis = genesis_block(args.network).header.block_hash();
443 Arc::new(NetGraphMsgHandler::new(genesis, None::<Arc<dyn chain::Access>>, logger.clone()));
445 // Step 14: Initialize the PeerManager
446 let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
447 let mut ephemeral_bytes = [0; 32];
448 rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
449 let lightning_msg_handler =
450 MessageHandler { chan_handler: channel_manager.clone(), route_handler: router.clone() };
451 let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
452 lightning_msg_handler,
453 keys_manager.get_node_secret(),
459 // Step 16: Initialize Peer Connection Handling
461 // We poll for events in handle_ldk_events(..) rather than waiting for them over the
462 // mpsc::channel, so we can leave the event receiver as unused.
463 let (event_ntfn_sender, _event_ntfn_receiver) = mpsc::channel(2);
464 let peer_manager_connection_handler = peer_manager.clone();
465 let event_notifier = event_ntfn_sender.clone();
466 let listening_port = args.ldk_peer_listening_port;
467 tokio::spawn(async move {
468 let listener = std::net::TcpListener::bind(format!("0.0.0.0:{}", listening_port)).unwrap();
470 let tcp_stream = listener.accept().unwrap().0;
471 lightning_net_tokio::setup_inbound(
472 peer_manager_connection_handler.clone(),
473 event_notifier.clone(),
480 // Step 17: Connect and Disconnect Blocks
481 if chain_tip.is_none() {
483 Some(init::validate_best_block_header(&mut bitcoind_client.deref()).await.unwrap());
485 let channel_manager_listener = channel_manager.clone();
486 let chain_monitor_listener = chain_monitor.clone();
487 let bitcoind_block_source = bitcoind_client.clone();
488 let network = args.network;
489 tokio::spawn(async move {
490 let mut derefed = bitcoind_block_source.deref();
491 let chain_poller = poll::ChainPoller::new(&mut derefed, network);
492 let chain_listener = (chain_monitor_listener, channel_manager_listener);
494 SpvClient::new(chain_tip.unwrap(), chain_poller, &mut cache, &chain_listener);
496 spv_client.poll_best_tip().await.unwrap();
497 tokio::time::sleep(Duration::from_secs(1)).await;
501 // Step 17 & 18: Initialize ChannelManager persistence & Once Per Minute: ChannelManager's
502 // timer_chan_freshness_every_min() and PeerManager's timer_tick_occurred
503 let data_dir = ldk_data_dir.clone();
504 let persist_channel_manager_callback =
505 move |node: &ChannelManager| FilesystemPersister::persist_manager(data_dir.clone(), &*node);
506 BackgroundProcessor::start(
507 persist_channel_manager_callback,
508 channel_manager.clone(),
512 let peer_manager_processor = peer_manager.clone();
513 tokio::spawn(async move {
515 peer_manager_processor.timer_tick_occurred();
516 tokio::time::sleep(Duration::from_secs(60)).await;
520 // Step 15: Initialize LDK Event Handling
521 let peer_manager_event_listener = peer_manager.clone();
522 let channel_manager_event_listener = channel_manager.clone();
523 let chain_monitor_event_listener = chain_monitor.clone();
524 let keys_manager_listener = keys_manager.clone();
525 let payment_info: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
526 let payment_info_for_events = payment_info.clone();
527 let network = args.network;
528 let bitcoind_rpc = bitcoind_client.clone();
529 tokio::spawn(async move {
531 peer_manager_event_listener,
532 channel_manager_event_listener,
533 chain_monitor_event_listener,
535 keys_manager_listener,
536 payment_info_for_events,
542 // Reconnect to channel peers if possible.
543 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
544 match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
546 for (pubkey, peer_addr) in info.drain() {
547 for chan_info in channel_manager.list_channels() {
548 if pubkey == chan_info.remote_network_id {
549 let _ = cli::connect_peer_if_necessary(
552 peer_manager.clone(),
553 event_ntfn_sender.clone(),
559 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
563 cli::poll_for_user_input(
564 peer_manager.clone(),
565 channel_manager.clone(),
568 keys_manager.get_node_secret(),
570 ldk_data_dir.clone(),