Merge pull request #85 from ch1ru/main
[ldk-sample] / src / cli.rs
index 7d865158e6e7e786a93b52ff99a513d766f50b08..030109ecf792d353cf41b6adae34f58d3a05f946 100644 (file)
@@ -9,18 +9,19 @@ use bitcoin::hashes::Hash;
 use bitcoin::network::constants::Network;
 use bitcoin::secp256k1::PublicKey;
 use lightning::chain::keysinterface::{KeysInterface, KeysManager, Recipient};
-use lightning::ln::msgs::NetAddress;
+use lightning::ln::msgs::{DecodeError, NetAddress};
 use lightning::ln::{PaymentHash, PaymentPreimage};
-use lightning::onion_message::Destination;
+use lightning::onion_message::{CustomOnionMessageContents, Destination, OnionMessageContents};
 use lightning::routing::gossip::NodeId;
 use lightning::util::config::{ChannelHandshakeConfig, ChannelHandshakeLimits, UserConfig};
 use lightning::util::events::EventHandler;
+use lightning::util::ser::{MaybeReadableArgs, Writeable, Writer};
 use lightning_invoice::payment::PaymentError;
 use lightning_invoice::{utils, Currency, Invoice};
 use std::env;
 use std::io;
 use std::io::Write;
-use std::net::{IpAddr, SocketAddr, ToSocketAddrs};
+use std::net::{SocketAddr, ToSocketAddrs};
 use std::ops::Deref;
 use std::path::Path;
 use std::str::FromStr;
@@ -39,105 +40,27 @@ pub(crate) struct LdkUserInfo {
        pub(crate) network: Network,
 }
 
