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