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