Remove `chain_tip`'s unneeded `Option`
[ldk-sample] / src / main.rs
1 pub mod bitcoind_client;
2 mod cli;
3 mod convert;
4 mod disk;
5 mod hex_utils;
6
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::network::constants::Network;
13 use bitcoin::secp256k1::Secp256k1;
14 use bitcoin::BlockHash;
15 use bitcoin_bech32::WitnessProgram;
16 use lightning::chain;
17 use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
18 use lightning::chain::keysinterface::{InMemorySigner, KeysInterface, KeysManager, Recipient};
19 use lightning::chain::{chainmonitor, ChannelMonitorUpdateStatus};
20 use lightning::chain::{Filter, Watch};
21 use lightning::ln::channelmanager;
22 use lightning::ln::channelmanager::{
23         ChainParameters, ChannelManagerReadArgs, SimpleArcChannelManager,
24 };
25 use lightning::ln::peer_handler::{IgnoringMessageHandler, MessageHandler, SimpleArcPeerManager};
26 use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
27 use lightning::onion_message::SimpleArcOnionMessenger;
28 use lightning::routing::gossip;
29 use lightning::routing::gossip::{NodeId, P2PGossipSync};
30 use lightning::routing::scoring::ProbabilisticScorer;
31 use lightning::util::config::UserConfig;
32 use lightning::util::events::{Event, PaymentPurpose};
33 use lightning::util::ser::ReadableArgs;
34 use lightning_background_processor::{BackgroundProcessor, GossipSync};
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_invoice::payment;
40 use lightning_invoice::utils::DefaultRouter;
41 use lightning_net_tokio::SocketDescriptor;
42 use lightning_persister::FilesystemPersister;
43 use rand::{thread_rng, Rng};
44 use std::collections::hash_map::Entry;
45 use std::collections::HashMap;
46 use std::convert::TryInto;
47 use std::fmt;
48 use std::fs;
49 use std::fs::File;
50 use std::io;
51 use std::io::Write;
52 use std::path::Path;
53 use std::sync::atomic::{AtomicBool, Ordering};
54 use std::sync::{Arc, Mutex};
55 use std::time::{Duration, SystemTime};
56
57 pub(crate) enum HTLCStatus {
58         Pending,
59         Succeeded,
60         Failed,
61 }
62
63 pub(crate) struct MillisatAmount(Option<u64>);
64
65 impl fmt::Display for MillisatAmount {
66         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
67                 match self.0 {
68                         Some(amt) => write!(f, "{}", amt),
69                         None => write!(f, "unknown"),
70                 }
71         }
72 }
73
74 pub(crate) struct PaymentInfo {
75         preimage: Option<PaymentPreimage>,
76         secret: Option<PaymentSecret>,
77         status: HTLCStatus,
78         amt_msat: MillisatAmount,
79 }
80
81 pub(crate) type PaymentInfoStorage = Arc<Mutex<HashMap<PaymentHash, PaymentInfo>>>;
82
83 type ChainMonitor = chainmonitor::ChainMonitor<
84         InMemorySigner,
85         Arc<dyn Filter + Send + Sync>,
86         Arc<BitcoindClient>,
87         Arc<BitcoindClient>,
88         Arc<FilesystemLogger>,
89         Arc<FilesystemPersister>,
90 >;
91
92 pub(crate) type PeerManager = SimpleArcPeerManager<
93         SocketDescriptor,
94         ChainMonitor,
95         BitcoindClient,
96         BitcoindClient,
97         dyn chain::Access + Send + Sync,
98         FilesystemLogger,
99 >;
100
101 pub(crate) type ChannelManager =
102         SimpleArcChannelManager<ChainMonitor, BitcoindClient, BitcoindClient, FilesystemLogger>;
103
104 pub(crate) type InvoicePayer<E> =
105         payment::InvoicePayer<Arc<ChannelManager>, Router, Arc<FilesystemLogger>, E>;
106
107 type Router = DefaultRouter<
108         Arc<NetworkGraph>,
109         Arc<FilesystemLogger>,
110         Arc<Mutex<ProbabilisticScorer<Arc<NetworkGraph>, Arc<FilesystemLogger>>>>,
111 >;
112
113 pub(crate) type NetworkGraph = gossip::NetworkGraph<Arc<FilesystemLogger>>;
114
115 type OnionMessenger = SimpleArcOnionMessenger<FilesystemLogger>;
116
117 async fn handle_ldk_events(
118         channel_manager: &Arc<ChannelManager>, bitcoind_client: &BitcoindClient,
119         network_graph: &NetworkGraph, keys_manager: &KeysManager,
120         inbound_payments: &PaymentInfoStorage, outbound_payments: &PaymentInfoStorage,
121         network: Network, event: &Event,
122 ) {
123         match event {
124                 Event::FundingGenerationReady {
125                         temporary_channel_id,
126                         counterparty_node_id,
127                         channel_value_satoshis,
128                         output_script,
129                         ..
130                 } => {
131                         // Construct the raw transaction with one output, that is paid the amount of the
132                         // channel.
133                         let addr = WitnessProgram::from_scriptpubkey(
134                                 &output_script[..],
135                                 match network {
136                                         Network::Bitcoin => bitcoin_bech32::constants::Network::Bitcoin,
137                                         Network::Testnet => bitcoin_bech32::constants::Network::Testnet,
138                                         Network::Regtest => bitcoin_bech32::constants::Network::Regtest,
139                                         Network::Signet => bitcoin_bech32::constants::Network::Signet,
140                                 },
141                         )
142                         .expect("Lightning funding tx should always be to a SegWit output")
143                         .to_address();
144                         let mut outputs = vec![HashMap::with_capacity(1)];
145                         outputs[0].insert(addr, *channel_value_satoshis as f64 / 100_000_000.0);
146                         let raw_tx = bitcoind_client.create_raw_transaction(outputs).await;
147
148                         // Have your wallet put the inputs into the transaction such that the output is
149                         // satisfied.
150                         let funded_tx = bitcoind_client.fund_raw_transaction(raw_tx).await;
151
152                         // Sign the final funding transaction and broadcast it.
153                         let signed_tx = bitcoind_client.sign_raw_transaction_with_wallet(funded_tx.hex).await;
154                         assert_eq!(signed_tx.complete, true);
155                         let final_tx: Transaction =
156                                 encode::deserialize(&hex_utils::to_vec(&signed_tx.hex).unwrap()).unwrap();
157                         // Give the funding transaction back to LDK for opening the channel.
158                         if channel_manager
159                                 .funding_transaction_generated(
160                                         &temporary_channel_id,
161                                         counterparty_node_id,
162                                         final_tx,
163                                 )
164                                 .is_err()
165                         {
166                                 println!(
167                                         "\nERROR: Channel went away before we could fund it. The peer disconnected or refused the channel.");
168                                 print!("> ");
169                                 io::stdout().flush().unwrap();
170                         }
171                 }
172                 Event::PaymentReceived { payment_hash, purpose, amount_msat } => {
173                         println!(
174                                 "\nEVENT: received payment from payment hash {} of {} millisatoshis",
175                                 hex_utils::hex_str(&payment_hash.0),
176                                 amount_msat,
177                         );
178                         print!("> ");
179                         io::stdout().flush().unwrap();
180                         let payment_preimage = match purpose {
181                                 PaymentPurpose::InvoicePayment { payment_preimage, .. } => *payment_preimage,
182                                 PaymentPurpose::SpontaneousPayment(preimage) => Some(*preimage),
183                         };
184                         channel_manager.claim_funds(payment_preimage.unwrap());
185                 }
186                 Event::PaymentClaimed { payment_hash, purpose, amount_msat } => {
187                         println!(
188                                 "\nEVENT: claimed payment from payment hash {} of {} millisatoshis",
189                                 hex_utils::hex_str(&payment_hash.0),
190                                 amount_msat,
191                         );
192                         print!("> ");
193                         io::stdout().flush().unwrap();
194                         let (payment_preimage, payment_secret) = match purpose {
195                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
196                                         (*payment_preimage, Some(*payment_secret))
197                                 }
198                                 PaymentPurpose::SpontaneousPayment(preimage) => (Some(*preimage), None),
199                         };
200                         let mut payments = inbound_payments.lock().unwrap();
201                         match payments.entry(*payment_hash) {
202                                 Entry::Occupied(mut e) => {
203                                         let payment = e.get_mut();
204                                         payment.status = HTLCStatus::Succeeded;
205                                         payment.preimage = payment_preimage;
206                                         payment.secret = payment_secret;
207                                 }
208                                 Entry::Vacant(e) => {
209                                         e.insert(PaymentInfo {
210                                                 preimage: payment_preimage,
211                                                 secret: payment_secret,
212                                                 status: HTLCStatus::Succeeded,
213                                                 amt_msat: MillisatAmount(Some(*amount_msat)),
214                                         });
215                                 }
216                         }
217                 }
218                 Event::PaymentSent { payment_preimage, payment_hash, fee_paid_msat, .. } => {
219                         let mut payments = outbound_payments.lock().unwrap();
220                         for (hash, payment) in payments.iter_mut() {
221                                 if *hash == *payment_hash {
222                                         payment.preimage = Some(*payment_preimage);
223                                         payment.status = HTLCStatus::Succeeded;
224                                         println!(
225                                                 "\nEVENT: successfully sent payment of {} millisatoshis{} from \
226                                                                  payment hash {:?} with preimage {:?}",
227                                                 payment.amt_msat,
228                                                 if let Some(fee) = fee_paid_msat {
229                                                         format!(" (fee {} msat)", fee)
230                                                 } else {
231                                                         "".to_string()
232                                                 },
233                                                 hex_utils::hex_str(&payment_hash.0),
234                                                 hex_utils::hex_str(&payment_preimage.0)
235                                         );
236                                         print!("> ");
237                                         io::stdout().flush().unwrap();
238                                 }
239                         }
240                 }
241                 Event::OpenChannelRequest { .. } => {
242                         // Unreachable, we don't set manually_accept_inbound_channels
243                 }
244                 Event::PaymentPathSuccessful { .. } => {}
245                 Event::PaymentPathFailed { .. } => {}
246                 Event::ProbeSuccessful { .. } => {}
247                 Event::ProbeFailed { .. } => {}
248                 Event::PaymentFailed { payment_hash, .. } => {
249                         print!(
250                                 "\nEVENT: Failed to send payment to payment hash {:?}: exhausted payment retry attempts",
251                                 hex_utils::hex_str(&payment_hash.0)
252                         );
253                         print!("> ");
254                         io::stdout().flush().unwrap();
255
256                         let mut payments = outbound_payments.lock().unwrap();
257                         if payments.contains_key(&payment_hash) {
258                                 let payment = payments.get_mut(&payment_hash).unwrap();
259                                 payment.status = HTLCStatus::Failed;
260                         }
261                 }
262                 Event::PaymentForwarded {
263                         prev_channel_id,
264                         next_channel_id,
265                         fee_earned_msat,
266                         claim_from_onchain_tx,
267                 } => {
268                         let read_only_network_graph = network_graph.read_only();
269                         let nodes = read_only_network_graph.nodes();
270                         let channels = channel_manager.list_channels();
271
272                         let node_str = |channel_id: &Option<[u8; 32]>| match channel_id {
273                                 None => String::new(),
274                                 Some(channel_id) => match channels.iter().find(|c| c.channel_id == *channel_id) {
275                                         None => String::new(),
276                                         Some(channel) => {
277                                                 match nodes.get(&NodeId::from_pubkey(&channel.counterparty.node_id)) {
278                                                         None => "private node".to_string(),
279                                                         Some(node) => match &node.announcement_info {
280                                                                 None => "unnamed node".to_string(),
281                                                                 Some(announcement) => {
282                                                                         format!("node {}", announcement.alias)
283                                                                 }
284                                                         },
285                                                 }
286                                         }
287                                 },
288                         };
289                         let channel_str = |channel_id: &Option<[u8; 32]>| {
290                                 channel_id
291                                         .map(|channel_id| format!(" with channel {}", hex_utils::hex_str(&channel_id)))
292                                         .unwrap_or_default()
293                         };
294                         let from_prev_str =
295                                 format!(" from {}{}", node_str(prev_channel_id), channel_str(prev_channel_id));
296                         let to_next_str =
297                                 format!(" to {}{}", node_str(next_channel_id), channel_str(next_channel_id));
298
299                         let from_onchain_str = if *claim_from_onchain_tx {
300                                 "from onchain downstream claim"
301                         } else {
302                                 "from HTLC fulfill message"
303                         };
304                         if let Some(fee_earned) = fee_earned_msat {
305                                 println!(
306                                         "\nEVENT: Forwarded payment{}{}, earning {} msat {}",
307                                         from_prev_str, to_next_str, fee_earned, from_onchain_str
308                                 );
309                         } else {
310                                 println!(
311                                         "\nEVENT: Forwarded payment{}{}, claiming onchain {}",
312                                         from_prev_str, to_next_str, from_onchain_str
313                                 );
314                         }
315                         print!("> ");
316                         io::stdout().flush().unwrap();
317                 }
318                 Event::HTLCHandlingFailed { .. } => {}
319                 Event::PendingHTLCsForwardable { time_forwardable } => {
320                         let forwarding_channel_manager = channel_manager.clone();
321                         let min = time_forwardable.as_millis() as u64;
322                         tokio::spawn(async move {
323                                 let millis_to_sleep = thread_rng().gen_range(min, min * 5) as u64;
324                                 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
325                                 forwarding_channel_manager.process_pending_htlc_forwards();
326                         });
327                 }
328                 Event::SpendableOutputs { outputs } => {
329                         let destination_address = bitcoind_client.get_new_address().await;
330                         let output_descriptors = &outputs.iter().map(|a| a).collect::<Vec<_>>();
331                         let tx_feerate =
332                                 bitcoind_client.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
333                         let spending_tx = keys_manager
334                                 .spend_spendable_outputs(
335                                         output_descriptors,
336                                         Vec::new(),
337                                         destination_address.script_pubkey(),
338                                         tx_feerate,
339                                         &Secp256k1::new(),
340                                 )
341                                 .unwrap();
342                         bitcoind_client.broadcast_transaction(&spending_tx);
343                 }
344                 Event::ChannelClosed { channel_id, reason, user_channel_id: _ } => {
345                         println!(
346                                 "\nEVENT: Channel {} closed due to: {:?}",
347                                 hex_utils::hex_str(channel_id),
348                                 reason
349                         );
350                         print!("> ");
351                         io::stdout().flush().unwrap();
352                 }
353                 Event::DiscardFunding { .. } => {
354                         // A "real" node should probably "lock" the UTXOs spent in funding transactions until
355                         // the funding transaction either confirms, or this event is generated.
356                 }
357         }
358 }
359
360 async fn start_ldk() {
361         let args = match cli::parse_startup_args() {
362                 Ok(user_args) => user_args,
363                 Err(()) => return,
364         };
365
366         // Initialize the LDK data directory if necessary.
367         let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
368         fs::create_dir_all(ldk_data_dir.clone()).unwrap();
369
370         // Initialize our bitcoind client.
371         let bitcoind_client = match BitcoindClient::new(
372                 args.bitcoind_rpc_host.clone(),
373                 args.bitcoind_rpc_port,
374                 args.bitcoind_rpc_username.clone(),
375                 args.bitcoind_rpc_password.clone(),
376                 tokio::runtime::Handle::current(),
377         )
378         .await
379         {
380                 Ok(client) => Arc::new(client),
381                 Err(e) => {
382                         println!("Failed to connect to bitcoind client: {}", e);
383                         return;
384                 }
385         };
386
387         // Check that the bitcoind we've connected to is running the network we expect
388         let bitcoind_chain = bitcoind_client.get_blockchain_info().await.chain;
389         if bitcoind_chain
390                 != match args.network {
391                         bitcoin::Network::Bitcoin => "main",
392                         bitcoin::Network::Testnet => "test",
393                         bitcoin::Network::Regtest => "regtest",
394                         bitcoin::Network::Signet => "signet",
395                 } {
396                 println!(
397                         "Chain argument ({}) didn't match bitcoind chain ({})",
398                         args.network, bitcoind_chain
399                 );
400                 return;
401         }
402
403         // ## Setup
404         // Step 1: Initialize the FeeEstimator
405
406         // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
407         let fee_estimator = bitcoind_client.clone();
408
409         // Step 2: Initialize the Logger
410         let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
411
412         // Step 3: Initialize the BroadcasterInterface
413
414         // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
415         // broadcaster.
416         let broadcaster = bitcoind_client.clone();
417
418         // Step 4: Initialize Persist
419         let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
420
421         // Step 5: Initialize the ChainMonitor
422         let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
423                 None,
424                 broadcaster.clone(),
425                 logger.clone(),
426                 fee_estimator.clone(),
427                 persister.clone(),
428         ));
429
430         // Step 6: Initialize the KeysManager
431
432         // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
433         // other secret key material.
434         let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
435         let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
436                 assert_eq!(seed.len(), 32);
437                 let mut key = [0; 32];
438                 key.copy_from_slice(&seed);
439                 key
440         } else {
441                 let mut key = [0; 32];
442                 thread_rng().fill_bytes(&mut key);
443                 match File::create(keys_seed_path.clone()) {
444                         Ok(mut f) => {
445                                 f.write_all(&key).expect("Failed to write node keys seed to disk");
446                                 f.sync_all().expect("Failed to sync node keys seed to disk");
447                         }
448                         Err(e) => {
449                                 println!("ERROR: Unable to create keys seed file {}: {}", keys_seed_path, e);
450                                 return;
451                         }
452                 }
453                 key
454         };
455         let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
456         let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
457
458         // Step 7: Read ChannelMonitor state from disk
459         let mut channelmonitors = persister.read_channelmonitors(keys_manager.clone()).unwrap();
460
461         // Step 8: Poll for the best chain tip, which may be used by the channel manager & spv client
462         let polled_chain_tip = init::validate_best_block_header(bitcoind_client.as_ref())
463                 .await
464                 .expect("Failed to fetch best block header and best block");
465
466         // Step 9: Initialize the ChannelManager
467         let mut user_config = UserConfig::default();
468         user_config.channel_handshake_limits.force_announced_channel_preference = false;
469         let mut restarting_node = true;
470         let (channel_manager_blockhash, channel_manager) = {
471                 if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
472                         let mut channel_monitor_mut_references = Vec::new();
473                         for (_, channel_monitor) in channelmonitors.iter_mut() {
474                                 channel_monitor_mut_references.push(channel_monitor);
475                         }
476                         let read_args = ChannelManagerReadArgs::new(
477                                 keys_manager.clone(),
478                                 fee_estimator.clone(),
479                                 chain_monitor.clone(),
480                                 broadcaster.clone(),
481                                 logger.clone(),
482                                 user_config,
483                                 channel_monitor_mut_references,
484                         );
485                         <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
486                 } else {
487                         // We're starting a fresh node.
488                         restarting_node = false;
489
490                         let polled_best_block = polled_chain_tip.to_best_block();
491                         let polled_best_block_hash = polled_best_block.block_hash();
492                         let chain_params =
493                                 ChainParameters { network: args.network, best_block: polled_best_block };
494                         let fresh_channel_manager = channelmanager::ChannelManager::new(
495                                 fee_estimator.clone(),
496                                 chain_monitor.clone(),
497                                 broadcaster.clone(),
498                                 logger.clone(),
499                                 keys_manager.clone(),
500                                 user_config,
501                                 chain_params,
502                         );
503                         (polled_best_block_hash, fresh_channel_manager)
504                 }
505         };
506
507         // Step 10: Sync ChannelMonitors and ChannelManager to chain tip
508         let mut chain_listener_channel_monitors = Vec::new();
509         let mut cache = UnboundedCache::new();
510         let chain_tip = if restarting_node {
511                 let mut chain_listeners = vec![(
512                         channel_manager_blockhash,
513                         &channel_manager as &(dyn chain::Listen + Send + Sync),
514                 )];
515
516                 for (blockhash, channel_monitor) in channelmonitors.drain(..) {
517                         let outpoint = channel_monitor.get_funding_txo().0;
518                         chain_listener_channel_monitors.push((
519                                 blockhash,
520                                 (channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()),
521                                 outpoint,
522                         ));
523                 }
524
525                 for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
526                         chain_listeners.push((
527                                 monitor_listener_info.0,
528                                 &monitor_listener_info.1 as &(dyn chain::Listen + Send + Sync),
529                         ));
530                 }
531
532                 init::synchronize_listeners(
533                         bitcoind_client.as_ref(),
534                         args.network,
535                         &mut cache,
536                         chain_listeners,
537                 )
538                 .await
539                 .unwrap()
540         } else {
541                 polled_chain_tip
542         };
543
544         // Step 11: Give ChannelMonitors to ChainMonitor
545         for item in chain_listener_channel_monitors.drain(..) {
546                 let channel_monitor = item.1 .0;
547                 let funding_outpoint = item.2;
548                 assert_eq!(
549                         chain_monitor.watch_channel(funding_outpoint, channel_monitor),
550                         ChannelMonitorUpdateStatus::Completed
551                 );
552         }
553
554         // Step 12: Optional: Initialize the P2PGossipSync
555         let genesis = genesis_block(args.network).header.block_hash();
556         let network_graph_path = format!("{}/network_graph", ldk_data_dir.clone());
557         let network_graph =
558                 Arc::new(disk::read_network(Path::new(&network_graph_path), genesis, logger.clone()));
559         let gossip_sync = Arc::new(P2PGossipSync::new(
560                 Arc::clone(&network_graph),
561                 None::<Arc<dyn chain::Access + Send + Sync>>,
562                 logger.clone(),
563         ));
564
565         // Step 13: Initialize the PeerManager
566         let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
567         let onion_messenger: Arc<OnionMessenger> = Arc::new(OnionMessenger::new(
568                 Arc::clone(&keys_manager),
569                 Arc::clone(&logger),
570                 IgnoringMessageHandler {},
571         ));
572         let mut ephemeral_bytes = [0; 32];
573         let current_time = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs();
574         rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
575         let lightning_msg_handler = MessageHandler {
576                 chan_handler: channel_manager.clone(),
577                 route_handler: gossip_sync.clone(),
578                 onion_message_handler: onion_messenger.clone(),
579         };
580         let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
581                 lightning_msg_handler,
582                 keys_manager.get_node_secret(Recipient::Node).unwrap(),
583                 current_time.try_into().unwrap(),
584                 &ephemeral_bytes,
585                 logger.clone(),
586                 IgnoringMessageHandler {},
587         ));
588
589         // ## Running LDK
590         // Step 14: Initialize networking
591
592         let peer_manager_connection_handler = peer_manager.clone();
593         let listening_port = args.ldk_peer_listening_port;
594         let stop_listen_connect = Arc::new(AtomicBool::new(false));
595         let stop_listen = Arc::clone(&stop_listen_connect);
596         tokio::spawn(async move {
597                 let listener = tokio::net::TcpListener::bind(format!("0.0.0.0:{}", listening_port))
598                         .await
599                         .expect("Failed to bind to listen port - is something else already listening on it?");
600                 loop {
601                         let peer_mgr = peer_manager_connection_handler.clone();
602                         let tcp_stream = listener.accept().await.unwrap().0;
603                         if stop_listen.load(Ordering::Acquire) {
604                                 return;
605                         }
606                         tokio::spawn(async move {
607                                 lightning_net_tokio::setup_inbound(
608                                         peer_mgr.clone(),
609                                         tcp_stream.into_std().unwrap(),
610                                 )
611                                 .await;
612                         });
613                 }
614         });
615
616         // Step 15: Connect and Disconnect Blocks
617         let channel_manager_listener = channel_manager.clone();
618         let chain_monitor_listener = chain_monitor.clone();
619         let bitcoind_block_source = bitcoind_client.clone();
620         let network = args.network;
621         tokio::spawn(async move {
622                 let chain_poller = poll::ChainPoller::new(bitcoind_block_source.as_ref(), network);
623                 let chain_listener = (chain_monitor_listener, channel_manager_listener);
624                 let mut spv_client = SpvClient::new(chain_tip, chain_poller, &mut cache, &chain_listener);
625                 loop {
626                         spv_client.poll_best_tip().await.unwrap();
627                         tokio::time::sleep(Duration::from_secs(1)).await;
628                 }
629         });
630
631         // Step 16: Handle LDK Events
632         let channel_manager_event_listener = channel_manager.clone();
633         let keys_manager_listener = keys_manager.clone();
634         // TODO: persist payment info to disk
635         let inbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
636         let outbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
637         let inbound_pmts_for_events = inbound_payments.clone();
638         let outbound_pmts_for_events = outbound_payments.clone();
639         let network = args.network;
640         let bitcoind_rpc = bitcoind_client.clone();
641         let network_graph_events = network_graph.clone();
642         let handle = tokio::runtime::Handle::current();
643         let event_handler = move |event: &Event| {
644                 handle.block_on(handle_ldk_events(
645                         &channel_manager_event_listener,
646                         &bitcoind_rpc,
647                         &network_graph_events,
648                         &keys_manager_listener,
649                         &inbound_pmts_for_events,
650                         &outbound_pmts_for_events,
651                         network,
652                         event,
653                 ));
654         };
655
656         // Step 17: Initialize routing ProbabilisticScorer
657         let scorer_path = format!("{}/scorer", ldk_data_dir.clone());
658         let scorer = Arc::new(Mutex::new(disk::read_scorer(
659                 Path::new(&scorer_path),
660                 Arc::clone(&network_graph),
661                 Arc::clone(&logger),
662         )));
663
664         // Step 18: Create InvoicePayer
665         let router = DefaultRouter::new(
666                 network_graph.clone(),
667                 logger.clone(),
668                 keys_manager.get_secure_random_bytes(),
669                 scorer.clone(),
670         );
671         let invoice_payer = Arc::new(InvoicePayer::new(
672                 channel_manager.clone(),
673                 router,
674                 logger.clone(),
675                 event_handler,
676                 payment::Retry::Timeout(Duration::from_secs(10)),
677         ));
678
679         // Step 19: Persist ChannelManager and NetworkGraph
680         let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
681
682         // Step 20: Background Processing
683         let background_processor = BackgroundProcessor::start(
684                 persister,
685                 invoice_payer.clone(),
686                 chain_monitor.clone(),
687                 channel_manager.clone(),
688                 GossipSync::p2p(gossip_sync.clone()),
689                 peer_manager.clone(),
690                 logger.clone(),
691                 Some(scorer.clone()),
692         );
693
694         // Regularly reconnect to channel peers.
695         let connect_cm = Arc::clone(&channel_manager);
696         let connect_pm = Arc::clone(&peer_manager);
697         let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
698         let stop_connect = Arc::clone(&stop_listen_connect);
699         tokio::spawn(async move {
700                 let mut interval = tokio::time::interval(Duration::from_secs(1));
701                 loop {
702                         interval.tick().await;
703                         match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
704                                 Ok(info) => {
705                                         let peers = connect_pm.get_peer_node_ids();
706                                         for node_id in connect_cm
707                                                 .list_channels()
708                                                 .iter()
709                                                 .map(|chan| chan.counterparty.node_id)
710                                                 .filter(|id| !peers.contains(id))
711                                         {
712                                                 if stop_connect.load(Ordering::Acquire) {
713                                                         return;
714                                                 }
715                                                 for (pubkey, peer_addr) in info.iter() {
716                                                         if *pubkey == node_id {
717                                                                 let _ = cli::do_connect_peer(
718                                                                         *pubkey,
719                                                                         peer_addr.clone(),
720                                                                         Arc::clone(&connect_pm),
721                                                                 )
722                                                                 .await;
723                                                         }
724                                                 }
725                                         }
726                                 }
727                                 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
728                         }
729                 }
730         });
731
732         // Regularly broadcast our node_announcement. This is only required (or possible) if we have
733         // some public channels, and is only useful if we have public listen address(es) to announce.
734         // In a production environment, this should occur only after the announcement of new channels
735         // to avoid churn in the global network graph.
736         let peer_man = Arc::clone(&peer_manager);
737         let network = args.network;
738         if !args.ldk_announced_listen_addr.is_empty() {
739                 tokio::spawn(async move {
740                         let mut interval = tokio::time::interval(Duration::from_secs(60));
741                         loop {
742                                 interval.tick().await;
743                                 peer_man.broadcast_node_announcement(
744                                         [0; 3],
745                                         args.ldk_announced_node_name,
746                                         args.ldk_announced_listen_addr.clone(),
747                                 );
748                         }
749                 });
750         }
751
752         // Start the CLI.
753         cli::poll_for_user_input(
754                 Arc::clone(&invoice_payer),
755                 Arc::clone(&peer_manager),
756                 Arc::clone(&channel_manager),
757                 Arc::clone(&keys_manager),
758                 Arc::clone(&network_graph),
759                 Arc::clone(&onion_messenger),
760                 inbound_payments,
761                 outbound_payments,
762                 ldk_data_dir.clone(),
763                 network,
764                 Arc::clone(&logger),
765         )
766         .await;
767
768         // Disconnect our peers and stop accepting new connections. This ensures we don't continue
769         // updating our channel data after we've stopped the background processor.
770         stop_listen_connect.store(true, Ordering::Release);
771         peer_manager.disconnect_all_peers();
772
773         // Stop the background processor.
774         background_processor.stop().unwrap();
775 }
776
777 #[tokio::main]
778 pub async fn main() {
779         #[cfg(not(target_os = "windows"))]
780         {
781                 // Catch Ctrl-C with a dummy signal handler.
782                 unsafe {
783                         let mut new_action: libc::sigaction = core::mem::zeroed();
784                         let mut old_action: libc::sigaction = core::mem::zeroed();
785
786                         extern "C" fn dummy_handler(
787                                 _: libc::c_int, _: *const libc::siginfo_t, _: *const libc::c_void,
788                         ) {
789                         }
790
791                         new_action.sa_sigaction = dummy_handler as libc::sighandler_t;
792                         new_action.sa_flags = libc::SA_SIGINFO;
793
794                         libc::sigaction(
795                                 libc::SIGINT,
796                                 &new_action as *const libc::sigaction,
797                                 &mut old_action as *mut libc::sigaction,
798                         );
799                 }
800         }
801
802         start_ldk().await;
803 }