Provide an MSRV of 1.48
[ldk-sample] / src / cli.rs
index f50d3f9fa175aca2e18b49b43d9e93386829a80f..99a43784cb69ad55b2aabd9598f6c47d6db3a9be 100644 (file)
@@ -9,17 +9,18 @@ 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::{BufRead, Write};
+use std::io::Write;
 use std::net::{IpAddr, SocketAddr, ToSocketAddrs};
 use std::ops::Deref;
 use std::path::Path;
@@ -140,25 +141,54 @@ pub(crate) fn parse_startup_args() -> Result<LdkUserInfo, ()> {
        })
 }
 
+struct UserOnionMessageContents {
+       tlv_type: u64,
+       data: Vec<u8>,
+}
+
+impl CustomOnionMessageContents for UserOnionMessageContents {
+       fn tlv_type(&self) -> u64 {
+               self.tlv_type
+       }
+}
+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!();
+       }
+}
+impl Writeable for UserOnionMessageContents {
+       fn write<W: Writer>(&self, w: &mut W) -> Result<(), std::io::Error> {
+               w.write_all(&self.data)
+       }
+}
+
 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,
+       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());
-       let stdin = io::stdin();
-       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 line = String::new();
+               if let Err(e) = io::stdin().read_line(&mut line) {
+                       break println!("ERROR: {}", e);
+               }
+
+               if line.len() == 0 {
+                       // We hit EOF / Ctrl-D
+                       break;
+               }
+
                let mut words = line.split_whitespace();
                if let Some(word) = words.next() {
                        match word {
@@ -298,11 +328,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" => {
@@ -450,16 +481,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."),
                        }
                }
@@ -467,19 +514,35 @@ 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!("      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>) {
@@ -743,8 +806,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 {
@@ -754,8 +818,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(),