-pub(crate) fn parse_startup_args() -> Result<LdkUserInfo, ()> {
-       if env::args().len() < 3 {
-               println!("ldk-tutorial-node requires 3 arguments: `cargo run <bitcoind-rpc-username>:<bitcoind-rpc-password>@<bitcoind-rpc-host>:<bitcoind-rpc-port> ldk_storage_directory_path [<ldk-incoming-peer-listening-port>] [bitcoin-network] [announced-node-name announced-listen-addr*]`");
-               return Err(());
-       }
-       let bitcoind_rpc_info = env::args().skip(1).next().unwrap();
-       let bitcoind_rpc_info_parts: Vec<&str> = bitcoind_rpc_info.rsplitn(2, "@").collect();
-       if bitcoind_rpc_info_parts.len() != 2 {
-               println!("ERROR: bad bitcoind RPC URL provided");
-               return Err(());
-       }
-       let rpc_user_and_password: Vec<&str> = bitcoind_rpc_info_parts[1].split(":").collect();
-       if rpc_user_and_password.len() != 2 {
-               println!("ERROR: bad bitcoind RPC username/password combo provided");
-               return Err(());
+struct UserOnionMessageContents {
+       tlv_type: u64,
+       data: Vec<u8>,
+}
+
+impl CustomOnionMessageContents for UserOnionMessageContents {
+       fn tlv_type(&self) -> u64 {
+               self.tlv_type
        }
-       let bitcoind_rpc_username = rpc_user_and_password[0].to_string();
-       let bitcoind_rpc_password = rpc_user_and_password[1].to_string();
-       let bitcoind_rpc_path: Vec<&str> = bitcoind_rpc_info_parts[0].split(":").collect();
-       if bitcoind_rpc_path.len() != 2 {
-               println!("ERROR: bad bitcoind RPC path provided");
-               return Err(());
+}
+impl MaybeReadableArgs<u64> for UserOnionMessageContents {
+       fn read<R: std::io::Read>(_r: &mut R, _args: u64) -> Result<Option<Self>, DecodeError> {
+               // UserOnionMessageContents is only ever passed to `send_onion_message`, never to an
+               // `OnionMessageHandler`, thus it does not need to implement the read side here.
+               unreachable!();
        }
-       let bitcoind_rpc_host = bitcoind_rpc_path[0].to_string();
-       let bitcoind_rpc_port = bitcoind_rpc_path[1].parse::<u16>().unwrap();
-
-       let ldk_storage_dir_path = env::args().skip(2).next().unwrap();
-
-       let mut ldk_peer_port_set = true;
-       let ldk_peer_listening_port: u16 = match env::args().skip(3).next().map(|p| p.parse()) {
-               Some(Ok(p)) => p,
-               Some(Err(_)) => {
-                       ldk_peer_port_set = false;
-                       9735
-               }
-               None => {
-                       ldk_peer_port_set = false;
-                       9735
-               }
-       };
-
-       let mut arg_idx = match ldk_peer_port_set {
-               true => 4,
-               false => 3,
-       };
-       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`, and `signet`. Got {}", net);
-               }
-               None => Network::Testnet,
-       };
-
-       let ldk_announced_node_name = match env::args().skip(arg_idx + 1).next().as_ref() {
-               Some(s) => {
-                       if s.len() > 32 {
-                               panic!("Node Alias can not be longer than 32 bytes");
-                       }
-                       arg_idx += 1;
-                       let mut bytes = [0; 32];
-                       bytes[..s.len()].copy_from_slice(s.as_bytes());
-                       bytes
-               }
-               None => [0; 32],
-       };
-
-       let mut ldk_announced_listen_addr = Vec::new();
-       loop {
-               match env::args().skip(arg_idx + 1).next().as_ref() {
-                       Some(s) => match IpAddr::from_str(s) {
-                               Ok(IpAddr::V4(a)) => {
-                                       ldk_announced_listen_addr
-                                               .push(NetAddress::IPv4 { addr: a.octets(), port: ldk_peer_listening_port });
-                                       arg_idx += 1;
-                               }
-                               Ok(IpAddr::V6(a)) => {
-                                       ldk_announced_listen_addr
-                                               .push(NetAddress::IPv6 { addr: a.octets(), port: ldk_peer_listening_port });
-                                       arg_idx += 1;
-                               }
-                               Err(_) => panic!("Failed to parse announced-listen-addr into an IP address"),
-                       },
-                       None => break,
-               }
+}
+impl Writeable for UserOnionMessageContents {
+       fn write<W: Writer>(&self, w: &mut W) -> Result<(), std::io::Error> {
+               w.write_all(&self.data)
        }
-
-       Ok(LdkUserInfo {
-               bitcoind_rpc_username,
-               bitcoind_rpc_password,
-               bitcoind_rpc_host,
-               bitcoind_rpc_port,
-               ldk_storage_dir_path,
-               ldk_peer_listening_port,
-               ldk_announced_listen_addr,
-               ldk_announced_node_name,
-               network,
-       })
 }
 
 pub(crate) async fn poll_for_user_input<E: EventHandler>(
@@ -145,9 +68,11 @@ pub(crate) async fn poll_for_user_input<E: EventHandler>(
        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,
+       ldk_data_dir: String, network: Network, logger: Arc<disk::FilesystemLogger>,
 ) {
-       println!("LDK startup successful. To view available commands: \"help\".");
+       println!(
+               "LDK startup successful. Enter \"help\" to view available commands. Press Ctrl-D to quit."
+       );
        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());
        loop {
@@ -155,7 +80,12 @@ pub(crate) async fn poll_for_user_input<E: EventHandler>(
                io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
                let mut line = String::new();
                if let Err(e) = io::stdin().read_line(&mut line) {
-                       break println!("ERROR: {e:#}");
+                       break println!("ERROR: {}", e);
+               }
+
+               if line.len() == 0 {
+                       // We hit EOF / Ctrl-D
+                       break;
                }
 
                let mut words = line.split_whitespace();
@@ -297,11 +227,12 @@ pub(crate) async fn poll_for_user_input<E: EventHandler>(
 
                                        get_invoice(
                                                amt_msat.unwrap(),
-                                               inbound_payments.clone(),
-                                               channel_manager.clone(),
-                                               keys_manager.clone(),
+                                               Arc::clone(&inbound_payments),
+                                               &*channel_manager,
+                                               Arc::clone(&keys_manager),
                                                network,
                                                expiry_secs.unwrap(),
+                                               Arc::clone(&logger),
                                        );
                                }
                                "connectpeer" => {
@@ -325,6 +256,32 @@ pub(crate) async fn poll_for_user_input<E: EventHandler>(
                                                println!("SUCCESS: connected to peer {}", pubkey);
                                        }
                                }
+                               "disconnectpeer" => {
+                                       let peer_pubkey = words.next();
+                                       if peer_pubkey.is_none() {
+                                               println!("ERROR: disconnectpeer requires peer public key: `disconnectpeer <peer_pubkey>`");
+                                               continue;
+                                       }
+
+                                       let peer_pubkey =
+                                               match bitcoin::secp256k1::PublicKey::from_str(peer_pubkey.unwrap()) {
+                                                       Ok(pubkey) => pubkey,
+                                                       Err(e) => {
+                                                               println!("ERROR: {}", e.to_string());
+                                                               continue;
+                                                       }
+                                               };
+
+                                       if do_disconnect_peer(
+                                               peer_pubkey,
+                                               peer_manager.clone(),
+                                               channel_manager.clone(),
+                                       )
+                                       .is_ok()
+                                       {
+                                               println!("SUCCESS: disconnected from peer {}", peer_pubkey);
+                                       }
+                               }
                                "listchannels" => list_channels(&channel_manager, &network_graph),
                                "listpayments" => {
                                        list_payments(inbound_payments.clone(), outbound_payments.clone())
@@ -449,16 +406,32 @@ pub(crate) async fn poll_for_user_input<E: EventHandler>(
                                        if errored {
                                                continue;
                                        }
+                                       let tlv_type = match words.next().map(|ty_str| ty_str.parse()) {
+                                               Some(Ok(ty)) if ty >= 64 => ty,
+                                               _ => {
+                                                       println!("Need an integral message type above 64");
+                                                       continue;
+                                               }
+                                       };
+                                       let data = match words.next().map(|s| hex_utils::to_vec(s)) {
+                                               Some(Some(data)) => data,
+                                               _ => {
+                                                       println!("Need a hex data string");
+                                                       continue;
+                                               }
+                                       };
                                        let destination_pk = node_pks.pop().unwrap();
                                        match onion_messenger.send_onion_message(
                                                &node_pks,
                                                Destination::Node(destination_pk),
+                                               OnionMessageContents::Custom(UserOnionMessageContents { tlv_type, data }),
                                                None,
                                        ) {
                                                Ok(()) => println!("SUCCESS: forwarded onion message to first hop"),
                                                Err(e) => println!("ERROR: failed to send onion message: {:?}", e),
                                        }
                                }
+                               "quit" | "exit" => break,
                                _ => println!("Unknown command. See `\"help\" for available commands."),
                        }
                }
@@ -466,19 +439,36 @@ pub(crate) async fn poll_for_user_input<E: EventHandler>(
 }
 
 fn help() {
-       println!("openchannel pubkey@host:port <amt_satoshis> [--public]");
-       println!("sendpayment <invoice>");
-       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> <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>");
+       let package_version = env!("CARGO_PKG_VERSION");
+       let package_name = env!("CARGO_PKG_NAME");
+       println!("\nVERSION:");
+       println!("  {} v{}", package_name, package_version);
+       println!("\nUSAGE:");
+       println!("  Command [arguments]");
+       println!("\nCOMMANDS:");
+       println!("  help\tShows a list of commands.");
+       println!("  quit\tClose the application.");
+       println!("\n  Channels:");
+       println!("      openchannel pubkey@host:port <amt_satoshis> [--public]");
+       println!("      closechannel <channel_id> <peer_pubkey>");
+       println!("      forceclosechannel <channel_id> <peer_pubkey>");
+       println!("      listchannels");
+       println!("\n  Peers:");
+       println!("      connectpeer pubkey@host:port");
+       println!("      disconnectpeer <peer_pubkey>");
+       println!("      listpeers");
+       println!("\n  Payments:");
+       println!("      sendpayment <invoice>");
+       println!("      keysend <dest_pubkey> <amt_msats>");
+       println!("      listpayments");
+       println!("\n  Invoices:");
+       println!("      getinvoice <amt_msats> <expiry_secs>");
+       println!("\n  Other:");
+       println!("      signmessage <message>");
+       println!(
+               "      sendonionmessage <node_id_1,node_id_2,..,destination_node_id> <type> <hex_bytes>"
+       );
+       println!("      nodeinfo");
 }
 
 fn node_info(channel_manager: &Arc<ChannelManager>, peer_manager: &Arc<PeerManager>) {
@@ -624,6 +614,29 @@ pub(crate) async fn do_connect_peer(
        }
 }
 
+fn do_disconnect_peer(
+       pubkey: bitcoin::secp256k1::PublicKey, peer_manager: Arc<PeerManager>,
+       channel_manager: Arc<ChannelManager>,
+) -> Result<(), ()> {
+       //check for open channels with peer
+       for channel in channel_manager.list_channels() {
+               if channel.counterparty.node_id == pubkey {
+                       println!("Error: Node has an active channel with this peer, close any channels first");
+                       return Err(());
+               }
+       }
+
+       //check the pubkey matches a valid connected peer
+       let peers = peer_manager.get_peer_node_ids();
+       if !peers.contains(&pubkey) {
+               println!("Error: Could not find peer {}", pubkey);
+               return Err(());
+       }
+
+       peer_manager.disconnect_by_node_id(pubkey, false);
+       Ok(())
+}
+
 fn open_channel(
        peer_pubkey: PublicKey, channel_amt_sat: u64, announced_channel: bool,
        channel_manager: Arc<ChannelManager>,
@@ -742,8 +755,9 @@ fn keysend<E: EventHandler, K: KeysInterface>(
 }
 
 fn get_invoice(
-       amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: Arc<ChannelManager>,
+       amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: &ChannelManager,
        keys_manager: Arc<KeysManager>, network: Network, expiry_secs: u32,
+       logger: Arc<disk::FilesystemLogger>,
 ) {
        let mut payments = payment_storage.lock().unwrap();
        let currency = match network {
@@ -753,8 +767,9 @@ fn get_invoice(
                Network::Signet => Currency::Signet,
        };
        let invoice = match utils::create_invoice_from_channelmanager(
-               &channel_manager,
+               channel_manager,
                keys_manager,
+               logger,
                currency,
                Some(amt_msat),
                "ldk-tutorial-node".to_string(),