Update to LDK v0.0.114
[ldk-sample] / src / main.rs
index 6cff9f152492058c156e7fb1cf48ccb4e3910f38..1e5edf47f00b1d2fa860a789c2dfe0a09f8a6865 100644 (file)
@@ -1,3 +1,4 @@
+mod args;
 pub mod bitcoind_client;
 mod cli;
 mod convert;
@@ -6,7 +7,6 @@ mod hex_utils;
 
 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::network::constants::Network;
@@ -15,9 +15,9 @@ 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::{BestBlock, Filter, Watch};
+use lightning::chain::keysinterface::{EntropySource, InMemorySigner, KeysManager};
+use lightning::chain::{chainmonitor, ChannelMonitorUpdateStatus};
+use lightning::chain::{Filter, Watch};
 use lightning::ln::channelmanager;
 use lightning::ln::channelmanager::{
        ChainParameters, ChannelManagerReadArgs, SimpleArcChannelManager,
@@ -27,7 +27,7 @@ use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
 use lightning::onion_message::SimpleArcOnionMessenger;
 use lightning::routing::gossip;
 use lightning::routing::gossip::{NodeId, P2PGossipSync};
-use lightning::routing::scoring::ProbabilisticScorer;
+use lightning::routing::router::DefaultRouter;
 use lightning::util::config::UserConfig;
 use lightning::util::events::{Event, PaymentPurpose};
 use lightning::util::ser::ReadableArgs;
@@ -36,19 +36,17 @@ 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};
 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};
@@ -94,23 +92,13 @@ pub(crate) type PeerManager = SimpleArcPeerManager<
        ChainMonitor,
        BitcoindClient,
        BitcoindClient,
-       dyn chain::Access + Send + Sync,
+       BitcoindClient,
        FilesystemLogger,
 >;
 
 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>>>>,
-       Arc<FilesystemLogger>,
-       E,
->;
-
-type Router = DefaultRouter<Arc<NetworkGraph>, Arc<FilesystemLogger>>;
-
 pub(crate) type NetworkGraph = gossip::NetworkGraph<Arc<FilesystemLogger>>;
 
 type OnionMessenger = SimpleArcOnionMessenger<FilesystemLogger>;
@@ -170,7 +158,14 @@ async fn handle_ldk_events(
                                io::stdout().flush().unwrap();
                        }
                }
