4 ChannelManager, FilesystemLogger, HTLCStatus, MillisatAmount, PaymentInfo, PaymentInfoStorage,
7 use bitcoin::network::constants::Network;
8 use bitcoin::secp256k1::key::PublicKey;
10 use lightning::chain::keysinterface::KeysManager;
11 use lightning::ln::features::InvoiceFeatures;
12 use lightning::ln::msgs::NetAddress;
13 use lightning::ln::{PaymentHash, PaymentSecret};
14 use lightning::routing::network_graph::NetGraphMsgHandler;
15 use lightning::routing::router;
16 use lightning::routing::router::RouteHint;
17 use lightning::util::config::UserConfig;
18 use lightning_invoice::{utils, Currency, Invoice};
21 use std::io::{BufRead, Write};
22 use std::net::{IpAddr, SocketAddr, ToSocketAddrs};
25 use std::str::FromStr;
27 use std::time::Duration;
29 pub(crate) struct LdkUserInfo {
30 pub(crate) bitcoind_rpc_username: String,
31 pub(crate) bitcoind_rpc_password: String,
32 pub(crate) bitcoind_rpc_port: u16,
33 pub(crate) bitcoind_rpc_host: String,
34 pub(crate) ldk_storage_dir_path: String,
35 pub(crate) ldk_peer_listening_port: u16,
36 pub(crate) ldk_announced_listen_addr: Option<NetAddress>,
37 pub(crate) ldk_announced_node_name: [u8; 32],
38 pub(crate) network: Network,
41 pub(crate) fn parse_startup_args() -> Result<LdkUserInfo, ()> {
42 if env::args().len() < 3 {
43 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-listen-addr announced-node-name]`");
46 let bitcoind_rpc_info = env::args().skip(1).next().unwrap();
47 let bitcoind_rpc_info_parts: Vec<&str> = bitcoind_rpc_info.split("@").collect();
48 if bitcoind_rpc_info_parts.len() != 2 {
49 println!("ERROR: bad bitcoind RPC URL provided");
52 let rpc_user_and_password: Vec<&str> = bitcoind_rpc_info_parts[0].split(":").collect();
53 if rpc_user_and_password.len() != 2 {
54 println!("ERROR: bad bitcoind RPC username/password combo provided");
57 let bitcoind_rpc_username = rpc_user_and_password[0].to_string();
58 let bitcoind_rpc_password = rpc_user_and_password[1].to_string();
59 let bitcoind_rpc_path: Vec<&str> = bitcoind_rpc_info_parts[1].split(":").collect();
60 if bitcoind_rpc_path.len() != 2 {
61 println!("ERROR: bad bitcoind RPC path provided");
64 let bitcoind_rpc_host = bitcoind_rpc_path[0].to_string();
65 let bitcoind_rpc_port = bitcoind_rpc_path[1].parse::<u16>().unwrap();
67 let ldk_storage_dir_path = env::args().skip(2).next().unwrap();
69 let mut ldk_peer_port_set = true;
70 let ldk_peer_listening_port: u16 = match env::args().skip(3).next().map(|p| p.parse()) {
72 Some(Err(e)) => panic!("{}", e),
74 ldk_peer_port_set = false;
79 let arg_idx = match ldk_peer_port_set {
83 let network: Network = match env::args().skip(arg_idx).next().as_ref().map(String::as_str) {
84 Some("testnet") => Network::Testnet,
85 Some("regtest") => Network::Regtest,
86 Some(_) => panic!("Unsupported network provided. Options are: `regtest`, `testnet`"),
87 None => Network::Testnet,
90 let ldk_announced_listen_addr = match env::args().skip(arg_idx + 1).next().as_ref() {
91 Some(s) => match IpAddr::from_str(s) {
92 Ok(IpAddr::V4(a)) => {
93 Some(NetAddress::IPv4 { addr: a.octets(), port: ldk_peer_listening_port })
95 Ok(IpAddr::V6(a)) => {
96 Some(NetAddress::IPv6 { addr: a.octets(), port: ldk_peer_listening_port })
98 Err(_) => panic!("Failed to parse announced-listen-addr into an IP address"),
103 let ldk_announced_node_name = match env::args().skip(arg_idx + 2).next().as_ref() {
106 panic!("Node Alias can not be longer than 32 bytes");
108 let mut bytes = [0; 32];
109 bytes[..s.len()].copy_from_slice(s.as_bytes());
116 bitcoind_rpc_username,
117 bitcoind_rpc_password,
120 ldk_storage_dir_path,
121 ldk_peer_listening_port,
122 ldk_announced_listen_addr,
123 ldk_announced_node_name,
128 pub(crate) async fn poll_for_user_input(
129 peer_manager: Arc<PeerManager>, channel_manager: Arc<ChannelManager>,
130 keys_manager: Arc<KeysManager>,
131 router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access + Send + Sync>, Arc<FilesystemLogger>>>,
132 inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage,
133 ldk_data_dir: String, logger: Arc<FilesystemLogger>, network: Network,
135 println!("LDK startup successful. To view available commands: \"help\".");
136 println!("LDK logs are available at <your-supplied-ldk-data-dir-path>/.ldk/logs");
137 println!("Local Node ID is {}.", channel_manager.get_our_node_id());
138 let stdin = io::stdin();
140 io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
141 for line in stdin.lock().lines() {
142 let line = line.unwrap();
143 let mut words = line.split_whitespace();
144 if let Some(word) = words.next() {
148 let peer_pubkey_and_ip_addr = words.next();
149 let channel_value_sat = words.next();
150 if peer_pubkey_and_ip_addr.is_none() || channel_value_sat.is_none() {
151 println!("ERROR: openchannel has 2 required arguments: `openchannel pubkey@host:port channel_amt_satoshis` [--public]");
153 io::stdout().flush().unwrap();
156 let peer_pubkey_and_ip_addr = peer_pubkey_and_ip_addr.unwrap();
157 let (pubkey, peer_addr) =
158 match parse_peer_info(peer_pubkey_and_ip_addr.to_string()) {
161 println!("{:?}", e.into_inner().unwrap());
163 io::stdout().flush().unwrap();
168 let chan_amt_sat: Result<u64, _> = channel_value_sat.unwrap().parse();
169 if chan_amt_sat.is_err() {
170 println!("ERROR: channel amount must be a number");
172 io::stdout().flush().unwrap();
176 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
181 io::stdout().flush().unwrap();
185 let announce_channel = match words.next() {
186 Some("--public") | Some("--public=true") => true,
187 Some("--public=false") => false,
189 println!("ERROR: invalid `--public` command format. Valid formats: `--public`, `--public=true` `--public=false`");
191 io::stdout().flush().unwrap();
199 chan_amt_sat.unwrap(),
201 channel_manager.clone(),
205 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
206 let _ = disk::persist_channel_peer(
207 Path::new(&peer_data_path),
208 peer_pubkey_and_ip_addr,
213 let invoice_str = words.next();
214 if invoice_str.is_none() {
215 println!("ERROR: sendpayment requires an invoice: `sendpayment <invoice>`");
217 io::stdout().flush().unwrap();
221 let invoice = match Invoice::from_str(invoice_str.unwrap()) {
224 println!("ERROR: invalid invoice: {:?}", e);
226 io::stdout().flush().unwrap();
230 let last_hops = invoice.route_hints();
232 let amt_pico_btc = invoice.amount_pico_btc();
233 if amt_pico_btc.is_none() {
234 println!("ERROR: invalid invoice: must contain amount to pay");
236 io::stdout().flush().unwrap();
239 let amt_msat = amt_pico_btc.unwrap() / 10;
241 let payee_pubkey = invoice.recover_payee_pub_key();
242 let final_cltv = invoice.min_final_cltv_expiry() as u32;
244 let mut payment_hash = PaymentHash([0; 32]);
245 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
247 let payment_secret = match invoice.payment_secret() {
249 let mut payment_secret = PaymentSecret([0; 32]);
250 payment_secret.0.copy_from_slice(&secret.0);
256 let invoice_features = match invoice.features() {
257 Some(feat) => Some(feat.clone()),
270 channel_manager.clone(),
271 outbound_payments.clone(),
276 let amt_str = words.next();
277 if amt_str.is_none() {
278 println!("ERROR: getinvoice requires an amount in millisatoshis");
280 io::stdout().flush().unwrap();
284 let amt_msat: Result<u64, _> = amt_str.unwrap().parse();
285 if amt_msat.is_err() {
286 println!("ERROR: getinvoice provided payment amount was not a number");
288 io::stdout().flush().unwrap();
293 inbound_payments.clone(),
294 channel_manager.clone(),
295 keys_manager.clone(),
300 let peer_pubkey_and_ip_addr = words.next();
301 if peer_pubkey_and_ip_addr.is_none() {
302 println!("ERROR: connectpeer requires peer connection info: `connectpeer pubkey@host:port`");
304 io::stdout().flush().unwrap();
307 let (pubkey, peer_addr) =
308 match parse_peer_info(peer_pubkey_and_ip_addr.unwrap().to_string()) {
311 println!("{:?}", e.into_inner().unwrap());
313 io::stdout().flush().unwrap();
317 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
321 println!("SUCCESS: connected to peer {}", pubkey);
324 "listchannels" => list_channels(channel_manager.clone()),
326 list_payments(inbound_payments.clone(), outbound_payments.clone())
329 let channel_id_str = words.next();
330 if channel_id_str.is_none() {
331 println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id>`");
333 io::stdout().flush().unwrap();
336 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
337 if channel_id_vec.is_none() {
338 println!("ERROR: couldn't parse channel_id as hex");
340 io::stdout().flush().unwrap();
343 let mut channel_id = [0; 32];
344 channel_id.copy_from_slice(&channel_id_vec.unwrap());
345 close_channel(channel_id, channel_manager.clone());
347 "forceclosechannel" => {
348 let channel_id_str = words.next();
349 if channel_id_str.is_none() {
350 println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id>`");
352 io::stdout().flush().unwrap();
355 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
356 if channel_id_vec.is_none() {
357 println!("ERROR: couldn't parse channel_id as hex");
359 io::stdout().flush().unwrap();
362 let mut channel_id = [0; 32];
363 channel_id.copy_from_slice(&channel_id_vec.unwrap());
364 force_close_channel(channel_id, channel_manager.clone());
366 "nodeinfo" => node_info(channel_manager.clone(), peer_manager.clone()),
367 "listpeers" => list_peers(peer_manager.clone()),
368 _ => println!("Unknown command. See `\"help\" for available commands."),
372 io::stdout().flush().unwrap();
377 println!("openchannel pubkey@host:port <amt_satoshis>");
378 println!("sendpayment <invoice>");
379 println!("getinvoice <amt_millisatoshis>");
380 println!("connectpeer pubkey@host:port");
381 println!("listchannels");
382 println!("listpayments");
383 println!("closechannel <channel_id>");
384 println!("forceclosechannel <channel_id>");
385 println!("nodeinfo");
386 println!("listpeers");
389 fn node_info(channel_manager: Arc<ChannelManager>, peer_manager: Arc<PeerManager>) {
391 println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
392 println!("\t\t num_channels: {}", channel_manager.list_channels().len());
393 println!("\t\t num_usable_channels: {}", channel_manager.list_usable_channels().len());
394 println!("\t\t num_peers: {}", peer_manager.get_peer_node_ids().len());
398 fn list_peers(peer_manager: Arc<PeerManager>) {
400 for pubkey in peer_manager.get_peer_node_ids() {
401 println!("\t\t pubkey: {}", pubkey);
406 fn list_channels(channel_manager: Arc<ChannelManager>) {
408 for chan_info in channel_manager.list_channels() {
411 println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..]));
412 if let Some(funding_txo) = chan_info.funding_txo {
413 println!("\t\tfunding_txid: {},", funding_txo.txid);
416 "\t\tpeer_pubkey: {},",
417 hex_utils::hex_str(&chan_info.remote_network_id.serialize())
419 if let Some(id) = chan_info.short_channel_id {
420 println!("\t\tshort_channel_id: {},", id);
422 println!("\t\tis_confirmed_onchain: {},", chan_info.is_funding_locked);
423 println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
424 if chan_info.is_usable {
425 println!("\t\tavailable_balance_for_send_msat: {},", chan_info.outbound_capacity_msat);
426 println!("\t\tavailable_balance_for_recv_msat: {},", chan_info.inbound_capacity_msat);
428 println!("\t\tchannel_can_send_payments: {},", chan_info.is_usable);
429 println!("\t\tpublic: {},", chan_info.is_public);
435 fn list_payments(inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage) {
436 let inbound = inbound_payments.lock().unwrap();
437 let outbound = outbound_payments.lock().unwrap();
439 for (payment_hash, payment_info) in inbound.deref() {
442 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
443 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
444 println!("\t\thtlc_direction: inbound,");
446 "\t\thtlc_status: {},",
447 match payment_info.status {
448 HTLCStatus::Pending => "pending",
449 HTLCStatus::Succeeded => "succeeded",
450 HTLCStatus::Failed => "failed",
457 for (payment_hash, payment_info) in outbound.deref() {
460 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
461 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
462 println!("\t\thtlc_direction: outbound,");
464 "\t\thtlc_status: {},",
465 match payment_info.status {
466 HTLCStatus::Pending => "pending",
467 HTLCStatus::Succeeded => "succeeded",
468 HTLCStatus::Failed => "failed",
477 pub(crate) async fn connect_peer_if_necessary(
478 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
479 ) -> Result<(), ()> {
480 for node_pubkey in peer_manager.get_peer_node_ids() {
481 if node_pubkey == pubkey {
485 match lightning_net_tokio::connect_outbound(Arc::clone(&peer_manager), pubkey, peer_addr).await
487 Some(conn_closed_fut) => {
488 let mut closed_fut_box = Box::pin(conn_closed_fut);
489 let mut peer_connected = false;
490 while !peer_connected {
491 match futures::poll!(&mut closed_fut_box) {
492 std::task::Poll::Ready(_) => {
493 println!("ERROR: Peer disconnected before we finished the handshake");
496 std::task::Poll::Pending => {}
498 for node_pubkey in peer_manager.get_peer_node_ids() {
499 if node_pubkey == pubkey {
500 peer_connected = true;
503 // Avoid blocking the tokio context by sleeping a bit
504 tokio::time::sleep(Duration::from_millis(10)).await;
508 println!("ERROR: failed to connect to peer");
516 peer_pubkey: PublicKey, channel_amt_sat: u64, announce_channel: bool,
517 channel_manager: Arc<ChannelManager>,
518 ) -> Result<(), ()> {
519 let mut config = UserConfig::default();
520 if announce_channel {
521 config.channel_options.announced_channel = true;
523 // lnd's max to_self_delay is 2016, so we want to be compatible.
524 config.peer_channel_config_limits.their_to_self_delay = 2016;
525 match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, Some(config)) {
527 println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
531 println!("ERROR: failed to open channel: {:?}", e);
538 payee: PublicKey, amt_msat: u64, final_cltv: u32, payment_hash: PaymentHash,
539 payment_secret: Option<PaymentSecret>, payee_features: Option<InvoiceFeatures>,
540 route_hints: Vec<&RouteHint>,
541 router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access + Send + Sync>, Arc<FilesystemLogger>>>,
542 channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
543 logger: Arc<FilesystemLogger>,
545 let network_graph = router.network_graph.read().unwrap();
546 let first_hops = channel_manager.list_usable_channels();
547 let payer_pubkey = channel_manager.get_our_node_id();
549 let route = router::get_route(
554 Some(&first_hops.iter().collect::<Vec<_>>()),
560 if let Err(e) = route {
561 println!("ERROR: failed to find route: {}", e.err);
564 let status = match channel_manager.send_payment(&route.unwrap(), payment_hash, &payment_secret)
567 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee);
571 println!("ERROR: failed to send payment: {:?}", e);
575 let mut payments = payment_storage.lock().unwrap();
580 secret: payment_secret,
582 amt_msat: MillisatAmount(Some(amt_msat)),
588 amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: Arc<ChannelManager>,
589 keys_manager: Arc<KeysManager>, network: Network,
591 let mut payments = payment_storage.lock().unwrap();
592 let currency = match network {
593 Network::Bitcoin => Currency::Bitcoin,
594 Network::Testnet => Currency::BitcoinTestnet,
595 Network::Regtest => Currency::Regtest,
596 Network::Signet => panic!("Signet unsupported"),
598 let invoice = match utils::create_invoice_from_channelmanager(
603 "ldk-tutorial-node".to_string(),
606 println!("SUCCESS: generated invoice: {}", inv);
610 println!("ERROR: failed to create invoice: {:?}", e);
615 let mut payment_hash = PaymentHash([0; 32]);
616 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
621 // We can't add payment secrets to invoices until we support features in invoices.
622 // Otherwise lnd errors with "destination hop doesn't understand payment addresses"
623 // (for context, lnd calls payment secrets "payment addresses").
624 secret: Some(invoice.payment_secret().unwrap().clone()),
625 status: HTLCStatus::Pending,
626 amt_msat: MillisatAmount(Some(amt_msat)),
631 fn close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
632 match channel_manager.close_channel(&channel_id) {
633 Ok(()) => println!("EVENT: initiating channel close"),
634 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
638 fn force_close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
639 match channel_manager.force_close_channel(&channel_id) {
640 Ok(()) => println!("EVENT: initiating channel force-close"),
641 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
645 pub(crate) fn parse_peer_info(
646 peer_pubkey_and_ip_addr: String,
647 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
648 let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
649 let pubkey = pubkey_and_addr.next();
650 let peer_addr_str = pubkey_and_addr.next();
651 if peer_addr_str.is_none() || peer_addr_str.is_none() {
652 return Err(std::io::Error::new(
653 std::io::ErrorKind::Other,
654 "ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`",
658 let peer_addr = peer_addr_str.unwrap().to_socket_addrs().map(|mut r| r.next());
659 if peer_addr.is_err() || peer_addr.as_ref().unwrap().is_none() {
660 return Err(std::io::Error::new(
661 std::io::ErrorKind::Other,
662 "ERROR: couldn't parse pubkey@host:port into a socket address",
666 let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
667 if pubkey.is_none() {
668 return Err(std::io::Error::new(
669 std::io::ErrorKind::Other,
670 "ERROR: unable to parse given pubkey for node",
674 Ok((pubkey.unwrap(), peer_addr.unwrap().unwrap()))