_ Git - ldk-sample/blob - src/main.rs

   1 pub mod bitcoind_client;
   2 mod cli;
   3 mod convert;
   4 mod disk;
   5 mod hex_utils;
   6
   7 use crate::bitcoind_client::BitcoindClient;
   8 use crate::disk::FilesystemLogger;
   9 use bitcoin::blockdata::constants::genesis_block;
  10 use bitcoin::blockdata::transaction::Transaction;
  11 use bitcoin::consensus::encode;
  12 use bitcoin::hashes::sha256::Hash as Sha256;
  13 use bitcoin::hashes::Hash;
  14 use bitcoin::network::constants::Network;
  15 use bitcoin::secp256k1::Secp256k1;
  16 use bitcoin::BlockHash;
  17 use bitcoin_bech32::WitnessProgram;
  18 use lightning::chain;
  19 use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
  20 use lightning::chain::chainmonitor;
  21 use lightning::chain::keysinterface::{InMemorySigner, KeysInterface, KeysManager};
  22 use lightning::chain::Filter;
  23 use lightning::chain::Watch;
  24 use lightning::ln::channelmanager;
  25 use lightning::ln::channelmanager::{
  26         ChainParameters, ChannelManagerReadArgs, PaymentHash, PaymentPreimage, SimpleArcChannelManager,
  27 };
  28 use lightning::ln::peer_handler::{MessageHandler, SimpleArcPeerManager};
  29 use lightning::routing::network_graph::NetGraphMsgHandler;
  30 use lightning::util::config::UserConfig;
  31 use lightning::util::events::{Event, EventsProvider};
  32 use lightning::util::ser::ReadableArgs;
  33 use lightning_background_processor::BackgroundProcessor;
  34 use lightning_block_sync::init;
  35 use lightning_block_sync::poll;
  36 use lightning_block_sync::SpvClient;
  37 use lightning_block_sync::UnboundedCache;
  38 use lightning_net_tokio::SocketDescriptor;
  39 use lightning_persister::FilesystemPersister;
  40 use rand::{thread_rng, Rng};
  41 use std::collections::HashMap;
  42 use std::fmt;
  43 use std::fs;
  44 use std::fs::File;
  45 use std::io;
  46 use std::io::Write;
  47 use std::ops::Deref;
  48 use std::path::Path;
  49 use std::sync::{Arc, Mutex};
  50 use std::time::{Duration, SystemTime};
  51 use tokio::sync::mpsc;
  52
  53 #[derive(PartialEq)]
  54 pub(crate) enum HTLCDirection {
  55         Inbound,
  56         Outbound,
  57 }
  58
  59 pub(crate) enum HTLCStatus {
  60         Pending,
  61         Succeeded,
  62         Failed,
  63 }
  64
  65 pub(crate) struct SatoshiAmount(Option<u64>);
  66
  67 impl fmt::Display for SatoshiAmount {
  68         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
  69                 match self.0 {
  70                         Some(amt) => write!(f, "{}", amt),
  71                         None => write!(f, "unknown"),
  72                 }
  73         }
  74 }
  75
  76 pub(crate) type PaymentInfoStorage = Arc<
  77         Mutex<
  78                 HashMap<PaymentHash, (Option<PaymentPreimage>, HTLCDirection, HTLCStatus, SatoshiAmount)>,
  79         >,
  80 >;
  81
  82 type ChainMonitor = chainmonitor::ChainMonitor<
  83         InMemorySigner,
  84         Arc<dyn Filter>,
  85         Arc<BitcoindClient>,
  86         Arc<BitcoindClient>,
  87         Arc<FilesystemLogger>,
  88         Arc<FilesystemPersister>,
  89 >;
  90
  91 pub(crate) type PeerManager = SimpleArcPeerManager<
  92         SocketDescriptor,
  93         ChainMonitor,
  94         BitcoindClient,
  95         BitcoindClient,
  96         dyn chain::Access,
  97         FilesystemLogger,
  98 >;
  99
 100 pub(crate) type ChannelManager =
 101         SimpleArcChannelManager<ChainMonitor, BitcoindClient, BitcoindClient, FilesystemLogger>;
 102
 103 async fn handle_ldk_events(
 104         channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 105         bitcoind_client: Arc<BitcoindClient>, keys_manager: Arc<KeysManager>,
 106         payment_storage: PaymentInfoStorage, network: Network,
 107 ) {
 108         loop {
 109                 let loop_channel_manager = channel_manager.clone();
 110                 let mut events = channel_manager.get_and_clear_pending_events();
 111                 events.append(&mut chain_monitor.get_and_clear_pending_events());
 112                 for event in events {
 113                         match event {
 114                                 Event::FundingGenerationReady {
 115                                         temporary_channel_id,
 116                                         channel_value_satoshis,
 117                                         output_script,
 118                                         ..
 119                                 } => {
 120                                         // Construct the raw transaction with one output, that is paid the amount of the
 121                                         // channel.
 122                                         let addr = WitnessProgram::from_scriptpubkey(
 123                                                 &output_script[..],
 124                                                 match network {
 125                                                         Network::Bitcoin => bitcoin_bech32::constants::Network::Bitcoin,
 126                                                         Network::Testnet => bitcoin_bech32::constants::Network::Testnet,
 127                                                         Network::Regtest => bitcoin_bech32::constants::Network::Regtest,
 128                                                         Network::Signet => panic!("Signet unsupported"),
 129                                                 },
 130                                         )
 131                                         .expect("Lightning funding tx should always be to a SegWit output")
 132                                         .to_address();
 133                                         let mut outputs = vec![HashMap::with_capacity(1)];
 134                                         outputs[0].insert(addr, channel_value_satoshis as f64 / 100_000_000.0);
 135                                         let raw_tx = bitcoind_client.create_raw_transaction(outputs).await;
 136
 137                                         // Have your wallet put the inputs into the transaction such that the output is
 138                                         // satisfied.
 139                                         let funded_tx = bitcoind_client.fund_raw_transaction(raw_tx).await;
 140                                         let change_output_position = funded_tx.changepos;
 141                                         assert!(change_output_position == 0 || change_output_position == 1);
 142
 143                                         // Sign the final funding transaction and broadcast it.
 144                                         let signed_tx =
 145                                                 bitcoind_client.sign_raw_transaction_with_wallet(funded_tx.hex).await;
 146                                         assert_eq!(signed_tx.complete, true);
 147                                         let final_tx: Transaction =
 148                                                 encode::deserialize(&hex_utils::to_vec(&signed_tx.hex).unwrap()).unwrap();
 149                                         // Give the funding transaction back to LDK for opening the channel.
 150                                         loop_channel_manager
 151                                                 .funding_transaction_generated(&temporary_channel_id, final_tx)
 152                                                 .unwrap();
 153                                 }
 154                                 Event::FundingBroadcastSafe { funding_txo, .. } => {
 155                                 Event::PaymentReceived { payment_hash, payment_secret, amt: amt_msat } => {
 156                                         let mut payments = payment_storage.lock().unwrap();
 157                                         if let Some((Some(preimage), _, _, _)) = payments.get(&payment_hash) {
 158                                                 assert!(loop_channel_manager.claim_funds(
 159                                                         preimage.clone(),
 160                                                         &payment_secret,
 161                                                         amt_msat
 162                                                 ));
 163                                                 println!(
 164                                                         "\nEVENT: received payment from payment_hash {} of {} satoshis",
 165                                                         hex_utils::hex_str(&payment_hash.0),
 166                                                         amt_msat / 1000
 167                                                 );
 168                                                 print!("> ");
 169                                                 io::stdout().flush().unwrap();
 170                                                 let (_, _, ref mut status, _) = payments.get_mut(&payment_hash).unwrap();
 171                                                 *status = HTLCStatus::Succeeded;
 172                                         } else {
 173                                                 println!("\nERROR: we received a payment but didn't know the preimage");
 174                                                 print!("> ");
 175                                                 io::stdout().flush().unwrap();
 176                                                 loop_channel_manager.fail_htlc_backwards(&payment_hash, &payment_secret);
 177                                                 payments.insert(
 178                                                         payment_hash,
 179                                                         (None, HTLCDirection::Inbound, HTLCStatus::Failed, SatoshiAmount(None)),
 180                                                 );
 181                                         }
 182                                 }
 183                                 Event::PaymentSent { payment_preimage } => {
 184                                         let hashed = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
 185                                         let mut payments = payment_storage.lock().unwrap();
 186                                         for (payment_hash, (preimage_option, _, status, amt_sat)) in payments.iter_mut()
 187                                         {
 188                                                 if *payment_hash == hashed {
 189                                                         *preimage_option = Some(payment_preimage);
 190                                                         *status = HTLCStatus::Succeeded;
 191                                                         println!(
 192                                                                 "\nEVENT: successfully sent payment of {} satoshis from \
 193                                          payment hash {:?} with preimage {:?}",
 194                                                                 amt_sat,
 195                                                                 hex_utils::hex_str(&payment_hash.0),
 196                                                                 hex_utils::hex_str(&payment_preimage.0)
 197                                                         );
 198                                                         print!("> ");
 199                                                         io::stdout().flush().unwrap();
 200                                                 }
 201                                         }
 202                                 }
 203                                 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
 204                                         print!(
 205                                                 "\nEVENT: Failed to send payment to payment hash {:?}: ",
 206                                                 hex_utils::hex_str(&payment_hash.0)
 207                                         );
 208                                         if rejected_by_dest {
 209                                                 println!("rejected by destination node");
 210                                         } else {
 211                                                 println!("route failed");
 212                                         }
 213                                         print!("> ");
 214                                         io::stdout().flush().unwrap();
 215
 216                                         let mut payments = payment_storage.lock().unwrap();
 217                                         if payments.contains_key(&payment_hash) {
 218                                                 let (_, _, ref mut status, _) = payments.get_mut(&payment_hash).unwrap();
 219                                                 *status = HTLCStatus::Failed;
 220                                         }
 221                                 }
 222                                 Event::PendingHTLCsForwardable { time_forwardable } => {
 223                                         let forwarding_channel_manager = loop_channel_manager.clone();
 224                                         tokio::spawn(async move {
 225                                                 let min = time_forwardable.as_millis() as u64;
 226                                                 let millis_to_sleep = thread_rng().gen_range(min, min * 5) as u64;
 227                                                 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
 228                                                 forwarding_channel_manager.process_pending_htlc_forwards();
 229                                         });
 230                                 }
 231                                 Event::SpendableOutputs { outputs } => {
 232                                         let destination_address = bitcoind_client.get_new_address().await;
 233                                         let output_descriptors = &outputs.iter().map(|a| a).collect::<Vec<_>>();
 234                                         let tx_feerate =
 235                                                 bitcoind_client.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
 236                                         let spending_tx = keys_manager
 237                                                 .spend_spendable_outputs(
 238                                                         output_descriptors,
 239                                                         Vec::new(),
 240                                                         destination_address.script_pubkey(),
 241                                                         tx_feerate,
 242                                                         &Secp256k1::new(),
 243                                                 )
 244                                                 .unwrap();
 245                                         bitcoind_client.broadcast_transaction(&spending_tx);
 246                                 }
 247                         }
 248                 }
 249                 tokio::time::sleep(Duration::from_secs(1)).await;
 250         }
 251 }
 252
 253 async fn start_ldk() {
 254         let args = match cli::parse_startup_args() {
 255                 Ok(user_args) => user_args,
 256                 Err(()) => return,
 257         };
 258
 259         // Initialize the LDK data directory if necessary.
 260         let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
 261         fs::create_dir_all(ldk_data_dir.clone()).unwrap();
 262
 263         // Initialize our bitcoind client.
 264         let bitcoind_client = match BitcoindClient::new(
 265                 args.bitcoind_rpc_host.clone(),
 266                 args.bitcoind_rpc_port,
 267                 args.bitcoind_rpc_username.clone(),
 268                 args.bitcoind_rpc_password.clone(),
 269         )
 270         .await
 271         {
 272                 Ok(client) => Arc::new(client),
 273                 Err(e) => {
 274                         println!("Failed to connect to bitcoind client: {}", e);
 275                         return;
 276                 }
 277         };
 278
 279         // ## Setup
 280         // Step 1: Initialize the FeeEstimator
 281
 282         // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
 283         let fee_estimator = bitcoind_client.clone();
 284
 285         // Step 2: Initialize the Logger
 286         let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
 287
 288         // Step 3: Initialize the BroadcasterInterface
 289
 290         // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
 291         // broadcaster.
 292         let broadcaster = bitcoind_client.clone();
 293
 294         // Step 4: Initialize Persist
 295         let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
 296
 297         // Step 5: Initialize the ChainMonitor
 298         let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
 299                 None,
 300                 broadcaster.clone(),
 301                 logger.clone(),
 302                 fee_estimator.clone(),
 303                 persister.clone(),
 304         ));
 305
 306         // Step 6: Initialize the KeysManager
 307
 308         // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
 309         // other secret key material.
 310         let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
 311         let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
 312                 assert_eq!(seed.len(), 32);
 313                 let mut key = [0; 32];
 314                 key.copy_from_slice(&seed);
 315                 key
 316         } else {
 317                 let mut key = [0; 32];
 318                 thread_rng().fill_bytes(&mut key);
 319                 match File::create(keys_seed_path.clone()) {
 320                         Ok(mut f) => {
 321                                 f.write_all(&key).expect("Failed to write node keys seed to disk");
 322                                 f.sync_all().expect("Failed to sync node keys seed to disk");
 323                         }
 324                         Err(e) => {
 325                                 println!("ERROR: Unable to create keys seed file {}: {}", keys_seed_path, e);
 326                                 return;
 327                         }
 328                 }
 329                 key
 330         };
 331         let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
 332         let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
 333
 334         // Step 7: Read ChannelMonitor state from disk
 335         let mut channelmonitors = persister.read_channelmonitors(keys_manager.clone()).unwrap();
 336
 337         // Step 9: Initialize the ChannelManager
 338         let user_config = UserConfig::default();
 339         let mut restarting_node = true;
 340         let (channel_manager_blockhash, mut channel_manager) = {
 341                 if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
 342                         let mut channel_monitor_mut_references = Vec::new();
 343                         for (_, channel_monitor) in channelmonitors.iter_mut() {
 344                                 channel_monitor_mut_references.push(channel_monitor);
 345                         }
 346                         let read_args = ChannelManagerReadArgs::new(
 347                                 keys_manager.clone(),
 348                                 fee_estimator.clone(),
 349                                 chain_monitor.clone(),
 350                                 broadcaster.clone(),
 351                                 logger.clone(),
 352                                 user_config,
 353                                 channel_monitor_mut_references,
 354                         );
 355                         <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
 356                 } else {
 357                         // We're starting a fresh node.
 358                         restarting_node = false;
 359                         let getinfo_resp = bitcoind_client.get_blockchain_info().await;
 360
 361                         let chain_params = ChainParameters {
 362                                 network: args.network,
 363                                 latest_hash: getinfo_resp.latest_blockhash,
 364                                 latest_height: getinfo_resp.latest_height,
 365                         };
 366                         let fresh_channel_manager = channelmanager::ChannelManager::new(
 367                                 fee_estimator.clone(),
 368                                 chain_monitor.clone(),
 369                                 broadcaster.clone(),
 370                                 logger.clone(),
 371                                 keys_manager.clone(),
 372                                 user_config,
 373                                 chain_params,
 374                         );
 375                         (getinfo_resp.latest_blockhash, fresh_channel_manager)
 376                 }
 377         };
 378
 379         // Step 10: Sync ChannelMonitors and ChannelManager to chain tip
 380         let mut chain_listener_channel_monitors = Vec::new();
 381         let mut cache = UnboundedCache::new();
 382         let mut chain_tip: Option<poll::ValidatedBlockHeader> = None;
 383         if restarting_node {
 384                 let mut chain_listeners =
 385                         vec![(channel_manager_blockhash, &mut channel_manager as &mut dyn chain::Listen)];
 386
 387                 for (blockhash, channel_monitor) in channelmonitors.drain(..) {
 388                         let outpoint = channel_monitor.get_funding_txo().0;
 389                         chain_listener_channel_monitors.push((
 390                                 blockhash,
 391                                 (channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()),
 392                                 outpoint,
 393                         ));
 394                 }
 395
 396                 for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
 397                         chain_listeners.push((
 398                                 monitor_listener_info.0,
 399                                 &mut monitor_listener_info.1 as &mut dyn chain::Listen,
 400                         ));
 401                 }
 402                 chain_tip = Some(
 403                         init::synchronize_listeners(
 404                                 &mut bitcoind_client.deref(),
 405                                 args.network,
 406                                 &mut cache,
 407                                 chain_listeners,
 408                         )
 409                         .await
 410                         .unwrap(),
 411                 );
 412         }
 413
 414         // Step 11: Give ChannelMonitors to ChainMonitor
 415         for item in chain_listener_channel_monitors.drain(..) {
 416                 let channel_monitor = item.1 .0;
 417                 let funding_outpoint = item.2;
 418                 chain_monitor.watch_channel(funding_outpoint, channel_monitor).unwrap();
 419         }
 420
 421         // Step 13: Optional: Initialize the NetGraphMsgHandler
 422         // XXX persist routing data
 423         let genesis = genesis_block(args.network).header.block_hash();
 424         let router =
 425                 Arc::new(NetGraphMsgHandler::new(genesis, None::<Arc<dyn chain::Access>>, logger.clone()));
 426
 427         // Step 14: Initialize the PeerManager
 428         let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
 429         let mut ephemeral_bytes = [0; 32];
 430         rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
 431         let lightning_msg_handler =
 432                 MessageHandler { chan_handler: channel_manager.clone(), route_handler: router.clone() };
 433         let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
 434                 lightning_msg_handler,
 435                 keys_manager.get_node_secret(),
 436                 &ephemeral_bytes,
 437                 logger.clone(),
 438         ));
 439
 440         // ## Running LDK
 441         // Step 16: Initialize Peer Connection Handling
 442
 443         // We poll for events in handle_ldk_events(..) rather than waiting for them over the
 444         // mpsc::channel, so we can leave the event receiver as unused.
 445         let (event_ntfn_sender, _event_ntfn_receiver) = mpsc::channel(2);
 446         let peer_manager_connection_handler = peer_manager.clone();
 447         let event_notifier = event_ntfn_sender.clone();
 448         let listening_port = args.ldk_peer_listening_port;
 449         tokio::spawn(async move {
 450                 let listener = std::net::TcpListener::bind(format!("0.0.0.0:{}", listening_port)).unwrap();
 451                 loop {
 452                         let tcp_stream = listener.accept().unwrap().0;
 453                         lightning_net_tokio::setup_inbound(
 454                                 peer_manager_connection_handler.clone(),
 455                                 event_notifier.clone(),
 456                                 tcp_stream,
 457                         )
 458                         .await;
 459                 }
 460         });
 461
 462         // Step 17: Connect and Disconnect Blocks
 463         if chain_tip.is_none() {
 464                 chain_tip =
 465                         Some(init::validate_best_block_header(&mut bitcoind_client.deref()).await.unwrap());
 466         }
 467         let channel_manager_listener = channel_manager.clone();
 468         let chain_monitor_listener = chain_monitor.clone();
 469         let bitcoind_block_source = bitcoind_client.clone();
 470         let network = args.network;
 471         tokio::spawn(async move {
 472                 let mut derefed = bitcoind_block_source.deref();
 473                 let chain_poller = poll::ChainPoller::new(&mut derefed, network);
 474                 let chain_listener = (chain_monitor_listener, channel_manager_listener);
 475                 let mut spv_client =
 476                         SpvClient::new(chain_tip.unwrap(), chain_poller, &mut cache, &chain_listener);
 477                 loop {
 478                         spv_client.poll_best_tip().await.unwrap();
 479                         tokio::time::sleep(Duration::from_secs(1)).await;
 480                 }
 481         });
 482
 483         // Step 17 & 18: Initialize ChannelManager persistence & Once Per Minute: ChannelManager's
 484         // timer_chan_freshness_every_min() and PeerManager's timer_tick_occurred
 485         let data_dir = ldk_data_dir.clone();
 486         let persist_channel_manager_callback =
 487                 move |node: &ChannelManager| FilesystemPersister::persist_manager(data_dir.clone(), &*node);
 488         BackgroundProcessor::start(
 489                 persist_channel_manager_callback,
 490                 channel_manager.clone(),
 491                 peer_manager.clone(),
 492                 logger.clone(),
 493         );
 494
 495         let peer_manager_processor = peer_manager.clone();
 496         tokio::spawn(async move {
 497                 loop {
 498                         peer_manager_processor.timer_tick_occurred();
 499                         tokio::time::sleep(Duration::from_secs(60)).await;
 500                 }
 501         });
 502
 503         // Step 15: Initialize LDK Event Handling
 504         let channel_manager_event_listener = channel_manager.clone();
 505         let chain_monitor_event_listener = chain_monitor.clone();
 506         let keys_manager_listener = keys_manager.clone();
 507         let payment_info: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
 508         let payment_info_for_events = payment_info.clone();
 509         let network = args.network;
 510         let bitcoind_rpc = bitcoind_client.clone();
 511         tokio::spawn(async move {
 512                 handle_ldk_events(
 513                         channel_manager_event_listener,
 514                         chain_monitor_event_listener,
 515                         bitcoind_rpc,
 516                         keys_manager_listener,
 517                         payment_info_for_events,
 518                         network,
 519                 )
 520                 .await;
 521         });
 522
 523         // Reconnect to channel peers if possible.
 524         let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
 525         match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
 526                 Ok(mut info) => {
 527                         for (pubkey, peer_addr) in info.drain() {
 528                                 for chan_info in channel_manager.list_channels() {
 529                                         if pubkey == chan_info.remote_network_id {
 530                                                 let _ = cli::connect_peer_if_necessary(
 531                                                         pubkey,
 532                                                         peer_addr,
 533                                                         peer_manager.clone(),
 534                                                         event_ntfn_sender.clone(),
 535                                                 );
 536                                         }
 537                                 }
 538                         }
 539                 }
 540                 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
 541         }
 542
 543         // Start the CLI.
 544         cli::poll_for_user_input(
 545                 peer_manager.clone(),
 546                 channel_manager.clone(),
 547                 router.clone(),
 548                 payment_info,
 549                 keys_manager.get_node_secret(),
 550                 event_ntfn_sender,
 551                 ldk_data_dir.clone(),
 552                 logger.clone(),
 553                 args.network,
 554         )
 555         .await;
 556 }
 557
 558 #[tokio::main]
 559 pub async fn main() {
 560         start_ldk().await;
 561 }