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