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