_ 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::{chainmonitor, ChannelMonitorUpdateStatus};
  18 use lightning::chain::{Filter, Watch};
  19 use lightning::events::{Event, PaymentFailureReason, PaymentPurpose};
  20 use lightning::ln::channelmanager::{self, RecentPaymentDetails};
  21 use lightning::ln::channelmanager::{
  22         ChainParameters, ChannelManagerReadArgs, SimpleArcChannelManager,
  23 };
  24 use lightning::ln::msgs::DecodeError;
  25 use lightning::ln::peer_handler::{IgnoringMessageHandler, MessageHandler, SimpleArcPeerManager};
  26 use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
  27 use lightning::onion_message::{DefaultMessageRouter, SimpleArcOnionMessenger};
  28 use lightning::routing::gossip;
  29 use lightning::routing::gossip::{NodeId, P2PGossipSync};
  30 use lightning::routing::router::DefaultRouter;
  31 use lightning::routing::scoring::ProbabilisticScoringFeeParameters;
  32 use lightning::sign::{EntropySource, InMemorySigner, KeysManager, SpendableOutputDescriptor};
  33 use lightning::util::config::UserConfig;
  34 use lightning::util::persist::KVStorePersister;
  35 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
  36 use lightning::{chain, impl_writeable_tlv_based, impl_writeable_tlv_based_enum};
  37 use lightning_background_processor::{process_events_async, GossipSync};
  38 use lightning_block_sync::init;
  39 use lightning_block_sync::poll;
  40 use lightning_block_sync::SpvClient;
  41 use lightning_block_sync::UnboundedCache;
  42 use lightning_net_tokio::SocketDescriptor;
  43 use lightning_persister::FilesystemPersister;
  44 use rand::{thread_rng, Rng};
  45 use std::collections::hash_map::Entry;
  46 use std::collections::HashMap;
  47 use std::convert::TryInto;
  48 use std::fmt;
  49 use std::fs;
  50 use std::fs::File;
  51 use std::io;
  52 use std::io::Write;
  53 use std::path::Path;
  54 use std::sync::atomic::{AtomicBool, Ordering};
  55 use std::sync::{Arc, Mutex};
  56 use std::time::{Duration, SystemTime};
  57
  58 pub(crate) const PENDING_SPENDABLE_OUTPUT_DIR: &'static str = "pending_spendable_outputs";
  59
  60 #[derive(Copy, Clone)]
  61 pub(crate) enum HTLCStatus {
  62         Pending,
  63         Succeeded,
  64         Failed,
  65 }
  66
  67 impl_writeable_tlv_based_enum!(HTLCStatus,
  68         (0, Pending) => {},
  69         (1, Succeeded) => {},
  70         (2, Failed) => {};
  71 );
  72
  73 pub(crate) struct MillisatAmount(Option<u64>);
  74
  75 impl fmt::Display for MillisatAmount {
  76         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
  77                 match self.0 {
  78                         Some(amt) => write!(f, "{}", amt),
  79                         None => write!(f, "unknown"),
  80                 }
  81         }
  82 }
  83
  84 impl Readable for MillisatAmount {
  85         fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
  86                 let amt: Option<u64> = Readable::read(r)?;
  87                 Ok(MillisatAmount(amt))
  88         }
  89 }
  90
  91 impl Writeable for MillisatAmount {
  92         fn write<W: Writer>(&self, w: &mut W) -> Result<(), std::io::Error> {
  93                 self.0.write(w)
  94         }
  95 }
  96
  97 pub(crate) struct PaymentInfo {
  98         preimage: Option<PaymentPreimage>,
  99         secret: Option<PaymentSecret>,
 100         status: HTLCStatus,
 101         amt_msat: MillisatAmount,
 102 }
 103
 104 impl_writeable_tlv_based!(PaymentInfo, {
 105         (0, preimage, required),
 106         (2, secret, required),
 107         (4, status, required),
 108         (6, amt_msat, required),
 109 });
 110
 111 pub(crate) struct PaymentInfoStorage {
 112         payments: HashMap<PaymentHash, PaymentInfo>,
 113 }
 114
 115 impl_writeable_tlv_based!(PaymentInfoStorage, {
 116         (0, payments, required),
 117 });
 118
 119 type ChainMonitor = chainmonitor::ChainMonitor<
 120         InMemorySigner,
 121         Arc<dyn Filter + Send + Sync>,
 122         Arc<BitcoindClient>,
 123         Arc<BitcoindClient>,
 124         Arc<FilesystemLogger>,
 125         Arc<FilesystemPersister>,
 126 >;
 127
 128 pub(crate) type PeerManager = SimpleArcPeerManager<
 129         SocketDescriptor,
 130         ChainMonitor,
 131         BitcoindClient,
 132         BitcoindClient,
 133         BitcoindClient,
 134         FilesystemLogger,
 135 >;
 136
 137 pub(crate) type ChannelManager =
 138         SimpleArcChannelManager<ChainMonitor, BitcoindClient, BitcoindClient, FilesystemLogger>;
 139
 140 pub(crate) type NetworkGraph = gossip::NetworkGraph<Arc<FilesystemLogger>>;
 141
 142 type OnionMessenger = SimpleArcOnionMessenger<FilesystemLogger>;
 143
 144 async fn handle_ldk_events(
 145         channel_manager: &Arc<ChannelManager>, bitcoind_client: &BitcoindClient,
 146         network_graph: &NetworkGraph, keys_manager: &KeysManager,
 147         inbound_payments: Arc<Mutex<PaymentInfoStorage>>,
 148         outbound_payments: Arc<Mutex<PaymentInfoStorage>>, persister: &Arc<FilesystemPersister>,
 149         network: Network, event: Event,
 150 ) {
 151         match event {
 152                 Event::FundingGenerationReady {
 153                         temporary_channel_id,
 154                         counterparty_node_id,
 155                         channel_value_satoshis,
 156                         output_script,
 157                         ..
 158                 } => {
 159                         // Construct the raw transaction with one output, that is paid the amount of the
 160                         // channel.
 161                         let addr = WitnessProgram::from_scriptpubkey(
 162                                 &output_script[..],
 163                                 match network {
 164                                         Network::Bitcoin => bitcoin_bech32::constants::Network::Bitcoin,
 165                                         Network::Testnet => bitcoin_bech32::constants::Network::Testnet,
 166                                         Network::Regtest => bitcoin_bech32::constants::Network::Regtest,
 167                                         Network::Signet => bitcoin_bech32::constants::Network::Signet,
 168                                 },
 169                         )
 170                         .expect("Lightning funding tx should always be to a SegWit output")
 171                         .to_address();
 172                         let mut outputs = vec![HashMap::with_capacity(1)];
 173                         outputs[0].insert(addr, channel_value_satoshis as f64 / 100_000_000.0);
 174                         let raw_tx = bitcoind_client.create_raw_transaction(outputs).await;
 175
 176                         // Have your wallet put the inputs into the transaction such that the output is
 177                         // satisfied.
 178                         let funded_tx = bitcoind_client.fund_raw_transaction(raw_tx).await;
 179
 180                         // Sign the final funding transaction and broadcast it.
 181                         let signed_tx = bitcoind_client.sign_raw_transaction_with_wallet(funded_tx.hex).await;
 182                         assert_eq!(signed_tx.complete, true);
 183                         let final_tx: Transaction =
 184                                 encode::deserialize(&hex_utils::to_vec(&signed_tx.hex).unwrap()).unwrap();
 185                         // Give the funding transaction back to LDK for opening the channel.
 186                         if channel_manager
 187                                 .funding_transaction_generated(
 188                                         &temporary_channel_id,
 189                                         &counterparty_node_id,
 190                                         final_tx,
 191                                 )
 192                                 .is_err()
 193                         {
 194                                 println!(
 195                                         "\nERROR: Channel went away before we could fund it. The peer disconnected or refused the channel.");
 196                                 print!("> ");
 197                                 io::stdout().flush().unwrap();
 198                         }
 199                 }
 200                 Event::PaymentClaimable {
 201                         payment_hash,
 202                         purpose,
 203                         amount_msat,
 204                         receiver_node_id: _,
 205                         via_channel_id: _,
 206                         via_user_channel_id: _,
 207                         claim_deadline: _,
 208                         onion_fields: _,
 209                         counterparty_skimmed_fee_msat: _,
 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                 Event::BumpTransaction(_) => {}
 433         }
 434 }
 435
 436 async fn start_ldk() {
 437         let args = match args::parse_startup_args() {
 438                 Ok(user_args) => user_args,
 439                 Err(()) => return,
 440         };
 441
 442         // Initialize the LDK data directory if necessary.
 443         let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
 444         fs::create_dir_all(ldk_data_dir.clone()).unwrap();
 445
 446         // ## Setup
 447         // Step 1: Initialize the Logger
 448         let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
 449
 450         // Initialize our bitcoind client.
 451         let bitcoind_client = match BitcoindClient::new(
 452                 args.bitcoind_rpc_host.clone(),
 453                 args.bitcoind_rpc_port,
 454                 args.bitcoind_rpc_username.clone(),
 455                 args.bitcoind_rpc_password.clone(),
 456                 tokio::runtime::Handle::current(),
 457                 Arc::clone(&logger),
 458         )
 459         .await
 460         {
 461                 Ok(client) => Arc::new(client),
 462                 Err(e) => {
 463                         println!("Failed to connect to bitcoind client: {}", e);
 464                         return;
 465                 }
 466         };
 467
 468         // Check that the bitcoind we've connected to is running the network we expect
 469         let bitcoind_chain = bitcoind_client.get_blockchain_info().await.chain;
 470         if bitcoind_chain
 471                 != match args.network {
 472                         bitcoin::Network::Bitcoin => "main",
 473                         bitcoin::Network::Testnet => "test",
 474                         bitcoin::Network::Regtest => "regtest",
 475                         bitcoin::Network::Signet => "signet",
 476                 } {
 477                 println!(
 478                         "Chain argument ({}) didn't match bitcoind chain ({})",
 479                         args.network, bitcoind_chain
 480                 );
 481                 return;
 482         }
 483
 484         // Step 2: Initialize the FeeEstimator
 485
 486         // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
 487         let fee_estimator = bitcoind_client.clone();
 488
 489         // Step 3: Initialize the BroadcasterInterface
 490
 491         // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
 492         // broadcaster.
 493         let broadcaster = bitcoind_client.clone();
 494
 495         // Step 4: Initialize Persist
 496         let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
 497
 498         // Step 5: Initialize the ChainMonitor
 499         let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
 500                 None,
 501                 broadcaster.clone(),
 502                 logger.clone(),
 503                 fee_estimator.clone(),
 504                 persister.clone(),
 505         ));
 506
 507         // Step 6: Initialize the KeysManager
 508
 509         // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
 510         // other secret key material.
 511         let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
 512         let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
 513                 assert_eq!(seed.len(), 32);
 514                 let mut key = [0; 32];
 515                 key.copy_from_slice(&seed);
 516                 key
 517         } else {
 518                 let mut key = [0; 32];
 519                 thread_rng().fill_bytes(&mut key);
 520                 match File::create(keys_seed_path.clone()) {
 521                         Ok(mut f) => {
 522                                 Write::write_all(&mut f, &key).expect("Failed to write node keys seed to disk");
 523                                 f.sync_all().expect("Failed to sync node keys seed to disk");
 524                         }
 525                         Err(e) => {
 526                                 println!("ERROR: Unable to create keys seed file {}: {}", keys_seed_path, e);
 527                                 return;
 528                         }
 529                 }
 530                 key
 531         };
 532         let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
 533         let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
 534
 535         // Step 7: Read ChannelMonitor state from disk
 536         let mut channelmonitors =
 537                 persister.read_channelmonitors(keys_manager.clone(), keys_manager.clone()).unwrap();
 538
 539         // Step 8: Poll for the best chain tip, which may be used by the channel manager & spv client
 540         let polled_chain_tip = init::validate_best_block_header(bitcoind_client.as_ref())
 541                 .await
 542                 .expect("Failed to fetch best block header and best block");
 543
 544         // Step 9: Initialize routing ProbabilisticScorer
 545         let network_graph_path = format!("{}/network_graph", ldk_data_dir.clone());
 546         let network_graph =
 547                 Arc::new(disk::read_network(Path::new(&network_graph_path), args.network, logger.clone()));
 548
 549         let scorer_path = format!("{}/scorer", ldk_data_dir.clone());
 550         let scorer = Arc::new(Mutex::new(disk::read_scorer(
 551                 Path::new(&scorer_path),
 552                 Arc::clone(&network_graph),
 553                 Arc::clone(&logger),
 554         )));
 555
 556         // Step 10: Create Router
 557         let scoring_fee_params = ProbabilisticScoringFeeParameters::default();
 558         let router = Arc::new(DefaultRouter::new(
 559                 network_graph.clone(),
 560                 logger.clone(),
 561                 keys_manager.get_secure_random_bytes(),
 562                 scorer.clone(),
 563                 scoring_fee_params,
 564         ));
 565
 566         // Step 11: Initialize the ChannelManager
 567         let mut user_config = UserConfig::default();
 568         user_config.channel_handshake_limits.force_announced_channel_preference = false;
 569         let mut restarting_node = true;
 570         let (channel_manager_blockhash, channel_manager) = {
 571                 if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
 572                         let mut channel_monitor_mut_references = Vec::new();
 573                         for (_, channel_monitor) in channelmonitors.iter_mut() {
 574                                 channel_monitor_mut_references.push(channel_monitor);
 575                         }
 576                         let read_args = ChannelManagerReadArgs::new(
 577                                 keys_manager.clone(),
 578                                 keys_manager.clone(),
 579                                 keys_manager.clone(),
 580                                 fee_estimator.clone(),
 581                                 chain_monitor.clone(),
 582                                 broadcaster.clone(),
 583                                 router,
 584                                 logger.clone(),
 585                                 user_config,
 586                                 channel_monitor_mut_references,
 587                         );
 588                         <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
 589                 } else {
 590                         // We're starting a fresh node.
 591                         restarting_node = false;
 592
 593                         let polled_best_block = polled_chain_tip.to_best_block();
 594                         let polled_best_block_hash = polled_best_block.block_hash();
 595                         let chain_params =
 596                                 ChainParameters { network: args.network, best_block: polled_best_block };
 597                         let fresh_channel_manager = channelmanager::ChannelManager::new(
 598                                 fee_estimator.clone(),
 599                                 chain_monitor.clone(),
 600                                 broadcaster.clone(),
 601                                 router,
 602                                 logger.clone(),
 603                                 keys_manager.clone(),
 604                                 keys_manager.clone(),
 605                                 keys_manager.clone(),
 606                                 user_config,
 607                                 chain_params,
 608                                 cur.as_secs() as u32,
 609                         );
 610                         (polled_best_block_hash, fresh_channel_manager)
 611                 }
 612         };
 613
 614         // Step 12: Sync ChannelMonitors and ChannelManager to chain tip
 615         let mut chain_listener_channel_monitors = Vec::new();
 616         let mut cache = UnboundedCache::new();
 617         let chain_tip = if restarting_node {
 618                 let mut chain_listeners = vec![(
 619                         channel_manager_blockhash,
 620                         &channel_manager as &(dyn chain::Listen + Send + Sync),
 621                 )];
 622
 623                 for (blockhash, channel_monitor) in channelmonitors.drain(..) {
 624                         let outpoint = channel_monitor.get_funding_txo().0;
 625                         chain_listener_channel_monitors.push((
 626                                 blockhash,
 627                                 (channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()),
 628                                 outpoint,
 629                         ));
 630                 }
 631
 632                 for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
 633                         chain_listeners.push((
 634                                 monitor_listener_info.0,
 635                                 &monitor_listener_info.1 as &(dyn chain::Listen + Send + Sync),
 636                         ));
 637                 }
 638
 639                 init::synchronize_listeners(
 640                         bitcoind_client.as_ref(),
 641                         args.network,
 642                         &mut cache,
 643                         chain_listeners,
 644                 )
 645                 .await
 646                 .unwrap()
 647         } else {
 648                 polled_chain_tip
 649         };
 650
 651         // Step 13: Give ChannelMonitors to ChainMonitor
 652         for item in chain_listener_channel_monitors.drain(..) {
 653                 let channel_monitor = item.1 .0;
 654                 let funding_outpoint = item.2;
 655                 assert_eq!(
 656                         chain_monitor.watch_channel(funding_outpoint, channel_monitor),
 657                         ChannelMonitorUpdateStatus::Completed
 658                 );
 659         }
 660
 661         // Step 14: Optional: Initialize the P2PGossipSync
 662         let gossip_sync = Arc::new(P2PGossipSync::new(
 663                 Arc::clone(&network_graph),
 664                 None::<Arc<BitcoindClient>>,
 665                 logger.clone(),
 666         ));
 667
 668         // Step 15: Initialize the PeerManager
 669         let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
 670         let onion_messenger: Arc<OnionMessenger> = Arc::new(OnionMessenger::new(
 671                 Arc::clone(&keys_manager),
 672                 Arc::clone(&keys_manager),
 673                 Arc::clone(&logger),
 674                 Arc::new(DefaultMessageRouter {}),
 675                 IgnoringMessageHandler {},
 676                 IgnoringMessageHandler {},
 677         ));
 678         let mut ephemeral_bytes = [0; 32];
 679         let current_time = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs();
 680         rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
 681         let lightning_msg_handler = MessageHandler {
 682                 chan_handler: channel_manager.clone(),
 683                 route_handler: gossip_sync.clone(),
 684                 onion_message_handler: onion_messenger.clone(),
 685                 custom_message_handler: IgnoringMessageHandler {},
 686         };
 687         let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
 688                 lightning_msg_handler,
 689                 current_time.try_into().unwrap(),
 690                 &ephemeral_bytes,
 691                 logger.clone(),
 692                 Arc::clone(&keys_manager),
 693         ));
 694
 695         // ## Running LDK
 696         // Step 16: Initialize networking
 697
 698         let peer_manager_connection_handler = peer_manager.clone();
 699         let listening_port = args.ldk_peer_listening_port;
 700         let stop_listen_connect = Arc::new(AtomicBool::new(false));
 701         let stop_listen = Arc::clone(&stop_listen_connect);
 702         tokio::spawn(async move {
 703                 let listener = tokio::net::TcpListener::bind(format!("[::]:{}", listening_port))
 704                         .await
 705                         .expect("Failed to bind to listen port - is something else already listening on it?");
 706                 loop {
 707                         let peer_mgr = peer_manager_connection_handler.clone();
 708                         let tcp_stream = listener.accept().await.unwrap().0;
 709                         if stop_listen.load(Ordering::Acquire) {
 710                                 return;
 711                         }
 712                         tokio::spawn(async move {
 713                                 lightning_net_tokio::setup_inbound(
 714                                         peer_mgr.clone(),
 715                                         tcp_stream.into_std().unwrap(),
 716                                 )
 717                                 .await;
 718                         });
 719                 }
 720         });
 721
 722         // Step 17: Connect and Disconnect Blocks
 723         let channel_manager_listener = channel_manager.clone();
 724         let chain_monitor_listener = chain_monitor.clone();
 725         let bitcoind_block_source = bitcoind_client.clone();
 726         let network = args.network;
 727         tokio::spawn(async move {
 728                 let chain_poller = poll::ChainPoller::new(bitcoind_block_source.as_ref(), network);
 729                 let chain_listener = (chain_monitor_listener, channel_manager_listener);
 730                 let mut spv_client = SpvClient::new(chain_tip, chain_poller, &mut cache, &chain_listener);
 731                 loop {
 732                         spv_client.poll_best_tip().await.unwrap();
 733                         tokio::time::sleep(Duration::from_secs(1)).await;
 734                 }
 735         });
 736
 737         let inbound_payments = Arc::new(Mutex::new(disk::read_payment_info(Path::new(&format!(
 738                 "{}/{}",
 739                 ldk_data_dir, INBOUND_PAYMENTS_FNAME
 740         )))));
 741         let outbound_payments = Arc::new(Mutex::new(disk::read_payment_info(Path::new(&format!(
 742                 "{}/{}",
 743                 ldk_data_dir, OUTBOUND_PAYMENTS_FNAME
 744         )))));
 745         let recent_payments_payment_hashes = channel_manager
 746                 .list_recent_payments()
 747                 .into_iter()
 748                 .filter_map(|p| match p {
 749                         RecentPaymentDetails::Pending { payment_hash, .. } => Some(payment_hash),
 750                         RecentPaymentDetails::Fulfilled { payment_hash } => payment_hash,
 751                         RecentPaymentDetails::Abandoned { payment_hash } => Some(payment_hash),
 752                 })
 753                 .collect::<Vec<PaymentHash>>();
 754         for (payment_hash, payment_info) in outbound_payments
 755                 .lock()
 756                 .unwrap()
 757                 .payments
 758                 .iter_mut()
 759                 .filter(|(_, i)| matches!(i.status, HTLCStatus::Pending))
 760         {
 761                 if !recent_payments_payment_hashes.contains(payment_hash) {
 762                         payment_info.status = HTLCStatus::Failed;
 763                 }
 764         }
 765         persister.persist(OUTBOUND_PAYMENTS_FNAME, &*outbound_payments.lock().unwrap()).unwrap();
 766
 767         // Step 18: Handle LDK Events
 768         let channel_manager_event_listener = Arc::clone(&channel_manager);
 769         let bitcoind_client_event_listener = Arc::clone(&bitcoind_client);
 770         let network_graph_event_listener = Arc::clone(&network_graph);
 771         let keys_manager_event_listener = Arc::clone(&keys_manager);
 772         let inbound_payments_event_listener = Arc::clone(&inbound_payments);
 773         let outbound_payments_event_listener = Arc::clone(&outbound_payments);
 774         let persister_event_listener = Arc::clone(&persister);
 775         let network = args.network;
 776         let event_handler = move |event: Event| {
 777                 let channel_manager_event_listener = Arc::clone(&channel_manager_event_listener);
 778                 let bitcoind_client_event_listener = Arc::clone(&bitcoind_client_event_listener);
 779                 let network_graph_event_listener = Arc::clone(&network_graph_event_listener);
 780                 let keys_manager_event_listener = Arc::clone(&keys_manager_event_listener);
 781                 let inbound_payments_event_listener = Arc::clone(&inbound_payments_event_listener);
 782                 let outbound_payments_event_listener = Arc::clone(&outbound_payments_event_listener);
 783                 let persister_event_listener = Arc::clone(&persister_event_listener);
 784                 async move {
 785                         handle_ldk_events(
 786                                 &channel_manager_event_listener,
 787                                 &bitcoind_client_event_listener,
 788                                 &network_graph_event_listener,
 789                                 &keys_manager_event_listener,
 790                                 inbound_payments_event_listener,
 791                                 outbound_payments_event_listener,
 792                                 &persister_event_listener,
 793                                 network,
 794                                 event,
 795                         )
 796                         .await;
 797                 }
 798         };
 799
 800         // Step 19: Persist ChannelManager and NetworkGraph
 801         let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
 802
 803         // Step 20: Background Processing
 804         let (bp_exit, bp_exit_check) = tokio::sync::watch::channel(());
 805         let background_processor = tokio::spawn(process_events_async(
 806                 Arc::clone(&persister),
 807                 event_handler,
 808                 chain_monitor.clone(),
 809                 channel_manager.clone(),
 810                 GossipSync::p2p(gossip_sync.clone()),
 811                 peer_manager.clone(),
 812                 logger.clone(),
 813                 Some(scorer.clone()),
 814                 move |t| {
 815                         let mut bp_exit_fut_check = bp_exit_check.clone();
 816                         Box::pin(async move {
 817                                 tokio::select! {
 818                                         _ = tokio::time::sleep(t) => false,
 819                                         _ = bp_exit_fut_check.changed() => true,
 820                                 }
 821                         })
 822                 },
 823                 false,
 824         ));
 825
 826         // Regularly reconnect to channel peers.
 827         let connect_cm = Arc::clone(&channel_manager);
 828         let connect_pm = Arc::clone(&peer_manager);
 829         let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
 830         let stop_connect = Arc::clone(&stop_listen_connect);
 831         tokio::spawn(async move {
 832                 let mut interval = tokio::time::interval(Duration::from_secs(1));
 833                 interval.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Delay);
 834                 loop {
 835                         interval.tick().await;
 836                         match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
 837                                 Ok(info) => {
 838                                         let peers = connect_pm.get_peer_node_ids();
 839                                         for node_id in connect_cm
 840                                                 .list_channels()
 841                                                 .iter()
 842                                                 .map(|chan| chan.counterparty.node_id)
 843                                                 .filter(|id| !peers.iter().any(|(pk, _)| id == pk))
 844                                         {
 845                                                 if stop_connect.load(Ordering::Acquire) {
 846                                                         return;
 847                                                 }
 848                                                 for (pubkey, peer_addr) in info.iter() {
 849                                                         if *pubkey == node_id {
 850                                                                 let _ = cli::do_connect_peer(
 851                                                                         *pubkey,
 852                                                                         peer_addr.clone(),
 853                                                                         Arc::clone(&connect_pm),
 854                                                                 )
 855                                                                 .await;
 856                                                         }
 857                                                 }
 858                                         }
 859                                 }
 860                                 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
 861                         }
 862                 }
 863         });
 864
 865         // Regularly broadcast our node_announcement. This is only required (or possible) if we have
 866         // some public channels.
 867         let peer_man = Arc::clone(&peer_manager);
 868         let chan_man = Arc::clone(&channel_manager);
 869         let network = args.network;
 870         tokio::spawn(async move {
 871                 // First wait a minute until we have some peers and maybe have opened a channel.
 872                 tokio::time::sleep(Duration::from_secs(60)).await;
 873                 // Then, update our announcement once an hour to keep it fresh but avoid unnecessary churn
 874                 // in the global gossip network.
 875                 let mut interval = tokio::time::interval(Duration::from_secs(3600));
 876                 loop {
 877                         interval.tick().await;
 878                         // Don't bother trying to announce if we don't have any public channls, though our
 879                         // peers should drop such an announcement anyway. Note that announcement may not
 880                         // propagate until we have a channel with 6+ confirmations.
 881                         if chan_man.list_channels().iter().any(|chan| chan.is_public) {
 882                                 peer_man.broadcast_node_announcement(
 883                                         [0; 3],
 884                                         args.ldk_announced_node_name,
 885                                         args.ldk_announced_listen_addr.clone(),
 886                                 );
 887                         }
 888                 }
 889         });
 890
 891         tokio::spawn(sweep::periodic_sweep(
 892                 ldk_data_dir.clone(),
 893                 Arc::clone(&keys_manager),
 894                 Arc::clone(&logger),
 895                 Arc::clone(&persister),
 896                 Arc::clone(&bitcoind_client),
 897                 Arc::clone(&channel_manager),
 898         ));
 899
 900         // Start the CLI.
 901         cli::poll_for_user_input(
 902                 Arc::clone(&peer_manager),
 903                 Arc::clone(&channel_manager),
 904                 Arc::clone(&keys_manager),
 905                 Arc::clone(&network_graph),
 906                 Arc::clone(&onion_messenger),
 907                 inbound_payments,
 908                 outbound_payments,
 909                 ldk_data_dir,
 910                 network,
 911                 Arc::clone(&logger),
 912                 Arc::clone(&persister),
 913         )
 914         .await;
 915
 916         // Disconnect our peers and stop accepting new connections. This ensures we don't continue
 917         // updating our channel data after we've stopped the background processor.
 918         stop_listen_connect.store(true, Ordering::Release);
 919         peer_manager.disconnect_all_peers();
 920
 921         // Stop the background processor.
 922         bp_exit.send(()).unwrap();
 923         background_processor.await.unwrap().unwrap();
 924 }
 925
 926 #[tokio::main]
 927 pub async fn main() {
 928         #[cfg(not(target_os = "windows"))]
 929         {
 930                 // Catch Ctrl-C with a dummy signal handler.
 931                 unsafe {
 932                         let mut new_action: libc::sigaction = core::mem::zeroed();
 933                         let mut old_action: libc::sigaction = core::mem::zeroed();
 934
 935                         extern "C" fn dummy_handler(
 936                                 _: libc::c_int, _: *const libc::siginfo_t, _: *const libc::c_void,
 937                         ) {
 938                         }
 939
 940                         new_action.sa_sigaction = dummy_handler as libc::sighandler_t;
 941                         new_action.sa_flags = libc::SA_SIGINFO;
 942
 943                         libc::sigaction(
 944                                 libc::SIGINT,
 945                                 &new_action as *const libc::sigaction,
 946                                 &mut old_action as *mut libc::sigaction,
 947                         );
 948                 }
 949         }
 950
 951         start_ldk().await;
 952 }