X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain.rs;h=bfb586adfbe630c3df9ff7fc31b51c67d493ff9c;hb=ed39ac6dd5f0b297fe4bf1468b2c0e6e20ce9f9d;hp=d8b0f23b415305d6a4c07c7889067c782ba0c1ad;hpb=a6962463ad036f472c03a67975fd94ba4350f63b;p=ldk-sample diff --git a/src/main.rs b/src/main.rs index d8b0f23..bfb586a 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,68 +1,618 @@ -use base64; -use serde_json; +pub mod bitcoind_client; +mod cli; +mod convert; +mod disk; +mod hex_utils; -use lightning::chain::chaininterface::{ConfirmationTarget, FeeEstimator}; -use lightning::util::logger::{Logger, Record}; -use lightning_block_sync::http::HttpEndpoint; -use lightning_block_sync::rpc::RpcClient; +use crate::bitcoind_client::BitcoindClient; +use crate::disk::FilesystemLogger; +use bitcoin::blockdata::constants::genesis_block; +use bitcoin::blockdata::transaction::Transaction; +use bitcoin::consensus::encode; +use bitcoin::hashes::sha256::Hash as Sha256; +use bitcoin::hashes::Hash; +use bitcoin::network::constants::Network; +use bitcoin::secp256k1::Secp256k1; +use bitcoin::BlockHash; +use bitcoin_bech32::WitnessProgram; +use lightning::chain; +use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator}; +use lightning::chain::chainmonitor; +use lightning::chain::keysinterface::{InMemorySigner, KeysInterface, KeysManager}; +use lightning::chain::{BestBlock, Filter, Watch}; +use lightning::ln::channelmanager; +use lightning::ln::channelmanager::{ + ChainParameters, ChannelManagerReadArgs, SimpleArcChannelManager, +}; +use lightning::ln::peer_handler::{MessageHandler, SimpleArcPeerManager}; +use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret}; +use lightning::routing::network_graph::NetGraphMsgHandler; +use lightning::util::config::UserConfig; +use lightning::util::events::{Event, PaymentPurpose}; +use lightning::util::ser::ReadableArgs; +use lightning_background_processor::BackgroundProcessor; +use lightning_block_sync::init; +use lightning_block_sync::poll; +use lightning_block_sync::SpvClient; +use lightning_block_sync::UnboundedCache; +use lightning_net_tokio::SocketDescriptor; +use lightning_persister::FilesystemPersister; +use rand::{thread_rng, Rng}; +use std::collections::hash_map::Entry; +use std::collections::HashMap; +use std::fmt; +use std::fs; +use std::fs::File; +use std::io; +use std::io::Write; +use std::ops::Deref; +use std::path::Path; +use std::sync::{Arc, Mutex}; +use std::time::{Duration, SystemTime}; -use std::sync::Mutex; +pub(crate) enum HTLCStatus { + Pending, + Succeeded, + Failed, +} + +pub(crate) struct MillisatAmount(Option); -pub struct BitcoindFeeEstimator { - bitcoind_rpc_client: Mutex, +impl fmt::Display for MillisatAmount { + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { + match self.0 { + Some(amt) => write!(f, "{}", amt), + None => write!(f, "unknown"), + } + } } -impl BitcoindFeeEstimator { - fn new(host: String, port: u16, path: Option, rpc_user: String, rpc_password: String) -> - std::io::Result - { - let mut http_endpoint = HttpEndpoint::for_host(host).with_port(port); - if let Some(p) = path { - http_endpoint = http_endpoint.with_path(p); - } - let rpc_credentials = base64::encode(format!("{}:{}", rpc_user, rpc_password)); - let bitcoind_rpc_client = RpcClient::new(&rpc_credentials, http_endpoint)?; - Ok(Self { - bitcoind_rpc_client: Mutex::new(bitcoind_rpc_client) - }) - } +pub(crate) struct PaymentInfo { + preimage: Option, + secret: Option, + status: HTLCStatus, + amt_msat: MillisatAmount, +} + +pub(crate) type PaymentInfoStorage = Arc>>; + +type ChainMonitor = chainmonitor::ChainMonitor< + InMemorySigner, + Arc, + Arc, + Arc, + Arc, + Arc, +>; + +pub(crate) type PeerManager = SimpleArcPeerManager< + SocketDescriptor, + ChainMonitor, + BitcoindClient, + BitcoindClient, + dyn chain::Access + Send + Sync, + FilesystemLogger, +>; + +pub(crate) type ChannelManager = + SimpleArcChannelManager; + +async fn handle_ldk_events( + channel_manager: Arc, bitcoind_client: Arc, + keys_manager: Arc, inbound_payments: PaymentInfoStorage, + outbound_payments: PaymentInfoStorage, network: Network, event: Event, +) { + match event { + Event::FundingGenerationReady { + temporary_channel_id, + channel_value_satoshis, + output_script, + .. + } => { + // Construct the raw transaction with one output, that is paid the amount of the + // channel. + let addr = WitnessProgram::from_scriptpubkey( + &output_script[..], + match network { + Network::Bitcoin => bitcoin_bech32::constants::Network::Bitcoin, + Network::Testnet => bitcoin_bech32::constants::Network::Testnet, + Network::Regtest => bitcoin_bech32::constants::Network::Regtest, + Network::Signet => panic!("Signet unsupported"), + }, + ) + .expect("Lightning funding tx should always be to a SegWit output") + .to_address(); + let mut outputs = vec![HashMap::with_capacity(1)]; + outputs[0].insert(addr, channel_value_satoshis as f64 / 100_000_000.0); + let raw_tx = bitcoind_client.create_raw_transaction(outputs).await; + + // Have your wallet put the inputs into the transaction such that the output is + // satisfied. + let funded_tx = bitcoind_client.fund_raw_transaction(raw_tx).await; + let change_output_position = funded_tx.changepos; + assert!(change_output_position == 0 || change_output_position == 1); + + // Sign the final funding transaction and broadcast it. + let signed_tx = bitcoind_client.sign_raw_transaction_with_wallet(funded_tx.hex).await; + assert_eq!(signed_tx.complete, true); + let final_tx: Transaction = + encode::deserialize(&hex_utils::to_vec(&signed_tx.hex).unwrap()).unwrap(); + // Give the funding transaction back to LDK for opening the channel. + if channel_manager + .funding_transaction_generated(&temporary_channel_id, final_tx) + .is_err() + { + println!( + "\nERROR: Channel went away before we could fund it. The peer disconnected or refused the channel."); + print!("> "); + io::stdout().flush().unwrap(); + } + } + Event::PaymentReceived { payment_hash, purpose, amt, .. } => { + let mut payments = inbound_payments.lock().unwrap(); + let (payment_preimage, payment_secret) = match purpose { + PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => { + (payment_preimage, Some(payment_secret)) + } + PaymentPurpose::SpontaneousPayment(preimage) => (Some(preimage), None), + }; + let status = match channel_manager.claim_funds(payment_preimage.unwrap()) { + true => { + println!( + "\nEVENT: received payment from payment hash {} of {} millisatoshis", + hex_utils::hex_str(&payment_hash.0), + amt + ); + print!("> "); + io::stdout().flush().unwrap(); + HTLCStatus::Succeeded + } + _ => HTLCStatus::Failed, + }; + match payments.entry(payment_hash) { + Entry::Occupied(mut e) => { + let payment = e.get_mut(); + payment.status = status; + payment.preimage = payment_preimage; + payment.secret = payment_secret; + } + Entry::Vacant(e) => { + e.insert(PaymentInfo { + preimage: payment_preimage, + secret: payment_secret, + status, + amt_msat: MillisatAmount(Some(amt)), + }); + } + } + } + Event::PaymentSent { payment_preimage } => { + let hashed = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner()); + let mut payments = outbound_payments.lock().unwrap(); + for (payment_hash, payment) in payments.iter_mut() { + if *payment_hash == hashed { + payment.preimage = Some(payment_preimage); + payment.status = HTLCStatus::Succeeded; + println!( + "\nEVENT: successfully sent payment of {} millisatoshis from \ + payment hash {:?} with preimage {:?}", + payment.amt_msat, + hex_utils::hex_str(&payment_hash.0), + hex_utils::hex_str(&payment_preimage.0) + ); + print!("> "); + io::stdout().flush().unwrap(); + } + } + } + Event::PaymentFailed { payment_hash, rejected_by_dest } => { + print!( + "\nEVENT: Failed to send payment to payment hash {:?}: ", + hex_utils::hex_str(&payment_hash.0) + ); + if rejected_by_dest { + println!("re-attempting the payment will not succeed"); + } else { + println!("payment may be retried"); + } + print!("> "); + io::stdout().flush().unwrap(); + + let mut payments = outbound_payments.lock().unwrap(); + if payments.contains_key(&payment_hash) { + let payment = payments.get_mut(&payment_hash).unwrap(); + payment.status = HTLCStatus::Failed; + } + } + Event::PendingHTLCsForwardable { time_forwardable } => { + let forwarding_channel_manager = channel_manager.clone(); + tokio::spawn(async move { + let min = time_forwardable.as_millis() as u64; + let millis_to_sleep = thread_rng().gen_range(min, min * 5) as u64; + tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await; + forwarding_channel_manager.process_pending_htlc_forwards(); + }); + } + Event::SpendableOutputs { outputs } => { + let destination_address = bitcoind_client.get_new_address().await; + let output_descriptors = &outputs.iter().map(|a| a).collect::>(); + let tx_feerate = + bitcoind_client.get_est_sat_per_1000_weight(ConfirmationTarget::Normal); + let spending_tx = keys_manager + .spend_spendable_outputs( + output_descriptors, + Vec::new(), + destination_address.script_pubkey(), + tx_feerate, + &Secp256k1::new(), + ) + .unwrap(); + bitcoind_client.broadcast_transaction(&spending_tx); + } + } } -impl FeeEstimator for BitcoindFeeEstimator { - fn get_est_sat_per_1000_weight(&self, confirmation_target: ConfirmationTarget) -> u32 { - let mut rpc_client_guard = self.bitcoind_rpc_client.lock().unwrap(); - match confirmation_target { - ConfirmationTarget::Background => { - let conf_target = serde_json::json!(144); - let estimate_mode = serde_json::json!("ECONOMICAL"); - let resp = rpc_client_guard.call_method("estimatesmartfee", - &vec![conf_target, estimate_mode]).unwrap(); - resp["feerate"].as_u64().unwrap() as u32 - }, - ConfirmationTarget::Normal => { - let conf_target = serde_json::json!(18); - let estimate_mode = serde_json::json!("ECONOMICAL"); - let resp = rpc_client_guard.call_method("estimatesmartfee", - &vec![conf_target, estimate_mode]).unwrap(); - resp["feerate"].as_u64().unwrap() as u32 - }, - ConfirmationTarget::HighPriority => { - let conf_target = serde_json::json!(6); - let estimate_mode = serde_json::json!("CONSERVATIVE"); - let resp = rpc_client_guard.call_method("estimatesmartfee", - &vec![conf_target, estimate_mode]).unwrap(); - resp["feerate"].as_u64().unwrap() as u32 - }, - } - } +async fn start_ldk() { + let args = match cli::parse_startup_args() { + Ok(user_args) => user_args, + Err(()) => return, + }; + + // Initialize the LDK data directory if necessary. + let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path); + fs::create_dir_all(ldk_data_dir.clone()).unwrap(); + + // Initialize our bitcoind client. + let bitcoind_client = match BitcoindClient::new( + args.bitcoind_rpc_host.clone(), + args.bitcoind_rpc_port, + args.bitcoind_rpc_username.clone(), + args.bitcoind_rpc_password.clone(), + ) + .await + { + Ok(client) => Arc::new(client), + Err(e) => { + println!("Failed to connect to bitcoind client: {}", e); + return; + } + }; + + // Check that the bitcoind we've connected to is running the network we expect + let bitcoind_chain = bitcoind_client.get_blockchain_info().await.chain; + if bitcoind_chain + != match args.network { + bitcoin::Network::Bitcoin => "main", + bitcoin::Network::Testnet => "test", + bitcoin::Network::Regtest => "regtest", + bitcoin::Network::Signet => "signet", + } { + println!( + "Chain argument ({}) didn't match bitcoind chain ({})", + args.network, bitcoind_chain + ); + return; + } + + // ## Setup + // Step 1: Initialize the FeeEstimator + + // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator. + let fee_estimator = bitcoind_client.clone(); + + // Step 2: Initialize the Logger + let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone())); + + // Step 3: Initialize the BroadcasterInterface + + // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction + // broadcaster. + let broadcaster = bitcoind_client.clone(); + + // Step 4: Initialize Persist + let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone())); + + // Step 5: Initialize the ChainMonitor + let chain_monitor: Arc = Arc::new(chainmonitor::ChainMonitor::new( + None, + broadcaster.clone(), + logger.clone(), + fee_estimator.clone(), + persister.clone(), + )); + + // Step 6: Initialize the KeysManager + + // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and + // other secret key material. + let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone()); + let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) { + assert_eq!(seed.len(), 32); + let mut key = [0; 32]; + key.copy_from_slice(&seed); + key + } else { + let mut key = [0; 32]; + thread_rng().fill_bytes(&mut key); + match File::create(keys_seed_path.clone()) { + Ok(mut f) => { + f.write_all(&key).expect("Failed to write node keys seed to disk"); + f.sync_all().expect("Failed to sync node keys seed to disk"); + } + Err(e) => { + println!("ERROR: Unable to create keys seed file {}: {}", keys_seed_path, e); + return; + } + } + key + }; + let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap(); + let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos())); + + // Step 7: Read ChannelMonitor state from disk + let mut channelmonitors = persister.read_channelmonitors(keys_manager.clone()).unwrap(); + + // Step 8: Initialize the ChannelManager + let mut user_config = UserConfig::default(); + user_config.peer_channel_config_limits.force_announced_channel_preference = false; + let mut restarting_node = true; + let (channel_manager_blockhash, mut channel_manager) = { + if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) { + let mut channel_monitor_mut_references = Vec::new(); + for (_, channel_monitor) in channelmonitors.iter_mut() { + channel_monitor_mut_references.push(channel_monitor); + } + let read_args = ChannelManagerReadArgs::new( + keys_manager.clone(), + fee_estimator.clone(), + chain_monitor.clone(), + broadcaster.clone(), + logger.clone(), + user_config, + channel_monitor_mut_references, + ); + <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap() + } else { + // We're starting a fresh node. + restarting_node = false; + let getinfo_resp = bitcoind_client.get_blockchain_info().await; + + let chain_params = ChainParameters { + network: args.network, + best_block: BestBlock::new( + getinfo_resp.latest_blockhash, + getinfo_resp.latest_height as u32, + ), + }; + let fresh_channel_manager = channelmanager::ChannelManager::new( + fee_estimator.clone(), + chain_monitor.clone(), + broadcaster.clone(), + logger.clone(), + keys_manager.clone(), + user_config, + chain_params, + ); + (getinfo_resp.latest_blockhash, fresh_channel_manager) + } + }; + + // Step 9: Sync ChannelMonitors and ChannelManager to chain tip + let mut chain_listener_channel_monitors = Vec::new(); + let mut cache = UnboundedCache::new(); + let mut chain_tip: Option = None; + if restarting_node { + let mut chain_listeners = + vec![(channel_manager_blockhash, &mut channel_manager as &mut dyn chain::Listen)]; + + for (blockhash, channel_monitor) in channelmonitors.drain(..) { + let outpoint = channel_monitor.get_funding_txo().0; + chain_listener_channel_monitors.push(( + blockhash, + (channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()), + outpoint, + )); + } + + for monitor_listener_info in chain_listener_channel_monitors.iter_mut() { + chain_listeners.push(( + monitor_listener_info.0, + &mut monitor_listener_info.1 as &mut dyn chain::Listen, + )); + } + chain_tip = Some( + init::synchronize_listeners( + &mut bitcoind_client.deref(), + args.network, + &mut cache, + chain_listeners, + ) + .await + .unwrap(), + ); + } + + // Step 10: Give ChannelMonitors to ChainMonitor + for item in chain_listener_channel_monitors.drain(..) { + let channel_monitor = item.1 .0; + let funding_outpoint = item.2; + chain_monitor.watch_channel(funding_outpoint, channel_monitor).unwrap(); + } + + // Step 11: Optional: Initialize the NetGraphMsgHandler + let genesis = genesis_block(args.network).header.block_hash(); + let network_graph_path = format!("{}/network_graph", ldk_data_dir.clone()); + let network_graph = disk::read_network(Path::new(&network_graph_path), genesis); + let router = Arc::new(NetGraphMsgHandler::from_net_graph( + None::>, + logger.clone(), + network_graph, + )); + let router_persist = Arc::clone(&router); + tokio::spawn(async move { + let mut interval = tokio::time::interval(Duration::from_secs(600)); + loop { + interval.tick().await; + if disk::persist_network( + Path::new(&network_graph_path), + &*router_persist.network_graph.read().unwrap(), + ) + .is_err() + { + // Persistence errors here are non-fatal as we can just fetch the routing graph + // again later, but they may indicate a disk error which could be fatal elsewhere. + eprintln!( + "Warning: Failed to persist network graph, check your disk and permissions" + ); + } + } + }); + + // Step 12: Initialize the PeerManager + let channel_manager: Arc = Arc::new(channel_manager); + let mut ephemeral_bytes = [0; 32]; + rand::thread_rng().fill_bytes(&mut ephemeral_bytes); + let lightning_msg_handler = + MessageHandler { chan_handler: channel_manager.clone(), route_handler: router.clone() }; + let peer_manager: Arc = Arc::new(PeerManager::new( + lightning_msg_handler, + keys_manager.get_node_secret(), + &ephemeral_bytes, + logger.clone(), + )); + + // ## Running LDK + // Step 13: Initialize networking + + let peer_manager_connection_handler = peer_manager.clone(); + let listening_port = args.ldk_peer_listening_port; + tokio::spawn(async move { + let listener = tokio::net::TcpListener::bind(format!("0.0.0.0:{}", listening_port)) + .await + .expect("Failed to bind to listen port - is something else already listening on it?"); + loop { + let peer_mgr = peer_manager_connection_handler.clone(); + let tcp_stream = listener.accept().await.unwrap().0; + tokio::spawn(async move { + lightning_net_tokio::setup_inbound( + peer_mgr.clone(), + tcp_stream.into_std().unwrap(), + ) + .await; + }); + } + }); + + // Step 14: Connect and Disconnect Blocks + if chain_tip.is_none() { + chain_tip = + Some(init::validate_best_block_header(&mut bitcoind_client.deref()).await.unwrap()); + } + let channel_manager_listener = channel_manager.clone(); + let chain_monitor_listener = chain_monitor.clone(); + let bitcoind_block_source = bitcoind_client.clone(); + let network = args.network; + tokio::spawn(async move { + let mut derefed = bitcoind_block_source.deref(); + let chain_poller = poll::ChainPoller::new(&mut derefed, network); + let chain_listener = (chain_monitor_listener, channel_manager_listener); + let mut spv_client = + SpvClient::new(chain_tip.unwrap(), chain_poller, &mut cache, &chain_listener); + loop { + spv_client.poll_best_tip().await.unwrap(); + tokio::time::sleep(Duration::from_secs(1)).await; + } + }); + + // Step 15: Handle LDK Events + let channel_manager_event_listener = channel_manager.clone(); + let keys_manager_listener = keys_manager.clone(); + // TODO: persist payment info to disk + let inbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new())); + let outbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new())); + let inbound_pmts_for_events = inbound_payments.clone(); + let outbound_pmts_for_events = outbound_payments.clone(); + let network = args.network; + let bitcoind_rpc = bitcoind_client.clone(); + let handle = tokio::runtime::Handle::current(); + let event_handler = move |event| { + handle.block_on(handle_ldk_events( + channel_manager_event_listener.clone(), + bitcoind_rpc.clone(), + keys_manager_listener.clone(), + inbound_pmts_for_events.clone(), + outbound_pmts_for_events.clone(), + network, + event, + )) + }; + // Step 16: Persist ChannelManager + let data_dir = ldk_data_dir.clone(); + let persist_channel_manager_callback = + move |node: &ChannelManager| FilesystemPersister::persist_manager(data_dir.clone(), &*node); + // Step 17: Background Processing + BackgroundProcessor::start( + persist_channel_manager_callback, + event_handler, + chain_monitor.clone(), + channel_manager.clone(), + peer_manager.clone(), + logger.clone(), + ); + + // Reconnect to channel peers if possible. + let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone()); + match disk::read_channel_peer_data(Path::new(&peer_data_path)) { + Ok(mut info) => { + for (pubkey, peer_addr) in info.drain() { + for chan_info in channel_manager.list_channels() { + if pubkey == chan_info.counterparty.node_id { + let _ = + cli::connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone()) + .await; + } + } + } + } + Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e), + } + + // Regularly broadcast our node_announcement. This is only required (or possible) if we have + // some public channels, and is only useful if we have public listen address(es) to announce. + // In a production environment, this should occur only after the announcement of new channels + // to avoid churn in the global network graph. + let chan_manager = Arc::clone(&channel_manager); + let network = args.network; + if !args.ldk_announced_listen_addr.is_empty() { + tokio::spawn(async move { + let mut interval = tokio::time::interval(Duration::from_secs(60)); + loop { + interval.tick().await; + chan_manager.broadcast_node_announcement( + [0; 3], + args.ldk_announced_node_name, + args.ldk_announced_listen_addr.clone(), + ); + } + }); + } + + // Start the CLI. + cli::poll_for_user_input( + peer_manager.clone(), + channel_manager.clone(), + keys_manager.clone(), + router.clone(), + inbound_payments, + outbound_payments, + ldk_data_dir.clone(), + logger.clone(), + network, + ) + .await; } -fn main() { - let bitcoind_host = "127.0.0.1".to_string(); - let bitcoind_port = 18443; - let rpc_user = "polaruser".to_string(); - let rpc_password = "polarpass".to_string(); - let fee_estimator = BitcoindFeeEstimator::new(bitcoind_host, bitcoind_port, None, rpc_user, rpc_password).unwrap(); - let normal_fee = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal); - println!("VMW: {}", normal_fee); +#[tokio::main] +pub async fn main() { + start_ldk().await; }