Update to 0.0.105 upstream API
[ldk-sample] / src / cli.rs
index 610acb6f637f1ac9820586f54bb20f219fb91e4d..c7dffd280b3bbc3a74119bd09f1dd9ec669ed809 100644 (file)
@@ -1,21 +1,19 @@
 use crate::disk;
 use crate::hex_utils;
 use crate::{
-       ChannelManager, FilesystemLogger, HTLCStatus, MillisatAmount, PaymentInfo, PaymentInfoStorage,
+       ChannelManager, HTLCStatus, InvoicePayer, MillisatAmount, PaymentInfo, PaymentInfoStorage,
        PeerManager,
 };
+use bitcoin::hashes::sha256::Hash as Sha256;
 use bitcoin::hashes::Hash;
 use bitcoin::network::constants::Network;
 use bitcoin::secp256k1::key::PublicKey;
-use lightning::chain::keysinterface::{KeysInterface, KeysManager};
-use lightning::ln::features::InvoiceFeatures;
+use lightning::chain::keysinterface::{KeysInterface, KeysManager, Recipient};
 use lightning::ln::msgs::NetAddress;
-use lightning::ln::{PaymentHash, PaymentSecret};
-use lightning::routing::network_graph::NetworkGraph;
-use lightning::routing::router;
-use lightning::routing::router::{Payee, RouteHint, RouteParameters};
-use lightning::routing::scorer::Scorer;
+use lightning::ln::{PaymentHash, PaymentPreimage};
 use lightning::util::config::{ChannelConfig, ChannelHandshakeLimits, UserConfig};
+use lightning::util::events::EventHandler;
+use lightning_invoice::payment::PaymentError;
 use lightning_invoice::{utils, Currency, Invoice};
 use std::env;
 use std::io;
@@ -87,8 +85,9 @@ pub(crate) fn parse_startup_args() -> Result<LdkUserInfo, ()> {
        let network: Network = match env::args().skip(arg_idx).next().as_ref().map(String::as_str) {
                Some("testnet") => Network::Testnet,
                Some("regtest") => Network::Regtest,
+               Some("signet") => Network::Signet,
                Some(net) => {
-                       panic!("Unsupported network provided. Options are: `regtest`, `testnet`. Got {}", net);
+                       panic!("Unsupported network provided. Options are: `regtest`, `testnet`, and `signet`. Got {}", net);
                }
                None => Network::Testnet,
        };
@@ -139,20 +138,24 @@ pub(crate) fn parse_startup_args() -> Result<LdkUserInfo, ()> {
        })
 }
 
