Update to LDK 0.0.112
[ldk-sample] / src / main.rs
index 1c1d7941011ae0602d174d9481e079a638d26110..4314ac87131dc05ee92f56b51ebfc36e5f3336f2 100644 (file)
@@ -15,8 +15,8 @@ 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, Recipient};
+use lightning::chain::{chainmonitor, ChannelMonitorUpdateStatus};
 use lightning::chain::{BestBlock, Filter, Watch};
 use lightning::ln::channelmanager;
 use lightning::ln::channelmanager::{
@@ -24,14 +24,14 @@ use lightning::ln::channelmanager::{
 };
 use lightning::ln::peer_handler::{IgnoringMessageHandler, MessageHandler, SimpleArcPeerManager};
 use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
-use lightning::log_bytes;
+use lightning::onion_message::SimpleArcOnionMessenger;
 use lightning::routing::gossip;
-use lightning::routing::gossip::P2PGossipSync;
+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;
@@ -40,16 +40,15 @@ use lightning_invoice::payment;
 use lightning_invoice::utils::DefaultRouter;
 use lightning_net_tokio::SocketDescriptor;
 use lightning_persister::FilesystemPersister;
-use lightning_rapid_gossip_sync::RapidGossipSync;
 use rand::{thread_rng, Rng};
 use std::collections::hash_map::Entry;
 use std::collections::HashMap;
+use std::convert::TryInto;
 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::atomic::{AtomicBool, Ordering};
 use std::sync::{Arc, Mutex};
@@ -102,25 +101,24 @@ pub(crate) type PeerManager = SimpleArcPeerManager<
 pub(crate) type ChannelManager =
        SimpleArcChannelManager<ChainMonitor, BitcoindClient, BitcoindClient, FilesystemLogger>;
 
-pub(crate) type InvoicePayer<E> = payment::InvoicePayer<
-       Arc<ChannelManager>,
-       Router,
-       Arc<Mutex<ProbabilisticScorer<Arc<NetworkGraph>, Arc<FilesystemLogger>>>>,
+pub(crate) type InvoicePayer<E> =
+       payment::InvoicePayer<Arc<ChannelManager>, Router, Arc<FilesystemLogger>, E>;
+
+type Router = DefaultRouter<
+       Arc<NetworkGraph>,
        Arc<FilesystemLogger>,
-       E,
+       Arc<Mutex<ProbabilisticScorer<Arc<NetworkGraph>, Arc<FilesystemLogger>>>>,
 >;
 
-type Router = DefaultRouter<Arc<NetworkGraph>, Arc<FilesystemLogger>>;
-
-type GossipSync<P, G, A, L> =
-       lightning_background_processor::GossipSync<P, Arc<RapidGossipSync<G, L>>, G, A, L>;
-
 pub(crate) type NetworkGraph = gossip::NetworkGraph<Arc<FilesystemLogger>>;
 
+type OnionMessenger = SimpleArcOnionMessenger<FilesystemLogger>;
+
 async fn handle_ldk_events(
-       channel_manager: Arc<ChannelManager>, bitcoind_client: Arc<BitcoindClient>,
-       keys_manager: Arc<KeysManager>, inbound_payments: PaymentInfoStorage,
-       outbound_payments: PaymentInfoStorage, network: Network, event: &Event,
+       channel_manager: &Arc<ChannelManager>, bitcoind_client: &BitcoindClient,
+       network_graph: &NetworkGraph, keys_manager: &KeysManager,
+       inbound_payments: &PaymentInfoStorage, outbound_payments: &PaymentInfoStorage,
+       network: Network, event: &Event,
 ) {
        match event {
                Event::FundingGenerationReady {
@@ -245,6 +243,8 @@ async fn handle_ldk_events(
                }
                Event::PaymentPathSuccessful { .. } => {}
                Event::PaymentPathFailed { .. } => {}
+               Event::ProbeSuccessful { .. } => {}
+               Event::ProbeFailed { .. } => {}
                Event::PaymentFailed { payment_hash, .. } => {
                        print!(
                                "\nEVENT: Failed to send payment to payment hash {:?}: exhausted payment retry attempts",
@@ -265,12 +265,37 @@ async fn handle_ldk_events(
                        fee_earned_msat,
                        claim_from_onchain_tx,
                } => {
-                       let from_channel_str = prev_channel_id
-                               .map(|channel_id| format!(" from channel {}", log_bytes!(channel_id)))
-                               .unwrap_or_default();
-                       let to_channel_str = next_channel_id
-                               .map(|channel_id| format!(" to channel {}", log_bytes!(channel_id)))
-                               .unwrap_or_default();
+                       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 {
@@ -279,17 +304,18 @@ async fn handle_ldk_events(
                        if let Some(fee_earned) = fee_earned_msat {
                                println!(
                                        "\nEVENT: Forwarded payment{}{}, earning {} msat {}",
-                                       from_channel_str, to_channel_str, fee_earned, from_onchain_str
+                                       from_prev_str, to_next_str, fee_earned, from_onchain_str
                                );
                        } else {
                                println!(
                                        "\nEVENT: Forwarded payment{}{}, claiming onchain {}",
-                                       from_channel_str, to_channel_str, from_onchain_str
+                                       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;
@@ -434,7 +460,7 @@ 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, channel_manager) = {
                if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
@@ -482,8 +508,10 @@ async fn start_ldk() {
        let mut cache = UnboundedCache::new();
        let mut chain_tip: Option<poll::ValidatedBlockHeader> = None;
        if restarting_node {
-               let mut chain_listeners =
-                       vec![(channel_manager_blockhash, &channel_manager as &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;
@@ -495,12 +523,14 @@ async fn start_ldk() {
                }
 
                for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
-                       chain_listeners
-                               .push((monitor_listener_info.0, &monitor_listener_info.1 as &dyn chain::Listen));
+                       chain_listeners.push((
+                               monitor_listener_info.0,
+                               &monitor_listener_info.1 as &(dyn chain::Listen + Send + Sync),
+                       ));
                }
                chain_tip = Some(
                        init::synchronize_listeners(
-                               &mut bitcoind_client.deref(),
+                               bitcoind_client.as_ref(),
                                args.network,
                                &mut cache,
                                chain_listeners,
@@ -514,7 +544,10 @@ async fn start_ldk() {
        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();
+               assert_eq!(
+                       chain_monitor.watch_channel(funding_outpoint, channel_monitor),
+                       ChannelMonitorUpdateStatus::Completed
+               );
        }
 
        // Step 11: Optional: Initialize the P2PGossipSync
@@ -530,18 +563,26 @@ async fn start_ldk() {
 
        // Step 12: Initialize the PeerManager
        let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
+       let onion_messenger: Arc<OnionMessenger> = Arc::new(OnionMessenger::new(
+               Arc::clone(&keys_manager),
+               Arc::clone(&logger),
+               IgnoringMessageHandler {},
+       ));
        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: gossip_sync.clone(),
+               onion_message_handler: onion_messenger.clone(),
        };
        let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
                lightning_msg_handler,
                keys_manager.get_node_secret(Recipient::Node).unwrap(),
+               current_time.try_into().unwrap(),
                &ephemeral_bytes,
                logger.clone(),
-               Arc::new(IgnoringMessageHandler {}),
+               IgnoringMessageHandler {},
        ));
 
        // ## Running LDK
@@ -573,16 +614,14 @@ async fn start_ldk() {
 
        // 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());
+               chain_tip = Some(init::validate_best_block_header(bitcoind_client.as_ref()).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_poller = poll::ChainPoller::new(bitcoind_block_source.as_ref(), 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);
@@ -602,14 +641,16 @@ 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,
                ));
@@ -628,14 +669,14 @@ async fn start_ldk() {
                network_graph.clone(),
                logger.clone(),
                keys_manager.get_secure_random_bytes(),
+               scorer.clone(),
        );
        let invoice_payer = Arc::new(InvoicePayer::new(
                channel_manager.clone(),
                router,
-               scorer.clone(),
                logger.clone(),
                event_handler,
-               payment::Retry::Attempts(5),
+               payment::Retry::Timeout(Duration::from_secs(10)),
        ));
 
        // Step 18: Persist ChannelManager and NetworkGraph
@@ -647,7 +688,7 @@ async fn start_ldk() {
                invoice_payer.clone(),
                chain_monitor.clone(),
                channel_manager.clone(),
-               GossipSync::P2P(gossip_sync.clone()),
+               GossipSync::p2p(gossip_sync.clone()),
                peer_manager.clone(),
                logger.clone(),
                Some(scorer.clone()),
@@ -695,14 +736,14 @@ async fn start_ldk() {
        // 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(),
@@ -718,10 +759,12 @@ async fn start_ldk() {
                Arc::clone(&channel_manager),
                Arc::clone(&keys_manager),
                Arc::clone(&network_graph),
+               Arc::clone(&onion_messenger),
                inbound_payments,
                outbound_payments,
                ldk_data_dir.clone(),
                network,
+               Arc::clone(&logger),
        )
        .await;
 
@@ -736,5 +779,28 @@ async fn start_ldk() {
 
 #[tokio::main]
 pub async fn main() {
+       #[cfg(not(target_os = "windows"))]
+       {
+               // Catch Ctrl-C with a dummy signal handler.
+               unsafe {
+                       let mut new_action: libc::sigaction = core::mem::zeroed();
+                       let mut old_action: libc::sigaction = core::mem::zeroed();
+
+                       extern "C" fn dummy_handler(
+                               _: libc::c_int, _: *const libc::siginfo_t, _: *const libc::c_void,
+                       ) {
+                       }
+
+                       new_action.sa_sigaction = dummy_handler as libc::sighandler_t;
+                       new_action.sa_flags = libc::SA_SIGINFO;
+
+                       libc::sigaction(
+                               libc::SIGINT,
+                               &new_action as *const libc::sigaction,
+                               &mut old_action as *mut libc::sigaction,
+                       );
+               }
+       }
+
        start_ldk().await;
 }