4 ChannelManager, FilesystemLogger, HTLCStatus, MillisatAmount, PaymentInfo, PaymentInfoStorage,
7 use bitcoin::hashes::Hash;
8 use bitcoin::network::constants::Network;
9 use bitcoin::secp256k1::key::PublicKey;
10 use lightning::chain::keysinterface::{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::NetworkGraph;
15 use lightning::routing::router;
16 use lightning::routing::router::{Payee, RouteHint, RouteParameters};
17 use lightning::routing::scorer::Scorer;
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>, network_graph: Arc<NetworkGraph>,
145 inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage,
146 ldk_data_dir: String, logger: Arc<FilesystemLogger>, network: Network,
148 println!("LDK startup successful. To view available commands: \"help\".");
149 println!("LDK logs are available at <your-supplied-ldk-data-dir-path>/.ldk/logs");
150 println!("Local Node ID is {}.", channel_manager.get_our_node_id());
151 let stdin = io::stdin();
153 io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
154 for line in stdin.lock().lines() {
155 let line = line.unwrap();
156 let mut words = line.split_whitespace();
157 if let Some(word) = words.next() {
161 let peer_pubkey_and_ip_addr = words.next();
162 let channel_value_sat = words.next();
163 if peer_pubkey_and_ip_addr.is_none() || channel_value_sat.is_none() {
164 println!("ERROR: openchannel has 2 required arguments: `openchannel pubkey@host:port channel_amt_satoshis` [--public]");
166 io::stdout().flush().unwrap();
169 let peer_pubkey_and_ip_addr = peer_pubkey_and_ip_addr.unwrap();
170 let (pubkey, peer_addr) =
171 match parse_peer_info(peer_pubkey_and_ip_addr.to_string()) {
174 println!("{:?}", e.into_inner().unwrap());
176 io::stdout().flush().unwrap();
181 let chan_amt_sat: Result<u64, _> = channel_value_sat.unwrap().parse();
182 if chan_amt_sat.is_err() {
183 println!("ERROR: channel amount must be a number");
185 io::stdout().flush().unwrap();
189 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
194 io::stdout().flush().unwrap();
198 let announce_channel = match words.next() {
199 Some("--public") | Some("--public=true") => true,
200 Some("--public=false") => false,
202 println!("ERROR: invalid `--public` command format. Valid formats: `--public`, `--public=true` `--public=false`");
204 io::stdout().flush().unwrap();
212 chan_amt_sat.unwrap(),
214 channel_manager.clone(),
218 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
219 let _ = disk::persist_channel_peer(
220 Path::new(&peer_data_path),
221 peer_pubkey_and_ip_addr,
226 let invoice_str = words.next();
227 if invoice_str.is_none() {
228 println!("ERROR: sendpayment requires an invoice: `sendpayment <invoice>`");
230 io::stdout().flush().unwrap();
234 let invoice = match Invoice::from_str(invoice_str.unwrap()) {
237 println!("ERROR: invalid invoice: {:?}", e);
239 io::stdout().flush().unwrap();
243 let last_hops = invoice.route_hints();
245 let amt_msat = invoice.amount_milli_satoshis();
246 if amt_msat.is_none() {
247 println!("ERROR: invalid invoice: must contain amount to pay");
249 io::stdout().flush().unwrap();
253 let payee_pubkey = invoice.recover_payee_pub_key();
254 let final_cltv = invoice.min_final_cltv_expiry() as u32;
255 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
256 let payment_secret = Some(invoice.payment_secret().clone());
257 let invoice_features = invoice.features().cloned();
267 network_graph.clone(),
268 channel_manager.clone(),
269 outbound_payments.clone(),
274 let dest_pubkey = match words.next() {
275 Some(dest) => match hex_utils::to_compressed_pubkey(dest) {
278 println!("ERROR: couldn't parse destination pubkey");
280 io::stdout().flush().unwrap();
285 println!("ERROR: keysend requires a destination pubkey: `keysend <dest_pubkey> <amt_msat>`");
287 io::stdout().flush().unwrap();
291 let amt_msat_str = match words.next() {
294 println!("ERROR: keysend requires an amount in millisatoshis: `keysend <dest_pubkey> <amt_msat>`");
297 io::stdout().flush().unwrap();
301 let amt_msat: u64 = match amt_msat_str.parse() {
304 println!("ERROR: couldn't parse amount_msat: {}", e);
306 io::stdout().flush().unwrap();
313 network_graph.clone(),
314 channel_manager.clone(),
315 outbound_payments.clone(),
320 let amt_str = words.next();
321 if amt_str.is_none() {
322 println!("ERROR: getinvoice requires an amount in millisatoshis");
324 io::stdout().flush().unwrap();
328 let amt_msat: Result<u64, _> = amt_str.unwrap().parse();
329 if amt_msat.is_err() {
330 println!("ERROR: getinvoice provided payment amount was not a number");
332 io::stdout().flush().unwrap();
337 inbound_payments.clone(),
338 channel_manager.clone(),
339 keys_manager.clone(),
344 let peer_pubkey_and_ip_addr = words.next();
345 if peer_pubkey_and_ip_addr.is_none() {
346 println!("ERROR: connectpeer requires peer connection info: `connectpeer pubkey@host:port`");
348 io::stdout().flush().unwrap();
351 let (pubkey, peer_addr) =
352 match parse_peer_info(peer_pubkey_and_ip_addr.unwrap().to_string()) {
355 println!("{:?}", e.into_inner().unwrap());
357 io::stdout().flush().unwrap();
361 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
365 println!("SUCCESS: connected to peer {}", pubkey);
368 "listchannels" => list_channels(channel_manager.clone()),
370 list_payments(inbound_payments.clone(), outbound_payments.clone())
373 let channel_id_str = words.next();
374 if channel_id_str.is_none() {
375 println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id>`");
377 io::stdout().flush().unwrap();
380 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
381 if channel_id_vec.is_none() {
382 println!("ERROR: couldn't parse channel_id as hex");
384 io::stdout().flush().unwrap();
387 let mut channel_id = [0; 32];
388 channel_id.copy_from_slice(&channel_id_vec.unwrap());
389 close_channel(channel_id, channel_manager.clone());
391 "forceclosechannel" => {
392 let channel_id_str = words.next();
393 if channel_id_str.is_none() {
394 println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id>`");
396 io::stdout().flush().unwrap();
399 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
400 if channel_id_vec.is_none() {
401 println!("ERROR: couldn't parse channel_id as hex");
403 io::stdout().flush().unwrap();
406 let mut channel_id = [0; 32];
407 channel_id.copy_from_slice(&channel_id_vec.unwrap());
408 force_close_channel(channel_id, channel_manager.clone());
410 "nodeinfo" => node_info(channel_manager.clone(), peer_manager.clone()),
411 "listpeers" => list_peers(peer_manager.clone()),
413 const MSG_STARTPOS: usize = "signmsg".len() + 1;
414 if line.as_bytes().len() <= MSG_STARTPOS {
415 println!("ERROR: signmsg requires a message");
417 io::stdout().flush().unwrap();
422 lightning::util::message_signing::sign(
423 &line.as_bytes()[MSG_STARTPOS..],
424 &keys_manager.get_node_secret()
428 io::stdout().flush().unwrap();
430 _ => println!("Unknown command. See `\"help\" for available commands."),
434 io::stdout().flush().unwrap();
439 println!("openchannel pubkey@host:port <amt_satoshis>");
440 println!("sendpayment <invoice>");
441 println!("getinvoice <amt_millisatoshis>");
442 println!("connectpeer pubkey@host:port");
443 println!("listchannels");
444 println!("listpayments");
445 println!("closechannel <channel_id>");
446 println!("forceclosechannel <channel_id>");
447 println!("nodeinfo");
448 println!("listpeers");
449 println!("signmessage <message>");
452 fn node_info(channel_manager: Arc<ChannelManager>, peer_manager: Arc<PeerManager>) {
454 println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
455 println!("\t\t num_channels: {}", channel_manager.list_channels().len());
456 println!("\t\t num_usable_channels: {}", channel_manager.list_usable_channels().len());
457 println!("\t\t num_peers: {}", peer_manager.get_peer_node_ids().len());
461 fn list_peers(peer_manager: Arc<PeerManager>) {
463 for pubkey in peer_manager.get_peer_node_ids() {
464 println!("\t\t pubkey: {}", pubkey);
469 fn list_channels(channel_manager: Arc<ChannelManager>) {
471 for chan_info in channel_manager.list_channels() {
474 println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..]));
475 if let Some(funding_txo) = chan_info.funding_txo {
476 println!("\t\tfunding_txid: {},", funding_txo.txid);
479 "\t\tpeer_pubkey: {},",
480 hex_utils::hex_str(&chan_info.counterparty.node_id.serialize())
482 if let Some(id) = chan_info.short_channel_id {
483 println!("\t\tshort_channel_id: {},", id);
485 println!("\t\tis_confirmed_onchain: {},", chan_info.is_funding_locked);
486 println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
488 "\t\tlocal_balance_msat: {},",
489 chan_info.outbound_capacity_msat
490 + chan_info.unspendable_punishment_reserve.unwrap_or(0) * 1000
492 if chan_info.is_usable {
493 println!("\t\tavailable_balance_for_send_msat: {},", chan_info.outbound_capacity_msat);
494 println!("\t\tavailable_balance_for_recv_msat: {},", chan_info.inbound_capacity_msat);
496 println!("\t\tchannel_can_send_payments: {},", chan_info.is_usable);
497 println!("\t\tpublic: {},", chan_info.is_public);
503 fn list_payments(inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage) {
504 let inbound = inbound_payments.lock().unwrap();
505 let outbound = outbound_payments.lock().unwrap();
507 for (payment_hash, payment_info) in inbound.deref() {
510 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
511 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
512 println!("\t\thtlc_direction: inbound,");
514 "\t\thtlc_status: {},",
515 match payment_info.status {
516 HTLCStatus::Pending => "pending",
517 HTLCStatus::Succeeded => "succeeded",
518 HTLCStatus::Failed => "failed",
525 for (payment_hash, payment_info) in outbound.deref() {
528 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
529 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
530 println!("\t\thtlc_direction: outbound,");
532 "\t\thtlc_status: {},",
533 match payment_info.status {
534 HTLCStatus::Pending => "pending",
535 HTLCStatus::Succeeded => "succeeded",
536 HTLCStatus::Failed => "failed",
545 pub(crate) async fn connect_peer_if_necessary(
546 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
547 ) -> Result<(), ()> {
548 for node_pubkey in peer_manager.get_peer_node_ids() {
549 if node_pubkey == pubkey {
553 match lightning_net_tokio::connect_outbound(Arc::clone(&peer_manager), pubkey, peer_addr).await
555 Some(connection_closed_future) => {
556 let mut connection_closed_future = Box::pin(connection_closed_future);
558 match futures::poll!(&mut connection_closed_future) {
559 std::task::Poll::Ready(_) => {
560 println!("ERROR: Peer disconnected before we finished the handshake");
563 std::task::Poll::Pending => {}
565 // Avoid blocking the tokio context by sleeping a bit
566 match peer_manager.get_peer_node_ids().iter().find(|id| **id == pubkey) {
568 None => tokio::time::sleep(Duration::from_millis(10)).await,
573 println!("ERROR: failed to connect to peer");
581 peer_pubkey: PublicKey, channel_amt_sat: u64, announced_channel: bool,
582 channel_manager: Arc<ChannelManager>,
583 ) -> Result<(), ()> {
584 let config = UserConfig {
585 peer_channel_config_limits: ChannelHandshakeLimits {
586 // lnd's max to_self_delay is 2016, so we want to be compatible.
587 their_to_self_delay: 2016,
590 channel_options: ChannelConfig { announced_channel, ..Default::default() },
594 match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, Some(config)) {
596 println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
600 println!("ERROR: failed to open channel: {:?}", e);
607 payee_pubkey: PublicKey, amt_msat: u64, final_cltv: u32, payment_hash: PaymentHash,
608 payment_secret: Option<PaymentSecret>, payee_features: Option<InvoiceFeatures>,
609 route_hints: Vec<RouteHint>, network_graph: Arc<NetworkGraph>,
610 channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
611 logger: Arc<FilesystemLogger>,
613 let first_hops = channel_manager.list_usable_channels();
614 let payer_pubkey = channel_manager.get_our_node_id();
616 let mut payee = Payee::from_node_id(payee_pubkey).with_route_hints(route_hints);
617 if let Some(features) = payee_features {
618 payee = payee.with_features(features);
621 RouteParameters { payee, final_value_msat: amt_msat, final_cltv_expiry_delta: final_cltv };
623 let route = router::find_route(
627 Some(&first_hops.iter().collect::<Vec<_>>()),
631 if let Err(e) = route {
632 println!("ERROR: failed to find route: {}", e.err);
635 let status = match channel_manager.send_payment(&route.unwrap(), payment_hash, &payment_secret)
638 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
642 println!("ERROR: failed to send payment: {:?}", e);
646 let mut payments = payment_storage.lock().unwrap();
651 secret: payment_secret,
653 amt_msat: MillisatAmount(Some(amt_msat)),
659 payee_pubkey: PublicKey, amt_msat: u64, network_graph: Arc<NetworkGraph>,
660 channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
661 logger: Arc<FilesystemLogger>,
663 let first_hops = channel_manager.list_usable_channels();
664 let payer_pubkey = channel_manager.get_our_node_id();
666 let payee = Payee::for_keysend(payee_pubkey);
667 let params = RouteParameters { payee, final_value_msat: amt_msat, final_cltv_expiry_delta: 40 };
669 let route = match router::find_route(
673 Some(&first_hops.iter().collect::<Vec<_>>()),
679 println!("ERROR: failed to find route: {}", e.err);
684 let mut payments = payment_storage.lock().unwrap();
685 let payment_hash = channel_manager.send_spontaneous_payment(&route, None).unwrap().0;
691 status: HTLCStatus::Pending,
692 amt_msat: MillisatAmount(Some(amt_msat)),
698 amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: Arc<ChannelManager>,
699 keys_manager: Arc<KeysManager>, network: Network,
701 let mut payments = payment_storage.lock().unwrap();
702 let currency = match network {
703 Network::Bitcoin => Currency::Bitcoin,
704 Network::Testnet => Currency::BitcoinTestnet,
705 Network::Regtest => Currency::Regtest,
706 Network::Signet => panic!("Signet unsupported"),
708 let invoice = match utils::create_invoice_from_channelmanager(
713 "ldk-tutorial-node".to_string(),
716 println!("SUCCESS: generated invoice: {}", inv);
720 println!("ERROR: failed to create invoice: {:?}", e);
725 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
730 secret: Some(invoice.payment_secret().clone()),
731 status: HTLCStatus::Pending,
732 amt_msat: MillisatAmount(Some(amt_msat)),
737 fn close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
738 match channel_manager.close_channel(&channel_id) {
739 Ok(()) => println!("EVENT: initiating channel close"),
740 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
744 fn force_close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
745 match channel_manager.force_close_channel(&channel_id) {
746 Ok(()) => println!("EVENT: initiating channel force-close"),
747 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
751 pub(crate) fn parse_peer_info(
752 peer_pubkey_and_ip_addr: String,
753 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
754 let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
755 let pubkey = pubkey_and_addr.next();
756 let peer_addr_str = pubkey_and_addr.next();
757 if peer_addr_str.is_none() || peer_addr_str.is_none() {
758 return Err(std::io::Error::new(
759 std::io::ErrorKind::Other,
760 "ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`",
764 let peer_addr = peer_addr_str.unwrap().to_socket_addrs().map(|mut r| r.next());
765 if peer_addr.is_err() || peer_addr.as_ref().unwrap().is_none() {
766 return Err(std::io::Error::new(
767 std::io::ErrorKind::Other,
768 "ERROR: couldn't parse pubkey@host:port into a socket address",
772 let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
773 if pubkey.is_none() {
774 return Err(std::io::Error::new(
775 std::io::ErrorKind::Other,
776 "ERROR: unable to parse given pubkey for node",
780 Ok((pubkey.unwrap(), peer_addr.unwrap().unwrap()))