X-Git-Url: http://git.bitcoin.ninja/index.cgi?p=ldk-sample;a=blobdiff_plain;f=src%2Fcli.rs;h=20c43147a6369634f83c0c00a22d181eb6561c35;hp=c046d0cf6fe4771d0e7427b3c25c236a6ee112e5;hb=224d32a53718a00f01456711d2ee524e59c5ff46;hpb=1b034d63a4cb4e0b249ae6240166513b6be76737 diff --git a/src/cli.rs b/src/cli.rs index c046d0c..20c4314 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -1,65 +1,274 @@ -use bitcoin::secp256k1::key::PublicKey; -use crate::{FilesystemLogger, PeerManager, ChannelManager}; -use crate::utils; +use bitcoin::network::constants::Network; +use bitcoin::hashes::Hash; +use bitcoin::hashes::sha256::Hash as Sha256Hash; +use bitcoin::secp256k1::Secp256k1; +use bitcoin::secp256k1::key::{PublicKey, SecretKey}; +use crate::{ChannelManager, FilesystemLogger, HTLCDirection, HTLCStatus, NETWORK, + PaymentInfoStorage, PeerManager}; +use crate::disk; +use crate::hex_utils; +use lightning::chain; +use lightning::ln::channelmanager::{PaymentHash, PaymentPreimage, PaymentSecret}; +use lightning::ln::features::InvoiceFeatures; +use lightning::routing::network_graph::NetGraphMsgHandler; +use lightning::routing::router; +use lightning::util::config::UserConfig; +use rand; +use rand::Rng; +use std::env; use std::io; use std::io::{BufRead, Write}; use std::net::{SocketAddr, TcpStream}; +use std::ops::Deref; +use std::path::Path; +use std::str::FromStr; use std::sync::Arc; -use std::thread; use std::time::Duration; -// use tokio::runtime::Runtime; -use tokio::runtime::{Builder, Runtime}; +use tokio::runtime::Handle; use tokio::sync::mpsc; -pub fn poll_for_user_input(peer_manager: Arc, channel_manager: Arc, event_notifier: mpsc::Sender<()>) { - println!("LDK startup successful. To view available commands: \"help\".\nLDK logs are available in the `logs` folder of the current directory."); - print!("> "); io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print +pub(crate) struct LdkUserInfo { + pub(crate) bitcoind_rpc_username: String, + pub(crate) bitcoind_rpc_password: String, + pub(crate) bitcoind_rpc_port: u16, + pub(crate) bitcoind_rpc_host: String, + pub(crate) ldk_storage_dir_path: String, + pub(crate) ldk_peer_listening_port: u16, +} + +pub(crate) fn parse_startup_args() -> Result { + if env::args().len() < 4 { + println!("ldk-tutorial-node requires 3 arguments: `cargo run :@: ldk_storage_directory_path [optional: ]`"); + return Err(()) + } + let bitcoind_rpc_info = env::args().skip(1).next().unwrap(); + let bitcoind_rpc_info_parts: Vec<&str> = bitcoind_rpc_info.split("@").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[0].split(":").collect(); + if rpc_user_and_password.len() != 2 { + println!("ERROR: bad bitcoind RPC username/password combo provided"); + return Err(()) + } + 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[1].split(":").collect(); + if bitcoind_rpc_path.len() != 2 { + println!("ERROR: bad bitcoind RPC path provided"); + return Err(()) + } + let bitcoind_rpc_host = bitcoind_rpc_path[0].to_string(); + let bitcoind_rpc_port = bitcoind_rpc_path[1].parse::().unwrap(); + + let ldk_storage_dir_path = env::args().skip(2).next().unwrap(); + + 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), + None => 9735, + }; + Ok(LdkUserInfo { + bitcoind_rpc_username, + bitcoind_rpc_password, + bitcoind_rpc_host, + bitcoind_rpc_port, + ldk_storage_dir_path, + ldk_peer_listening_port, + }) +} + +pub(crate) fn poll_for_user_input(peer_manager: Arc, channel_manager: + Arc, router: Arc, Arc>>, payment_storage: + PaymentInfoStorage, node_privkey: SecretKey, event_notifier: + mpsc::Sender<()>, ldk_data_dir: String, logger: Arc, + runtime_handle: Handle) { + println!("LDK startup successful. To view available commands: \"help\".\nLDK logs are available in the `logs` folder of /.ldk/logs"); 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() { match word { - "help" => handle_help(), + "help" => help(), "openchannel" => { let peer_pubkey_and_ip_addr = words.next(); let channel_value_sat = words.next(); if peer_pubkey_and_ip_addr.is_none() || channel_value_sat.is_none() { - println!("ERROR: openchannel takes 2 arguments: `openchannel pubkey@host:port channel_amt_satoshis`") - } else { - let peer_pubkey_and_ip_addr = peer_pubkey_and_ip_addr.unwrap(); - let channel_value_sat = channel_value_sat.unwrap(); - 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() { - println!("ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`"); - } else { - let pubkey = pubkey.unwrap(); - let peer_addr_str = peer_addr_str.unwrap(); - let peer_addr_res: Result = peer_addr_str.parse(); - let chan_amt: Result = channel_value_sat.parse(); - if let Some(pk) = utils::hex_to_compressed_pubkey(pubkey) { - if let Ok(addr) = peer_addr_res { - if let Ok(amt) = chan_amt { - handle_open_channel(pk, addr, amt, - peer_manager.clone(), - channel_manager.clone(), - event_notifier.clone()); - } else { - println!("ERROR: channel amount must be a number"); + println!("ERROR: openchannel takes 2 arguments: `openchannel pubkey@host:port channel_amt_satoshis`"); + print!("> "); io::stdout().flush().unwrap(); continue; + } + let peer_pubkey_and_ip_addr = peer_pubkey_and_ip_addr.unwrap(); + let (pubkey, peer_addr) = match parse_peer_info(peer_pubkey_and_ip_addr.to_string()) { + Ok(info) => info, + Err(e) => { + println!("{:?}", e.into_inner().unwrap()); + print!("> "); io::stdout().flush().unwrap(); continue; + } + }; + + let chan_amt_sat: Result = 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; + } + + if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone(), + event_notifier.clone(), + runtime_handle.clone()).is_err() { + print!("> "); io::stdout().flush().unwrap(); continue; + }; + + if open_channel(pubkey, chan_amt_sat.unwrap(), channel_manager.clone()).is_ok() { + let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone()); + let _ = disk::persist_channel_peer(Path::new(&peer_data_path), peer_pubkey_and_ip_addr); + } + }, + "sendpayment" => { + let invoice_str = words.next(); + if invoice_str.is_none() { + println!("ERROR: sendpayment requires an invoice: `sendpayment `"); + print!("> "); io::stdout().flush().unwrap(); continue; + } + + let invoice_res = lightning_invoice::Invoice::from_str(invoice_str.unwrap()); + if invoice_res.is_err() { + println!("ERROR: invalid invoice: {:?}", invoice_res.unwrap_err()); + print!("> "); io::stdout().flush().unwrap(); continue; + } + let invoice = invoice_res.unwrap(); + + let amt_pico_btc = invoice.amount_pico_btc(); + if amt_pico_btc.is_none () { + println!("ERROR: invalid invoice: must contain amount to pay"); + print!("> "); io::stdout().flush().unwrap(); continue; + } + let amt_msat = amt_pico_btc.unwrap() / 10; + + let payee_pubkey = invoice.recover_payee_pub_key(); + let final_cltv = *invoice.min_final_cltv_expiry().unwrap_or(&9) 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 mut invoice_features = InvoiceFeatures::empty(); + for field in &invoice.into_signed_raw().raw_invoice().data.tagged_fields { + match field { + lightning_invoice::RawTaggedField::UnknownSemantics(vec) => { + if vec[0] == bech32::u5::try_from_u8(5).unwrap() { + if vec.len() >= 6 && vec[5].to_u8() & 0b10000 != 0 { + invoice_features.set_supports_var_onion_optin(); + } + if vec.len() >= 6 && vec[5].to_u8() & 0b01000 != 0 { + invoice_features.set_requires_var_onion_optin(); + } + if vec.len() >= 4 && vec[3].to_u8() & 0b00001 != 0 { + invoice_features.set_supports_payment_secret(); + } + if vec.len() >= 5 && vec[4].to_u8() & 0b10000 != 0 { + invoice_features.set_requires_payment_secret(); + } + if vec.len() >= 4 && vec[3].to_u8() & 0b00100 != 0 { + invoice_features.set_supports_basic_mpp(); + } + if vec.len() >= 4 && vec[3].to_u8() & 0b00010 != 0 { + invoice_features.set_requires_basic_mpp(); } - } else { - println!("ERROR: couldn't parse - pubkey@host:port into a socket address"); } - } else { - println!("ERROR: unable to parse given pubkey for node"); - } + }, + _ => {} } } + let invoice_features_opt = match invoice_features == InvoiceFeatures::empty() { + true => None, + false => Some(invoice_features) + }; + send_payment(payee_pubkey, amt_msat, final_cltv, payment_hash, + payment_secret, invoice_features_opt, router.clone(), + channel_manager.clone(), payment_storage.clone(), + logger.clone()); }, - _ => println!("hello") + "getinvoice" => { + let amt_str = words.next(); + if amt_str.is_none() { + println!("ERROR: getinvoice requires an amount in satoshis"); + print!("> "); io::stdout().flush().unwrap(); continue; + } + + let amt_sat: Result = amt_str.unwrap().parse(); + if amt_sat.is_err() { + println!("ERROR: getinvoice provided payment amount was not a number"); + print!("> "); io::stdout().flush().unwrap(); continue; + } + get_invoice(amt_sat.unwrap(), payment_storage.clone(), node_privkey.clone(), + channel_manager.clone(), router.clone()); + }, + "connectpeer" => { + 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) = match parse_peer_info(peer_pubkey_and_ip_addr.unwrap().to_string()) { + Ok(info) => info, + Err(e) => { + println!("{:?}", e.into_inner().unwrap()); + print!("> "); io::stdout().flush().unwrap(); continue; + } + }; + if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone(), + event_notifier.clone(), runtime_handle.clone()).is_ok() { + println!("SUCCESS: connected to peer {}", pubkey); + } + + }, + "listchannels" => list_channels(channel_manager.clone()), + "listpayments" => list_payments(payment_storage.clone()), + "closechannel" => { + let channel_id_str = words.next(); + if channel_id_str.is_none() { + println!("ERROR: closechannel requires a channel ID: `closechannel `"); + 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]; + channel_id.copy_from_slice(&channel_id_vec.unwrap()); + close_channel(channel_id, channel_manager.clone()); + }, + "forceclosechannel" => { + let channel_id_str = words.next(); + if channel_id_str.is_none() { + println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel `"); + 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]; + channel_id.copy_from_slice(&channel_id_vec.unwrap()); + force_close_channel(channel_id, channel_manager.clone()); + } + _ => println!("Unknown command. See `\"help\" for available commands.") } } print!("> "); io::stdout().flush().unwrap(); @@ -67,34 +276,244 @@ pub fn poll_for_user_input(peer_manager: Arc, channel_manager: Arc< } } -fn handle_help() { - println!("") +fn help() { + println!("openchannel pubkey@host:port channel_amt_satoshis"); + println!("sendpayment "); + println!("getinvoice "); + println!("connectpeer pubkey@host:port"); + println!("listchannels"); + println!("listpayments"); + println!("closechannel "); + println!("forceclosechannel "); } -fn handle_open_channel(peer_pubkey: PublicKey, peer_socket: SocketAddr, - channel_amt_sat: u64, peer_manager: Arc, - channel_manager: Arc, event_notifier: - mpsc::Sender<()>) -{ - // let runtime = Runtime::new().expect("Unable to create a runtime").enable_all(); - let runtime = Builder::new_multi_thread() - .worker_threads(3) - .enable_all() - .build() - .unwrap(); - match TcpStream::connect_timeout(&peer_socket, Duration::from_secs(10)) { +fn list_channels(channel_manager: Arc) { + print!("["); + for chan_info in channel_manager.list_channels() { + println!(""); + println!("\t{{"); + println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..])); + println!("\t\tpeer_pubkey: {},", hex_utils::hex_str(&chan_info.remote_network_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; + } + } + println!("\t\tpending_open: {},", pending_channel); + println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis); + println!("\t\tchannel_can_send_payments: {},", chan_info.is_live); + println!("\t}},"); + } + println!("]"); +} + +fn list_payments(payment_storage: PaymentInfoStorage) { + let payments = payment_storage.lock().unwrap(); + print!("["); + for (payment_hash, payment_info) in payments.deref() { + println!(""); + println!("\t{{"); + println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0)); + println!("\t\thtlc_direction: {},", if payment_info.1 == HTLCDirection::Inbound { "inbound" } else { "outbound" }); + println!("\t\thtlc_status: {},", match payment_info.2 { + HTLCStatus::Pending => "pending", + HTLCStatus::Succeeded => "succeeded", + HTLCStatus::Failed => "failed" + }); + + + println!("\t}},"); + } + println!("]"); +} + +pub(crate) fn connect_peer_if_necessary(pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: + Arc, event_notifier: mpsc::Sender<()>, runtime: Handle) -> + 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) => { - runtime.block_on(|| { - lightning_net_tokio::setup_outbound(peer_manager, - event_notifier, - peer_pubkey, - stream); + let peer_mgr = peer_manager.clone(); + let event_ntfns = event_notifier.clone(); + runtime.spawn(async move { + lightning_net_tokio::setup_outbound(peer_mgr, event_ntfns, pubkey, stream).await; }); - match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, None) { - Ok(_) => println!("SUCCESS: channel created! Mine some blocks to open it."), - Err(e) => println!("ERROR: failed to open channel: {:?}", e) + 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; } + } } }, - Err(e) => println!("ERROR: failed to connect to peer: {:?}", e) + Err(e) => {println!("ERROR: failed to connect to peer: {:?}", e); + return Err(()) + } + } + Ok(()) +} + +fn open_channel(peer_pubkey: PublicKey, channel_amt_sat: u64, channel_manager: Arc) + -> Result<(), ()> { + let mut config = UserConfig::default(); + // 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) { + Ok(_) => { + println!("EVENT: initiated channel with peer {}. ", peer_pubkey); + return Ok(()) + }, + Err(e) => { + println!("ERROR: failed to open channel: {:?}", e); + return Err(()) + } + } +} + +fn send_payment(payee: PublicKey, amt_msat: u64, final_cltv: u32, payment_hash: PaymentHash, + payment_secret: Option, payee_features: + Option, router: Arc, Arc>>, channel_manager: + Arc, payment_storage: PaymentInfoStorage, logger: + Arc) { + let network_graph = router.network_graph.read().unwrap(); + let first_hops = channel_manager.list_usable_channels(); + let payer_pubkey = channel_manager.get_our_node_id(); + + let route = router::get_route(&payer_pubkey, &network_graph, &payee, payee_features, + Some(&first_hops.iter().collect::>()), &vec![], amt_msat, + final_cltv, logger); + 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) { + Ok(()) => { + println!("EVENT: initiated sending {} msats to {}", amt_msat, payee); + HTLCStatus::Pending + }, + Err(e) => { + println!("ERROR: failed to send payment: {:?}", e); + HTLCStatus::Failed + } + }; + let mut payments = payment_storage.lock().unwrap(); + payments.insert(payment_hash, (None, HTLCDirection::Outbound, status)); +} + +fn get_invoice(amt_sat: u64, payment_storage: PaymentInfoStorage, our_node_privkey: SecretKey, + channel_manager: Arc, router: Arc, Arc>>) { + let mut payments = payment_storage.lock().unwrap(); + let secp_ctx = Secp256k1::new(); + + let mut preimage = [0; 32]; + rand::thread_rng().fill_bytes(&mut preimage); + let payment_hash = Sha256Hash::hash(&preimage); + + + let our_node_pubkey = channel_manager.get_our_node_id(); + let invoice = lightning_invoice::InvoiceBuilder::new(match NETWORK { + Network::Bitcoin => lightning_invoice::Currency::Bitcoin, + Network::Testnet => lightning_invoice::Currency::BitcoinTestnet, + Network::Regtest => lightning_invoice::Currency::Regtest, + Network::Signet => panic!("Signet invoices not supported") + }).payment_hash(payment_hash).description("rust-lightning-bitcoinrpc invoice".to_string()) + .amount_pico_btc(amt_sat * 10) + .current_timestamp() + .payee_pub_key(our_node_pubkey); + + // Add route hints to the invoice. + // let our_channels = channel_manager.list_usable_channels(); + // let network_graph = router.network_graph.read().unwrap(); + // let network_channels = network_graph.get_channels(); + // for channel in our_channels { + // let short_channel_id_opt = channel.short_channel_id; + // if short_channel_id_opt.is_none() { + // continue + // } + + // let short_channel_id = short_channel_id_opt.unwrap(); + // let channel_routing_info_opt = network_channels.get(&short_channel_id); + // if channel_routing_info_opt.is_none() { + // continue + // } + + // let channel_routing_info = channel_routing_info_opt.unwrap(); + // let mut counterparty = channel_routing_info.node_two; + // let mut counterparty_chan_fees_opt = channel_routing_info.one_to_two.as_ref(); + // if channel_routing_info.node_two != our_node_pubkey { // e.g. if our counterparty is node_one + // counterparty = channel_routing_info.node_one; + // counterparty_chan_fees_opt = channel_routing_info.two_to_one.as_ref(); + // } + // if counterparty_chan_fees_opt.is_none() { + // continue + // } + + // let counterparty_chan_fees = counterparty_chan_fees_opt.unwrap(); + // invoice = invoice.route(vec![ + // lightning_invoice::RouteHop { + // short_channel_id: short_channel_id.to_be_bytes(), + // cltv_expiry_delta: counterparty_chan_fees.cltv_expiry_delta, + // fee_base_msat: counterparty_chan_fees.fees.base_msat, + // fee_proportional_millionths: counterparty_chan_fees.fees.proportional_millionths, + // pubkey: counterparty, + // } + // ]); + // } + + // Sign the invoice. + let invoice = invoice.build_signed(|msg_hash| { + secp_ctx.sign_recoverable(msg_hash, &our_node_privkey) + }); + + match invoice { + Ok(invoice) => println!("SUCCESS: generated invoice: {}", invoice), + Err(e) => println!("ERROR: failed to create invoice: {:?}", e), + } + + payments.insert(PaymentHash(payment_hash.into_inner()), (Some(PaymentPreimage(preimage)), + HTLCDirection::Inbound, + HTLCStatus::Pending)); +} + +fn close_channel(channel_id: [u8; 32], channel_manager: Arc) { + match channel_manager.close_channel(&channel_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) { + match channel_manager.force_close_channel(&channel_id) { + Ok(()) => println!("EVENT: initiating channel force-close"), + Err(e) => println!("ERROR: failed to force-close channel: {:?}", e) + } +} + +pub(crate) fn parse_peer_info(peer_pubkey_and_ip_addr: String) -> Result<(PublicKey, SocketAddr), std::io::Error> { + 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() { + return Err(std::io::Error::new(std::io::ErrorKind::Other, "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() { + return Err(std::io::Error::new(std::io::ErrorKind::Other, "ERROR: couldn't parse pubkey@host:port into a socket address")); } + + let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap()); + if pubkey.is_none() { + return Err(std::io::Error::new(std::io::ErrorKind::Other, "ERROR: unable to parse given pubkey for node")); + } + + Ok((pubkey.unwrap(), peer_addr.unwrap())) }