4 ChannelManager, FilesystemLogger, HTLCStatus, MillisatAmount, PaymentInfo, PaymentInfoStorage,
7 use bitcoin::hashes::Hash;
8 use bitcoin::network::constants::Network;
9 use bitcoin::secp256k1::key::PublicKey;
11 use lightning::chain::keysinterface::KeysManager;
12 use lightning::ln::features::InvoiceFeatures;
13 use lightning::ln::msgs::NetAddress;
14 use lightning::ln::{PaymentHash, PaymentSecret};
15 use lightning::routing::network_graph::NetGraphMsgHandler;
16 use lightning::routing::router;
17 use lightning::routing::router::RouteHint;
18 use lightning::util::config::{ChannelConfig, ChannelHandshakeLimits, UserConfig};
19 use lightning_invoice::{utils, Currency, Invoice};
22 use std::io::{BufRead, Write};
23 use std::net::{IpAddr, SocketAddr, ToSocketAddrs};
26 use std::str::FromStr;
28 use std::time::Duration;
30 pub(crate) struct LdkUserInfo {
31 pub(crate) bitcoind_rpc_username: String,
32 pub(crate) bitcoind_rpc_password: String,
33 pub(crate) bitcoind_rpc_port: u16,
34 pub(crate) bitcoind_rpc_host: String,
35 pub(crate) ldk_storage_dir_path: String,
36 pub(crate) ldk_peer_listening_port: u16,
37 pub(crate) ldk_announced_listen_addr: Vec<NetAddress>,
38 pub(crate) ldk_announced_node_name: [u8; 32],
39 pub(crate) network: Network,
42 pub(crate) fn parse_startup_args() -> Result<LdkUserInfo, ()> {
43 if env::args().len() < 3 {
44 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*]`");
47 let bitcoind_rpc_info = env::args().skip(1).next().unwrap();
48 let bitcoind_rpc_info_parts: Vec<&str> = bitcoind_rpc_info.rsplitn(2, "@").collect();
49 if bitcoind_rpc_info_parts.len() != 2 {
50 println!("ERROR: bad bitcoind RPC URL provided");
53 let rpc_user_and_password: Vec<&str> = bitcoind_rpc_info_parts[1].split(":").collect();
54 if rpc_user_and_password.len() != 2 {
55 println!("ERROR: bad bitcoind RPC username/password combo provided");
58 let bitcoind_rpc_username = rpc_user_and_password[0].to_string();
59 let bitcoind_rpc_password = rpc_user_and_password[1].to_string();
60 let bitcoind_rpc_path: Vec<&str> = bitcoind_rpc_info_parts[0].split(":").collect();
61 if bitcoind_rpc_path.len() != 2 {
62 println!("ERROR: bad bitcoind RPC path provided");
65 let bitcoind_rpc_host = bitcoind_rpc_path[0].to_string();
66 let bitcoind_rpc_port = bitcoind_rpc_path[1].parse::<u16>().unwrap();
68 let ldk_storage_dir_path = env::args().skip(2).next().unwrap();
70 let mut ldk_peer_port_set = true;
71 let ldk_peer_listening_port: u16 = match env::args().skip(3).next().map(|p| p.parse()) {
74 ldk_peer_port_set = false;
78 ldk_peer_port_set = false;
83 let mut arg_idx = match ldk_peer_port_set {
87 let network: Network = match env::args().skip(arg_idx).next().as_ref().map(String::as_str) {
88 Some("testnet") => Network::Testnet,
89 Some("regtest") => Network::Regtest,
91 panic!("Unsupported network provided. Options are: `regtest`, `testnet`. Got {}", net);
93 None => Network::Testnet,
96 let ldk_announced_node_name = match env::args().skip(arg_idx + 1).next().as_ref() {
99 panic!("Node Alias can not be longer than 32 bytes");
102 let mut bytes = [0; 32];
103 bytes[..s.len()].copy_from_slice(s.as_bytes());
109 let mut ldk_announced_listen_addr = Vec::new();
111 match env::args().skip(arg_idx + 1).next().as_ref() {
112 Some(s) => match IpAddr::from_str(s) {
113 Ok(IpAddr::V4(a)) => {
114 ldk_announced_listen_addr
115 .push(NetAddress::IPv4 { addr: a.octets(), port: ldk_peer_listening_port });
118 Ok(IpAddr::V6(a)) => {
119 ldk_announced_listen_addr
120 .push(NetAddress::IPv6 { addr: a.octets(), port: ldk_peer_listening_port });
123 Err(_) => panic!("Failed to parse announced-listen-addr into an IP address"),
130 bitcoind_rpc_username,
131 bitcoind_rpc_password,
134 ldk_storage_dir_path,
135 ldk_peer_listening_port,
136 ldk_announced_listen_addr,
137 ldk_announced_node_name,
142 pub(crate) async fn poll_for_user_input(
143 peer_manager: Arc<PeerManager>, channel_manager: Arc<ChannelManager>,
144 keys_manager: Arc<KeysManager>,
145 router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access + Send + Sync>, Arc<FilesystemLogger>>>,
146 inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage,
147 ldk_data_dir: String, logger: Arc<FilesystemLogger>, network: Network,
149 println!("LDK startup successful. To view available commands: \"help\".");
150 println!("LDK logs are available at <your-supplied-ldk-data-dir-path>/.ldk/logs");
151 println!("Local Node ID is {}.", channel_manager.get_our_node_id());
152 let stdin = io::stdin();
154 io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
155 for line in stdin.lock().lines() {
156 let line = line.unwrap();
157 let mut words = line.split_whitespace();
158 if let Some(word) = words.next() {
162 let peer_pubkey_and_ip_addr = words.next();
163 let channel_value_sat = words.next();
164 if peer_pubkey_and_ip_addr.is_none() || channel_value_sat.is_none() {
165 println!("ERROR: openchannel has 2 required arguments: `openchannel pubkey@host:port channel_amt_satoshis` [--public]");
167 io::stdout().flush().unwrap();
170 let peer_pubkey_and_ip_addr = peer_pubkey_and_ip_addr.unwrap();
171 let (pubkey, peer_addr) =
172 match parse_peer_info(peer_pubkey_and_ip_addr.to_string()) {
175 println!("{:?}", e.into_inner().unwrap());
177 io::stdout().flush().unwrap();
182 let chan_amt_sat: Result<u64, _> = channel_value_sat.unwrap().parse();
183 if chan_amt_sat.is_err() {
184 println!("ERROR: channel amount must be a number");
186 io::stdout().flush().unwrap();
190 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
195 io::stdout().flush().unwrap();
199 let announce_channel = match words.next() {
200 Some("--public") | Some("--public=true") => true,
201 Some("--public=false") => false,
203 println!("ERROR: invalid `--public` command format. Valid formats: `--public`, `--public=true` `--public=false`");
205 io::stdout().flush().unwrap();
213 chan_amt_sat.unwrap(),
215 channel_manager.clone(),
219 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
220 let _ = disk::persist_channel_peer(
221 Path::new(&peer_data_path),
222 peer_pubkey_and_ip_addr,
227 let invoice_str = words.next();
228 if invoice_str.is_none() {
229 println!("ERROR: sendpayment requires an invoice: `sendpayment <invoice>`");
231 io::stdout().flush().unwrap();
235 let invoice = match Invoice::from_str(invoice_str.unwrap()) {
238 println!("ERROR: invalid invoice: {:?}", e);
240 io::stdout().flush().unwrap();
244 let last_hops = invoice.route_hints();
246 let amt_pico_btc = invoice.amount_pico_btc();
247 if amt_pico_btc.is_none() {
248 println!("ERROR: invalid invoice: must contain amount to pay");
250 io::stdout().flush().unwrap();
253 let amt_msat = amt_pico_btc.unwrap() / 10;
255 let payee_pubkey = invoice.recover_payee_pub_key();
256 let final_cltv = invoice.min_final_cltv_expiry() as u32;
257 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
258 let payment_secret = Some(invoice.payment_secret().clone());
259 let invoice_features = invoice.features().cloned();
270 channel_manager.clone(),
271 outbound_payments.clone(),
276 let dest_pubkey = match words.next() {
277 Some(dest) => match hex_utils::to_compressed_pubkey(dest) {
280 println!("ERROR: couldn't parse destination pubkey");
282 io::stdout().flush().unwrap();
287 println!("ERROR: keysend requires a destination pubkey: `keysend <dest_pubkey> <amt_msat>`");
289 io::stdout().flush().unwrap();
293 let amt_msat_str = match words.next() {
296 println!("ERROR: keysend requires an amount in millisatoshis: `keysend <dest_pubkey> <amt_msat>`");
299 io::stdout().flush().unwrap();
303 let amt_msat: u64 = match amt_msat_str.parse() {
306 println!("ERROR: couldn't parse amount_msat: {}", e);
308 io::stdout().flush().unwrap();
316 channel_manager.clone(),
317 outbound_payments.clone(),
322 let amt_str = words.next();
323 if amt_str.is_none() {
324 println!("ERROR: getinvoice requires an amount in millisatoshis");
326 io::stdout().flush().unwrap();
330 let amt_msat: Result<u64, _> = amt_str.unwrap().parse();
331 if amt_msat.is_err() {
332 println!("ERROR: getinvoice provided payment amount was not a number");
334 io::stdout().flush().unwrap();
339 inbound_payments.clone(),
340 channel_manager.clone(),
341 keys_manager.clone(),
346 let peer_pubkey_and_ip_addr = words.next();
347 if peer_pubkey_and_ip_addr.is_none() {
348 println!("ERROR: connectpeer requires peer connection info: `connectpeer pubkey@host:port`");
350 io::stdout().flush().unwrap();
353 let (pubkey, peer_addr) =
354 match parse_peer_info(peer_pubkey_and_ip_addr.unwrap().to_string()) {
357 println!("{:?}", e.into_inner().unwrap());
359 io::stdout().flush().unwrap();
363 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
367 println!("SUCCESS: connected to peer {}", pubkey);
370 "listchannels" => list_channels(channel_manager.clone()),
372 list_payments(inbound_payments.clone(), outbound_payments.clone())
375 let channel_id_str = words.next();
376 if channel_id_str.is_none() {
377 println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id>`");
379 io::stdout().flush().unwrap();
382 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
383 if channel_id_vec.is_none() {
384 println!("ERROR: couldn't parse channel_id as hex");
386 io::stdout().flush().unwrap();
389 let mut channel_id = [0; 32];
390 channel_id.copy_from_slice(&channel_id_vec.unwrap());
391 close_channel(channel_id, channel_manager.clone());
393 "forceclosechannel" => {
394 let channel_id_str = words.next();
395 if channel_id_str.is_none() {
396 println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id>`");
398 io::stdout().flush().unwrap();
401 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
402 if channel_id_vec.is_none() {
403 println!("ERROR: couldn't parse channel_id as hex");
405 io::stdout().flush().unwrap();
408 let mut channel_id = [0; 32];
409 channel_id.copy_from_slice(&channel_id_vec.unwrap());
410 force_close_channel(channel_id, channel_manager.clone());
412 "nodeinfo" => node_info(channel_manager.clone(), peer_manager.clone()),
413 "listpeers" => list_peers(peer_manager.clone()),
414 _ => println!("Unknown command. See `\"help\" for available commands."),
418 io::stdout().flush().unwrap();
423 println!("openchannel pubkey@host:port <amt_satoshis>");
424 println!("sendpayment <invoice>");
425 println!("getinvoice <amt_millisatoshis>");
426 println!("connectpeer pubkey@host:port");
427 println!("listchannels");
428 println!("listpayments");
429 println!("closechannel <channel_id>");
430 println!("forceclosechannel <channel_id>");
431 println!("nodeinfo");
432 println!("listpeers");
435 fn node_info(channel_manager: Arc<ChannelManager>, peer_manager: Arc<PeerManager>) {
437 println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
438 println!("\t\t num_channels: {}", channel_manager.list_channels().len());
439 println!("\t\t num_usable_channels: {}", channel_manager.list_usable_channels().len());
440 println!("\t\t num_peers: {}", peer_manager.get_peer_node_ids().len());
444 fn list_peers(peer_manager: Arc<PeerManager>) {
446 for pubkey in peer_manager.get_peer_node_ids() {
447 println!("\t\t pubkey: {}", pubkey);
452 fn list_channels(channel_manager: Arc<ChannelManager>) {
454 for chan_info in channel_manager.list_channels() {
457 println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..]));
458 if let Some(funding_txo) = chan_info.funding_txo {
459 println!("\t\tfunding_txid: {},", funding_txo.txid);
462 "\t\tpeer_pubkey: {},",
463 hex_utils::hex_str(&chan_info.counterparty.node_id.serialize())
465 if let Some(id) = chan_info.short_channel_id {
466 println!("\t\tshort_channel_id: {},", id);
468 println!("\t\tis_confirmed_onchain: {},", chan_info.is_funding_locked);
469 println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
471 "\t\tlocal_balance_msat: {},",
472 chan_info.outbound_capacity_msat
473 + chan_info.unspendable_punishment_reserve.unwrap_or(0) * 1000
475 if chan_info.is_usable {
476 println!("\t\tavailable_balance_for_send_msat: {},", chan_info.outbound_capacity_msat);
477 println!("\t\tavailable_balance_for_recv_msat: {},", chan_info.inbound_capacity_msat);
479 println!("\t\tchannel_can_send_payments: {},", chan_info.is_usable);
480 println!("\t\tpublic: {},", chan_info.is_public);
486 fn list_payments(inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage) {
487 let inbound = inbound_payments.lock().unwrap();
488 let outbound = outbound_payments.lock().unwrap();
490 for (payment_hash, payment_info) in inbound.deref() {
493 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
494 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
495 println!("\t\thtlc_direction: inbound,");
497 "\t\thtlc_status: {},",
498 match payment_info.status {
499 HTLCStatus::Pending => "pending",
500 HTLCStatus::Succeeded => "succeeded",
501 HTLCStatus::Failed => "failed",
508 for (payment_hash, payment_info) in outbound.deref() {
511 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
512 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
513 println!("\t\thtlc_direction: outbound,");
515 "\t\thtlc_status: {},",
516 match payment_info.status {
517 HTLCStatus::Pending => "pending",
518 HTLCStatus::Succeeded => "succeeded",
519 HTLCStatus::Failed => "failed",
528 pub(crate) async fn connect_peer_if_necessary(
529 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
530 ) -> Result<(), ()> {
531 for node_pubkey in peer_manager.get_peer_node_ids() {
532 if node_pubkey == pubkey {
536 match lightning_net_tokio::connect_outbound(Arc::clone(&peer_manager), pubkey, peer_addr).await
538 Some(connection_closed_future) => {
539 let mut connection_closed_future = Box::pin(connection_closed_future);
541 match futures::poll!(&mut connection_closed_future) {
542 std::task::Poll::Ready(_) => {
543 println!("ERROR: Peer disconnected before we finished the handshake");
546 std::task::Poll::Pending => {}
548 // Avoid blocking the tokio context by sleeping a bit
549 match peer_manager.get_peer_node_ids().iter().find(|id| **id == pubkey) {
551 None => tokio::time::sleep(Duration::from_millis(10)).await,
556 println!("ERROR: failed to connect to peer");
564 peer_pubkey: PublicKey, channel_amt_sat: u64, announced_channel: bool,
565 channel_manager: Arc<ChannelManager>,
566 ) -> Result<(), ()> {
567 let config = UserConfig {
568 peer_channel_config_limits: ChannelHandshakeLimits {
569 // lnd's max to_self_delay is 2016, so we want to be compatible.
570 their_to_self_delay: 2016,
573 channel_options: ChannelConfig { announced_channel, ..Default::default() },
577 match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, Some(config)) {
579 println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
583 println!("ERROR: failed to open channel: {:?}", e);
590 payee: PublicKey, amt_msat: u64, final_cltv: u32, payment_hash: PaymentHash,
591 payment_secret: Option<PaymentSecret>, payee_features: Option<InvoiceFeatures>,
592 route_hints: Vec<&RouteHint>,
593 router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access + Send + Sync>, Arc<FilesystemLogger>>>,
594 channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
595 logger: Arc<FilesystemLogger>,
597 let network_graph = &router.network_graph;
598 let first_hops = channel_manager.list_usable_channels();
599 let payer_pubkey = channel_manager.get_our_node_id();
601 let route = router::get_route(
606 Some(&first_hops.iter().collect::<Vec<_>>()),
612 if let Err(e) = route {
613 println!("ERROR: failed to find route: {}", e.err);
616 let status = match channel_manager.send_payment(&route.unwrap(), payment_hash, &payment_secret)
619 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee);
623 println!("ERROR: failed to send payment: {:?}", e);
627 let mut payments = payment_storage.lock().unwrap();
632 secret: payment_secret,
634 amt_msat: MillisatAmount(Some(amt_msat)),
640 payee: PublicKey, amt_msat: u64,
641 router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access + Send + Sync>, Arc<FilesystemLogger>>>,
642 channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
643 logger: Arc<FilesystemLogger>,
645 let network_graph = &router.network_graph;
646 let first_hops = channel_manager.list_usable_channels();
647 let payer_pubkey = channel_manager.get_our_node_id();
649 let route = match router::get_keysend_route(
653 Some(&first_hops.iter().collect::<Vec<_>>()),
661 println!("ERROR: failed to find route: {}", e.err);
666 let mut payments = payment_storage.lock().unwrap();
667 let payment_hash = channel_manager.send_spontaneous_payment(&route, None).unwrap();
673 status: HTLCStatus::Pending,
674 amt_msat: MillisatAmount(Some(amt_msat)),
680 amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: Arc<ChannelManager>,
681 keys_manager: Arc<KeysManager>, network: Network,
683 let mut payments = payment_storage.lock().unwrap();
684 let currency = match network {
685 Network::Bitcoin => Currency::Bitcoin,
686 Network::Testnet => Currency::BitcoinTestnet,
687 Network::Regtest => Currency::Regtest,
688 Network::Signet => panic!("Signet unsupported"),
690 let invoice = match utils::create_invoice_from_channelmanager(
695 "ldk-tutorial-node".to_string(),
698 println!("SUCCESS: generated invoice: {}", inv);
702 println!("ERROR: failed to create invoice: {:?}", e);
707 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
712 secret: Some(invoice.payment_secret().clone()),
713 status: HTLCStatus::Pending,
714 amt_msat: MillisatAmount(Some(amt_msat)),
719 fn close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
720 match channel_manager.close_channel(&channel_id) {
721 Ok(()) => println!("EVENT: initiating channel close"),
722 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
726 fn force_close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
727 match channel_manager.force_close_channel(&channel_id) {
728 Ok(()) => println!("EVENT: initiating channel force-close"),
729 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
733 pub(crate) fn parse_peer_info(
734 peer_pubkey_and_ip_addr: String,
735 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
736 let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
737 let pubkey = pubkey_and_addr.next();
738 let peer_addr_str = pubkey_and_addr.next();
739 if peer_addr_str.is_none() || peer_addr_str.is_none() {
740 return Err(std::io::Error::new(
741 std::io::ErrorKind::Other,
742 "ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`",
746 let peer_addr = peer_addr_str.unwrap().to_socket_addrs().map(|mut r| r.next());
747 if peer_addr.is_err() || peer_addr.as_ref().unwrap().is_none() {
748 return Err(std::io::Error::new(
749 std::io::ErrorKind::Other,
750 "ERROR: couldn't parse pubkey@host:port into a socket address",
754 let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
755 if pubkey.is_none() {
756 return Err(std::io::Error::new(
757 std::io::ErrorKind::Other,
758 "ERROR: unable to parse given pubkey for node",
762 Ok((pubkey.unwrap(), peer_addr.unwrap().unwrap()))