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