Update to LDK 0.0.111 and add command for sending an empty onion message
[ldk-sample] / src / cli.rs
index 8ee046577ff443455f057f1cc582f90d734145e2..f50d3f9fa175aca2e18b49b43d9e93386829a80f 100644 (file)
@@ -1,17 +1,19 @@
 use crate::disk;
 use crate::hex_utils;
 use crate::{
-       ChannelManager, HTLCStatus, InvoicePayer, MillisatAmount, PaymentInfo, PaymentInfoStorage,
-       PeerManager,
+       ChannelManager, HTLCStatus, InvoicePayer, MillisatAmount, NetworkGraph, OnionMessenger,
+       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 bitcoin::secp256k1::PublicKey;
+use lightning::chain::keysinterface::{KeysInterface, KeysManager, Recipient};
 use lightning::ln::msgs::NetAddress;
 use lightning::ln::{PaymentHash, PaymentPreimage};
-use lightning::util::config::{ChannelConfig, ChannelHandshakeLimits, UserConfig};
+use lightning::onion_message::Destination;
+use lightning::routing::gossip::NodeId;
+use lightning::util::config::{ChannelHandshakeConfig, ChannelHandshakeLimits, UserConfig};
 use lightning::util::events::EventHandler;
 use lightning_invoice::payment::PaymentError;
 use lightning_invoice::{utils, Currency, Invoice};
@@ -85,8 +87,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,
        };
@@ -140,6 +143,7 @@ pub(crate) fn parse_startup_args() -> Result<LdkUserInfo, ()> {
 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>,
+       network_graph: Arc<NetworkGraph>, onion_messenger: Arc<OnionMessenger>,
        inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage,
        ldk_data_dir: String, network: Network,
 ) {
@@ -279,12 +283,26 @@ pub(crate) async fn poll_for_user_input<E: EventHandler>(
                                                println!("ERROR: getinvoice provided payment amount was not a number");
                                                continue;
                                        }
+
+                                       let expiry_secs_str = words.next();
+                                       if expiry_secs_str.is_none() {
+                                               println!("ERROR: getinvoice requires an expiry in seconds");
+                                               continue;
+                                       }
+
+                                       let expiry_secs: Result<u32, _> = expiry_secs_str.unwrap().parse();
+                                       if expiry_secs.is_err() {
+                                               println!("ERROR: getinvoice provided expiry was not a number");
+                                               continue;
+                                       }
+
                                        get_invoice(
                                                amt_msat.unwrap(),
                                                inbound_payments.clone(),
                                                channel_manager.clone(),
                                                keys_manager.clone(),
                                                network,
+                                               expiry_secs.unwrap(),
                                        );
                                }
                                "connectpeer" => {
@@ -308,41 +326,83 @@ pub(crate) async fn poll_for_user_input<E: EventHandler>(
                                                println!("SUCCESS: connected to peer {}", pubkey);
                                        }
                                }
