X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain.rs;h=6cff9f152492058c156e7fb1cf48ccb4e3910f38;hb=8984205acf1d328837d0f33798e89e479aea1882;hp=6f359756475134d64a693841ad9d1240094850df;hpb=ad819c58424c1f2a461ee9a0931daa9e217ff825;p=ldk-sample diff --git a/src/main.rs b/src/main.rs index 6f35975..6cff9f1 100644 --- a/src/main.rs +++ b/src/main.rs @@ -9,8 +9,6 @@ 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; @@ -18,7 +16,7 @@ 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::keysinterface::{InMemorySigner, KeysInterface, KeysManager, Recipient}; use lightning::chain::{BestBlock, Filter, Watch}; use lightning::ln::channelmanager; use lightning::ln::channelmanager::{ @@ -26,15 +24,20 @@ use lightning::ln::channelmanager::{ }; use lightning::ln::peer_handler::{IgnoringMessageHandler, MessageHandler, SimpleArcPeerManager}; use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret}; -use lightning::routing::network_graph::NetGraphMsgHandler; +use lightning::onion_message::SimpleArcOnionMessenger; +use lightning::routing::gossip; +use lightning::routing::gossip::{NodeId, P2PGossipSync}; +use lightning::routing::scoring::ProbabilisticScorer; use lightning::util::config::UserConfig; use lightning::util::events::{Event, PaymentPurpose}; use lightning::util::ser::ReadableArgs; -use lightning_background_processor::BackgroundProcessor; +use lightning_background_processor::{BackgroundProcessor, GossipSync}; use lightning_block_sync::init; use lightning_block_sync::poll; use lightning_block_sync::SpvClient; use lightning_block_sync::UnboundedCache; +use lightning_invoice::payment; +use lightning_invoice::utils::DefaultRouter; use lightning_net_tokio::SocketDescriptor; use lightning_persister::FilesystemPersister; use rand::{thread_rng, Rng}; @@ -47,6 +50,7 @@ use std::io; use std::io::Write; use std::ops::Deref; use std::path::Path; +use std::sync::atomic::{AtomicBool, Ordering}; use std::sync::{Arc, Mutex}; use std::time::{Duration, SystemTime}; @@ -97,14 +101,30 @@ pub(crate) type PeerManager = SimpleArcPeerManager< pub(crate) type ChannelManager = SimpleArcChannelManager; +pub(crate) type InvoicePayer = payment::InvoicePayer< + Arc, + Router, + Arc, Arc>>>, + Arc, + E, +>; + +type Router = DefaultRouter, Arc>; + +pub(crate) type NetworkGraph = gossip::NetworkGraph>; + +type OnionMessenger = SimpleArcOnionMessenger; + async fn handle_ldk_events( - channel_manager: Arc, bitcoind_client: Arc, - keys_manager: Arc, inbound_payments: PaymentInfoStorage, - outbound_payments: PaymentInfoStorage, network: Network, event: &Event, + channel_manager: &Arc, bitcoind_client: &BitcoindClient, + network_graph: &NetworkGraph, keys_manager: &KeysManager, + inbound_payments: &PaymentInfoStorage, outbound_payments: &PaymentInfoStorage, + network: Network, event: &Event, ) { match event { Event::FundingGenerationReady { temporary_channel_id, + counterparty_node_id, channel_value_satoshis, output_script, .. @@ -117,7 +137,7 @@ async fn handle_ldk_events( 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"), + Network::Signet => bitcoin_bech32::constants::Network::Signet, }, ) .expect("Lightning funding tx should always be to a SegWit output") @@ -137,7 +157,11 @@ async fn handle_ldk_events( 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) + .funding_transaction_generated( + &temporary_channel_id, + counterparty_node_id, + final_tx, + ) .is_err() { println!( @@ -146,31 +170,39 @@ async fn handle_ldk_events( io::stdout().flush().unwrap(); } } - Event::PaymentReceived { payment_hash, purpose, amt, .. } => { - let mut payments = inbound_payments.lock().unwrap(); + Event::PaymentReceived { payment_hash, purpose, amount_msat } => { + println!( + "\nEVENT: received payment from payment hash {} of {} millisatoshis", + hex_utils::hex_str(&payment_hash.0), + amount_msat, + ); + print!("> "); + io::stdout().flush().unwrap(); + let payment_preimage = match purpose { + PaymentPurpose::InvoicePayment { payment_preimage, .. } => *payment_preimage, + PaymentPurpose::SpontaneousPayment(preimage) => Some(*preimage), + }; + channel_manager.claim_funds(payment_preimage.unwrap()); + } + Event::PaymentClaimed { payment_hash, purpose, amount_msat } => { + println!( + "\nEVENT: claimed payment from payment hash {} of {} millisatoshis", + hex_utils::hex_str(&payment_hash.0), + amount_msat, + ); + print!("> "); + io::stdout().flush().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, - }; + let mut payments = inbound_payments.lock().unwrap(); match payments.entry(*payment_hash) { Entry::Occupied(mut e) => { let payment = e.get_mut(); - payment.status = status; + payment.status = HTLCStatus::Succeeded; payment.preimage = payment_preimage; payment.secret = payment_secret; } @@ -178,23 +210,27 @@ async fn handle_ldk_events( e.insert(PaymentInfo { preimage: payment_preimage, secret: payment_secret, - status, - amt_msat: MillisatAmount(Some(*amt)), + status: HTLCStatus::Succeeded, + amt_msat: MillisatAmount(Some(*amount_msat)), }); } } } - Event::PaymentSent { payment_preimage } => { - let hashed = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner()); + Event::PaymentSent { payment_preimage, payment_hash, fee_paid_msat, .. } => { let mut payments = outbound_payments.lock().unwrap(); - for (payment_hash, payment) in payments.iter_mut() { - if *payment_hash == hashed { + for (hash, payment) in payments.iter_mut() { + if *hash == *payment_hash { payment.preimage = Some(*payment_preimage); payment.status = HTLCStatus::Succeeded; println!( - "\nEVENT: successfully sent payment of {} millisatoshis from \ + "\nEVENT: successfully sent payment of {} millisatoshis{} from \ payment hash {:?} with preimage {:?}", payment.amt_msat, + if let Some(fee) = fee_paid_msat { + format!(" (fee {} msat)", fee) + } else { + "".to_string() + }, hex_utils::hex_str(&payment_hash.0), hex_utils::hex_str(&payment_preimage.0) ); @@ -203,23 +239,18 @@ async fn handle_ldk_events( } } } - Event::PaymentPathFailed { - payment_hash, - rejected_by_dest, - network_update: _, - all_paths_failed, - path: _, - } => { + Event::OpenChannelRequest { .. } => { + // Unreachable, we don't set manually_accept_inbound_channels + } + Event::PaymentPathSuccessful { .. } => {} + Event::PaymentPathFailed { .. } => {} + Event::ProbeSuccessful { .. } => {} + Event::ProbeFailed { .. } => {} + Event::PaymentFailed { payment_hash, .. } => { print!( - "\nEVENT: Failed to send payment{} to payment hash {:?}: ", - if *all_paths_failed { "" } else { " along MPP path" }, + "\nEVENT: Failed to send payment to payment hash {:?}: exhausted payment retry attempts", 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(); @@ -229,7 +260,43 @@ async fn handle_ldk_events( payment.status = HTLCStatus::Failed; } } - Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => { + Event::PaymentForwarded { + prev_channel_id, + next_channel_id, + fee_earned_msat, + claim_from_onchain_tx, + } => { + let read_only_network_graph = network_graph.read_only(); + let nodes = read_only_network_graph.nodes(); + let channels = channel_manager.list_channels(); + + let node_str = |channel_id: &Option<[u8; 32]>| match channel_id { + None => String::new(), + Some(channel_id) => match channels.iter().find(|c| c.channel_id == *channel_id) { + None => String::new(), + Some(channel) => { + match nodes.get(&NodeId::from_pubkey(&channel.counterparty.node_id)) { + None => "private node".to_string(), + Some(node) => match &node.announcement_info { + None => "unnamed node".to_string(), + Some(announcement) => { + format!("node {}", announcement.alias) + } + }, + } + } + }, + }; + let channel_str = |channel_id: &Option<[u8; 32]>| { + channel_id + .map(|channel_id| format!(" with channel {}", hex_utils::hex_str(&channel_id))) + .unwrap_or_default() + }; + let from_prev_str = + format!(" from {}{}", node_str(prev_channel_id), channel_str(prev_channel_id)); + let to_next_str = + format!(" to {}{}", node_str(next_channel_id), channel_str(next_channel_id)); + let from_onchain_str = if *claim_from_onchain_tx { "from onchain downstream claim" } else { @@ -237,15 +304,19 @@ async fn handle_ldk_events( }; if let Some(fee_earned) = fee_earned_msat { println!( - "\nEVENT: Forwarded payment, earning {} msat {}", - fee_earned, from_onchain_str + "\nEVENT: Forwarded payment{}{}, earning {} msat {}", + from_prev_str, to_next_str, fee_earned, from_onchain_str ); } else { - println!("\nEVENT: Forwarded payment, claiming onchain {}", from_onchain_str); + println!( + "\nEVENT: Forwarded payment{}{}, claiming onchain {}", + from_prev_str, to_next_str, from_onchain_str + ); } print!("> "); io::stdout().flush().unwrap(); } + Event::HTLCHandlingFailed { .. } => {} Event::PendingHTLCsForwardable { time_forwardable } => { let forwarding_channel_manager = channel_manager.clone(); let min = time_forwardable.as_millis() as u64; @@ -271,7 +342,7 @@ async fn handle_ldk_events( .unwrap(); bitcoind_client.broadcast_transaction(&spending_tx); } - Event::ChannelClosed { channel_id, reason } => { + Event::ChannelClosed { channel_id, reason, user_channel_id: _ } => { println!( "\nEVENT: Channel {} closed due to: {:?}", hex_utils::hex_str(channel_id), @@ -280,6 +351,10 @@ async fn handle_ldk_events( print!("> "); io::stdout().flush().unwrap(); } + Event::DiscardFunding { .. } => { + // A "real" node should probably "lock" the UTXOs spent in funding transactions until + // the funding transaction either confirms, or this event is generated. + } } } @@ -386,9 +461,9 @@ async fn start_ldk() { // Step 8: Initialize the ChannelManager let mut user_config = UserConfig::default(); - user_config.peer_channel_config_limits.force_announced_channel_preference = false; + user_config.channel_handshake_limits.force_announced_channel_preference = false; let mut restarting_node = true; - let (channel_manager_blockhash, mut channel_manager) = { + let (channel_manager_blockhash, 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() { @@ -434,8 +509,10 @@ async fn start_ldk() { 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)]; + let mut chain_listeners = vec![( + channel_manager_blockhash, + &channel_manager as &(dyn chain::Listen + Send + Sync), + )]; for (blockhash, channel_monitor) in channelmonitors.drain(..) { let outpoint = channel_monitor.get_funding_txo().0; @@ -449,7 +526,7 @@ async fn start_ldk() { 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, + &monitor_listener_info.1 as &(dyn chain::Listen + Send + Sync), )); } chain_tip = Some( @@ -471,44 +548,36 @@ async fn start_ldk() { chain_monitor.watch_channel(funding_outpoint, channel_monitor).unwrap(); } - // Step 11: Optional: Initialize the NetGraphMsgHandler + // Step 11: Optional: Initialize the P2PGossipSync 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::new( - network_graph, + let network_graph = + Arc::new(disk::read_network(Path::new(&network_graph_path), genesis, logger.clone())); + let gossip_sync = Arc::new(P2PGossipSync::new( + Arc::clone(&network_graph), None::>, logger.clone(), )); - 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) - .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 onion_messenger: Arc = + Arc::new(OnionMessenger::new(keys_manager.clone(), logger.clone())); let mut ephemeral_bytes = [0; 32]; + let current_time = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs(); rand::thread_rng().fill_bytes(&mut ephemeral_bytes); - let lightning_msg_handler = - MessageHandler { chan_handler: channel_manager.clone(), route_handler: router.clone() }; + let lightning_msg_handler = MessageHandler { + chan_handler: channel_manager.clone(), + route_handler: gossip_sync.clone(), + onion_message_handler: onion_messenger.clone(), + }; let peer_manager: Arc = Arc::new(PeerManager::new( lightning_msg_handler, - keys_manager.get_node_secret(), + keys_manager.get_node_secret(Recipient::Node).unwrap(), + current_time, &ephemeral_bytes, logger.clone(), - Arc::new(IgnoringMessageHandler {}), + IgnoringMessageHandler {}, )); // ## Running LDK @@ -516,6 +585,8 @@ async fn start_ldk() { let peer_manager_connection_handler = peer_manager.clone(); let listening_port = args.ldk_peer_listening_port; + let stop_listen_connect = Arc::new(AtomicBool::new(false)); + let stop_listen = Arc::clone(&stop_listen_connect); tokio::spawn(async move { let listener = tokio::net::TcpListener::bind(format!("0.0.0.0:{}", listening_port)) .await @@ -523,6 +594,9 @@ async fn start_ldk() { loop { let peer_mgr = peer_manager_connection_handler.clone(); let tcp_stream = listener.accept().await.unwrap().0; + if stop_listen.load(Ordering::Acquire) { + return; + } tokio::spawn(async move { lightning_net_tokio::setup_inbound( peer_mgr.clone(), @@ -564,62 +638,109 @@ async fn start_ldk() { let outbound_pmts_for_events = outbound_payments.clone(); let network = args.network; let bitcoind_rpc = bitcoind_client.clone(); + let network_graph_events = network_graph.clone(); let handle = tokio::runtime::Handle::current(); let event_handler = move |event: &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(), + &channel_manager_event_listener, + &bitcoind_rpc, + &network_graph_events, + &keys_manager_listener, + &inbound_pmts_for_events, + &outbound_pmts_for_events, 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 - let background_processor = BackgroundProcessor::start( - persist_channel_manager_callback, + + // Step 16: Initialize routing ProbabilisticScorer + let scorer_path = format!("{}/scorer", ldk_data_dir.clone()); + let scorer = Arc::new(Mutex::new(disk::read_scorer( + Path::new(&scorer_path), + Arc::clone(&network_graph), + Arc::clone(&logger), + ))); + + // Step 17: Create InvoicePayer + let router = DefaultRouter::new( + network_graph.clone(), + logger.clone(), + keys_manager.get_secure_random_bytes(), + ); + let invoice_payer = Arc::new(InvoicePayer::new( + channel_manager.clone(), + router, + scorer.clone(), + logger.clone(), event_handler, + payment::Retry::Timeout(Duration::from_secs(10)), + )); + + // Step 18: Persist ChannelManager and NetworkGraph + let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone())); + + // Step 19: Background Processing + let background_processor = BackgroundProcessor::start( + persister, + invoice_payer.clone(), chain_monitor.clone(), channel_manager.clone(), - Some(router.clone()), + GossipSync::p2p(gossip_sync.clone()), peer_manager.clone(), logger.clone(), + Some(scorer.clone()), ); - // Reconnect to channel peers if possible. + // Regularly reconnect to channel peers. + let connect_cm = Arc::clone(&channel_manager); + let connect_pm = Arc::clone(&peer_manager); 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()) + let stop_connect = Arc::clone(&stop_listen_connect); + tokio::spawn(async move { + let mut interval = tokio::time::interval(Duration::from_secs(1)); + loop { + interval.tick().await; + match disk::read_channel_peer_data(Path::new(&peer_data_path)) { + Ok(info) => { + let peers = connect_pm.get_peer_node_ids(); + for node_id in connect_cm + .list_channels() + .iter() + .map(|chan| chan.counterparty.node_id) + .filter(|id| !peers.contains(id)) + { + if stop_connect.load(Ordering::Acquire) { + return; + } + for (pubkey, peer_addr) in info.iter() { + if *pubkey == node_id { + let _ = cli::do_connect_peer( + *pubkey, + peer_addr.clone(), + Arc::clone(&connect_pm), + ) .await; + } + } } } + Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e), } } - 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 peer_man = Arc::clone(&peer_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( + peer_man.broadcast_node_announcement( [0; 3], args.ldk_announced_node_name, args.ldk_announced_listen_addr.clone(), @@ -630,18 +751,24 @@ async fn start_ldk() { // Start the CLI. cli::poll_for_user_input( - peer_manager.clone(), - channel_manager.clone(), - keys_manager.clone(), - router.clone(), + Arc::clone(&invoice_payer), + Arc::clone(&peer_manager), + Arc::clone(&channel_manager), + Arc::clone(&keys_manager), + Arc::clone(&network_graph), + Arc::clone(&onion_messenger), inbound_payments, outbound_payments, ldk_data_dir.clone(), - logger.clone(), network, ) .await; + // Disconnect our peers and stop accepting new connections. This ensures we don't continue + // updating our channel data after we've stopped the background processor. + stop_listen_connect.store(true, Ordering::Release); + peer_manager.disconnect_all_peers(); + // Stop the background processor. background_processor.stop().unwrap(); }