7 use lightning_background_processor::BackgroundProcessor;
8 use bitcoin::BlockHash;
9 use bitcoin::blockdata::constants::genesis_block;
10 use bitcoin::blockdata::transaction::Transaction;
11 use bitcoin::consensus::encode;
12 use bitcoin::hashes::Hash;
13 use bitcoin::hashes::sha256::Hash as Sha256;
14 use bitcoin::network::constants::Network;
15 use bitcoin::secp256k1::Secp256k1;
16 use bitcoin_bech32::WitnessProgram;
17 use crate::bitcoind_client::BitcoindClient;
18 use crate::disk::FilesystemLogger;
20 use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
21 use lightning::chain::chainmonitor::ChainMonitor;
22 use lightning::chain::Filter;
23 use lightning::chain::keysinterface::{InMemorySigner, KeysInterface, KeysManager};
24 use lightning::chain::transaction::OutPoint;
25 use lightning::chain::Watch;
26 use lightning::ln::channelmanager;
27 use lightning::ln::channelmanager::{ChainParameters, ChannelManagerReadArgs, PaymentHash, PaymentPreimage,
28 SimpleArcChannelManager};
29 use lightning::ln::peer_handler::{MessageHandler, SimpleArcPeerManager};
30 use lightning::util::config::UserConfig;
31 use lightning::util::events::{Event, EventsProvider};
32 use lightning::util::ser::ReadableArgs;
33 use lightning_block_sync::UnboundedCache;
34 use lightning_block_sync::SpvClient;
35 use lightning_block_sync::init;
36 use lightning_block_sync::poll;
37 use lightning_net_tokio::SocketDescriptor;
38 use lightning_persister::FilesystemPersister;
39 use rand::{thread_rng, Rng};
40 use lightning::routing::network_graph::NetGraphMsgHandler;
41 use std::collections::HashMap;
48 use std::sync::{Arc, Mutex};
50 use std::time::{Duration, SystemTime};
51 use tokio::runtime::Runtime;
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")
78 pub(crate) type PaymentInfoStorage = Arc<Mutex<HashMap<PaymentHash, (Option<PaymentPreimage>,
79 HTLCDirection, HTLCStatus,
82 type ArcChainMonitor = ChainMonitor<InMemorySigner, Arc<dyn Filter>, Arc<BitcoindClient>,
83 Arc<BitcoindClient>, Arc<FilesystemLogger>, Arc<FilesystemPersister>>;
85 pub(crate) type PeerManager = SimpleArcPeerManager<SocketDescriptor, ArcChainMonitor, BitcoindClient,
86 BitcoindClient, dyn chain::Access, FilesystemLogger>;
88 pub(crate) type ChannelManager = SimpleArcChannelManager<ArcChainMonitor, BitcoindClient, BitcoindClient,
91 fn handle_ldk_events(peer_manager: Arc<PeerManager>, channel_manager: Arc<ChannelManager>,
92 chain_monitor: Arc<ArcChainMonitor>, bitcoind_client: Arc<BitcoindClient>,
93 keys_manager: Arc<KeysManager>, payment_storage: PaymentInfoStorage,
96 let mut pending_txs: HashMap<OutPoint, Transaction> = HashMap::new();
98 peer_manager.process_events();
99 let loop_channel_manager = channel_manager.clone();
100 let mut events = channel_manager.get_and_clear_pending_events();
101 events.append(&mut chain_monitor.get_and_clear_pending_events());
102 for event in events {
104 Event::FundingGenerationReady { temporary_channel_id, channel_value_satoshis,
105 output_script, .. } => {
106 // Construct the raw transaction with one output, that is paid the amount of the
108 let addr = WitnessProgram::from_scriptpubkey(&output_script[..], match network {
109 Network::Bitcoin => bitcoin_bech32::constants::Network::Bitcoin,
110 Network::Testnet => bitcoin_bech32::constants::Network::Testnet,
111 Network::Regtest => bitcoin_bech32::constants::Network::Regtest,
112 Network::Signet => panic!("Signet unsupported"),
114 ).expect("Lightning funding tx should always be to a SegWit output").to_address();
115 let mut outputs = vec![HashMap::with_capacity(1)];
116 outputs[0].insert(addr, channel_value_satoshis as f64 / 100_000_000.0);
117 let raw_tx = bitcoind_client.create_raw_transaction(outputs);
119 // Have your wallet put the inputs into the transaction such that the output is
121 let funded_tx = bitcoind_client.fund_raw_transaction(raw_tx);
122 let change_output_position = funded_tx.changepos;
123 assert!(change_output_position == 0 || change_output_position == 1);
125 // Sign the final funding transaction and broadcast it.
126 let signed_tx = bitcoind_client.sign_raw_transaction_with_wallet(funded_tx.hex);
127 assert_eq!(signed_tx.complete, true);
128 let final_tx: Transaction = encode::deserialize(&hex_utils::to_vec(&signed_tx.hex).unwrap()).unwrap();
129 let outpoint = OutPoint {
130 txid: final_tx.txid(),
131 index: if change_output_position == 0 { 1 } else { 0 }
133 // Give the funding transaction back to LDK for opening the channel.
134 loop_channel_manager.funding_transaction_generated(&temporary_channel_id,
136 pending_txs.insert(outpoint, final_tx);
138 Event::FundingBroadcastSafe { funding_txo, .. } => {
139 let funding_tx = pending_txs.remove(&funding_txo).unwrap();
140 bitcoind_client.broadcast_transaction(&funding_tx);
141 println!("\nEVENT: broadcasted funding transaction");
142 print!("> "); io::stdout().flush().unwrap();
144 Event::PaymentReceived { payment_hash, payment_secret, amt: amt_msat } => {
145 let mut payments = payment_storage.lock().unwrap();
146 if let Some((Some(preimage), _, _, _)) = payments.get(&payment_hash) {
147 assert!(loop_channel_manager.claim_funds(preimage.clone(), &payment_secret,
149 println!("\nEVENT: received payment from payment_hash {} of {} satoshis",
150 hex_utils::hex_str(&payment_hash.0), amt_msat / 1000);
151 print!("> "); io::stdout().flush().unwrap();
152 let (_, _, ref mut status, _) = payments.get_mut(&payment_hash).unwrap();
153 *status = HTLCStatus::Succeeded;
155 println!("\nERROR: we received a payment but didn't know the preimage");
156 print!("> "); io::stdout().flush().unwrap();
157 loop_channel_manager.fail_htlc_backwards(&payment_hash, &payment_secret);
158 payments.insert(payment_hash, (None, HTLCDirection::Inbound,
159 HTLCStatus::Failed, SatoshiAmount(None)));
162 Event::PaymentSent { payment_preimage } => {
163 let hashed = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
164 let mut payments = payment_storage.lock().unwrap();
165 for (payment_hash, (preimage_option, _, status, amt_sat)) in payments.iter_mut() {
166 if *payment_hash == hashed {
167 *preimage_option = Some(payment_preimage);
168 *status = HTLCStatus::Succeeded;
169 println!("\nNEW EVENT: successfully sent payment of {} satoshis from \
170 payment hash {:?} with preimage {:?}", amt_sat,
171 hex_utils::hex_str(&payment_hash.0),
172 hex_utils::hex_str(&payment_preimage.0));
173 print!("> "); io::stdout().flush().unwrap();
177 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
178 print!("\nNEW EVENT: Failed to send payment to payment hash {:?}: ",
179 hex_utils::hex_str(&payment_hash.0));
180 if rejected_by_dest {
181 println!("rejected by destination node");
183 println!("route failed");
185 print!("> "); io::stdout().flush().unwrap();
187 let mut payments = payment_storage.lock().unwrap();
188 if payments.contains_key(&payment_hash) {
189 let (_, _, ref mut status, _) = payments.get_mut(&payment_hash).unwrap();
190 *status = HTLCStatus::Failed;
193 Event::PendingHTLCsForwardable { time_forwardable } => {
194 let forwarding_channel_manager = loop_channel_manager.clone();
195 thread::spawn(move || {
196 let min = time_forwardable.as_secs();
197 let seconds_to_sleep = thread_rng().gen_range(min, min * 5);
198 thread::sleep(Duration::new(seconds_to_sleep, 0));
199 forwarding_channel_manager.process_pending_htlc_forwards();
202 Event::SpendableOutputs { outputs } => {
203 let destination_address = bitcoind_client.get_new_address();
204 let output_descriptors = &outputs.iter().map(|a| a).collect::<Vec<_>>();
205 let tx_feerate = bitcoind_client.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
206 let spending_tx = keys_manager.spend_spendable_outputs(output_descriptors,
208 destination_address.script_pubkey(),
209 tx_feerate, &Secp256k1::new()).unwrap();
210 bitcoind_client.broadcast_transaction(&spending_tx);
211 // XXX maybe need to rescan and blah?
215 thread::sleep(Duration::new(1, 0));
220 let args = match cli::parse_startup_args() {
221 Ok(user_args) => user_args,
225 // Initialize the LDK data directory if necessary.
226 let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
227 fs::create_dir_all(ldk_data_dir.clone()).unwrap();
229 // Initialize our bitcoind client.
230 let bitcoind_client = match BitcoindClient::new(args.bitcoind_rpc_host.clone(),
231 args.bitcoind_rpc_port, args.bitcoind_rpc_username.clone(),
232 args.bitcoind_rpc_password.clone()) {
233 Ok(client) => Arc::new(client),
235 println!("Failed to connect to bitcoind client: {}", e);
239 let mut bitcoind_rpc_client = bitcoind_client.get_new_rpc_client().unwrap();
242 // Step 1: Initialize the FeeEstimator
244 // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
245 let fee_estimator = bitcoind_client.clone();
247 // Step 2: Initialize the Logger
248 let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
250 // Step 3: Initialize the BroadcasterInterface
252 // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
254 let broadcaster = bitcoind_client.clone();
256 // Step 4: Initialize Persist
257 let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
259 // Step 5: Initialize the ChainMonitor
260 let chain_monitor: Arc<ArcChainMonitor> = Arc::new(ChainMonitor::new(None, broadcaster.clone(),
261 logger.clone(), fee_estimator.clone(),
264 // Step 6: Initialize the KeysManager
266 // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
267 // other secret key material.
268 let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
269 let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
270 assert_eq!(seed.len(), 32);
271 let mut key = [0; 32];
272 key.copy_from_slice(&seed);
275 let mut key = [0; 32];
276 thread_rng().fill_bytes(&mut key);
277 let mut f = File::create(keys_seed_path).unwrap();
278 f.write_all(&key).expect("Failed to write node keys seed to disk");
279 f.sync_all().expect("Failed to sync node keys seed to disk");
282 let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
283 let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
285 // Step 7: Read ChannelMonitor state from disk
286 let monitors_path = format!("{}/monitors", ldk_data_dir.clone());
287 let mut outpoint_to_channelmonitor = disk::read_channelmonitors(monitors_path.to_string(),
288 keys_manager.clone()).unwrap();
290 // Step 9: Initialize the ChannelManager
291 let user_config = UserConfig::default();
292 let runtime = Runtime::new().unwrap();
293 let mut restarting_node = true;
294 let (channel_manager_blockhash, mut channel_manager) = {
295 if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
296 let mut channel_monitor_mut_references = Vec::new();
297 for (_, channel_monitor) in outpoint_to_channelmonitor.iter_mut() {
298 channel_monitor_mut_references.push(&mut channel_monitor.1);
300 let read_args = ChannelManagerReadArgs::new(keys_manager.clone(), fee_estimator.clone(),
301 chain_monitor.clone(), broadcaster.clone(),
302 logger.clone(), user_config,
303 channel_monitor_mut_references);
304 <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
305 } else { // We're starting a fresh node.
306 restarting_node = false;
307 let getinfo_resp = bitcoind_client.get_blockchain_info();
308 let chain_params = ChainParameters {
309 network: args.network,
310 latest_hash: getinfo_resp.latest_blockhash,
311 latest_height: getinfo_resp.latest_height,
313 let fresh_channel_manager = channelmanager::ChannelManager::new(fee_estimator.clone(),
314 chain_monitor.clone(),
317 keys_manager.clone(),
318 user_config, chain_params);
319 (getinfo_resp.latest_blockhash, fresh_channel_manager)
323 // Step 10: Sync ChannelMonitors and ChannelManager to chain tip
324 let mut chain_listener_channel_monitors = Vec::new();
325 let mut cache = UnboundedCache::new();
326 let mut chain_tip: Option<poll::ValidatedBlockHeader> = None;
328 let mut chain_listeners = vec![
329 (channel_manager_blockhash, &mut channel_manager as &mut dyn chain::Listen)];
331 for (outpoint, blockhash_and_monitor) in outpoint_to_channelmonitor.drain() {
332 let blockhash = blockhash_and_monitor.0;
333 let channel_monitor = blockhash_and_monitor.1;
334 chain_listener_channel_monitors.push((blockhash, (channel_monitor,
335 broadcaster.clone(), fee_estimator.clone(),
336 logger.clone()), outpoint));
339 for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
340 chain_listeners.push((monitor_listener_info.0,
341 &mut monitor_listener_info.1 as &mut dyn chain::Listen));
343 chain_tip = Some(runtime.block_on(init::synchronize_listeners(&mut bitcoind_rpc_client, args.network,
344 &mut cache, chain_listeners)).unwrap());
347 // Step 11: Give ChannelMonitors to ChainMonitor
348 for item in chain_listener_channel_monitors.drain(..) {
349 let channel_monitor = item.1.0;
350 let funding_outpoint = item.2;
351 chain_monitor.watch_channel(funding_outpoint, channel_monitor).unwrap();
354 // Step 13: Optional: Initialize the NetGraphMsgHandler
355 // XXX persist routing data
356 let genesis = genesis_block(args.network).header.block_hash();
357 let router = Arc::new(NetGraphMsgHandler::new(genesis, None::<Arc<dyn chain::Access>>, logger.clone()));
359 // Step 14: Initialize the PeerManager
360 let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
361 let mut ephemeral_bytes = [0; 32];
362 rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
363 let lightning_msg_handler = MessageHandler { chan_handler: channel_manager.clone(),
364 route_handler: router.clone() };
365 let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(lightning_msg_handler,
366 keys_manager.get_node_secret(),
367 &ephemeral_bytes, logger.clone()));
370 // Step 16: Initialize Peer Connection Handling
372 // We poll for events in handle_ldk_events(..) rather than waiting for them over the
373 // mpsc::channel, so we can leave the event receiver as unused.
374 let (event_ntfn_sender, mut _event_ntfn_receiver) = mpsc::channel(2);
375 let peer_manager_connection_handler = peer_manager.clone();
376 let event_notifier = event_ntfn_sender.clone();
377 let listening_port = args.ldk_peer_listening_port;
378 runtime.spawn(async move {
379 let listener = std::net::TcpListener::bind(format!("0.0.0.0:{}", listening_port)).unwrap();
381 let tcp_stream = listener.accept().unwrap().0;
382 lightning_net_tokio::setup_inbound(peer_manager_connection_handler.clone(),
383 event_notifier.clone(), tcp_stream).await;
387 // Step 17: Connect and Disconnect Blocks
388 if chain_tip.is_none() {
389 chain_tip = Some(runtime.block_on(init::validate_best_block_header(&mut bitcoind_rpc_client)).unwrap());
391 let channel_manager_listener = channel_manager.clone();
392 let chain_monitor_listener = chain_monitor.clone();
393 let network = args.network;
394 runtime.spawn(async move {
395 let chain_poller = poll::ChainPoller::new(&mut bitcoind_rpc_client, network);
396 let chain_listener = (chain_monitor_listener, channel_manager_listener);
397 let mut spv_client = SpvClient::new(chain_tip.unwrap(), chain_poller, &mut cache,
400 spv_client.poll_best_tip().await.unwrap();
401 thread::sleep(Duration::new(1, 0));
405 // Step 17 & 18: Initialize ChannelManager persistence & Once Per Minute: ChannelManager's
406 // timer_chan_freshness_every_min() and PeerManager's timer_tick_occurred
407 let runtime_handle = runtime.handle();
408 let data_dir = ldk_data_dir.clone();
409 let persist_channel_manager_callback = move |node: &ChannelManager| {
410 FilesystemPersister::persist_manager(data_dir.clone(), &*node)
412 BackgroundProcessor::start(persist_channel_manager_callback, channel_manager.clone(),
415 let peer_manager_processor = peer_manager.clone();
416 runtime_handle.spawn(async move {
418 peer_manager_processor.timer_tick_occurred();
419 thread::sleep(Duration::new(60, 0));
423 // Step 15: Initialize LDK Event Handling
424 let peer_manager_event_listener = peer_manager.clone();
425 let channel_manager_event_listener = channel_manager.clone();
426 let chain_monitor_event_listener = chain_monitor.clone();
427 let keys_manager_listener = keys_manager.clone();
428 let payment_info: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
429 let payment_info_for_events = payment_info.clone();
430 let handle = runtime_handle.clone();
431 let network = args.network;
432 thread::spawn(move || {
433 handle_ldk_events(peer_manager_event_listener, channel_manager_event_listener,
434 chain_monitor_event_listener, bitcoind_client.clone(),
435 keys_manager_listener, payment_info_for_events, network);
438 // Reconnect to channel peers if possible.
439 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
440 match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
442 for (pubkey, peer_addr) in info.drain() {
443 let _ = cli::connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone(),
444 event_ntfn_sender.clone(), handle.clone());
447 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
451 cli::poll_for_user_input(peer_manager.clone(), channel_manager.clone(), router.clone(),
452 payment_info, keys_manager.get_node_secret(), event_ntfn_sender,
453 ldk_data_dir.clone(), logger.clone(), handle, args.network);