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