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