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, .. } => {
153 let mut payments = inbound_payments.lock().unwrap();
154 if let Some(payment) = payments.get_mut(&payment_hash) {
155 assert!(loop_channel_manager.claim_funds(
156 payment.preimage.unwrap().clone(),
158 payment.amt_msat.0.unwrap(),
161 "\nEVENT: received payment from payment_hash {} of {} millisatoshis",
162 hex_utils::hex_str(&payment_hash.0),
166 io::stdout().flush().unwrap();
167 payment.status = HTLCStatus::Succeeded;
169 println!("\nERROR: we received a payment but didn't know the preimage");
171 io::stdout().flush().unwrap();
172 loop_channel_manager.fail_htlc_backwards(&payment_hash, &None);
178 status: HTLCStatus::Failed,
179 amt_msat: MillisatAmount(None),
184 Event::PaymentSent { payment_preimage } => {
185 let hashed = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
186 let mut payments = outbound_payments.lock().unwrap();
187 for (payment_hash, payment) in payments.iter_mut() {
188 if *payment_hash == hashed {
189 payment.preimage = Some(payment_preimage);
190 payment.status = HTLCStatus::Succeeded;
192 "\nEVENT: successfully sent payment of {} millisatoshis 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 = outbound_payments.lock().unwrap();
217 if payments.contains_key(&payment_hash) {
218 let payment = payments.get_mut(&payment_hash).unwrap();
219 payment.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 // Step 15: Initialize LDK Event Handling
496 let channel_manager_event_listener = channel_manager.clone();
497 let chain_monitor_event_listener = chain_monitor.clone();
498 let keys_manager_listener = keys_manager.clone();
499 // TODO: persist payment info to disk
500 let inbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
501 let outbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
502 let inbound_pmts_for_events = inbound_payments.clone();
503 let outbound_pmts_for_events = outbound_payments.clone();
504 let network = args.network;
505 let bitcoind_rpc = bitcoind_client.clone();
506 tokio::spawn(async move {
508 channel_manager_event_listener,
509 chain_monitor_event_listener,
511 keys_manager_listener,
512 inbound_pmts_for_events,
513 outbound_pmts_for_events,
519 // Reconnect to channel peers if possible.
520 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
521 match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
523 for (pubkey, peer_addr) in info.drain() {
524 for chan_info in channel_manager.list_channels() {
525 if pubkey == chan_info.remote_network_id {
526 let _ = cli::connect_peer_if_necessary(
529 peer_manager.clone(),
530 event_ntfn_sender.clone(),
536 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
540 cli::poll_for_user_input(
541 peer_manager.clone(),
542 channel_manager.clone(),
546 keys_manager.get_node_secret(),
548 ldk_data_dir.clone(),
556 pub async fn main() {