_ Git - ldk-sample/blob - src/main.rs

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