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, NetworkGraph};
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.split("@").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[0].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[1].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()) {
73 Some(Err(e)) => panic!("{}", e),
75 ldk_peer_port_set = false;
80 let mut arg_idx = match ldk_peer_port_set {
84 let network: Network = match env::args().skip(arg_idx).next().as_ref().map(String::as_str) {
85 Some("testnet") => Network::Testnet,
86 Some("regtest") => Network::Regtest,
87 Some(_) => panic!("Unsupported network provided. Options are: `regtest`, `testnet`"),
88 None => Network::Testnet,
91 let ldk_announced_node_name = match env::args().skip(arg_idx + 1).next().as_ref() {
94 panic!("Node Alias can not be longer than 32 bytes");
97 let mut bytes = [0; 32];
98 bytes[..s.len()].copy_from_slice(s.as_bytes());
104 let mut ldk_announced_listen_addr = Vec::new();
106 match env::args().skip(arg_idx + 1).next().as_ref() {
107 Some(s) => match IpAddr::from_str(s) {
108 Ok(IpAddr::V4(a)) => {
109 ldk_announced_listen_addr
110 .push(NetAddress::IPv4 { addr: a.octets(), port: ldk_peer_listening_port });
113 Ok(IpAddr::V6(a)) => {
114 ldk_announced_listen_addr
115 .push(NetAddress::IPv6 { addr: a.octets(), port: ldk_peer_listening_port });
118 Err(_) => panic!("Failed to parse announced-listen-addr into an IP address"),
125 bitcoind_rpc_username,
126 bitcoind_rpc_password,
129 ldk_storage_dir_path,
130 ldk_peer_listening_port,
131 ldk_announced_listen_addr,
132 ldk_announced_node_name,
137 pub(crate) async fn poll_for_user_input(
138 peer_manager: Arc<PeerManager>, channel_manager: Arc<ChannelManager>,
139 keys_manager: Arc<KeysManager>,
143 Arc<dyn chain::Access + Send + Sync>,
144 Arc<FilesystemLogger>,
147 inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage,
148 ldk_data_dir: String, logger: Arc<FilesystemLogger>, network: Network,
150 println!("LDK startup successful. To view available commands: \"help\".");
151 println!("LDK logs are available at <your-supplied-ldk-data-dir-path>/.ldk/logs");
152 println!("Local Node ID is {}.", channel_manager.get_our_node_id());
153 let stdin = io::stdin();
155 io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
156 for line in stdin.lock().lines() {
157 let line = line.unwrap();
158 let mut words = line.split_whitespace();
159 if let Some(word) = words.next() {
163 let peer_pubkey_and_ip_addr = words.next();
164 let channel_value_sat = words.next();
165 if peer_pubkey_and_ip_addr.is_none() || channel_value_sat.is_none() {
166 println!("ERROR: openchannel has 2 required arguments: `openchannel pubkey@host:port channel_amt_satoshis` [--public]");
168 io::stdout().flush().unwrap();
171 let peer_pubkey_and_ip_addr = peer_pubkey_and_ip_addr.unwrap();
172 let (pubkey, peer_addr) =
173 match parse_peer_info(peer_pubkey_and_ip_addr.to_string()) {
176 println!("{:?}", e.into_inner().unwrap());
178 io::stdout().flush().unwrap();
183 let chan_amt_sat: Result<u64, _> = channel_value_sat.unwrap().parse();
184 if chan_amt_sat.is_err() {
185 println!("ERROR: channel amount must be a number");
187 io::stdout().flush().unwrap();
191 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
196 io::stdout().flush().unwrap();
200 let announce_channel = match words.next() {
201 Some("--public") | Some("--public=true") => true,
202 Some("--public=false") => false,
204 println!("ERROR: invalid `--public` command format. Valid formats: `--public`, `--public=true` `--public=false`");
206 io::stdout().flush().unwrap();
214 chan_amt_sat.unwrap(),
216 channel_manager.clone(),
220 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
221 let _ = disk::persist_channel_peer(
222 Path::new(&peer_data_path),
223 peer_pubkey_and_ip_addr,
228 let invoice_str = words.next();
229 if invoice_str.is_none() {
230 println!("ERROR: sendpayment requires an invoice: `sendpayment <invoice>`");
232 io::stdout().flush().unwrap();
236 let invoice = match Invoice::from_str(invoice_str.unwrap()) {
239 println!("ERROR: invalid invoice: {:?}", e);
241 io::stdout().flush().unwrap();
245 let last_hops = invoice.route_hints();
247 let amt_pico_btc = invoice.amount_pico_btc();
248 if amt_pico_btc.is_none() {
249 println!("ERROR: invalid invoice: must contain amount to pay");
251 io::stdout().flush().unwrap();
254 let amt_msat = amt_pico_btc.unwrap() / 10;
256 let payee_pubkey = invoice.recover_payee_pub_key();
257 let final_cltv = invoice.min_final_cltv_expiry() as u32;
258 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
259 let payment_secret = invoice.payment_secret().cloned();
260 let invoice_features = invoice.features().cloned();
271 channel_manager.clone(),
272 outbound_payments.clone(),
277 let dest_pubkey = match words.next() {
278 Some(dest) => match hex_utils::to_compressed_pubkey(dest) {
281 println!("ERROR: couldn't parse destination pubkey");
283 io::stdout().flush().unwrap();
288 println!("ERROR: keysend requires a destination pubkey: `keysend <dest_pubkey> <amt_msat>`");
290 io::stdout().flush().unwrap();
294 let amt_msat_str = match words.next() {
297 println!("ERROR: keysend requires an amount in millisatoshis: `keysend <dest_pubkey> <amt_msat>`");
300 io::stdout().flush().unwrap();
304 let amt_msat: u64 = match amt_msat_str.parse() {
307 println!("ERROR: couldn't parse amount_msat: {}", e);
309 io::stdout().flush().unwrap();
317 channel_manager.clone(),
318 outbound_payments.clone(),
323 let amt_str = words.next();
324 if amt_str.is_none() {
325 println!("ERROR: getinvoice requires an amount in millisatoshis");
327 io::stdout().flush().unwrap();
331 let amt_msat: Result<u64, _> = amt_str.unwrap().parse();
332 if amt_msat.is_err() {
333 println!("ERROR: getinvoice provided payment amount was not a number");
335 io::stdout().flush().unwrap();
340 inbound_payments.clone(),
341 channel_manager.clone(),
342 keys_manager.clone(),
347 let peer_pubkey_and_ip_addr = words.next();
348 if peer_pubkey_and_ip_addr.is_none() {
349 println!("ERROR: connectpeer requires peer connection info: `connectpeer pubkey@host:port`");
351 io::stdout().flush().unwrap();
354 let (pubkey, peer_addr) =
355 match parse_peer_info(peer_pubkey_and_ip_addr.unwrap().to_string()) {
358 println!("{:?}", e.into_inner().unwrap());
360 io::stdout().flush().unwrap();
364 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
368 println!("SUCCESS: connected to peer {}", pubkey);
371 "listchannels" => list_channels(channel_manager.clone()),
373 list_payments(inbound_payments.clone(), outbound_payments.clone())
376 let channel_id_str = words.next();
377 if channel_id_str.is_none() {
378 println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id>`");
380 io::stdout().flush().unwrap();
383 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
384 if channel_id_vec.is_none() {
385 println!("ERROR: couldn't parse channel_id as hex");
387 io::stdout().flush().unwrap();
390 let mut channel_id = [0; 32];
391 channel_id.copy_from_slice(&channel_id_vec.unwrap());
392 close_channel(channel_id, channel_manager.clone());
394 "forceclosechannel" => {
395 let channel_id_str = words.next();
396 if channel_id_str.is_none() {
397 println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id>`");
399 io::stdout().flush().unwrap();
402 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
403 if channel_id_vec.is_none() {
404 println!("ERROR: couldn't parse channel_id as hex");
406 io::stdout().flush().unwrap();
409 let mut channel_id = [0; 32];
410 channel_id.copy_from_slice(&channel_id_vec.unwrap());
411 force_close_channel(channel_id, channel_manager.clone());
413 "nodeinfo" => node_info(channel_manager.clone(), peer_manager.clone()),
414 "listpeers" => list_peers(peer_manager.clone()),
415 _ => println!("Unknown command. See `\"help\" for available commands."),
419 io::stdout().flush().unwrap();
424 println!("openchannel pubkey@host:port <amt_satoshis>");
425 println!("sendpayment <invoice>");
426 println!("getinvoice <amt_millisatoshis>");
427 println!("connectpeer pubkey@host:port");
428 println!("listchannels");
429 println!("listpayments");
430 println!("closechannel <channel_id>");
431 println!("forceclosechannel <channel_id>");
432 println!("nodeinfo");
433 println!("listpeers");
436 fn node_info(channel_manager: Arc<ChannelManager>, peer_manager: Arc<PeerManager>) {
438 println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
439 println!("\t\t num_channels: {}", channel_manager.list_channels().len());
440 println!("\t\t num_usable_channels: {}", channel_manager.list_usable_channels().len());
441 println!("\t\t num_peers: {}", peer_manager.get_peer_node_ids().len());
445 fn list_peers(peer_manager: Arc<PeerManager>) {
447 for pubkey in peer_manager.get_peer_node_ids() {
448 println!("\t\t pubkey: {}", pubkey);
453 fn list_channels(channel_manager: Arc<ChannelManager>) {
455 for chan_info in channel_manager.list_channels() {
458 println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..]));
459 if let Some(funding_txo) = chan_info.funding_txo {
460 println!("\t\tfunding_txid: {},", funding_txo.txid);
463 "\t\tpeer_pubkey: {},",
464 hex_utils::hex_str(&chan_info.counterparty.node_id.serialize())
466 if let Some(id) = chan_info.short_channel_id {
467 println!("\t\tshort_channel_id: {},", id);
469 println!("\t\tis_confirmed_onchain: {},", chan_info.is_funding_locked);
470 println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
472 "\t\tlocal_balance_msat: {},",
473 chan_info.outbound_capacity_msat
474 + chan_info.unspendable_punishment_reserve.unwrap_or(0) * 1000
476 if chan_info.is_usable {
477 println!("\t\tavailable_balance_for_send_msat: {},", chan_info.outbound_capacity_msat);
478 println!("\t\tavailable_balance_for_recv_msat: {},", chan_info.inbound_capacity_msat);
480 println!("\t\tchannel_can_send_payments: {},", chan_info.is_usable);
481 println!("\t\tpublic: {},", chan_info.is_public);
487 fn list_payments(inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage) {
488 let inbound = inbound_payments.lock().unwrap();
489 let outbound = outbound_payments.lock().unwrap();
491 for (payment_hash, payment_info) in inbound.deref() {
494 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
495 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
496 println!("\t\thtlc_direction: inbound,");
498 "\t\thtlc_status: {},",
499 match payment_info.status {
500 HTLCStatus::Pending => "pending",
501 HTLCStatus::Succeeded => "succeeded",
502 HTLCStatus::Failed => "failed",
509 for (payment_hash, payment_info) in outbound.deref() {
512 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
513 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
514 println!("\t\thtlc_direction: outbound,");
516 "\t\thtlc_status: {},",
517 match payment_info.status {
518 HTLCStatus::Pending => "pending",
519 HTLCStatus::Succeeded => "succeeded",
520 HTLCStatus::Failed => "failed",
529 pub(crate) async fn connect_peer_if_necessary(
530 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
531 ) -> Result<(), ()> {
532 for node_pubkey in peer_manager.get_peer_node_ids() {
533 if node_pubkey == pubkey {
537 match lightning_net_tokio::connect_outbound(Arc::clone(&peer_manager), pubkey, peer_addr).await
539 Some(connection_closed_future) => {
540 let mut connection_closed_future = Box::pin(connection_closed_future);
542 match futures::poll!(&mut connection_closed_future) {
543 std::task::Poll::Ready(_) => {
544 println!("ERROR: Peer disconnected before we finished the handshake");
547 std::task::Poll::Pending => {}
549 // Avoid blocking the tokio context by sleeping a bit
550 match peer_manager.get_peer_node_ids().iter().find(|id| **id == pubkey) {
552 None => tokio::time::sleep(Duration::from_millis(10)).await,
557 println!("ERROR: failed to connect to peer");
565 peer_pubkey: PublicKey, channel_amt_sat: u64, announced_channel: bool,
566 channel_manager: Arc<ChannelManager>,
567 ) -> Result<(), ()> {
568 let config = UserConfig {
569 peer_channel_config_limits: ChannelHandshakeLimits {
570 // lnd's max to_self_delay is 2016, so we want to be compatible.
571 their_to_self_delay: 2016,
574 channel_options: ChannelConfig { announced_channel, ..Default::default() },
578 match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, Some(config)) {
580 println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
584 println!("ERROR: failed to open channel: {:?}", e);
591 payee: PublicKey, amt_msat: u64, final_cltv: u32, payment_hash: PaymentHash,
592 payment_secret: Option<PaymentSecret>, payee_features: Option<InvoiceFeatures>,
593 route_hints: Vec<&RouteHint>,
597 Arc<dyn chain::Access + Send + Sync>,
598 Arc<FilesystemLogger>,
601 channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
602 logger: Arc<FilesystemLogger>,
604 let first_hops = channel_manager.list_usable_channels();
605 let payer_pubkey = channel_manager.get_our_node_id();
607 let route = router::get_route(
609 &router.network_graph,
612 Some(&first_hops.iter().collect::<Vec<_>>()),
618 if let Err(e) = route {
619 println!("ERROR: failed to find route: {}", e.err);
622 let status = match channel_manager.send_payment(&route.unwrap(), payment_hash, &payment_secret)
625 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee);
629 println!("ERROR: failed to send payment: {:?}", e);
633 let mut payments = payment_storage.lock().unwrap();
638 secret: payment_secret,
640 amt_msat: MillisatAmount(Some(amt_msat)),
646 payee: PublicKey, amt_msat: u64,
650 Arc<dyn chain::Access + Send + Sync>,
651 Arc<FilesystemLogger>,
654 channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
655 logger: Arc<FilesystemLogger>,
657 let first_hops = channel_manager.list_usable_channels();
658 let payer_pubkey = channel_manager.get_our_node_id();
660 let route = match router::get_keysend_route(
662 &router.network_graph,
664 Some(&first_hops.iter().collect::<Vec<_>>()),
672 println!("ERROR: failed to find route: {}", e.err);
677 let mut payments = payment_storage.lock().unwrap();
678 let payment_hash = channel_manager.send_spontaneous_payment(&route, None).unwrap();
684 status: HTLCStatus::Pending,
685 amt_msat: MillisatAmount(Some(amt_msat)),
691 amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: Arc<ChannelManager>,
692 keys_manager: Arc<KeysManager>, network: Network,
694 let mut payments = payment_storage.lock().unwrap();
695 let currency = match network {
696 Network::Bitcoin => Currency::Bitcoin,
697 Network::Testnet => Currency::BitcoinTestnet,
698 Network::Regtest => Currency::Regtest,
699 Network::Signet => panic!("Signet unsupported"),
701 let invoice = match utils::create_invoice_from_channelmanager(
706 "ldk-tutorial-node".to_string(),
709 println!("SUCCESS: generated invoice: {}", inv);
713 println!("ERROR: failed to create invoice: {:?}", e);
718 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
723 secret: invoice.payment_secret().cloned(),
724 status: HTLCStatus::Pending,
725 amt_msat: MillisatAmount(Some(amt_msat)),
730 fn close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
731 match channel_manager.close_channel(&channel_id) {
732 Ok(()) => println!("EVENT: initiating channel close"),
733 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
737 fn force_close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
738 match channel_manager.force_close_channel(&channel_id) {
739 Ok(()) => println!("EVENT: initiating channel force-close"),
740 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
744 pub(crate) fn parse_peer_info(
745 peer_pubkey_and_ip_addr: String,
746 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
747 let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
748 let pubkey = pubkey_and_addr.next();
749 let peer_addr_str = pubkey_and_addr.next();
750 if peer_addr_str.is_none() || peer_addr_str.is_none() {
751 return Err(std::io::Error::new(
752 std::io::ErrorKind::Other,
753 "ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`",
757 let peer_addr = peer_addr_str.unwrap().to_socket_addrs().map(|mut r| r.next());
758 if peer_addr.is_err() || peer_addr.as_ref().unwrap().is_none() {
759 return Err(std::io::Error::new(
760 std::io::ErrorKind::Other,
761 "ERROR: couldn't parse pubkey@host:port into a socket address",
765 let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
766 if pubkey.is_none() {
767 return Err(std::io::Error::new(
768 std::io::ErrorKind::Other,
769 "ERROR: unable to parse given pubkey for node",
773 Ok((pubkey.unwrap(), peer_addr.unwrap().unwrap()))