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::routing::scorer::Scorer;
19 use lightning::util::config::{ChannelConfig, ChannelHandshakeLimits, UserConfig};
20 use lightning_invoice::{utils, Currency, Invoice};
23 use std::io::{BufRead, Write};
24 use std::net::{IpAddr, SocketAddr, ToSocketAddrs};
27 use std::str::FromStr;
29 use std::time::Duration;
31 pub(crate) struct LdkUserInfo {
32 pub(crate) bitcoind_rpc_username: String,
33 pub(crate) bitcoind_rpc_password: String,
34 pub(crate) bitcoind_rpc_port: u16,
35 pub(crate) bitcoind_rpc_host: String,
36 pub(crate) ldk_storage_dir_path: String,
37 pub(crate) ldk_peer_listening_port: u16,
38 pub(crate) ldk_announced_listen_addr: Vec<NetAddress>,
39 pub(crate) ldk_announced_node_name: [u8; 32],
40 pub(crate) network: Network,
43 pub(crate) fn parse_startup_args() -> Result<LdkUserInfo, ()> {
44 if env::args().len() < 3 {
45 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*]`");
48 let bitcoind_rpc_info = env::args().skip(1).next().unwrap();
49 let bitcoind_rpc_info_parts: Vec<&str> = bitcoind_rpc_info.split("@").collect();
50 if bitcoind_rpc_info_parts.len() != 2 {
51 println!("ERROR: bad bitcoind RPC URL provided");
54 let rpc_user_and_password: Vec<&str> = bitcoind_rpc_info_parts[0].split(":").collect();
55 if rpc_user_and_password.len() != 2 {
56 println!("ERROR: bad bitcoind RPC username/password combo provided");
59 let bitcoind_rpc_username = rpc_user_and_password[0].to_string();
60 let bitcoind_rpc_password = rpc_user_and_password[1].to_string();
61 let bitcoind_rpc_path: Vec<&str> = bitcoind_rpc_info_parts[1].split(":").collect();
62 if bitcoind_rpc_path.len() != 2 {
63 println!("ERROR: bad bitcoind RPC path provided");
66 let bitcoind_rpc_host = bitcoind_rpc_path[0].to_string();
67 let bitcoind_rpc_port = bitcoind_rpc_path[1].parse::<u16>().unwrap();
69 let ldk_storage_dir_path = env::args().skip(2).next().unwrap();
71 let mut ldk_peer_port_set = true;
72 let ldk_peer_listening_port: u16 = match env::args().skip(3).next().map(|p| p.parse()) {
75 ldk_peer_port_set = false;
79 ldk_peer_port_set = false;
84 let mut arg_idx = match ldk_peer_port_set {
88 let network: Network = match env::args().skip(arg_idx).next().as_ref().map(String::as_str) {
89 Some("testnet") => Network::Testnet,
90 Some("regtest") => Network::Regtest,
92 panic!("Unsupported network provided. Options are: `regtest`, `testnet`. Got {}", net);
94 None => Network::Testnet,
97 let ldk_announced_node_name = match env::args().skip(arg_idx + 1).next().as_ref() {
100 panic!("Node Alias can not be longer than 32 bytes");
103 let mut bytes = [0; 32];
104 bytes[..s.len()].copy_from_slice(s.as_bytes());
110 let mut ldk_announced_listen_addr = Vec::new();
112 match env::args().skip(arg_idx + 1).next().as_ref() {
113 Some(s) => match IpAddr::from_str(s) {
114 Ok(IpAddr::V4(a)) => {
115 ldk_announced_listen_addr
116 .push(NetAddress::IPv4 { addr: a.octets(), port: ldk_peer_listening_port });
119 Ok(IpAddr::V6(a)) => {
120 ldk_announced_listen_addr
121 .push(NetAddress::IPv6 { addr: a.octets(), port: ldk_peer_listening_port });
124 Err(_) => panic!("Failed to parse announced-listen-addr into an IP address"),
131 bitcoind_rpc_username,
132 bitcoind_rpc_password,
135 ldk_storage_dir_path,
136 ldk_peer_listening_port,
137 ldk_announced_listen_addr,
138 ldk_announced_node_name,
143 pub(crate) async fn poll_for_user_input(
144 peer_manager: Arc<PeerManager>, channel_manager: Arc<ChannelManager>,
145 keys_manager: Arc<KeysManager>,
146 router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access + Send + Sync>, 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 = Some(invoice.payment_secret().clone());
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>,
594 router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access + Send + Sync>, Arc<FilesystemLogger>>>,
595 channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
596 logger: Arc<FilesystemLogger>,
598 let network_graph = &router.network_graph;
599 let first_hops = channel_manager.list_usable_channels();
600 let payer_pubkey = channel_manager.get_our_node_id();
602 let route = router::get_route(
607 Some(&first_hops.iter().collect::<Vec<_>>()),
614 if let Err(e) = route {
615 println!("ERROR: failed to find route: {}", e.err);
618 let status = match channel_manager.send_payment(&route.unwrap(), payment_hash, &payment_secret)
621 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee);
625 println!("ERROR: failed to send payment: {:?}", e);
629 let mut payments = payment_storage.lock().unwrap();
634 secret: payment_secret,
636 amt_msat: MillisatAmount(Some(amt_msat)),
642 payee: PublicKey, amt_msat: u64,
643 router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access + Send + Sync>, Arc<FilesystemLogger>>>,
644 channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
645 logger: Arc<FilesystemLogger>,
647 let network_graph = &router.network_graph;
648 let first_hops = channel_manager.list_usable_channels();
649 let payer_pubkey = channel_manager.get_our_node_id();
651 let route = match router::get_keysend_route(
655 Some(&first_hops.iter().collect::<Vec<_>>()),
664 println!("ERROR: failed to find route: {}", e.err);
669 let mut payments = payment_storage.lock().unwrap();
670 let payment_hash = channel_manager.send_spontaneous_payment(&route, None).unwrap().0;
676 status: HTLCStatus::Pending,
677 amt_msat: MillisatAmount(Some(amt_msat)),
683 amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: Arc<ChannelManager>,
684 keys_manager: Arc<KeysManager>, network: Network,
686 let mut payments = payment_storage.lock().unwrap();
687 let currency = match network {
688 Network::Bitcoin => Currency::Bitcoin,
689 Network::Testnet => Currency::BitcoinTestnet,
690 Network::Regtest => Currency::Regtest,
691 Network::Signet => panic!("Signet unsupported"),
693 let invoice = match utils::create_invoice_from_channelmanager(
698 "ldk-tutorial-node".to_string(),
701 println!("SUCCESS: generated invoice: {}", inv);
705 println!("ERROR: failed to create invoice: {:?}", e);
710 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
715 secret: Some(invoice.payment_secret().clone()),
716 status: HTLCStatus::Pending,
717 amt_msat: MillisatAmount(Some(amt_msat)),
722 fn close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
723 match channel_manager.close_channel(&channel_id) {
724 Ok(()) => println!("EVENT: initiating channel close"),
725 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
729 fn force_close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
730 match channel_manager.force_close_channel(&channel_id) {
731 Ok(()) => println!("EVENT: initiating channel force-close"),
732 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
736 pub(crate) fn parse_peer_info(
737 peer_pubkey_and_ip_addr: String,
738 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
739 let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
740 let pubkey = pubkey_and_addr.next();
741 let peer_addr_str = pubkey_and_addr.next();
742 if peer_addr_str.is_none() || peer_addr_str.is_none() {
743 return Err(std::io::Error::new(
744 std::io::ErrorKind::Other,
745 "ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`",
749 let peer_addr = peer_addr_str.unwrap().to_socket_addrs().map(|mut r| r.next());
750 if peer_addr.is_err() || peer_addr.as_ref().unwrap().is_none() {
751 return Err(std::io::Error::new(
752 std::io::ErrorKind::Other,
753 "ERROR: couldn't parse pubkey@host:port into a socket address",
757 let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
758 if pubkey.is_none() {
759 return Err(std::io::Error::new(
760 std::io::ErrorKind::Other,
761 "ERROR: unable to parse given pubkey for node",
765 Ok((pubkey.unwrap(), peer_addr.unwrap().unwrap()))