-pub(crate) async fn poll_for_user_input(
-       peer_manager: Arc<PeerManager>, channel_manager: Arc<ChannelManager>,
-       keys_manager: Arc<KeysManager>, network_graph: Arc<NetworkGraph>,
+pub(crate) async fn poll_for_user_input<E: EventHandler>(
+       invoice_payer: Arc<InvoicePayer<E>>, peer_manager: Arc<PeerManager>,
+       channel_manager: Arc<ChannelManager>, keys_manager: Arc<KeysManager>,
        inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage,
-       ldk_data_dir: String, logger: Arc<FilesystemLogger>, network: Network,
+       ldk_data_dir: String, network: Network,
 ) {
        println!("LDK startup successful. To view available commands: \"help\".");
        println!("LDK logs are available at <your-supplied-ldk-data-dir-path>/.ldk/logs");
        println!("Local Node ID is {}.", channel_manager.get_our_node_id());
        let stdin = io::stdin();
-       print!("> ");
-       io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
-       for line in stdin.lock().lines() {
-               let line = line.unwrap();
+       let mut line_reader = stdin.lock().lines();
+       loop {
+               print!("> ");
+               io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
+               let line = match line_reader.next() {
+                       Some(l) => l.unwrap(),
+                       None => break,
+               };
                let mut words = line.split_whitespace();
                if let Some(word) = words.next() {
                        match word {
@@ -162,8 +165,6 @@ pub(crate) async fn poll_for_user_input(
                                        let channel_value_sat = words.next();
                                        if peer_pubkey_and_ip_addr.is_none() || channel_value_sat.is_none() {
                                                println!("ERROR: openchannel has 2 required arguments: `openchannel pubkey@host:port channel_amt_satoshis` [--public]");
-                                               print!("> ");
-                                               io::stdout().flush().unwrap();
                                                continue;
                                        }
                                        let peer_pubkey_and_ip_addr = peer_pubkey_and_ip_addr.unwrap();
@@ -172,8 +173,6 @@ pub(crate) async fn poll_for_user_input(
                                                        Ok(info) => info,
                                                        Err(e) => {
                                                                println!("{:?}", e.into_inner().unwrap());
-                                                               print!("> ");
-                                                               io::stdout().flush().unwrap();
                                                                continue;
                                                        }
                                                };
@@ -181,8 +180,6 @@ pub(crate) async fn poll_for_user_input(
                                        let chan_amt_sat: Result<u64, _> = channel_value_sat.unwrap().parse();
                                        if chan_amt_sat.is_err() {
                                                println!("ERROR: channel amount must be a number");
-                                               print!("> ");
-                                               io::stdout().flush().unwrap();
                                                continue;
                                        }
 
@@ -190,8 +187,6 @@ pub(crate) async fn poll_for_user_input(
                                                .await
                                                .is_err()
                                        {
-                                               print!("> ");
-                                               io::stdout().flush().unwrap();
                                                continue;
                                        };
 
@@ -200,8 +195,6 @@ pub(crate) async fn poll_for_user_input(
                                                Some("--public=false") => false,
                                                Some(_) => {
                                                        println!("ERROR: invalid `--public` command format. Valid formats: `--public`, `--public=true` `--public=false`");
-                                                       print!("> ");
-                                                       io::stdout().flush().unwrap();
                                                        continue;
                                                }
                                                None => false,
@@ -226,8 +219,6 @@ pub(crate) async fn poll_for_user_input(
                                        let invoice_str = words.next();
                                        if invoice_str.is_none() {
                                                println!("ERROR: sendpayment requires an invoice: `sendpayment <invoice>`");
-                                               print!("> ");
-                                               io::stdout().flush().unwrap();
                                                continue;
                                        }
 
@@ -235,40 +226,11 @@ pub(crate) async fn poll_for_user_input(
                                                Ok(inv) => inv,
                                                Err(e) => {
                                                        println!("ERROR: invalid invoice: {:?}", e);
-                                                       print!("> ");
-                                                       io::stdout().flush().unwrap();
                                                        continue;
                                                }
                                        };
-                                       let last_hops = invoice.route_hints();
-
-                                       let amt_msat = invoice.amount_milli_satoshis();
-                                       if amt_msat.is_none() {
-                                               println!("ERROR: invalid invoice: must contain amount to pay");
-                                               print!("> ");
-                                               io::stdout().flush().unwrap();
-                                               continue;
-                                       }
-
-                                       let payee_pubkey = invoice.recover_payee_pub_key();
-                                       let final_cltv = invoice.min_final_cltv_expiry() as u32;
-                                       let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
-                                       let payment_secret = Some(invoice.payment_secret().clone());
-                                       let invoice_features = invoice.features().cloned();
 
-                                       send_payment(
-                                               payee_pubkey,
-                                               amt_msat.unwrap(),
-                                               final_cltv,
-                                               payment_hash,
-                                               payment_secret,
-                                               invoice_features,
-                                               last_hops,
-                                               network_graph.clone(),
-                                               channel_manager.clone(),
-                                               outbound_payments.clone(),
-                                               logger.clone(),
-                                       );
+                                       send_payment(&*invoice_payer, &invoice, outbound_payments.clone());
                                }
                                "keysend" => {
                                        let dest_pubkey = match words.next() {
@@ -276,15 +238,11 @@ pub(crate) async fn poll_for_user_input(
                                                        Some(pk) => pk,
                                                        None => {
                                                                println!("ERROR: couldn't parse destination pubkey");
-                                                               print!("> ");
-                                                               io::stdout().flush().unwrap();
                                                                continue;
                                                        }
                                                },
                                                None => {
                                                        println!("ERROR: keysend requires a destination pubkey: `keysend <dest_pubkey> <amt_msat>`");
-                                                       print!("> ");
-                                                       io::stdout().flush().unwrap();
                                                        continue;
                                                }
                                        };
@@ -292,9 +250,6 @@ pub(crate) async fn poll_for_user_input(
                                                Some(amt) => amt,
                                                None => {
                                                        println!("ERROR: keysend requires an amount in millisatoshis: `keysend <dest_pubkey> <amt_msat>`");
-
-                                                       print!("> ");
-                                                       io::stdout().flush().unwrap();
                                                        continue;
                                                }
                                        };
@@ -302,34 +257,27 @@ pub(crate) async fn poll_for_user_input(
                                                Ok(amt) => amt,
                                                Err(e) => {
                                                        println!("ERROR: couldn't parse amount_msat: {}", e);
-                                                       print!("> ");
-                                                       io::stdout().flush().unwrap();
                                                        continue;
                                                }
                                        };
                                        keysend(
+                                               &*invoice_payer,
                                                dest_pubkey,
                                                amt_msat,
-                                               network_graph.clone(),
-                                               channel_manager.clone(),
+                                               &*keys_manager,
                                                outbound_payments.clone(),
-                                               logger.clone(),
                                        );
                                }
                                "getinvoice" => {
                                        let amt_str = words.next();
                                        if amt_str.is_none() {
                                                println!("ERROR: getinvoice requires an amount in millisatoshis");
-                                               print!("> ");
-                                               io::stdout().flush().unwrap();
                                                continue;
                                        }
 
                                        let amt_msat: Result<u64, _> = amt_str.unwrap().parse();
                                        if amt_msat.is_err() {
                                                println!("ERROR: getinvoice provided payment amount was not a number");
-                                               print!("> ");
-                                               io::stdout().flush().unwrap();
                                                continue;
                                        }
                                        get_invoice(
@@ -344,8 +292,6 @@ pub(crate) async fn poll_for_user_input(
                                        let peer_pubkey_and_ip_addr = words.next();
                                        if peer_pubkey_and_ip_addr.is_none() {
                                                println!("ERROR: connectpeer requires peer connection info: `connectpeer pubkey@host:port`");
-                                               print!("> ");
-                                               io::stdout().flush().unwrap();
                                                continue;
                                        }
                                        let (pubkey, peer_addr) =
@@ -353,8 +299,6 @@ pub(crate) async fn poll_for_user_input(
                                                        Ok(info) => info,
                                                        Err(e) => {
                                                                println!("{:?}", e.into_inner().unwrap());
-                                                               print!("> ");
-                                                               io::stdout().flush().unwrap();
                                                                continue;
                                                        }
                                                };
@@ -373,15 +317,11 @@ pub(crate) async fn poll_for_user_input(
                                        let channel_id_str = words.next();
                                        if channel_id_str.is_none() {
                                                println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id>`");
-                                               print!("> ");
-                                               io::stdout().flush().unwrap();
                                                continue;
                                        }
                                        let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
                                        if channel_id_vec.is_none() {
                                                println!("ERROR: couldn't parse channel_id as hex");
-                                               print!("> ");
-                                               io::stdout().flush().unwrap();
                                                continue;
                                        }
                                        let mut channel_id = [0; 32];
@@ -392,15 +332,11 @@ pub(crate) async fn poll_for_user_input(
                                        let channel_id_str = words.next();
                                        if channel_id_str.is_none() {
                                                println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id>`");
-                                               print!("> ");
-                                               io::stdout().flush().unwrap();
                                                continue;
                                        }
                                        let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
                                        if channel_id_vec.is_none() {
                                                println!("ERROR: couldn't parse channel_id as hex");
-                                               print!("> ");
-                                               io::stdout().flush().unwrap();
                                                continue;
                                        }
                                        let mut channel_id = [0; 32];
@@ -410,28 +346,22 @@ pub(crate) async fn poll_for_user_input(
                                "nodeinfo" => node_info(channel_manager.clone(), peer_manager.clone()),
                                "listpeers" => list_peers(peer_manager.clone()),
                                "signmessage" => {
-                                       const MSG_STARTPOS: usize = "signmsg".len() + 1;
+                                       const MSG_STARTPOS: usize = "signmessage".len() + 1;
                                        if line.as_bytes().len() <= MSG_STARTPOS {
                                                println!("ERROR: signmsg requires a message");
-                                               print!("> ");
-                                               io::stdout().flush().unwrap();
                                                continue;
                                        }
                                        println!(
                                                "{:?}",
                                                lightning::util::message_signing::sign(
                                                        &line.as_bytes()[MSG_STARTPOS..],
-                                                       &keys_manager.get_node_secret()
+                                                       &keys_manager.get_node_secret(Recipient::Node).unwrap()
                                                )
                                        );
-                                       print!("> ");
-                                       io::stdout().flush().unwrap();
                                }
                                _ => println!("Unknown command. See `\"help\" for available commands."),
                        }
                }
-               print!("> ");
-               io::stdout().flush().unwrap();
        }
 }
 
@@ -452,8 +382,14 @@ fn help() {
 fn node_info(channel_manager: Arc<ChannelManager>, peer_manager: Arc<PeerManager>) {
        println!("\t{{");
        println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
-       println!("\t\t num_channels: {}", channel_manager.list_channels().len());
-       println!("\t\t num_usable_channels: {}", channel_manager.list_usable_channels().len());
+       let chans = channel_manager.list_channels();
+       println!("\t\t num_channels: {}", chans.len());
+       println!("\t\t num_usable_channels: {}", chans.iter().filter(|c| c.is_usable).count());
+       let local_balance_msat = chans
+               .iter()
+               .map(|c| c.unspendable_punishment_reserve.unwrap_or(0) * 1000 + c.outbound_capacity_msat)
+               .sum::<u64>();
+       println!("\t\t local_balance_msat: {}", local_balance_msat);
        println!("\t\t num_peers: {}", peer_manager.get_peer_node_ids().len());
        println!("\t}},");
 }
@@ -550,6 +486,16 @@ pub(crate) async fn connect_peer_if_necessary(
                        return Ok(());
                }
        }
+       let res = do_connect_peer(pubkey, peer_addr, peer_manager).await;
+       if res.is_err() {
+               println!("ERROR: failed to connect to peer");
+       }
+       res
+}
+
+pub(crate) async fn do_connect_peer(
+       pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
+) -> Result<(), ()> {
        match lightning_net_tokio::connect_outbound(Arc::clone(&peer_manager), pubkey, peer_addr).await
        {
                Some(connection_closed_future) => {
@@ -557,24 +503,19 @@ pub(crate) async fn connect_peer_if_necessary(
                        loop {
                                match futures::poll!(&mut connection_closed_future) {
                                        std::task::Poll::Ready(_) => {
-                                               println!("ERROR: Peer disconnected before we finished the handshake");
                                                return Err(());
                                        }
                                        std::task::Poll::Pending => {}
                                }
                                // Avoid blocking the tokio context by sleeping a bit
                                match peer_manager.get_peer_node_ids().iter().find(|id| **id == pubkey) {
-                                       Some(_) => break,
+                                       Some(_) => return Ok(()),
                                        None => tokio::time::sleep(Duration::from_millis(10)).await,
                                }
                        }
                }
-               None => {
-                       println!("ERROR: failed to connect to peer");
-                       return Err(());
-               }
+               None => Err(()),
        }
-       Ok(())
 }
 
 fn open_channel(
@@ -603,46 +544,36 @@ fn open_channel(
        }
 }
 
-fn send_payment(
-       payee_pubkey: PublicKey, amt_msat: u64, final_cltv: u32, payment_hash: PaymentHash,
-       payment_secret: Option<PaymentSecret>, payee_features: Option<InvoiceFeatures>,
-       route_hints: Vec<RouteHint>, network_graph: Arc<NetworkGraph>,
-       channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
-       logger: Arc<FilesystemLogger>,
+fn send_payment<E: EventHandler>(
+       invoice_payer: &InvoicePayer<E>, invoice: &Invoice, payment_storage: PaymentInfoStorage,
 ) {
-       let first_hops = channel_manager.list_usable_channels();
-       let payer_pubkey = channel_manager.get_our_node_id();
-
-       let mut payee = Payee::from_node_id(payee_pubkey).with_route_hints(route_hints);
-       if let Some(features) = payee_features {
-               payee = payee.with_features(features);
-       }
-       let params =
-               RouteParameters { payee, final_value_msat: amt_msat, final_cltv_expiry_delta: final_cltv };
-
-       let route = router::find_route(
-               &payer_pubkey,
-               &params,
-               &network_graph,
-               Some(&first_hops.iter().collect::<Vec<_>>()),
-               logger,
-               &Scorer::default(),
-       );
-       if let Err(e) = route {
-               println!("ERROR: failed to find route: {}", e.err);
-               return;
-       }
-       let status = match channel_manager.send_payment(&route.unwrap(), payment_hash, &payment_secret)
-       {
+       let status = match invoice_payer.pay_invoice(invoice) {
                Ok(_payment_id) => {
+                       let payee_pubkey = invoice.recover_payee_pub_key();
+                       let amt_msat = invoice.amount_milli_satoshis().unwrap();
                        println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
+                       print!("> ");
                        HTLCStatus::Pending
                }
-               Err(e) => {
+               Err(PaymentError::Invoice(e)) => {
+                       println!("ERROR: invalid invoice: {}", e);
+                       print!("> ");
+                       return;
+               }
+               Err(PaymentError::Routing(e)) => {
+                       println!("ERROR: failed to find route: {}", e.err);
+                       print!("> ");
+                       return;
+               }
+               Err(PaymentError::Sending(e)) => {
                        println!("ERROR: failed to send payment: {:?}", e);
+                       print!("> ");
                        HTLCStatus::Failed
                }
        };
+       let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
+       let payment_secret = Some(invoice.payment_secret().clone());
+
        let mut payments = payment_storage.lock().unwrap();
        payments.insert(
                payment_hash,
@@ -650,45 +581,52 @@ fn send_payment(
                        preimage: None,
                        secret: payment_secret,
                        status,
-                       amt_msat: MillisatAmount(Some(amt_msat)),
+                       amt_msat: MillisatAmount(invoice.amount_milli_satoshis()),
                },
        );
 }
 
-fn keysend(
-       payee_pubkey: PublicKey, amt_msat: u64, network_graph: Arc<NetworkGraph>,
-       channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
-       logger: Arc<FilesystemLogger>,
+fn keysend<E: EventHandler, K: KeysInterface>(
+       invoice_payer: &InvoicePayer<E>, payee_pubkey: PublicKey, amt_msat: u64, keys: &K,
+       payment_storage: PaymentInfoStorage,
 ) {
-       let first_hops = channel_manager.list_usable_channels();
-       let payer_pubkey = channel_manager.get_our_node_id();
-
-       let payee = Payee::for_keysend(payee_pubkey);
-       let params = RouteParameters { payee, final_value_msat: amt_msat, final_cltv_expiry_delta: 40 };
-
-       let route = match router::find_route(
-               &payer_pubkey,
-               &params,
-               &network_graph,
-               Some(&first_hops.iter().collect::<Vec<_>>()),
-               logger,
-               &Scorer::default(),
+       let payment_preimage = keys.get_secure_random_bytes();
+
+       let status = match invoice_payer.pay_pubkey(
+               payee_pubkey,
+               PaymentPreimage(payment_preimage),
+               amt_msat,
+               40,
        ) {
-               Ok(r) => r,
-               Err(e) => {
+               Ok(_payment_id) => {
+                       println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
+                       print!("> ");
+                       HTLCStatus::Pending
+               }
+               Err(PaymentError::Invoice(e)) => {
+                       println!("ERROR: invalid payee: {}", e);
+                       print!("> ");
+                       return;
+               }
+               Err(PaymentError::Routing(e)) => {
                        println!("ERROR: failed to find route: {}", e.err);
+                       print!("> ");
                        return;
                }
+               Err(PaymentError::Sending(e)) => {
+                       println!("ERROR: failed to send payment: {:?}", e);
+                       print!("> ");
+                       HTLCStatus::Failed
+               }
        };
 
        let mut payments = payment_storage.lock().unwrap();
-       let payment_hash = channel_manager.send_spontaneous_payment(&route, None).unwrap().0;
        payments.insert(
-               payment_hash,
+               PaymentHash(Sha256::hash(&payment_preimage).into_inner()),
                PaymentInfo {
                        preimage: None,
                        secret: None,
-                       status: HTLCStatus::Pending,
+                       status,
                        amt_msat: MillisatAmount(Some(amt_msat)),
                },
        );
@@ -703,7 +641,7 @@ fn get_invoice(
                Network::Bitcoin => Currency::Bitcoin,
                Network::Testnet => Currency::BitcoinTestnet,
                Network::Regtest => Currency::Regtest,
-               Network::Signet => panic!("Signet unsupported"),
+               Network::Signet => Currency::Signet,
        };
        let invoice = match utils::create_invoice_from_channelmanager(
                &channel_manager,