4 ChannelManager, HTLCStatus, InvoicePayer, MillisatAmount, PaymentInfo, PaymentInfoStorage,
7 use bitcoin::hashes::sha256::Hash as Sha256;
8 use bitcoin::hashes::Hash;
9 use bitcoin::network::constants::Network;
10 use bitcoin::secp256k1::key::PublicKey;
11 use lightning::chain::keysinterface::{KeysInterface, KeysManager, Recipient};
12 use lightning::ln::msgs::NetAddress;
13 use lightning::ln::{PaymentHash, PaymentPreimage};
14 use lightning::routing::network_graph::{NetworkGraph, NodeId};
15 use lightning::util::config::{ChannelConfig, ChannelHandshakeLimits, UserConfig};
16 use lightning::util::events::EventHandler;
17 use lightning_invoice::payment::PaymentError;
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: Vec<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-node-name announced-listen-addr*]`");
46 let bitcoind_rpc_info = env::args().skip(1).next().unwrap();
47 let bitcoind_rpc_info_parts: Vec<&str> = bitcoind_rpc_info.rsplitn(2, "@").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[1].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[0].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()) {
73 ldk_peer_port_set = false;
77 ldk_peer_port_set = false;
82 let mut arg_idx = match ldk_peer_port_set {
86 let network: Network = match env::args().skip(arg_idx).next().as_ref().map(String::as_str) {
87 Some("testnet") => Network::Testnet,
88 Some("regtest") => Network::Regtest,
89 Some("signet") => Network::Signet,
91 panic!("Unsupported network provided. Options are: `regtest`, `testnet`, and `signet`. 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<E: EventHandler>(
143 invoice_payer: Arc<InvoicePayer<E>>, peer_manager: Arc<PeerManager>,
144 channel_manager: Arc<ChannelManager>, keys_manager: Arc<KeysManager>,
145 network_graph: Arc<NetworkGraph>, inbound_payments: PaymentInfoStorage,
146 outbound_payments: PaymentInfoStorage, ldk_data_dir: String, 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();
152 let mut line_reader = stdin.lock().lines();
155 io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
156 let line = match line_reader.next() {
157 Some(l) => l.unwrap(),
160 let mut words = line.split_whitespace();
161 if let Some(word) = words.next() {
165 let peer_pubkey_and_ip_addr = words.next();
166 let channel_value_sat = words.next();
167 if peer_pubkey_and_ip_addr.is_none() || channel_value_sat.is_none() {
168 println!("ERROR: openchannel has 2 required arguments: `openchannel pubkey@host:port channel_amt_satoshis` [--public]");
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());
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");
187 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
194 let announce_channel = match words.next() {
195 Some("--public") | Some("--public=true") => true,
196 Some("--public=false") => false,
198 println!("ERROR: invalid `--public` command format. Valid formats: `--public`, `--public=true` `--public=false`");
206 chan_amt_sat.unwrap(),
208 channel_manager.clone(),
212 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
213 let _ = disk::persist_channel_peer(
214 Path::new(&peer_data_path),
215 peer_pubkey_and_ip_addr,
220 let invoice_str = words.next();
221 if invoice_str.is_none() {
222 println!("ERROR: sendpayment requires an invoice: `sendpayment <invoice>`");
226 let invoice = match Invoice::from_str(invoice_str.unwrap()) {
229 println!("ERROR: invalid invoice: {:?}", e);
234 send_payment(&*invoice_payer, &invoice, outbound_payments.clone());
237 let dest_pubkey = match words.next() {
238 Some(dest) => match hex_utils::to_compressed_pubkey(dest) {
241 println!("ERROR: couldn't parse destination pubkey");
246 println!("ERROR: keysend requires a destination pubkey: `keysend <dest_pubkey> <amt_msat>`");
250 let amt_msat_str = match words.next() {
253 println!("ERROR: keysend requires an amount in millisatoshis: `keysend <dest_pubkey> <amt_msat>`");
257 let amt_msat: u64 = match amt_msat_str.parse() {
260 println!("ERROR: couldn't parse amount_msat: {}", e);
269 outbound_payments.clone(),
273 let amt_str = words.next();
274 if amt_str.is_none() {
275 println!("ERROR: getinvoice requires an amount in millisatoshis");
279 let amt_msat: Result<u64, _> = amt_str.unwrap().parse();
280 if amt_msat.is_err() {
281 println!("ERROR: getinvoice provided payment amount was not a number");
286 inbound_payments.clone(),
287 channel_manager.clone(),
288 keys_manager.clone(),
293 let peer_pubkey_and_ip_addr = words.next();
294 if peer_pubkey_and_ip_addr.is_none() {
295 println!("ERROR: connectpeer requires peer connection info: `connectpeer pubkey@host:port`");
298 let (pubkey, peer_addr) =
299 match parse_peer_info(peer_pubkey_and_ip_addr.unwrap().to_string()) {
302 println!("{:?}", e.into_inner().unwrap());
306 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
310 println!("SUCCESS: connected to peer {}", pubkey);
313 "listchannels" => list_channels(&channel_manager, &network_graph),
315 list_payments(inbound_payments.clone(), outbound_payments.clone())
318 let channel_id_str = words.next();
319 if channel_id_str.is_none() {
320 println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id>`");
323 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
324 if channel_id_vec.is_none() || channel_id_vec.as_ref().unwrap().len() != 32 {
325 println!("ERROR: couldn't parse channel_id");
328 let mut channel_id = [0; 32];
329 channel_id.copy_from_slice(&channel_id_vec.unwrap());
330 close_channel(channel_id, channel_manager.clone());
332 "forceclosechannel" => {
333 let channel_id_str = words.next();
334 if channel_id_str.is_none() {
335 println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id>`");
338 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
339 if channel_id_vec.is_none() || channel_id_vec.as_ref().unwrap().len() != 32 {
340 println!("ERROR: couldn't parse channel_id");
343 let mut channel_id = [0; 32];
344 channel_id.copy_from_slice(&channel_id_vec.unwrap());
345 force_close_channel(channel_id, channel_manager.clone());
347 "nodeinfo" => node_info(&channel_manager, &peer_manager),
348 "listpeers" => list_peers(peer_manager.clone()),
350 const MSG_STARTPOS: usize = "signmessage".len() + 1;
351 if line.as_bytes().len() <= MSG_STARTPOS {
352 println!("ERROR: signmsg requires a message");
357 lightning::util::message_signing::sign(
358 &line.as_bytes()[MSG_STARTPOS..],
359 &keys_manager.get_node_secret(Recipient::Node).unwrap()
363 _ => println!("Unknown command. See `\"help\" for available commands."),
370 println!("openchannel pubkey@host:port <amt_satoshis>");
371 println!("sendpayment <invoice>");
372 println!("getinvoice <amt_millisatoshis>");
373 println!("connectpeer pubkey@host:port");
374 println!("listchannels");
375 println!("listpayments");
376 println!("closechannel <channel_id>");
377 println!("forceclosechannel <channel_id>");
378 println!("nodeinfo");
379 println!("listpeers");
380 println!("signmessage <message>");
383 fn node_info(channel_manager: &Arc<ChannelManager>, peer_manager: &Arc<PeerManager>) {
385 println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
386 let chans = channel_manager.list_channels();
387 println!("\t\t num_channels: {}", chans.len());
388 println!("\t\t num_usable_channels: {}", chans.iter().filter(|c| c.is_usable).count());
389 let local_balance_msat = chans.iter().map(|c| c.balance_msat).sum::<u64>();
390 println!("\t\t local_balance_msat: {}", local_balance_msat);
391 println!("\t\t num_peers: {}", peer_manager.get_peer_node_ids().len());
395 fn list_peers(peer_manager: Arc<PeerManager>) {
397 for pubkey in peer_manager.get_peer_node_ids() {
398 println!("\t\t pubkey: {}", pubkey);
403 /// Takes some untrusted bytes and returns a sanitized string that is safe to print
404 fn sanitize_string(bytes: &[u8]) -> String {
405 let mut ret = String::with_capacity(bytes.len());
406 // We should really support some sane subset of UTF-8 here, but limiting to printable ASCII
407 // instead makes this trivial.
409 if *b >= 0x20 && *b <= 0x7e {
410 ret.push(*b as char);
416 fn list_channels(channel_manager: &Arc<ChannelManager>, network_graph: &Arc<NetworkGraph>) {
418 for chan_info in channel_manager.list_channels() {
421 println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..]));
422 if let Some(funding_txo) = chan_info.funding_txo {
423 println!("\t\tfunding_txid: {},", funding_txo.txid);
427 "\t\tpeer_pubkey: {},",
428 hex_utils::hex_str(&chan_info.counterparty.node_id.serialize())
430 if let Some(node_info) = network_graph
433 .get(&NodeId::from_pubkey(&chan_info.counterparty.node_id))
435 if let Some(announcement) = &node_info.announcement_info {
436 println!("\t\tpeer_alias: {}", sanitize_string(&announcement.alias));
440 if let Some(id) = chan_info.short_channel_id {
441 println!("\t\tshort_channel_id: {},", id);
443 println!("\t\tis_confirmed_onchain: {},", chan_info.is_funding_locked);
444 println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
445 println!("\t\tlocal_balance_msat: {},", chan_info.balance_msat);
446 if chan_info.is_usable {
447 println!("\t\tavailable_balance_for_send_msat: {},", chan_info.outbound_capacity_msat);
448 println!("\t\tavailable_balance_for_recv_msat: {},", chan_info.inbound_capacity_msat);
450 println!("\t\tchannel_can_send_payments: {},", chan_info.is_usable);
451 println!("\t\tpublic: {},", chan_info.is_public);
457 fn list_payments(inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage) {
458 let inbound = inbound_payments.lock().unwrap();
459 let outbound = outbound_payments.lock().unwrap();
461 for (payment_hash, payment_info) in inbound.deref() {
464 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
465 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
466 println!("\t\thtlc_direction: inbound,");
468 "\t\thtlc_status: {},",
469 match payment_info.status {
470 HTLCStatus::Pending => "pending",
471 HTLCStatus::Succeeded => "succeeded",
472 HTLCStatus::Failed => "failed",
479 for (payment_hash, payment_info) in outbound.deref() {
482 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
483 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
484 println!("\t\thtlc_direction: outbound,");
486 "\t\thtlc_status: {},",
487 match payment_info.status {
488 HTLCStatus::Pending => "pending",
489 HTLCStatus::Succeeded => "succeeded",
490 HTLCStatus::Failed => "failed",
499 pub(crate) async fn connect_peer_if_necessary(
500 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
501 ) -> Result<(), ()> {
502 for node_pubkey in peer_manager.get_peer_node_ids() {
503 if node_pubkey == pubkey {
507 let res = do_connect_peer(pubkey, peer_addr, peer_manager).await;
509 println!("ERROR: failed to connect to peer");
514 pub(crate) async fn do_connect_peer(
515 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
516 ) -> Result<(), ()> {
517 match lightning_net_tokio::connect_outbound(Arc::clone(&peer_manager), pubkey, peer_addr).await
519 Some(connection_closed_future) => {
520 let mut connection_closed_future = Box::pin(connection_closed_future);
522 match futures::poll!(&mut connection_closed_future) {
523 std::task::Poll::Ready(_) => {
526 std::task::Poll::Pending => {}
528 // Avoid blocking the tokio context by sleeping a bit
529 match peer_manager.get_peer_node_ids().iter().find(|id| **id == pubkey) {
530 Some(_) => return Ok(()),
531 None => tokio::time::sleep(Duration::from_millis(10)).await,
540 peer_pubkey: PublicKey, channel_amt_sat: u64, announced_channel: bool,
541 channel_manager: Arc<ChannelManager>,
542 ) -> Result<(), ()> {
543 let config = UserConfig {
544 peer_channel_config_limits: ChannelHandshakeLimits {
545 // lnd's max to_self_delay is 2016, so we want to be compatible.
546 their_to_self_delay: 2016,
549 channel_options: ChannelConfig { announced_channel, ..Default::default() },
553 match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, Some(config)) {
555 println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
559 println!("ERROR: failed to open channel: {:?}", e);
565 fn send_payment<E: EventHandler>(
566 invoice_payer: &InvoicePayer<E>, invoice: &Invoice, payment_storage: PaymentInfoStorage,
568 let status = match invoice_payer.pay_invoice(invoice) {
570 let payee_pubkey = invoice.recover_payee_pub_key();
571 let amt_msat = invoice.amount_milli_satoshis().unwrap();
572 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
576 Err(PaymentError::Invoice(e)) => {
577 println!("ERROR: invalid invoice: {}", e);
581 Err(PaymentError::Routing(e)) => {
582 println!("ERROR: failed to find route: {}", e.err);
586 Err(PaymentError::Sending(e)) => {
587 println!("ERROR: failed to send payment: {:?}", e);
592 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
593 let payment_secret = Some(invoice.payment_secret().clone());
595 let mut payments = payment_storage.lock().unwrap();
600 secret: payment_secret,
602 amt_msat: MillisatAmount(invoice.amount_milli_satoshis()),
607 fn keysend<E: EventHandler, K: KeysInterface>(
608 invoice_payer: &InvoicePayer<E>, payee_pubkey: PublicKey, amt_msat: u64, keys: &K,
609 payment_storage: PaymentInfoStorage,
611 let payment_preimage = keys.get_secure_random_bytes();
613 let status = match invoice_payer.pay_pubkey(
615 PaymentPreimage(payment_preimage),
620 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
624 Err(PaymentError::Invoice(e)) => {
625 println!("ERROR: invalid payee: {}", e);
629 Err(PaymentError::Routing(e)) => {
630 println!("ERROR: failed to find route: {}", e.err);
634 Err(PaymentError::Sending(e)) => {
635 println!("ERROR: failed to send payment: {:?}", e);
641 let mut payments = payment_storage.lock().unwrap();
643 PaymentHash(Sha256::hash(&payment_preimage).into_inner()),
648 amt_msat: MillisatAmount(Some(amt_msat)),
654 amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: Arc<ChannelManager>,
655 keys_manager: Arc<KeysManager>, network: Network,
657 let mut payments = payment_storage.lock().unwrap();
658 let currency = match network {
659 Network::Bitcoin => Currency::Bitcoin,
660 Network::Testnet => Currency::BitcoinTestnet,
661 Network::Regtest => Currency::Regtest,
662 Network::Signet => Currency::Signet,
664 let invoice = match utils::create_invoice_from_channelmanager(
669 "ldk-tutorial-node".to_string(),
672 println!("SUCCESS: generated invoice: {}", inv);
676 println!("ERROR: failed to create invoice: {:?}", e);
681 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
686 secret: Some(invoice.payment_secret().clone()),
687 status: HTLCStatus::Pending,
688 amt_msat: MillisatAmount(Some(amt_msat)),
693 fn close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
694 match channel_manager.close_channel(&channel_id) {
695 Ok(()) => println!("EVENT: initiating channel close"),
696 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
700 fn force_close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
701 match channel_manager.force_close_channel(&channel_id) {
702 Ok(()) => println!("EVENT: initiating channel force-close"),
703 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
707 pub(crate) fn parse_peer_info(
708 peer_pubkey_and_ip_addr: String,
709 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
710 let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
711 let pubkey = pubkey_and_addr.next();
712 let peer_addr_str = pubkey_and_addr.next();
713 if peer_addr_str.is_none() || peer_addr_str.is_none() {
714 return Err(std::io::Error::new(
715 std::io::ErrorKind::Other,
716 "ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`",
720 let peer_addr = peer_addr_str.unwrap().to_socket_addrs().map(|mut r| r.next());
721 if peer_addr.is_err() || peer_addr.as_ref().unwrap().is_none() {
722 return Err(std::io::Error::new(
723 std::io::ErrorKind::Other,
724 "ERROR: couldn't parse pubkey@host:port into a socket address",
728 let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
729 if pubkey.is_none() {
730 return Err(std::io::Error::new(
731 std::io::ErrorKind::Other,
732 "ERROR: unable to parse given pubkey for node",
736 Ok((pubkey.unwrap(), peer_addr.unwrap().unwrap()))