_ 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                         ref temporary_channel_id, ref counterparty_node_id, ..
 283                 } => {
 284                         let mut random_bytes = [0u8; 16];
 285                         random_bytes.copy_from_slice(&keys_manager.get_secure_random_bytes()[..16]);
 286                         let user_channel_id = u128::from_be_bytes(random_bytes);
 287                         let res = channel_manager.accept_inbound_channel(
 288                                 temporary_channel_id,
 289                                 counterparty_node_id,
 290                                 user_channel_id,
 291                         );
 292
 293                         if let Err(e) = res {
 294                                 print!(
 295                                         "\nEVENT: Failed to accept inbound channel ({}) from {}: {:?}",
 296                                         hex_utils::hex_str(&temporary_channel_id[..]),
 297                                         hex_utils::hex_str(&counterparty_node_id.serialize()),
 298                                         e,
 299                                 );
 300                         } else {
 301                                 print!(
 302                                         "\nEVENT: Accepted inbound channel ({}) from {}",
 303                                         hex_utils::hex_str(&temporary_channel_id[..]),
 304                                         hex_utils::hex_str(&counterparty_node_id.serialize()),
 305                                 );
 306                         }
 307                         print!("> ");
 308                         io::stdout().flush().unwrap();
 309                 }
 310                 Event::PaymentPathSuccessful { .. } => {}
 311                 Event::PaymentPathFailed { .. } => {}
 312                 Event::ProbeSuccessful { .. } => {}
 313                 Event::ProbeFailed { .. } => {}
 314                 Event::PaymentFailed { payment_hash, reason, .. } => {
 315                         print!(
 316                                 "\nEVENT: Failed to send payment to payment hash {:?}: {:?}",
 317                                 hex_utils::hex_str(&payment_hash.0),
 318                                 if let Some(r) = reason { r } else { PaymentFailureReason::RetriesExhausted }
 319                         );
 320                         print!("> ");
 321                         io::stdout().flush().unwrap();
 322
 323                         let mut outbound = outbound_payments.lock().unwrap();
 324                         if outbound.payments.contains_key(&payment_hash) {
 325                                 let payment = outbound.payments.get_mut(&payment_hash).unwrap();
 326                                 payment.status = HTLCStatus::Failed;
 327                         }
 328                         persister.persist(OUTBOUND_PAYMENTS_FNAME, &*outbound).unwrap();
 329                 }
 330                 Event::PaymentForwarded {
 331                         prev_channel_id,
 332                         next_channel_id,
 333                         fee_earned_msat,
 334                         claim_from_onchain_tx,
 335                         outbound_amount_forwarded_msat,
 336                 } => {
 337                         let read_only_network_graph = network_graph.read_only();
 338                         let nodes = read_only_network_graph.nodes();
 339                         let channels = channel_manager.list_channels();
 340
 341                         let node_str = |channel_id: &Option<[u8; 32]>| match channel_id {
 342                                 None => String::new(),
 343                                 Some(channel_id) => match channels.iter().find(|c| c.channel_id == *channel_id) {
 344                                         None => String::new(),
 345                                         Some(channel) => {
 346                                                 match nodes.get(&NodeId::from_pubkey(&channel.counterparty.node_id)) {
 347                                                         None => "private node".to_string(),
 348                                                         Some(node) => match &node.announcement_info {
 349                                                                 None => "unnamed node".to_string(),
 350                                                                 Some(announcement) => {
 351                                                                         format!("node {}", announcement.alias)
 352                                                                 }
 353                                                         },
 354                                                 }
 355                                         }
 356                                 },
 357                         };
 358                         let channel_str = |channel_id: &Option<[u8; 32]>| {
 359                                 channel_id
 360                                         .map(|channel_id| format!(" with channel {}", hex_utils::hex_str(&channel_id)))
 361                                         .unwrap_or_default()
 362                         };
 363                         let from_prev_str =
 364                                 format!(" from {}{}", node_str(&prev_channel_id), channel_str(&prev_channel_id));
 365                         let to_next_str =
 366                                 format!(" to {}{}", node_str(&next_channel_id), channel_str(&next_channel_id));
 367
 368                         let from_onchain_str = if claim_from_onchain_tx {
 369                                 "from onchain downstream claim"
 370                         } else {
 371                                 "from HTLC fulfill message"
 372                         };
 373                         let amt_args = if let Some(v) = outbound_amount_forwarded_msat {
 374                                 format!("{}", v)
 375                         } else {
 376                                 "?".to_string()
 377                         };
 378                         if let Some(fee_earned) = fee_earned_msat {
 379                                 println!(
 380                                         "\nEVENT: Forwarded payment for {} msat{}{}, earning {} msat {}",
 381                                         amt_args, from_prev_str, to_next_str, fee_earned, from_onchain_str
 382                                 );
 383                         } else {
 384                                 println!(
 385                                         "\nEVENT: Forwarded payment for {} msat{}{}, claiming onchain {}",
 386                                         amt_args, from_prev_str, to_next_str, from_onchain_str
 387                                 );
 388                         }
 389                         print!("> ");
 390                         io::stdout().flush().unwrap();
 391                 }
 392                 Event::HTLCHandlingFailed { .. } => {}
 393                 Event::PendingHTLCsForwardable { time_forwardable } => {
 394                         let forwarding_channel_manager = channel_manager.clone();
 395                         let min = time_forwardable.as_millis() as u64;
 396                         tokio::spawn(async move {
 397                                 let millis_to_sleep = thread_rng().gen_range(min, min * 5) as u64;
 398                                 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
 399                                 forwarding_channel_manager.process_pending_htlc_forwards();
 400                         });
 401                 }
 402                 Event::SpendableOutputs { outputs } => {
 403                         // SpendableOutputDescriptors, of which outputs is a vec of, are critical to keep track
 404                         // of! While a `StaticOutput` descriptor is just an output to a static, well-known key,
 405                         // other descriptors are not currently ever regenerated for you by LDK. Once we return
 406                         // from this method, the descriptor will be gone, and you may lose track of some funds.
 407                         //
 408                         // Here we simply persist them to disk, with a background task running which will try
 409                         // to spend them regularly (possibly duplicatively/RBF'ing them). These can just be
 410                         // treated as normal funds where possible - they are only spendable by us and there is
 411                         // no rush to claim them.
 412                         for output in outputs {
 413                                 let key = hex_utils::hex_str(&keys_manager.get_secure_random_bytes());
 414                                 // Note that if the type here changes our read code needs to change as well.
 415                                 let output: SpendableOutputDescriptor = output;
 416                                 persister
 417                                         .persist(&format!("{}/{}", PENDING_SPENDABLE_OUTPUT_DIR, key), &output)
 418                                         .unwrap();
 419                         }
 420                 }
 421                 Event::ChannelPending { channel_id, counterparty_node_id, .. } => {
 422                         println!(
 423                                 "\nEVENT: Channel {} with peer {} is pending awaiting funding lock-in!",
 424                                 hex_utils::hex_str(&channel_id),
 425                                 hex_utils::hex_str(&counterparty_node_id.serialize()),
 426                         );
 427                         print!("> ");
 428                         io::stdout().flush().unwrap();
 429                 }
 430                 Event::ChannelReady {
 431                         ref channel_id,
 432                         user_channel_id: _,
 433                         ref counterparty_node_id,
 434                         channel_type: _,
 435                 } => {
 436                         println!(
 437                                 "\nEVENT: Channel {} with peer {} is ready to be used!",
 438                                 hex_utils::hex_str(channel_id),
 439                                 hex_utils::hex_str(&counterparty_node_id.serialize()),
 440                         );
 441                         print!("> ");
 442                         io::stdout().flush().unwrap();
 443                 }
 444                 Event::ChannelClosed { channel_id, reason, user_channel_id: _ } => {
 445                         println!(
 446                                 "\nEVENT: Channel {} closed due to: {:?}",
 447                                 hex_utils::hex_str(&channel_id),
 448                                 reason
 449                         );
 450                         print!("> ");
 451                         io::stdout().flush().unwrap();
 452                 }
 453                 Event::DiscardFunding { .. } => {
 454                         // A "real" node should probably "lock" the UTXOs spent in funding transactions until
 455                         // the funding transaction either confirms, or this event is generated.
 456                 }
 457                 Event::HTLCIntercepted { .. } => {}
 458                 Event::BumpTransaction(_) => {}
 459         }
 460 }
 461
 462 async fn start_ldk() {
 463         let args = match args::parse_startup_args() {
 464                 Ok(user_args) => user_args,
 465                 Err(()) => return,
 466         };
 467
 468         // Initialize the LDK data directory if necessary.
 469         let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
 470         fs::create_dir_all(ldk_data_dir.clone()).unwrap();
 471
 472         // ## Setup
 473         // Step 1: Initialize the Logger
 474         let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
 475
 476         // Initialize our bitcoind client.
 477         let bitcoind_client = match BitcoindClient::new(
 478                 args.bitcoind_rpc_host.clone(),
 479                 args.bitcoind_rpc_port,
 480                 args.bitcoind_rpc_username.clone(),
 481                 args.bitcoind_rpc_password.clone(),
 482                 tokio::runtime::Handle::current(),
 483                 Arc::clone(&logger),
 484         )
 485         .await
 486         {
 487                 Ok(client) => Arc::new(client),
 488                 Err(e) => {
 489                         println!("Failed to connect to bitcoind client: {}", e);
 490                         return;
 491                 }
 492         };
 493
 494         // Check that the bitcoind we've connected to is running the network we expect
 495         let bitcoind_chain = bitcoind_client.get_blockchain_info().await.chain;
 496         if bitcoind_chain
 497                 != match args.network {
 498                         bitcoin::Network::Bitcoin => "main",
 499                         bitcoin::Network::Testnet => "test",
 500                         bitcoin::Network::Regtest => "regtest",
 501                         bitcoin::Network::Signet => "signet",
 502                 } {
 503                 println!(
 504                         "Chain argument ({}) didn't match bitcoind chain ({})",
 505                         args.network, bitcoind_chain
 506                 );
 507                 return;
 508         }
 509
 510         // Step 2: Initialize the FeeEstimator
 511
 512         // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
 513         let fee_estimator = bitcoind_client.clone();
 514
 515         // Step 3: Initialize the BroadcasterInterface
 516
 517         // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
 518         // broadcaster.
 519         let broadcaster = bitcoind_client.clone();
 520
 521         // Step 4: Initialize Persist
 522         let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
 523
 524         // Step 5: Initialize the ChainMonitor
 525         let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
 526                 None,
 527                 broadcaster.clone(),
 528                 logger.clone(),
 529                 fee_estimator.clone(),
 530                 persister.clone(),
 531         ));
 532
 533         // Step 6: Initialize the KeysManager
 534
 535         // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
 536         // other secret key material.
 537         let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
 538         let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
 539                 assert_eq!(seed.len(), 32);
 540                 let mut key = [0; 32];
 541                 key.copy_from_slice(&seed);
 542                 key
 543         } else {
 544                 let mut key = [0; 32];
 545                 thread_rng().fill_bytes(&mut key);
 546                 match File::create(keys_seed_path.clone()) {
 547                         Ok(mut f) => {
 548                                 Write::write_all(&mut f, &key).expect("Failed to write node keys seed to disk");
 549                                 f.sync_all().expect("Failed to sync node keys seed to disk");
 550                         }
 551                         Err(e) => {
 552                                 println!("ERROR: Unable to create keys seed file {}: {}", keys_seed_path, e);
 553                                 return;
 554                         }
 555                 }
 556                 key
 557         };
 558         let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
 559         let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
 560
 561         // Step 7: Read ChannelMonitor state from disk
 562         let mut channelmonitors =
 563                 persister.read_channelmonitors(keys_manager.clone(), keys_manager.clone()).unwrap();
 564
 565         // Step 8: Poll for the best chain tip, which may be used by the channel manager & spv client
 566         let polled_chain_tip = init::validate_best_block_header(bitcoind_client.as_ref())
 567                 .await
 568                 .expect("Failed to fetch best block header and best block");
 569
 570         // Step 9: Initialize routing ProbabilisticScorer
 571         let network_graph_path = format!("{}/network_graph", ldk_data_dir.clone());
 572         let network_graph =
 573                 Arc::new(disk::read_network(Path::new(&network_graph_path), args.network, logger.clone()));
 574
 575         let scorer_path = format!("{}/scorer", ldk_data_dir.clone());
 576         let scorer = Arc::new(Mutex::new(disk::read_scorer(
 577                 Path::new(&scorer_path),
 578                 Arc::clone(&network_graph),
 579                 Arc::clone(&logger),
 580         )));
 581
 582         // Step 10: Create Router
 583         let scoring_fee_params = ProbabilisticScoringFeeParameters::default();
 584         let router = Arc::new(DefaultRouter::new(
 585                 network_graph.clone(),
 586                 logger.clone(),
 587                 keys_manager.get_secure_random_bytes(),
 588                 scorer.clone(),
 589                 scoring_fee_params,
 590         ));
 591
 592         // Step 11: Initialize the ChannelManager
 593         let mut user_config = UserConfig::default();
 594         user_config.channel_handshake_limits.force_announced_channel_preference = false;
 595         user_config.manually_accept_inbound_channels = true;
 596         let mut restarting_node = true;
 597         let (channel_manager_blockhash, channel_manager) = {
 598                 if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
 599                         let mut channel_monitor_mut_references = Vec::new();
 600                         for (_, channel_monitor) in channelmonitors.iter_mut() {
 601                                 channel_monitor_mut_references.push(channel_monitor);
 602                         }
 603                         let read_args = ChannelManagerReadArgs::new(
 604                                 keys_manager.clone(),
 605                                 keys_manager.clone(),
 606                                 keys_manager.clone(),
 607                                 fee_estimator.clone(),
 608                                 chain_monitor.clone(),
 609                                 broadcaster.clone(),
 610                                 router,
 611                                 logger.clone(),
 612                                 user_config,
 613                                 channel_monitor_mut_references,
 614                         );
 615                         <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
 616                 } else {
 617                         // We're starting a fresh node.
 618                         restarting_node = false;
 619
 620                         let polled_best_block = polled_chain_tip.to_best_block();
 621                         let polled_best_block_hash = polled_best_block.block_hash();
 622                         let chain_params =
 623                                 ChainParameters { network: args.network, best_block: polled_best_block };
 624                         let fresh_channel_manager = channelmanager::ChannelManager::new(
 625                                 fee_estimator.clone(),
 626                                 chain_monitor.clone(),
 627                                 broadcaster.clone(),
 628                                 router,
 629                                 logger.clone(),
 630                                 keys_manager.clone(),
 631                                 keys_manager.clone(),
 632                                 keys_manager.clone(),
 633                                 user_config,
 634                                 chain_params,
 635                                 cur.as_secs() as u32,
 636                         );
 637                         (polled_best_block_hash, fresh_channel_manager)
 638                 }
 639         };
 640
 641         // Step 12: Sync ChannelMonitors and ChannelManager to chain tip
 642         let mut chain_listener_channel_monitors = Vec::new();
 643         let mut cache = UnboundedCache::new();
 644         let chain_tip = if restarting_node {
 645                 let mut chain_listeners = vec![(
 646                         channel_manager_blockhash,
 647                         &channel_manager as &(dyn chain::Listen + Send + Sync),
 648                 )];
 649
 650                 for (blockhash, channel_monitor) in channelmonitors.drain(..) {
 651                         let outpoint = channel_monitor.get_funding_txo().0;
 652                         chain_listener_channel_monitors.push((
 653                                 blockhash,
 654                                 (channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()),
 655                                 outpoint,
 656                         ));
 657                 }
 658
 659                 for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
 660                         chain_listeners.push((
 661                                 monitor_listener_info.0,
 662                                 &monitor_listener_info.1 as &(dyn chain::Listen + Send + Sync),
 663                         ));
 664                 }
 665
 666                 init::synchronize_listeners(
 667                         bitcoind_client.as_ref(),
 668                         args.network,
 669                         &mut cache,
 670                         chain_listeners,
 671                 )
 672                 .await
 673                 .unwrap()
 674         } else {
 675                 polled_chain_tip
 676         };
 677
 678         // Step 13: Give ChannelMonitors to ChainMonitor
 679         for item in chain_listener_channel_monitors.drain(..) {
 680                 let channel_monitor = item.1 .0;
 681                 let funding_outpoint = item.2;
 682                 assert_eq!(
 683                         chain_monitor.watch_channel(funding_outpoint, channel_monitor),
 684                         ChannelMonitorUpdateStatus::Completed
 685                 );
 686         }
 687
 688         // Step 14: Optional: Initialize the P2PGossipSync
 689         let gossip_sync = Arc::new(P2PGossipSync::new(
 690                 Arc::clone(&network_graph),
 691                 None::<Arc<BitcoindClient>>,
 692                 logger.clone(),
 693         ));
 694
 695         // Step 15: Initialize the PeerManager
 696         let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
 697         let onion_messenger: Arc<OnionMessenger> = Arc::new(OnionMessenger::new(
 698                 Arc::clone(&keys_manager),
 699                 Arc::clone(&keys_manager),
 700                 Arc::clone(&logger),
 701                 Arc::new(DefaultMessageRouter {}),
 702                 IgnoringMessageHandler {},
 703                 IgnoringMessageHandler {},
 704         ));
 705         let mut ephemeral_bytes = [0; 32];
 706         let current_time = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs();
 707         rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
 708         let lightning_msg_handler = MessageHandler {
 709                 chan_handler: channel_manager.clone(),
 710                 route_handler: gossip_sync.clone(),
 711                 onion_message_handler: onion_messenger.clone(),
 712                 custom_message_handler: IgnoringMessageHandler {},
 713         };
 714         let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
 715                 lightning_msg_handler,
 716                 current_time.try_into().unwrap(),
 717                 &ephemeral_bytes,
 718                 logger.clone(),
 719                 Arc::clone(&keys_manager),
 720         ));
 721
 722         // ## Running LDK
 723         // Step 16: Initialize networking
 724
 725         let peer_manager_connection_handler = peer_manager.clone();
 726         let listening_port = args.ldk_peer_listening_port;
 727         let stop_listen_connect = Arc::new(AtomicBool::new(false));
 728         let stop_listen = Arc::clone(&stop_listen_connect);
 729         tokio::spawn(async move {
 730                 let listener = tokio::net::TcpListener::bind(format!("[::]:{}", listening_port))
 731                         .await
 732                         .expect("Failed to bind to listen port - is something else already listening on it?");
 733                 loop {
 734                         let peer_mgr = peer_manager_connection_handler.clone();
 735                         let tcp_stream = listener.accept().await.unwrap().0;
 736                         if stop_listen.load(Ordering::Acquire) {
 737                                 return;
 738                         }
 739                         tokio::spawn(async move {
 740                                 lightning_net_tokio::setup_inbound(
 741                                         peer_mgr.clone(),
 742                                         tcp_stream.into_std().unwrap(),
 743                                 )
 744                                 .await;
 745                         });
 746                 }
 747         });
 748
 749         // Step 17: Connect and Disconnect Blocks
 750         let channel_manager_listener = channel_manager.clone();
 751         let chain_monitor_listener = chain_monitor.clone();
 752         let bitcoind_block_source = bitcoind_client.clone();
 753         let network = args.network;
 754         tokio::spawn(async move {
 755                 let chain_poller = poll::ChainPoller::new(bitcoind_block_source.as_ref(), network);
 756                 let chain_listener = (chain_monitor_listener, channel_manager_listener);
 757                 let mut spv_client = SpvClient::new(chain_tip, chain_poller, &mut cache, &chain_listener);
 758                 loop {
 759                         spv_client.poll_best_tip().await.unwrap();
 760                         tokio::time::sleep(Duration::from_secs(1)).await;
 761                 }
 762         });
 763
 764         let inbound_payments = Arc::new(Mutex::new(disk::read_payment_info(Path::new(&format!(
 765                 "{}/{}",
 766                 ldk_data_dir, INBOUND_PAYMENTS_FNAME
 767         )))));
 768         let outbound_payments = Arc::new(Mutex::new(disk::read_payment_info(Path::new(&format!(
 769                 "{}/{}",
 770                 ldk_data_dir, OUTBOUND_PAYMENTS_FNAME
 771         )))));
 772         let recent_payments_payment_hashes = channel_manager
 773                 .list_recent_payments()
 774                 .into_iter()
 775                 .filter_map(|p| match p {
 776                         RecentPaymentDetails::Pending { payment_hash, .. } => Some(payment_hash),
 777                         RecentPaymentDetails::Fulfilled { payment_hash } => payment_hash,
 778                         RecentPaymentDetails::Abandoned { payment_hash } => Some(payment_hash),
 779                 })
 780                 .collect::<Vec<PaymentHash>>();
 781         for (payment_hash, payment_info) in outbound_payments
 782                 .lock()
 783                 .unwrap()
 784                 .payments
 785                 .iter_mut()
 786                 .filter(|(_, i)| matches!(i.status, HTLCStatus::Pending))
 787         {
 788                 if !recent_payments_payment_hashes.contains(payment_hash) {
 789                         payment_info.status = HTLCStatus::Failed;
 790                 }
 791         }
 792         persister.persist(OUTBOUND_PAYMENTS_FNAME, &*outbound_payments.lock().unwrap()).unwrap();
 793
 794         // Step 18: Handle LDK Events
 795         let channel_manager_event_listener = Arc::clone(&channel_manager);
 796         let bitcoind_client_event_listener = Arc::clone(&bitcoind_client);
 797         let network_graph_event_listener = Arc::clone(&network_graph);
 798         let keys_manager_event_listener = Arc::clone(&keys_manager);
 799         let inbound_payments_event_listener = Arc::clone(&inbound_payments);
 800         let outbound_payments_event_listener = Arc::clone(&outbound_payments);
 801         let persister_event_listener = Arc::clone(&persister);
 802         let network = args.network;
 803         let event_handler = move |event: Event| {
 804                 let channel_manager_event_listener = Arc::clone(&channel_manager_event_listener);
 805                 let bitcoind_client_event_listener = Arc::clone(&bitcoind_client_event_listener);
 806                 let network_graph_event_listener = Arc::clone(&network_graph_event_listener);
 807                 let keys_manager_event_listener = Arc::clone(&keys_manager_event_listener);
 808                 let inbound_payments_event_listener = Arc::clone(&inbound_payments_event_listener);
 809                 let outbound_payments_event_listener = Arc::clone(&outbound_payments_event_listener);
 810                 let persister_event_listener = Arc::clone(&persister_event_listener);
 811                 async move {
 812                         handle_ldk_events(
 813                                 &channel_manager_event_listener,
 814                                 &bitcoind_client_event_listener,
 815                                 &network_graph_event_listener,
 816                                 &keys_manager_event_listener,
 817                                 inbound_payments_event_listener,
 818                                 outbound_payments_event_listener,
 819                                 &persister_event_listener,
 820                                 network,
 821                                 event,
 822                         )
 823                         .await;
 824                 }
 825         };
 826
 827         // Step 19: Persist ChannelManager and NetworkGraph
 828         let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
 829
 830         // Step 20: Background Processing
 831         let (bp_exit, bp_exit_check) = tokio::sync::watch::channel(());
 832         let mut background_processor = tokio::spawn(process_events_async(
 833                 Arc::clone(&persister),
 834                 event_handler,
 835                 chain_monitor.clone(),
 836                 channel_manager.clone(),
 837                 GossipSync::p2p(gossip_sync.clone()),
 838                 peer_manager.clone(),
 839                 logger.clone(),
 840                 Some(scorer.clone()),
 841                 move |t| {
 842                         let mut bp_exit_fut_check = bp_exit_check.clone();
 843                         Box::pin(async move {
 844                                 tokio::select! {
 845                                         _ = tokio::time::sleep(t) => false,
 846                                         _ = bp_exit_fut_check.changed() => true,
 847                                 }
 848                         })
 849                 },
 850                 false,
 851         ));
 852
 853         // Regularly reconnect to channel peers.
 854         let connect_cm = Arc::clone(&channel_manager);
 855         let connect_pm = Arc::clone(&peer_manager);
 856         let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
 857         let stop_connect = Arc::clone(&stop_listen_connect);
 858         tokio::spawn(async move {
 859                 let mut interval = tokio::time::interval(Duration::from_secs(1));
 860                 interval.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Delay);
 861                 loop {
 862                         interval.tick().await;
 863                         match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
 864                                 Ok(info) => {
 865                                         let peers = connect_pm.get_peer_node_ids();
 866                                         for node_id in connect_cm
 867                                                 .list_channels()
 868                                                 .iter()
 869                                                 .map(|chan| chan.counterparty.node_id)
 870                                                 .filter(|id| !peers.iter().any(|(pk, _)| id == pk))
 871                                         {
 872                                                 if stop_connect.load(Ordering::Acquire) {
 873                                                         return;
 874                                                 }
 875                                                 for (pubkey, peer_addr) in info.iter() {
 876                                                         if *pubkey == node_id {
 877                                                                 let _ = cli::do_connect_peer(
 878                                                                         *pubkey,
 879                                                                         peer_addr.clone(),
 880                                                                         Arc::clone(&connect_pm),
 881                                                                 )
 882                                                                 .await;
 883                                                         }
 884                                                 }
 885                                         }
 886                                 }
 887                                 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
 888                         }
 889                 }
 890         });
 891
 892         // Regularly broadcast our node_announcement. This is only required (or possible) if we have
 893         // some public channels.
 894         let peer_man = Arc::clone(&peer_manager);
 895         let chan_man = Arc::clone(&channel_manager);
 896         let network = args.network;
 897         tokio::spawn(async move {
 898                 // First wait a minute until we have some peers and maybe have opened a channel.
 899                 tokio::time::sleep(Duration::from_secs(60)).await;
 900                 // Then, update our announcement once an hour to keep it fresh but avoid unnecessary churn
 901                 // in the global gossip network.
 902                 let mut interval = tokio::time::interval(Duration::from_secs(3600));
 903                 loop {
 904                         interval.tick().await;
 905                         // Don't bother trying to announce if we don't have any public channls, though our
 906                         // peers should drop such an announcement anyway. Note that announcement may not
 907                         // propagate until we have a channel with 6+ confirmations.
 908                         if chan_man.list_channels().iter().any(|chan| chan.is_public) {
 909                                 peer_man.broadcast_node_announcement(
 910                                         [0; 3],
 911                                         args.ldk_announced_node_name,
 912                                         args.ldk_announced_listen_addr.clone(),
 913                                 );
 914                         }
 915                 }
 916         });
 917
 918         tokio::spawn(sweep::periodic_sweep(
 919                 ldk_data_dir.clone(),
 920                 Arc::clone(&keys_manager),
 921                 Arc::clone(&logger),
 922                 Arc::clone(&persister),
 923                 Arc::clone(&bitcoind_client),
 924                 Arc::clone(&channel_manager),
 925         ));
 926
 927         // Start the CLI.
 928         let cli_poll = tokio::spawn(cli::poll_for_user_input(
 929                 Arc::clone(&peer_manager),
 930                 Arc::clone(&channel_manager),
 931                 Arc::clone(&keys_manager),
 932                 Arc::clone(&network_graph),
 933                 Arc::clone(&onion_messenger),
 934                 inbound_payments,
 935                 outbound_payments,
 936                 ldk_data_dir,
 937                 network,
 938                 Arc::clone(&logger),
 939                 Arc::clone(&persister),
 940         ));
 941
 942         // Exit if either CLI polling exits or the background processor exits (which shouldn't happen
 943         // unless we fail to write to the filesystem).
 944         tokio::select! {
 945                 _ = cli_poll => {},
 946                 bg_res = &mut background_processor => {
 947                         stop_listen_connect.store(true, Ordering::Release);
 948                         peer_manager.disconnect_all_peers();
 949                         panic!("ERR: background processing stopped with result {:?}, exiting", bg_res);
 950                 },
 951         }
 952
 953         // Disconnect our peers and stop accepting new connections. This ensures we don't continue
 954         // updating our channel data after we've stopped the background processor.
 955         stop_listen_connect.store(true, Ordering::Release);
 956         peer_manager.disconnect_all_peers();
 957
 958         // Stop the background processor.
 959         if !bp_exit.is_closed() {
 960                 bp_exit.send(()).unwrap();
 961                 background_processor.await.unwrap().unwrap();
 962         }
 963 }
 964
 965 #[tokio::main]
 966 pub async fn main() {
 967         #[cfg(not(target_os = "windows"))]
 968         {
 969                 // Catch Ctrl-C with a dummy signal handler.
 970                 unsafe {
 971                         let mut new_action: libc::sigaction = core::mem::zeroed();
 972                         let mut old_action: libc::sigaction = core::mem::zeroed();
 973
 974                         extern "C" fn dummy_handler(
 975                                 _: libc::c_int, _: *const libc::siginfo_t, _: *const libc::c_void,
 976                         ) {
 977                         }
 978
 979                         new_action.sa_sigaction = dummy_handler as libc::sighandler_t;
 980                         new_action.sa_flags = libc::SA_SIGINFO;
 981
 982                         libc::sigaction(
 983                                 libc::SIGINT,
 984                                 &new_action as *const libc::sigaction,
 985                                 &mut old_action as *mut libc::sigaction,
 986                         );
 987                 }
 988         }
 989
 990         start_ldk().await;
 991 }