X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fcli.rs;h=9bc2ef1584d80acaea947d42c9223c63cc1f09a7;hb=68a95c0646810ed7afe5022ac211c1f214d950c5;hp=c5dda5fc33e11f19cad785bb5e042855e7babf68;hpb=a73d564d2b7f0733578747ed1c2604bd880efcd9;p=ldk-sample diff --git a/src/cli.rs b/src/cli.rs index c5dda5f..9bc2ef1 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -4,27 +4,29 @@ use crate::{ ChannelManager, FilesystemLogger, HTLCStatus, MillisatAmount, PaymentInfo, PaymentInfoStorage, PeerManager, }; +use bitcoin::hashes::Hash; use bitcoin::network::constants::Network; use bitcoin::secp256k1::key::PublicKey; use lightning::chain; -use lightning::chain::keysinterface::KeysManager; +use lightning::chain::keysinterface::{KeysInterface, KeysManager}; use lightning::ln::features::InvoiceFeatures; +use lightning::ln::msgs::NetAddress; use lightning::ln::{PaymentHash, PaymentSecret}; use lightning::routing::network_graph::NetGraphMsgHandler; use lightning::routing::router; -use lightning::routing::router::RouteHintHop; -use lightning::util::config::UserConfig; +use lightning::routing::router::RouteHint; +use lightning::routing::scorer::Scorer; +use lightning::util::config::{ChannelConfig, ChannelHandshakeLimits, UserConfig}; use lightning_invoice::{utils, Currency, Invoice}; use std::env; use std::io; use std::io::{BufRead, Write}; -use std::net::{SocketAddr, TcpStream}; +use std::net::{IpAddr, SocketAddr, ToSocketAddrs}; use std::ops::Deref; use std::path::Path; use std::str::FromStr; use std::sync::Arc; use std::time::Duration; -use tokio::sync::mpsc; pub(crate) struct LdkUserInfo { pub(crate) bitcoind_rpc_username: String, @@ -33,12 +35,14 @@ pub(crate) struct LdkUserInfo { pub(crate) bitcoind_rpc_host: String, pub(crate) ldk_storage_dir_path: String, pub(crate) ldk_peer_listening_port: u16, + pub(crate) ldk_announced_listen_addr: Vec, + pub(crate) ldk_announced_node_name: [u8; 32], pub(crate) network: Network, } pub(crate) fn parse_startup_args() -> Result { if env::args().len() < 3 { - println!("ldk-tutorial-node requires 3 arguments: `cargo run :@: ldk_storage_directory_path [] [bitcoin-network]`"); + println!("ldk-tutorial-node requires 3 arguments: `cargo run :@: ldk_storage_directory_path [] [bitcoin-network] [announced-node-name announced-listen-addr*]`"); return Err(()); } let bitcoind_rpc_info = env::args().skip(1).next().unwrap(); @@ -67,23 +71,62 @@ pub(crate) fn parse_startup_args() -> Result { 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(e)) => panic!("{}", e), + Some(Err(_)) => { + ldk_peer_port_set = false; + 9735 + } None => { ldk_peer_port_set = false; 9735 } }; - let arg_idx = match ldk_peer_port_set { + 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(_) => panic!("Unsupported network provided. Options are: `regtest`, `testnet`"), + Some(net) => { + panic!("Unsupported network provided. Options are: `regtest`, `testnet`. 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, + } + } + Ok(LdkUserInfo { bitcoind_rpc_username, bitcoind_rpc_password, @@ -91,6 +134,8 @@ pub(crate) fn parse_startup_args() -> Result { bitcoind_rpc_port, ldk_storage_dir_path, ldk_peer_listening_port, + ldk_announced_listen_addr, + ldk_announced_node_name, network, }) } @@ -100,15 +145,15 @@ pub(crate) async fn poll_for_user_input( keys_manager: Arc, router: Arc, Arc>>, inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage, - event_notifier: mpsc::Sender<()>, ldk_data_dir: String, logger: Arc, - network: Network, + ldk_data_dir: String, logger: Arc, network: Network, ) { - println!("LDK startup successful. To view available commands: \"help\".\nLDK logs are available at /.ldk/logs"); + println!("LDK startup successful. To view available commands: \"help\"."); + println!("LDK logs are available at /.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 _ = event_notifier.try_send(()); let line = line.unwrap(); let mut words = line.split_whitespace(); if let Some(word) = words.next() { @@ -143,13 +188,9 @@ pub(crate) async fn poll_for_user_input( continue; } - if connect_peer_if_necessary( - pubkey, - peer_addr, - peer_manager.clone(), - event_notifier.clone(), - ) - .is_err() + if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone()) + .await + .is_err() { print!("> "); io::stdout().flush().unwrap(); @@ -201,11 +242,7 @@ pub(crate) async fn poll_for_user_input( continue; } }; - let mut route_hints = invoice.routes().clone(); - let mut last_hops = Vec::new(); - for hint in route_hints.drain(..) { - last_hops.push(hint[hint.len() - 1].clone()); - } + let last_hops = invoice.route_hints(); let amt_pico_btc = invoice.amount_pico_btc(); if amt_pico_btc.is_none() { @@ -218,23 +255,9 @@ pub(crate) async fn poll_for_user_input( let payee_pubkey = invoice.recover_payee_pub_key(); let final_cltv = invoice.min_final_cltv_expiry() as u32; - - let mut payment_hash = PaymentHash([0; 32]); - payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]); - - let payment_secret = match invoice.payment_secret() { - Some(secret) => { - let mut payment_secret = PaymentSecret([0; 32]); - payment_secret.0.copy_from_slice(&secret.0); - Some(payment_secret) - } - None => None, - }; - - let invoice_features = match invoice.features() { - Some(feat) => Some(feat.clone()), - None => None, - }; + 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, @@ -250,6 +273,52 @@ pub(crate) async fn poll_for_user_input( logger.clone(), ); } + "keysend" => { + let dest_pubkey = match words.next() { + Some(dest) => match hex_utils::to_compressed_pubkey(dest) { + 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 `"); + print!("> "); + io::stdout().flush().unwrap(); + continue; + } + }; + let amt_msat_str = match words.next() { + Some(amt) => amt, + None => { + println!("ERROR: keysend requires an amount in millisatoshis: `keysend `"); + + print!("> "); + io::stdout().flush().unwrap(); + continue; + } + }; + let amt_msat: u64 = match amt_msat_str.parse() { + Ok(amt) => amt, + Err(e) => { + println!("ERROR: couldn't parse amount_msat: {}", e); + print!("> "); + io::stdout().flush().unwrap(); + continue; + } + }; + keysend( + dest_pubkey, + amt_msat, + router.clone(), + channel_manager.clone(), + outbound_payments.clone(), + logger.clone(), + ); + } "getinvoice" => { let amt_str = words.next(); if amt_str.is_none() { @@ -292,13 +361,9 @@ pub(crate) async fn poll_for_user_input( continue; } }; - if connect_peer_if_necessary( - pubkey, - peer_addr, - peer_manager.clone(), - event_notifier.clone(), - ) - .is_ok() + if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone()) + .await + .is_ok() { println!("SUCCESS: connected to peer {}", pubkey); } @@ -347,6 +412,24 @@ 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; + 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() + ) + ); + print!("> "); + io::stdout().flush().unwrap(); + } _ => println!("Unknown command. See `\"help\" for available commands."), } } @@ -356,14 +439,17 @@ pub(crate) async fn poll_for_user_input( } fn help() { - println!("openchannel pubkey@host:port "); + println!("openchannel pubkey@host:port "); println!("sendpayment "); - println!("getinvoice "); + println!("getinvoice "); println!("connectpeer pubkey@host:port"); println!("listchannels"); println!("listpayments"); println!("closechannel "); println!("forceclosechannel "); + println!("nodeinfo"); + println!("listpeers"); + println!("signmessage "); } fn node_info(channel_manager: Arc, peer_manager: Arc) { @@ -389,20 +475,29 @@ fn list_channels(channel_manager: Arc) { println!(""); println!("\t{{"); println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..])); + 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.remote_network_id.serialize()) + hex_utils::hex_str(&chan_info.counterparty.node_id.serialize()) ); - let mut pending_channel = false; - match chan_info.short_channel_id { - Some(id) => println!("\t\tshort_channel_id: {},", id), - None => { - pending_channel = true; - } + if let Some(id) = chan_info.short_channel_id { + println!("\t\tshort_channel_id: {},", id); } - println!("\t\tpending_open: {},", pending_channel); + println!("\t\tis_confirmed_onchain: {},", chan_info.is_funding_locked); println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis); - println!("\t\tchannel_can_send_payments: {},", chan_info.is_live); + println!( + "\t\tlocal_balance_msat: {},", + chan_info.outbound_capacity_msat + + chan_info.unspendable_punishment_reserve.unwrap_or(0) * 1000 + ); + 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); + } + println!("\t\tchannel_can_send_payments: {},", chan_info.is_usable); + println!("\t\tpublic: {},", chan_info.is_public); println!("\t}},"); } println!("]"); @@ -450,33 +545,35 @@ fn list_payments(inbound_payments: PaymentInfoStorage, outbound_payments: Paymen println!("]"); } -pub(crate) fn connect_peer_if_necessary( +pub(crate) async fn connect_peer_if_necessary( pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc, - event_notifier: mpsc::Sender<()>, ) -> Result<(), ()> { for node_pubkey in peer_manager.get_peer_node_ids() { if node_pubkey == pubkey { return Ok(()); } } - match TcpStream::connect_timeout(&peer_addr, Duration::from_secs(10)) { - Ok(stream) => { - let peer_mgr = peer_manager.clone(); - let event_ntfns = event_notifier.clone(); - tokio::spawn(async move { - lightning_net_tokio::setup_outbound(peer_mgr, event_ntfns, pubkey, stream).await; - }); - let mut peer_connected = false; - while !peer_connected { - for node_pubkey in peer_manager.get_peer_node_ids() { - if node_pubkey == pubkey { - peer_connected = true; + match lightning_net_tokio::connect_outbound(Arc::clone(&peer_manager), pubkey, peer_addr).await + { + Some(connection_closed_future) => { + let mut connection_closed_future = Box::pin(connection_closed_future); + 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, + None => tokio::time::sleep(Duration::from_millis(10)).await, } } } - Err(e) => { - println!("ERROR: failed to connect to peer: {:?}", e); + None => { + println!("ERROR: failed to connect to peer"); return Err(()); } } @@ -484,16 +581,20 @@ pub(crate) fn connect_peer_if_necessary( } fn open_channel( - peer_pubkey: PublicKey, channel_amt_sat: u64, announce_channel: bool, + peer_pubkey: PublicKey, channel_amt_sat: u64, announced_channel: bool, channel_manager: Arc, ) -> Result<(), ()> { - let mut config = UserConfig::default(); - if announce_channel { - config.channel_options.announced_channel = true; - } - // lnd's max to_self_delay is 2016, so we want to be compatible. - config.peer_channel_config_limits.their_to_self_delay = 2016; - match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, None) { + let config = UserConfig { + peer_channel_config_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() }, + ..Default::default() + }; + + match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, Some(config)) { Ok(_) => { println!("EVENT: initiated channel with peer {}. ", peer_pubkey); return Ok(()); @@ -508,12 +609,12 @@ fn open_channel( fn send_payment( payee: PublicKey, amt_msat: u64, final_cltv: u32, payment_hash: PaymentHash, payment_secret: Option, payee_features: Option, - route_hints: Vec, + route_hints: Vec<&RouteHint>, router: Arc, Arc>>, channel_manager: Arc, payment_storage: PaymentInfoStorage, logger: Arc, ) { - let network_graph = router.network_graph.read().unwrap(); + let network_graph = &router.network_graph; let first_hops = channel_manager.list_usable_channels(); let payer_pubkey = channel_manager.get_our_node_id(); @@ -523,10 +624,11 @@ fn send_payment( &payee, payee_features, Some(&first_hops.iter().collect::>()), - &route_hints.iter().collect::>(), + &route_hints, amt_msat, final_cltv, logger, + &Scorer::default(), ); if let Err(e) = route { println!("ERROR: failed to find route: {}", e.err); @@ -534,7 +636,7 @@ fn send_payment( } let status = match channel_manager.send_payment(&route.unwrap(), payment_hash, &payment_secret) { - Ok(()) => { + Ok(_payment_id) => { println!("EVENT: initiated sending {} msats to {}", amt_msat, payee); HTLCStatus::Pending } @@ -555,6 +657,47 @@ fn send_payment( ); } +fn keysend( + payee: PublicKey, amt_msat: u64, + router: Arc, Arc>>, + channel_manager: Arc, payment_storage: PaymentInfoStorage, + logger: Arc, +) { + let network_graph = &router.network_graph; + let first_hops = channel_manager.list_usable_channels(); + let payer_pubkey = channel_manager.get_our_node_id(); + + let route = match router::get_keysend_route( + &payer_pubkey, + &network_graph, + &payee, + Some(&first_hops.iter().collect::>()), + &vec![], + amt_msat, + 40, + logger, + &Scorer::default(), + ) { + Ok(r) => r, + Err(e) => { + println!("ERROR: failed to find route: {}", e.err); + return; + } + }; + + let mut payments = payment_storage.lock().unwrap(); + let payment_hash = channel_manager.send_spontaneous_payment(&route, None).unwrap().0; + payments.insert( + payment_hash, + PaymentInfo { + preimage: None, + secret: None, + status: HTLCStatus::Pending, + amt_msat: MillisatAmount(Some(amt_msat)), + }, + ); +} + fn get_invoice( amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: Arc, keys_manager: Arc, network: Network, @@ -583,16 +726,12 @@ fn get_invoice( } }; - let mut payment_hash = PaymentHash([0; 32]); - payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]); + let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner()); payments.insert( payment_hash, PaymentInfo { preimage: None, - // We can't add payment secrets to invoices until we support features in invoices. - // Otherwise lnd errors with "destination hop doesn't understand payment addresses" - // (for context, lnd calls payment secrets "payment addresses"). - secret: Some(invoice.payment_secret().unwrap().clone()), + secret: Some(invoice.payment_secret().clone()), status: HTLCStatus::Pending, amt_msat: MillisatAmount(Some(amt_msat)), }, @@ -622,13 +761,12 @@ pub(crate) fn parse_peer_info( if peer_addr_str.is_none() || 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`", + "ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`", )); } - let peer_addr: Result = peer_addr_str.unwrap().parse(); - if peer_addr.is_err() { + let peer_addr = peer_addr_str.unwrap().to_socket_addrs().map(|mut r| r.next()); + if peer_addr.is_err() || peer_addr.as_ref().unwrap().is_none() { return Err(std::io::Error::new( std::io::ErrorKind::Other, "ERROR: couldn't parse pubkey@host:port into a socket address", @@ -643,5 +781,5 @@ pub(crate) fn parse_peer_info( )); } - Ok((pubkey.unwrap(), peer_addr.unwrap())) + Ok((pubkey.unwrap(), peer_addr.unwrap().unwrap())) }