Fix inbound connections by using tokio net instead of std
[ldk-sample] / src / main.rs
index 5f213fca40b2dffac9a72c3ed0897c58b84e4bf3..bf0e24e9051ed6e8d75568f589d0da9fbd3f5570 100644 (file)
@@ -23,9 +23,10 @@ use lightning::chain::Filter;
 use lightning::chain::Watch;
 use lightning::ln::channelmanager;
 use lightning::ln::channelmanager::{
-       ChainParameters, ChannelManagerReadArgs, PaymentHash, PaymentPreimage, SimpleArcChannelManager,
+       BestBlock, 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, EventsProvider};
@@ -38,6 +39,7 @@ 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;
@@ -49,12 +51,7 @@ use std::path::Path;
 use std::sync::{Arc, Mutex};
 use std::time::{Duration, SystemTime};
 use tokio::sync::mpsc;
-
-#[derive(PartialEq)]
-pub(crate) enum HTLCDirection {
-       Inbound,
-       Outbound,
-}
+use tokio::sync::mpsc::Receiver;
 
 pub(crate) enum HTLCStatus {
        Pending,
@@ -62,9 +59,9 @@ pub(crate) enum HTLCStatus {
        Failed,
 }
 
-pub(crate) struct SatoshiAmount(Option<u64>);
+pub(crate) struct MillisatAmount(Option<u64>);
 
-impl fmt::Display for SatoshiAmount {
+impl fmt::Display for MillisatAmount {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
                match self.0 {
                        Some(amt) => write!(f, "{}", amt),
@@ -73,15 +70,18 @@ impl fmt::Display for SatoshiAmount {
        }
 }
 
-pub(crate) type PaymentInfoStorage = Arc<
-       Mutex<
-               HashMap<PaymentHash, (Option<PaymentPreimage>, HTLCDirection, HTLCStatus, SatoshiAmount)>,
-       >,
->;
+pub(crate) struct PaymentInfo {
+       preimage: Option<PaymentPreimage>,
+       secret: Option<PaymentSecret>,
+       status: HTLCStatus,
+       amt_msat: MillisatAmount,
+}
+
+pub(crate) type PaymentInfoStorage = Arc<Mutex<HashMap<PaymentHash, PaymentInfo>>>;
 
 type ChainMonitor = chainmonitor::ChainMonitor<
        InMemorySigner,
-       Arc<dyn Filter>,
+       Arc<dyn Filter + Send + Sync>,
        Arc<BitcoindClient>,
        Arc<BitcoindClient>,
        Arc<FilesystemLogger>,
@@ -93,7 +93,7 @@ pub(crate) type PeerManager = SimpleArcPeerManager<
        ChainMonitor,
        BitcoindClient,
        BitcoindClient,
-       dyn chain::Access,
+       dyn chain::Access + Send + Sync,
        FilesystemLogger,
 >;
 
@@ -103,9 +103,15 @@ pub(crate) type ChannelManager =
 async fn handle_ldk_events(
        channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
        bitcoind_client: Arc<BitcoindClient>, keys_manager: Arc<KeysManager>,
-       payment_storage: PaymentInfoStorage, network: Network,
+       inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage, network: Network,
+       mut event_receiver: Receiver<()>,
 ) {
        loop {
+               let received = event_receiver.recv();
+               if received.await.is_none() {
+                       println!("LDK Event channel closed!");
+                       return;
+               }
                let loop_channel_manager = channel_manager.clone();
                let mut events = channel_manager.get_and_clear_pending_events();
                events.append(&mut chain_monitor.get_and_clear_pending_events());
@@ -151,47 +157,55 @@ async fn handle_ldk_events(
                                                .funding_transaction_generated(&temporary_channel_id, final_tx)
                                                .unwrap();
                                }
-                               Event::FundingBroadcastSafe { funding_txo, .. } => {
-                               Event::PaymentReceived { payment_hash, payment_secret, amt: amt_msat } => {
-                                       let mut payments = payment_storage.lock().unwrap();
-                                       if let Some((Some(preimage), _, _, _)) = payments.get(&payment_hash) {
-                                               assert!(loop_channel_manager.claim_funds(
-                                                       preimage.clone(),
-                                                       &payment_secret,
-                                                       amt_msat
-                                               ));
-                                               println!(
-                                                       "\nEVENT: received payment from payment_hash {} of {} satoshis",
-                                                       hex_utils::hex_str(&payment_hash.0),
-                                                       amt_msat / 1000
-                                               );
-                                               print!("> ");
-                                               io::stdout().flush().unwrap();
-                                               let (_, _, ref mut status, _) = payments.get_mut(&payment_hash).unwrap();
-                                               *status = HTLCStatus::Succeeded;
-                                       } else {
-                                               println!("\nERROR: we received a payment but didn't know the preimage");
-                                               print!("> ");
-                                               io::stdout().flush().unwrap();
-                                               loop_channel_manager.fail_htlc_backwards(&payment_hash, &payment_secret);
-                                               payments.insert(
-                                                       payment_hash,
-                                                       (None, HTLCDirection::Inbound, HTLCStatus::Failed, SatoshiAmount(None)),
-                                               );
+                               Event::PaymentReceived {
+                                       payment_hash,
+                                       payment_preimage,
+                                       payment_secret,
+                                       amt,
+                                       ..
+                               } => {
+                                       let mut payments = inbound_payments.lock().unwrap();
+                                       let status = match loop_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 = Some(payment_preimage.unwrap());
+                                                       payment.secret = Some(payment_secret);
+                                               }
+                                               Entry::Vacant(e) => {
+                                                       e.insert(PaymentInfo {
+                                                               preimage: Some(payment_preimage.unwrap()),
+                                                               secret: Some(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 = payment_storage.lock().unwrap();
-                                       for (payment_hash, (preimage_option, _, status, amt_sat)) in payments.iter_mut()
-                                       {
+                                       let mut payments = outbound_payments.lock().unwrap();
+                                       for (payment_hash, payment) in payments.iter_mut() {
                                                if *payment_hash == hashed {
-                                                       *preimage_option = Some(payment_preimage);
-                                                       *status = HTLCStatus::Succeeded;
+                                                       payment.preimage = Some(payment_preimage);
+                                                       payment.status = HTLCStatus::Succeeded;
                                                        println!(
-                                                               "\nEVENT: successfully sent payment of {} satoshis from \
+                                                               "\nEVENT: successfully sent payment of {} millisatoshis from \
                                          payment hash {:?} with preimage {:?}",
-                                                               amt_sat,
+                                                               payment.amt_msat,
                                                                hex_utils::hex_str(&payment_hash.0),
                                                                hex_utils::hex_str(&payment_preimage.0)
                                                        );
@@ -213,10 +227,10 @@ async fn handle_ldk_events(
                                        print!("> ");
                                        io::stdout().flush().unwrap();
 
-                                       let mut payments = payment_storage.lock().unwrap();
+                                       let mut payments = outbound_payments.lock().unwrap();
                                        if payments.contains_key(&payment_hash) {
-                                               let (_, _, ref mut status, _) = payments.get_mut(&payment_hash).unwrap();
-                                               *status = HTLCStatus::Failed;
+                                               let payment = payments.get_mut(&payment_hash).unwrap();
+                                               payment.status = HTLCStatus::Failed;
                                        }
                                }
                                Event::PendingHTLCsForwardable { time_forwardable } => {
@@ -276,6 +290,22 @@ async fn start_ldk() {
                }
        };
 
+       // 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
 
@@ -334,7 +364,7 @@ async fn start_ldk() {
        // Step 7: Read ChannelMonitor state from disk
        let mut channelmonitors = persister.read_channelmonitors(keys_manager.clone()).unwrap();
 
-       // Step 9: Initialize the ChannelManager
+       // Step 8: Initialize the ChannelManager
        let user_config = UserConfig::default();
        let mut restarting_node = true;
        let (channel_manager_blockhash, mut channel_manager) = {
@@ -360,8 +390,10 @@ async fn start_ldk() {
 
                        let chain_params = ChainParameters {
                                network: args.network,
-                               latest_hash: getinfo_resp.latest_blockhash,
-                               latest_height: getinfo_resp.latest_height,
+                               best_block: BestBlock::new(
+                                       getinfo_resp.latest_blockhash,
+                                       getinfo_resp.latest_height as u32,
+                               ),
                        };
                        let fresh_channel_manager = channelmanager::ChannelManager::new(
                                fee_estimator.clone(),
@@ -376,7 +408,7 @@ async fn start_ldk() {
                }
        };
 
-       // Step 10: Sync ChannelMonitors and ChannelManager to chain tip
+       // 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<poll::ValidatedBlockHeader> = None;
@@ -411,20 +443,23 @@ async fn start_ldk() {
                );
        }
 
-       // Step 11: Give ChannelMonitors to ChainMonitor
+       // 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 13: Optional: Initialize the NetGraphMsgHandler
+       // Step 11: Optional: Initialize the NetGraphMsgHandler
        // XXX persist routing data
        let genesis = genesis_block(args.network).header.block_hash();
-       let router =
-               Arc::new(NetGraphMsgHandler::new(genesis, None::<Arc<dyn chain::Access>>, logger.clone()));
+       let router = Arc::new(NetGraphMsgHandler::new(
+               genesis,
+               None::<Arc<dyn chain::Access + Send + Sync>>,
+               logger.clone(),
+       ));
 
-       // Step 14: Initialize the PeerManager
+       // Step 12: Initialize the PeerManager
        let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
        let mut ephemeral_bytes = [0; 32];
        rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
@@ -438,28 +473,28 @@ async fn start_ldk() {
        ));
 
        // ## Running LDK
-       // Step 16: Initialize Peer Connection Handling
+       // Step 13: Initialize networking
 
        // We poll for events in handle_ldk_events(..) rather than waiting for them over the
        // mpsc::channel, so we can leave the event receiver as unused.
-       let (event_ntfn_sender, _event_ntfn_receiver) = mpsc::channel(2);
+       let (event_ntfn_sender, event_ntfn_receiver) = mpsc::channel(2);
        let peer_manager_connection_handler = peer_manager.clone();
        let event_notifier = event_ntfn_sender.clone();
        let listening_port = args.ldk_peer_listening_port;
        tokio::spawn(async move {
-               let listener = std::net::TcpListener::bind(format!("0.0.0.0:{}", listening_port)).unwrap();
+               let listener = tokio::net::TcpListener::bind(format!("0.0.0.0:{}", listening_port)).await.unwrap();
                loop {
-                       let tcp_stream = listener.accept().unwrap().0;
-                       lightning_net_tokio::setup_inbound(
-                               peer_manager_connection_handler.clone(),
-                               event_notifier.clone(),
-                               tcp_stream,
-                       )
-                       .await;
+                       let peer_mgr = peer_manager_connection_handler.clone();
+                       let notifier = event_notifier.clone();
+                       let tcp_stream = listener.accept().await.unwrap().0;
+                       tokio::spawn(async move {
+                               lightning_net_tokio::setup_inbound(peer_mgr.clone(), notifier.clone(), tcp_stream.into_std().unwrap())
+                                       .await;
+                       });
                }
        });
 
-       // Step 17: Connect and Disconnect Blocks
+       // 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());
@@ -480,32 +515,15 @@ async fn start_ldk() {
                }
        });
 
-       // Step 17 & 18: Initialize ChannelManager persistence & Once Per Minute: ChannelManager's
-       // timer_chan_freshness_every_min() and PeerManager's timer_tick_occurred
-       let data_dir = ldk_data_dir.clone();
-       let persist_channel_manager_callback =
-               move |node: &ChannelManager| FilesystemPersister::persist_manager(data_dir.clone(), &*node);
-       BackgroundProcessor::start(
-               persist_channel_manager_callback,
-               channel_manager.clone(),
-               peer_manager.clone(),
-               logger.clone(),
-       );
-
-       let peer_manager_processor = peer_manager.clone();
-       tokio::spawn(async move {
-               loop {
-                       peer_manager_processor.timer_tick_occurred();
-                       tokio::time::sleep(Duration::from_secs(60)).await;
-               }
-       });
-
        // Step 15: Initialize LDK Event Handling
        let channel_manager_event_listener = channel_manager.clone();
        let chain_monitor_event_listener = chain_monitor.clone();
        let keys_manager_listener = keys_manager.clone();
-       let payment_info: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
-       let payment_info_for_events = payment_info.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();
        tokio::spawn(async move {
@@ -514,12 +532,25 @@ async fn start_ldk() {
                        chain_monitor_event_listener,
                        bitcoind_rpc,
                        keys_manager_listener,
-                       payment_info_for_events,
+                       inbound_pmts_for_events,
+                       outbound_pmts_for_events,
                        network,
+                       event_ntfn_receiver,
                )
                .await;
        });
 
+       // Step 16 & 17: Persist ChannelManager & Background Processing
+       let data_dir = ldk_data_dir.clone();
+       let persist_channel_manager_callback =
+               move |node: &ChannelManager| FilesystemPersister::persist_manager(data_dir.clone(), &*node);
+       BackgroundProcessor::start(
+               persist_channel_manager_callback,
+               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)) {
@@ -544,9 +575,10 @@ async fn start_ldk() {
        cli::poll_for_user_input(
                peer_manager.clone(),
                channel_manager.clone(),
+               keys_manager.clone(),
                router.clone(),
-               payment_info,
-               keys_manager.get_node_secret(),
+               inbound_payments,
+               outbound_payments,
                event_ntfn_sender,
                ldk_data_dir.clone(),
                logger.clone(),