-                               "listchannels" => list_channels(channel_manager.clone()),
+                               "listchannels" => list_channels(&channel_manager, &network_graph),
                                "listpayments" => {
                                        list_payments(inbound_payments.clone(), outbound_payments.clone())
                                }
                                "closechannel" => {
                                        let channel_id_str = words.next();
                                        if channel_id_str.is_none() {
-                                               println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id>`");
+                                               println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id> <peer_pubkey>`");
                                                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");
+                                       if channel_id_vec.is_none() || channel_id_vec.as_ref().unwrap().len() != 32 {
+                                               println!("ERROR: couldn't parse channel_id");
                                                continue;
                                        }
                                        let mut channel_id = [0; 32];
                                        channel_id.copy_from_slice(&channel_id_vec.unwrap());
-                                       close_channel(channel_id, channel_manager.clone());
+
+                                       let peer_pubkey_str = words.next();
+                                       if peer_pubkey_str.is_none() {
+                                               println!("ERROR: closechannel requires a peer pubkey: `closechannel <channel_id> <peer_pubkey>`");
+                                               continue;
+                                       }
+                                       let peer_pubkey_vec = match hex_utils::to_vec(peer_pubkey_str.unwrap()) {
+                                               Some(peer_pubkey_vec) => peer_pubkey_vec,
+                                               None => {
+                                                       println!("ERROR: couldn't parse peer_pubkey");
+                                                       continue;
+                                               }
+                                       };
+                                       let peer_pubkey = match PublicKey::from_slice(&peer_pubkey_vec) {
+                                               Ok(peer_pubkey) => peer_pubkey,
+                                               Err(_) => {
+                                                       println!("ERROR: couldn't parse peer_pubkey");
+                                                       continue;
+                                               }
+                                       };
+
+                                       close_channel(channel_id, peer_pubkey, channel_manager.clone());
                                }
                                "forceclosechannel" => {
                                        let channel_id_str = words.next();
                                        if channel_id_str.is_none() {
-                                               println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id>`");
+                                               println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id> <peer_pubkey>`");
                                                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");
+                                       if channel_id_vec.is_none() || channel_id_vec.as_ref().unwrap().len() != 32 {
+                                               println!("ERROR: couldn't parse channel_id");
                                                continue;
                                        }
                                        let mut channel_id = [0; 32];
                                        channel_id.copy_from_slice(&channel_id_vec.unwrap());
-                                       force_close_channel(channel_id, channel_manager.clone());
+
+                                       let peer_pubkey_str = words.next();
+                                       if peer_pubkey_str.is_none() {
+                                               println!("ERROR: forceclosechannel requires a peer pubkey: `forceclosechannel <channel_id> <peer_pubkey>`");
+                                               continue;
+                                       }
+                                       let peer_pubkey_vec = match hex_utils::to_vec(peer_pubkey_str.unwrap()) {
+                                               Some(peer_pubkey_vec) => peer_pubkey_vec,
+                                               None => {
+                                                       println!("ERROR: couldn't parse peer_pubkey");
+                                                       continue;
+                                               }
+                                       };
+                                       let peer_pubkey = match PublicKey::from_slice(&peer_pubkey_vec) {
+                                               Ok(peer_pubkey) => peer_pubkey,
+                                               Err(_) => {
+                                                       println!("ERROR: couldn't parse peer_pubkey");
+                                                       continue;
+                                               }
+                                       };
+
+                                       force_close_channel(channel_id, peer_pubkey, channel_manager.clone());
                                }
-                               "nodeinfo" => node_info(channel_manager.clone(), peer_manager.clone()),
+                               "nodeinfo" => node_info(&channel_manager, &peer_manager),
                                "listpeers" => list_peers(peer_manager.clone()),
                                "signmessage" => {
                                        const MSG_STARTPOS: usize = "signmessage".len() + 1;
@@ -354,10 +414,52 @@ pub(crate) async fn poll_for_user_input<E: EventHandler>(
                                                "{:?}",
                                                lightning::util::message_signing::sign(
                                                        &line.as_bytes()[MSG_STARTPOS..],
-                                                       &keys_manager.get_node_secret()
+                                                       &keys_manager.get_node_secret(Recipient::Node).unwrap()
                                                )
                                        );
                                }
+                               "sendonionmessage" => {
+                                       let path_pks_str = words.next();
+                                       if path_pks_str.is_none() {
+                                               println!(
+                                                       "ERROR: sendonionmessage requires at least one node id for the path"
+                                               );
+                                               continue;
+                                       }
+                                       let mut node_pks = Vec::new();
+                                       let mut errored = false;
+                                       for pk_str in path_pks_str.unwrap().split(",") {
+                                               let node_pubkey_vec = match hex_utils::to_vec(pk_str) {
+                                                       Some(peer_pubkey_vec) => peer_pubkey_vec,
+                                                       None => {
+                                                               println!("ERROR: couldn't parse peer_pubkey");
+                                                               errored = true;
+                                                               break;
+                                                       }
+                                               };
+                                               let node_pubkey = match PublicKey::from_slice(&node_pubkey_vec) {
+                                                       Ok(peer_pubkey) => peer_pubkey,
+                                                       Err(_) => {
+                                                               println!("ERROR: couldn't parse peer_pubkey");
+                                                               errored = true;
+                                                               break;
+                                                       }
+                                               };
+                                               node_pks.push(node_pubkey);
+                                       }
+                                       if errored {
+                                               continue;
+                                       }
+                                       let destination_pk = node_pks.pop().unwrap();
+                                       match onion_messenger.send_onion_message(
+                                               &node_pks,
+                                               Destination::Node(destination_pk),
+                                               None,
+                                       ) {
+                                               Ok(()) => println!("SUCCESS: forwarded onion message to first hop"),
+                                               Err(e) => println!("ERROR: failed to send onion message: {:?}", e),
+                                       }
+                               }
                                _ => println!("Unknown command. See `\"help\" for available commands."),
                        }
                }
@@ -365,29 +467,28 @@ pub(crate) async fn poll_for_user_input<E: EventHandler>(
 }
 
 fn help() {
-       println!("openchannel pubkey@host:port <amt_satoshis>");
+       println!("openchannel pubkey@host:port <amt_satoshis> [--public]");
        println!("sendpayment <invoice>");
-       println!("getinvoice <amt_millisatoshis>");
+       println!("keysend <dest_pubkey> <amt_msats>");
+       println!("getinvoice <amt_msats> <expiry_secs>");
        println!("connectpeer pubkey@host:port");
        println!("listchannels");
        println!("listpayments");
-       println!("closechannel <channel_id>");
-       println!("forceclosechannel <channel_id>");
+       println!("closechannel <channel_id> <peer_pubkey>");
+       println!("forceclosechannel <channel_id> <peer_pubkey>");
        println!("nodeinfo");
        println!("listpeers");
        println!("signmessage <message>");
+       println!("sendonionmessage <node_id_1,node_id_2,..,destination_node_id>");
 }
 