-               Event::PaymentReceived { payment_hash, purpose, amount_msat } => {
+               Event::PaymentClaimable {
+                       payment_hash,
+                       purpose,
+                       amount_msat,
+                       receiver_node_id: _,
+                       via_channel_id: _,
+                       via_user_channel_id: _,
+               } => {
                        println!(
                                "\nEVENT: received payment from payment hash {} of {} millisatoshis",
                                hex_utils::hex_str(&payment_hash.0),
@@ -184,7 +179,7 @@ async fn handle_ldk_events(
                        };
                        channel_manager.claim_funds(payment_preimage.unwrap());
                }
-               Event::PaymentClaimed { payment_hash, purpose, amount_msat } => {
+               Event::PaymentClaimed { payment_hash, purpose, amount_msat, receiver_node_id: _ } => {
                        println!(
                                "\nEVENT: claimed payment from payment hash {} of {} millisatoshis",
                                hex_utils::hex_str(&payment_hash.0),
@@ -342,6 +337,20 @@ async fn handle_ldk_events(
                                .unwrap();
                        bitcoind_client.broadcast_transaction(&spending_tx);
                }
+               Event::ChannelReady {
+                       ref channel_id,
+                       user_channel_id: _,
+                       ref counterparty_node_id,
+                       channel_type: _,
+               } => {
+                       println!(
+                               "\nEVENT: Channel {} with peer {} is ready to be used!",
+                               hex_utils::hex_str(channel_id),
+                               hex_utils::hex_str(&counterparty_node_id.serialize()),
+                       );
+                       print!("> ");
+                       io::stdout().flush().unwrap();
+               }
                Event::ChannelClosed { channel_id, reason, user_channel_id: _ } => {
                        println!(
                                "\nEVENT: Channel {} closed due to: {:?}",
@@ -355,11 +364,12 @@ async fn handle_ldk_events(
                        // A "real" node should probably "lock" the UTXOs spent in funding transactions until
                        // the funding transaction either confirms, or this event is generated.
                }
+               Event::HTLCIntercepted { .. } => {}
        }
 }
 
 async fn start_ldk() {
-       let args = match cli::parse_startup_args() {
+       let args = match args::parse_startup_args() {
                Ok(user_args) => user_args,
                Err(()) => return,
        };
@@ -457,9 +467,35 @@ async fn start_ldk() {
        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();
+       let mut channelmonitors =
+               persister.read_channelmonitors(keys_manager.clone(), keys_manager.clone()).unwrap();
+
+       // Step 8: Poll for the best chain tip, which may be used by the channel manager & spv client
+       let polled_chain_tip = init::validate_best_block_header(bitcoind_client.as_ref())
+               .await
+               .expect("Failed to fetch best block header and best block");
+
+       // Step 9: Initialize routing ProbabilisticScorer
+       let network_graph_path = format!("{}/network_graph", ldk_data_dir.clone());
+       let network_graph =
+               Arc::new(disk::read_network(Path::new(&network_graph_path), args.network, logger.clone()));
+
+       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 10: Create Router
+       let router = Arc::new(DefaultRouter::new(
+               network_graph.clone(),
+               logger.clone(),
+               keys_manager.get_secure_random_bytes(),
+               scorer.clone(),
+       ));
 
-       // Step 8: Initialize the ChannelManager
+       // Step 11: Initialize the ChannelManager
        let mut user_config = UserConfig::default();
        user_config.channel_handshake_limits.force_announced_channel_preference = false;
        let mut restarting_node = true;
@@ -470,10 +506,13 @@ async fn start_ldk() {
                                channel_monitor_mut_references.push(channel_monitor);
                        }
                        let read_args = ChannelManagerReadArgs::new(
+                               keys_manager.clone(),
+                               keys_manager.clone(),
                                keys_manager.clone(),
                                fee_estimator.clone(),
                                chain_monitor.clone(),
                                broadcaster.clone(),
+                               router,
                                logger.clone(),
                                user_config,
                                channel_monitor_mut_references,
@@ -482,33 +521,31 @@ async fn start_ldk() {
                } 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 polled_best_block = polled_chain_tip.to_best_block();
+                       let polled_best_block_hash = polled_best_block.block_hash();
+                       let chain_params =
+                               ChainParameters { network: args.network, best_block: polled_best_block };
                        let fresh_channel_manager = channelmanager::ChannelManager::new(
                                fee_estimator.clone(),
                                chain_monitor.clone(),
                                broadcaster.clone(),
+                               router,
                                logger.clone(),
                                keys_manager.clone(),
+                               keys_manager.clone(),
+                               keys_manager.clone(),
                                user_config,
                                chain_params,
                        );
-                       (getinfo_resp.latest_blockhash, fresh_channel_manager)
+                       (polled_best_block_hash, fresh_channel_manager)
                }
        };
 
-       // Step 9: Sync ChannelMonitors and ChannelManager to chain tip
+       // Step 12: 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<poll::ValidatedBlockHeader> = None;
-       if restarting_node {
+       let chain_tip = if restarting_node {
                let mut chain_listeners = vec![(
                        channel_manager_blockhash,
                        &channel_manager as &(dyn chain::Listen + Send + Sync),
@@ -529,40 +566,44 @@ async fn start_ldk() {
                                &monitor_listener_info.1 as &(dyn chain::Listen + Send + Sync),
                        ));
                }
-               chain_tip = Some(
-                       init::synchronize_listeners(
-                               &mut bitcoind_client.deref(),
-                               args.network,
-                               &mut cache,
-                               chain_listeners,
-                       )
-                       .await
-                       .unwrap(),
-               );
-       }
 
-       // Step 10: Give ChannelMonitors to ChainMonitor
+               init::synchronize_listeners(
+                       bitcoind_client.as_ref(),
+                       args.network,
+                       &mut cache,
+                       chain_listeners,
+               )
+               .await
+               .unwrap()
+       } else {
+               polled_chain_tip
+       };
+
+       // Step 13: 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();
+               assert_eq!(
+                       chain_monitor.watch_channel(funding_outpoint, channel_monitor),
+                       ChannelMonitorUpdateStatus::Completed
+               );
        }
 
-       // 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 =
-               Arc::new(disk::read_network(Path::new(&network_graph_path), genesis, logger.clone()));
+       // Step 14: Optional: Initialize the P2PGossipSync
        let gossip_sync = Arc::new(P2PGossipSync::new(
                Arc::clone(&network_graph),
-               None::<Arc<dyn chain::Access + Send + Sync>>,
+               None::<Arc<BitcoindClient>>,
                logger.clone(),
        ));
 
-       // Step 12: Initialize the PeerManager
+       // Step 15: Initialize the PeerManager
        let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
-       let onion_messenger: Arc<OnionMessenger> =
-               Arc::new(OnionMessenger::new(keys_manager.clone(), logger.clone()));
+       let onion_messenger: Arc<OnionMessenger> = Arc::new(OnionMessenger::new(
+               Arc::clone(&keys_manager),
+               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);
@@ -573,15 +614,15 @@ async fn start_ldk() {
        };
        let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
                lightning_msg_handler,
-               keys_manager.get_node_secret(Recipient::Node).unwrap(),
-               current_time,
+               current_time.try_into().unwrap(),
                &ephemeral_bytes,
                logger.clone(),
                IgnoringMessageHandler {},
+               Arc::clone(&keys_manager),
        ));
 
        // ## Running LDK
-       // Step 13: Initialize networking
+       // Step 16: Initialize networking
 
        let peer_manager_connection_handler = peer_manager.clone();
        let listening_port = args.ldk_peer_listening_port;
@@ -607,28 +648,22 @@ 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());
-       }
+       // Step 17: Connect and Disconnect Blocks
        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);
+               let mut spv_client = SpvClient::new(chain_tip, 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
+       // Step 18: Handle LDK Events
        let channel_manager_event_listener = channel_manager.clone();
        let keys_manager_listener = keys_manager.clone();
        // TODO: persist payment info to disk
@@ -640,7 +675,7 @@ async fn start_ldk() {
        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| {
+       let event_handler = move |event: Event| {
                handle.block_on(handle_ldk_events(
                        &channel_manager_event_listener,
                        &bitcoind_rpc,
@@ -649,40 +684,17 @@ async fn start_ldk() {
                        &inbound_pmts_for_events,
                        &outbound_pmts_for_events,
                        network,
-                       event,
+                       &event,
                ));
        };
 
-       // 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
+       // Step 19: Persist ChannelManager and NetworkGraph
        let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
 
-       // Step 19: Background Processing
+       // Step 20: Background Processing
        let background_processor = BackgroundProcessor::start(
                persister,
-               invoice_payer.clone(),
+               event_handler,
                chain_monitor.clone(),
                channel_manager.clone(),
                GossipSync::p2p(gossip_sync.clone()),
@@ -707,7 +719,7 @@ async fn start_ldk() {
                                                .list_channels()
                                                .iter()
                                                .map(|chan| chan.counterparty.node_id)
-                                               .filter(|id| !peers.contains(id))
+                                               .filter(|id| !peers.iter().any(|(pk, _)| id == pk))
                                        {
                                                if stop_connect.load(Ordering::Acquire) {
                                                        return;
@@ -751,7 +763,6 @@ async fn start_ldk() {
 
        // Start the CLI.
        cli::poll_for_user_input(
-               Arc::clone(&invoice_payer),
                Arc::clone(&peer_manager),
                Arc::clone(&channel_manager),
                Arc::clone(&keys_manager),
@@ -761,6 +772,7 @@ async fn start_ldk() {
                outbound_payments,
                ldk_data_dir.clone(),
                network,
+               Arc::clone(&logger),
        )
        .await;
 
@@ -775,5 +787,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;
 }