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

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