-fn node_info(channel_manager: Arc<ChannelManager>, peer_manager: Arc<PeerManager>) {
+fn node_info(channel_manager: &Arc<ChannelManager>, peer_manager: &Arc<PeerManager>) {
        println!("\t{{");
        println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
        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>();
+       let local_balance_msat = chans.iter().map(|c| c.balance_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}},");
@@ -401,7 +502,7 @@ fn list_peers(peer_manager: Arc<PeerManager>) {
        println!("\t}},");
 }
 
-fn list_channels(channel_manager: Arc<ChannelManager>) {
+fn list_channels(channel_manager: &Arc<ChannelManager>, network_graph: &Arc<NetworkGraph>) {
        print!("[");
        for chan_info in channel_manager.list_channels() {
                println!("");
@@ -410,20 +511,27 @@ fn list_channels(channel_manager: Arc<ChannelManager>) {
                if let Some(funding_txo) = chan_info.funding_txo {
                        println!("\t\tfunding_txid: {},", funding_txo.txid);
                }
+
                println!(
                        "\t\tpeer_pubkey: {},",
                        hex_utils::hex_str(&chan_info.counterparty.node_id.serialize())
                );
+               if let Some(node_info) = network_graph
+                       .read_only()
+                       .nodes()
+                       .get(&NodeId::from_pubkey(&chan_info.counterparty.node_id))
+               {
+                       if let Some(announcement) = &node_info.announcement_info {
+                               println!("\t\tpeer_alias: {}", announcement.alias);
+                       }
+               }
+
                if let Some(id) = chan_info.short_channel_id {
                        println!("\t\tshort_channel_id: {},", id);
                }
-               println!("\t\tis_confirmed_onchain: {},", chan_info.is_funding_locked);
+               println!("\t\tis_channel_ready: {},", chan_info.is_channel_ready);
                println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
-               println!(
-                       "\t\tlocal_balance_msat: {},",
-                       chan_info.outbound_capacity_msat
-                               + chan_info.unspendable_punishment_reserve.unwrap_or(0) * 1000
-               );
+               println!("\t\tlocal_balance_msat: {},", chan_info.balance_msat);
                if chan_info.is_usable {
                        println!("\t\tavailable_balance_for_send_msat: {},", chan_info.outbound_capacity_msat);
                        println!("\t\tavailable_balance_for_recv_msat: {},", chan_info.inbound_capacity_msat);
@@ -522,12 +630,15 @@ fn open_channel(
        channel_manager: Arc<ChannelManager>,
 ) -> Result<(), ()> {
        let config = UserConfig {
-               peer_channel_config_limits: ChannelHandshakeLimits {
+               channel_handshake_limits: ChannelHandshakeLimits {
                        // lnd's max to_self_delay is 2016, so we want to be compatible.
                        their_to_self_delay: 2016,
                        ..Default::default()
                },
-               channel_options: ChannelConfig { announced_channel, ..Default::default() },
+               channel_handshake_config: ChannelHandshakeConfig {
+                       announced_channel,
+                       ..Default::default()
+               },
                ..Default::default()
        };
 
@@ -633,14 +744,14 @@ fn keysend<E: EventHandler, K: KeysInterface>(
 
 fn get_invoice(
        amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: Arc<ChannelManager>,
-       keys_manager: Arc<KeysManager>, network: Network,
+       keys_manager: Arc<KeysManager>, network: Network, expiry_secs: u32,
 ) {
        let mut payments = payment_storage.lock().unwrap();
        let currency = match network {
                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,
@@ -648,6 +759,7 @@ fn get_invoice(
                currency,
                Some(amt_msat),
                "ldk-tutorial-node".to_string(),
+               expiry_secs,
        ) {
                Ok(inv) => {
                        println!("SUCCESS: generated invoice: {}", inv);
@@ -671,15 +783,19 @@ fn get_invoice(
        );
 }
 
-fn close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
-       match channel_manager.close_channel(&channel_id) {
+fn close_channel(
+       channel_id: [u8; 32], counterparty_node_id: PublicKey, channel_manager: Arc<ChannelManager>,
+) {
+       match channel_manager.close_channel(&channel_id, &counterparty_node_id) {
                Ok(()) => println!("EVENT: initiating channel close"),
                Err(e) => println!("ERROR: failed to close channel: {:?}", e),
        }
 }
 
-fn force_close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
-       match channel_manager.force_close_channel(&channel_id) {
+fn force_close_channel(
+       channel_id: [u8; 32], counterparty_node_id: PublicKey, channel_manager: Arc<ChannelManager>,
+) {
+       match channel_manager.force_close_broadcasting_latest_txn(&channel_id, &counterparty_node_id) {
                Ok(()) => println!("EVENT: initiating channel force-close"),
                Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
        }
@@ -691,7 +807,7 @@ pub(crate) fn parse_peer_info(
        let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
        let pubkey = pubkey_and_addr.next();
        let peer_addr_str = pubkey_and_addr.next();
-       if peer_addr_str.is_none() || peer_addr_str.is_none() {
+       if peer_addr_str.is_none() {
                return Err(std::io::Error::new(
                        std::io::ErrorKind::Other,
                        "ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`",