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::util::config::{ChannelConfig, ChannelHandshakeLimits, UserConfig};
15 use lightning::util::events::EventHandler;
16 use lightning_invoice::payment::PaymentError;
17 use lightning_invoice::{utils, Currency, Invoice};
20 use std::io::{BufRead, Write};
21 use std::net::{IpAddr, SocketAddr, ToSocketAddrs};
24 use std::str::FromStr;
26 use std::time::Duration;
28 pub(crate) struct LdkUserInfo {
29 pub(crate) bitcoind_rpc_username: String,
30 pub(crate) bitcoind_rpc_password: String,
31 pub(crate) bitcoind_rpc_port: u16,
32 pub(crate) bitcoind_rpc_host: String,
33 pub(crate) ldk_storage_dir_path: String,
34 pub(crate) ldk_peer_listening_port: u16,
35 pub(crate) ldk_announced_listen_addr: Vec<NetAddress>,
36 pub(crate) ldk_announced_node_name: [u8; 32],
37 pub(crate) network: Network,
40 pub(crate) fn parse_startup_args() -> Result<LdkUserInfo, ()> {
41 if env::args().len() < 3 {
42 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*]`");
45 let bitcoind_rpc_info = env::args().skip(1).next().unwrap();
46 let bitcoind_rpc_info_parts: Vec<&str> = bitcoind_rpc_info.rsplitn(2, "@").collect();
47 if bitcoind_rpc_info_parts.len() != 2 {
48 println!("ERROR: bad bitcoind RPC URL provided");
51 let rpc_user_and_password: Vec<&str> = bitcoind_rpc_info_parts[1].split(":").collect();
52 if rpc_user_and_password.len() != 2 {
53 println!("ERROR: bad bitcoind RPC username/password combo provided");
56 let bitcoind_rpc_username = rpc_user_and_password[0].to_string();
57 let bitcoind_rpc_password = rpc_user_and_password[1].to_string();
58 let bitcoind_rpc_path: Vec<&str> = bitcoind_rpc_info_parts[0].split(":").collect();
59 if bitcoind_rpc_path.len() != 2 {
60 println!("ERROR: bad bitcoind RPC path provided");
63 let bitcoind_rpc_host = bitcoind_rpc_path[0].to_string();
64 let bitcoind_rpc_port = bitcoind_rpc_path[1].parse::<u16>().unwrap();
66 let ldk_storage_dir_path = env::args().skip(2).next().unwrap();
68 let mut ldk_peer_port_set = true;
69 let ldk_peer_listening_port: u16 = match env::args().skip(3).next().map(|p| p.parse()) {
72 ldk_peer_port_set = false;
76 ldk_peer_port_set = false;
81 let mut arg_idx = match ldk_peer_port_set {
85 let network: Network = match env::args().skip(arg_idx).next().as_ref().map(String::as_str) {
86 Some("testnet") => Network::Testnet,
87 Some("regtest") => Network::Regtest,
88 Some("signet") => Network::Signet,
90 panic!("Unsupported network provided. Options are: `regtest`, `testnet`, and `signet`. Got {}", net);
92 None => Network::Testnet,
95 let ldk_announced_node_name = match env::args().skip(arg_idx + 1).next().as_ref() {
98 panic!("Node Alias can not be longer than 32 bytes");
101 let mut bytes = [0; 32];
102 bytes[..s.len()].copy_from_slice(s.as_bytes());
108 let mut ldk_announced_listen_addr = Vec::new();
110 match env::args().skip(arg_idx + 1).next().as_ref() {
111 Some(s) => match IpAddr::from_str(s) {
112 Ok(IpAddr::V4(a)) => {
113 ldk_announced_listen_addr
114 .push(NetAddress::IPv4 { addr: a.octets(), port: ldk_peer_listening_port });
117 Ok(IpAddr::V6(a)) => {
118 ldk_announced_listen_addr
119 .push(NetAddress::IPv6 { addr: a.octets(), port: ldk_peer_listening_port });
122 Err(_) => panic!("Failed to parse announced-listen-addr into an IP address"),
129 bitcoind_rpc_username,
130 bitcoind_rpc_password,
133 ldk_storage_dir_path,
134 ldk_peer_listening_port,
135 ldk_announced_listen_addr,
136 ldk_announced_node_name,
141 pub(crate) async fn poll_for_user_input<E: EventHandler>(
142 invoice_payer: Arc<InvoicePayer<E>>, peer_manager: Arc<PeerManager>,
143 channel_manager: Arc<ChannelManager>, keys_manager: Arc<KeysManager>,
144 inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage,
145 ldk_data_dir: String, network: Network,
147 println!("LDK startup successful. To view available commands: \"help\".");
148 println!("LDK logs are available at <your-supplied-ldk-data-dir-path>/.ldk/logs");
149 println!("Local Node ID is {}.", channel_manager.get_our_node_id());
150 let stdin = io::stdin();
151 let mut line_reader = stdin.lock().lines();
154 io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
155 let line = match line_reader.next() {
156 Some(l) => l.unwrap(),
159 let mut words = line.split_whitespace();
160 if let Some(word) = words.next() {
164 let peer_pubkey_and_ip_addr = words.next();
165 let channel_value_sat = words.next();
166 if peer_pubkey_and_ip_addr.is_none() || channel_value_sat.is_none() {
167 println!("ERROR: openchannel has 2 required arguments: `openchannel pubkey@host:port channel_amt_satoshis` [--public]");
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());
180 let chan_amt_sat: Result<u64, _> = channel_value_sat.unwrap().parse();
181 if chan_amt_sat.is_err() {
182 println!("ERROR: channel amount must be a number");
186 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
193 let announce_channel = match words.next() {
194 Some("--public") | Some("--public=true") => true,
195 Some("--public=false") => false,
197 println!("ERROR: invalid `--public` command format. Valid formats: `--public`, `--public=true` `--public=false`");
205 chan_amt_sat.unwrap(),
207 channel_manager.clone(),
211 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
212 let _ = disk::persist_channel_peer(
213 Path::new(&peer_data_path),
214 peer_pubkey_and_ip_addr,
219 let invoice_str = words.next();
220 if invoice_str.is_none() {
221 println!("ERROR: sendpayment requires an invoice: `sendpayment <invoice>`");
225 let invoice = match Invoice::from_str(invoice_str.unwrap()) {
228 println!("ERROR: invalid invoice: {:?}", e);
233 send_payment(&*invoice_payer, &invoice, outbound_payments.clone());
236 let dest_pubkey = match words.next() {
237 Some(dest) => match hex_utils::to_compressed_pubkey(dest) {
240 println!("ERROR: couldn't parse destination pubkey");
245 println!("ERROR: keysend requires a destination pubkey: `keysend <dest_pubkey> <amt_msat>`");
249 let amt_msat_str = match words.next() {
252 println!("ERROR: keysend requires an amount in millisatoshis: `keysend <dest_pubkey> <amt_msat>`");
256 let amt_msat: u64 = match amt_msat_str.parse() {
259 println!("ERROR: couldn't parse amount_msat: {}", e);
268 outbound_payments.clone(),
272 let amt_str = words.next();
273 if amt_str.is_none() {
274 println!("ERROR: getinvoice requires an amount in millisatoshis");
278 let amt_msat: Result<u64, _> = amt_str.unwrap().parse();
279 if amt_msat.is_err() {
280 println!("ERROR: getinvoice provided payment amount was not a number");
285 inbound_payments.clone(),
286 channel_manager.clone(),
287 keys_manager.clone(),
292 let peer_pubkey_and_ip_addr = words.next();
293 if peer_pubkey_and_ip_addr.is_none() {
294 println!("ERROR: connectpeer requires peer connection info: `connectpeer pubkey@host:port`");
297 let (pubkey, peer_addr) =
298 match parse_peer_info(peer_pubkey_and_ip_addr.unwrap().to_string()) {
301 println!("{:?}", e.into_inner().unwrap());
305 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
309 println!("SUCCESS: connected to peer {}", pubkey);
312 "listchannels" => list_channels(channel_manager.clone()),
314 list_payments(inbound_payments.clone(), outbound_payments.clone())
317 let channel_id_str = words.next();
318 if channel_id_str.is_none() {
319 println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id>`");
322 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
323 if channel_id_vec.is_none() {
324 println!("ERROR: couldn't parse channel_id as hex");
327 let mut channel_id = [0; 32];
328 channel_id.copy_from_slice(&channel_id_vec.unwrap());
329 close_channel(channel_id, channel_manager.clone());
331 "forceclosechannel" => {
332 let channel_id_str = words.next();
333 if channel_id_str.is_none() {
334 println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id>`");
337 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
338 if channel_id_vec.is_none() {
339 println!("ERROR: couldn't parse channel_id as hex");
342 let mut channel_id = [0; 32];
343 channel_id.copy_from_slice(&channel_id_vec.unwrap());
344 force_close_channel(channel_id, channel_manager.clone());
346 "nodeinfo" => node_info(channel_manager.clone(), peer_manager.clone()),
347 "listpeers" => list_peers(peer_manager.clone()),
349 const MSG_STARTPOS: usize = "signmessage".len() + 1;
350 if line.as_bytes().len() <= MSG_STARTPOS {
351 println!("ERROR: signmsg requires a message");
356 lightning::util::message_signing::sign(
357 &line.as_bytes()[MSG_STARTPOS..],
358 &keys_manager.get_node_secret(Recipient::Node).unwrap()
362 _ => println!("Unknown command. See `\"help\" for available commands."),
369 println!("openchannel pubkey@host:port <amt_satoshis>");
370 println!("sendpayment <invoice>");
371 println!("getinvoice <amt_millisatoshis>");
372 println!("connectpeer pubkey@host:port");
373 println!("listchannels");
374 println!("listpayments");
375 println!("closechannel <channel_id>");
376 println!("forceclosechannel <channel_id>");
377 println!("nodeinfo");
378 println!("listpeers");
379 println!("signmessage <message>");
382 fn node_info(channel_manager: Arc<ChannelManager>, peer_manager: Arc<PeerManager>) {
384 println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
385 let chans = channel_manager.list_channels();
386 println!("\t\t num_channels: {}", chans.len());
387 println!("\t\t num_usable_channels: {}", chans.iter().filter(|c| c.is_usable).count());
388 let local_balance_msat = chans
390 .map(|c| c.unspendable_punishment_reserve.unwrap_or(0) * 1000 + c.outbound_capacity_msat)
392 println!("\t\t local_balance_msat: {}", local_balance_msat);
393 println!("\t\t num_peers: {}", peer_manager.get_peer_node_ids().len());
397 fn list_peers(peer_manager: Arc<PeerManager>) {
399 for pubkey in peer_manager.get_peer_node_ids() {
400 println!("\t\t pubkey: {}", pubkey);
405 fn list_channels(channel_manager: Arc<ChannelManager>) {
407 for chan_info in channel_manager.list_channels() {
410 println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..]));
411 if let Some(funding_txo) = chan_info.funding_txo {
412 println!("\t\tfunding_txid: {},", funding_txo.txid);
415 "\t\tpeer_pubkey: {},",
416 hex_utils::hex_str(&chan_info.counterparty.node_id.serialize())
418 if let Some(id) = chan_info.short_channel_id {
419 println!("\t\tshort_channel_id: {},", id);
421 println!("\t\tis_confirmed_onchain: {},", chan_info.is_funding_locked);
422 println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
424 "\t\tlocal_balance_msat: {},",
425 chan_info.outbound_capacity_msat
426 + chan_info.unspendable_punishment_reserve.unwrap_or(0) * 1000
428 if chan_info.is_usable {
429 println!("\t\tavailable_balance_for_send_msat: {},", chan_info.outbound_capacity_msat);
430 println!("\t\tavailable_balance_for_recv_msat: {},", chan_info.inbound_capacity_msat);
432 println!("\t\tchannel_can_send_payments: {},", chan_info.is_usable);
433 println!("\t\tpublic: {},", chan_info.is_public);
439 fn list_payments(inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage) {
440 let inbound = inbound_payments.lock().unwrap();
441 let outbound = outbound_payments.lock().unwrap();
443 for (payment_hash, payment_info) in inbound.deref() {
446 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
447 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
448 println!("\t\thtlc_direction: inbound,");
450 "\t\thtlc_status: {},",
451 match payment_info.status {
452 HTLCStatus::Pending => "pending",
453 HTLCStatus::Succeeded => "succeeded",
454 HTLCStatus::Failed => "failed",
461 for (payment_hash, payment_info) in outbound.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: outbound,");
468 "\t\thtlc_status: {},",
469 match payment_info.status {
470 HTLCStatus::Pending => "pending",
471 HTLCStatus::Succeeded => "succeeded",
472 HTLCStatus::Failed => "failed",
481 pub(crate) async fn connect_peer_if_necessary(
482 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
483 ) -> Result<(), ()> {
484 for node_pubkey in peer_manager.get_peer_node_ids() {
485 if node_pubkey == pubkey {
489 let res = do_connect_peer(pubkey, peer_addr, peer_manager).await;
491 println!("ERROR: failed to connect to peer");
496 pub(crate) async fn do_connect_peer(
497 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
498 ) -> Result<(), ()> {
499 match lightning_net_tokio::connect_outbound(Arc::clone(&peer_manager), pubkey, peer_addr).await
501 Some(connection_closed_future) => {
502 let mut connection_closed_future = Box::pin(connection_closed_future);
504 match futures::poll!(&mut connection_closed_future) {
505 std::task::Poll::Ready(_) => {
508 std::task::Poll::Pending => {}
510 // Avoid blocking the tokio context by sleeping a bit
511 match peer_manager.get_peer_node_ids().iter().find(|id| **id == pubkey) {
512 Some(_) => return Ok(()),
513 None => tokio::time::sleep(Duration::from_millis(10)).await,
522 peer_pubkey: PublicKey, channel_amt_sat: u64, announced_channel: bool,
523 channel_manager: Arc<ChannelManager>,
524 ) -> Result<(), ()> {
525 let config = UserConfig {
526 peer_channel_config_limits: ChannelHandshakeLimits {
527 // lnd's max to_self_delay is 2016, so we want to be compatible.
528 their_to_self_delay: 2016,
531 channel_options: ChannelConfig { announced_channel, ..Default::default() },
535 match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, Some(config)) {
537 println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
541 println!("ERROR: failed to open channel: {:?}", e);
547 fn send_payment<E: EventHandler>(
548 invoice_payer: &InvoicePayer<E>, invoice: &Invoice, payment_storage: PaymentInfoStorage,
550 let status = match invoice_payer.pay_invoice(invoice) {
552 let payee_pubkey = invoice.recover_payee_pub_key();
553 let amt_msat = invoice.amount_milli_satoshis().unwrap();
554 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
558 Err(PaymentError::Invoice(e)) => {
559 println!("ERROR: invalid invoice: {}", e);
563 Err(PaymentError::Routing(e)) => {
564 println!("ERROR: failed to find route: {}", e.err);
568 Err(PaymentError::Sending(e)) => {
569 println!("ERROR: failed to send payment: {:?}", e);
574 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
575 let payment_secret = Some(invoice.payment_secret().clone());
577 let mut payments = payment_storage.lock().unwrap();
582 secret: payment_secret,
584 amt_msat: MillisatAmount(invoice.amount_milli_satoshis()),
589 fn keysend<E: EventHandler, K: KeysInterface>(
590 invoice_payer: &InvoicePayer<E>, payee_pubkey: PublicKey, amt_msat: u64, keys: &K,
591 payment_storage: PaymentInfoStorage,
593 let payment_preimage = keys.get_secure_random_bytes();
595 let status = match invoice_payer.pay_pubkey(
597 PaymentPreimage(payment_preimage),
602 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
606 Err(PaymentError::Invoice(e)) => {
607 println!("ERROR: invalid payee: {}", e);
611 Err(PaymentError::Routing(e)) => {
612 println!("ERROR: failed to find route: {}", e.err);
616 Err(PaymentError::Sending(e)) => {
617 println!("ERROR: failed to send payment: {:?}", e);
623 let mut payments = payment_storage.lock().unwrap();
625 PaymentHash(Sha256::hash(&payment_preimage).into_inner()),
630 amt_msat: MillisatAmount(Some(amt_msat)),
636 amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: Arc<ChannelManager>,
637 keys_manager: Arc<KeysManager>, network: Network,
639 let mut payments = payment_storage.lock().unwrap();
640 let currency = match network {
641 Network::Bitcoin => Currency::Bitcoin,
642 Network::Testnet => Currency::BitcoinTestnet,
643 Network::Regtest => Currency::Regtest,
644 Network::Signet => Currency::Signet,
646 let invoice = match utils::create_invoice_from_channelmanager(
651 "ldk-tutorial-node".to_string(),
654 println!("SUCCESS: generated invoice: {}", inv);
658 println!("ERROR: failed to create invoice: {:?}", e);
663 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
668 secret: Some(invoice.payment_secret().clone()),
669 status: HTLCStatus::Pending,
670 amt_msat: MillisatAmount(Some(amt_msat)),
675 fn close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
676 match channel_manager.close_channel(&channel_id) {
677 Ok(()) => println!("EVENT: initiating channel close"),
678 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
682 fn force_close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
683 match channel_manager.force_close_channel(&channel_id) {
684 Ok(()) => println!("EVENT: initiating channel force-close"),
685 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
689 pub(crate) fn parse_peer_info(
690 peer_pubkey_and_ip_addr: String,
691 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
692 let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
693 let pubkey = pubkey_and_addr.next();
694 let peer_addr_str = pubkey_and_addr.next();
695 if peer_addr_str.is_none() || peer_addr_str.is_none() {
696 return Err(std::io::Error::new(
697 std::io::ErrorKind::Other,
698 "ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`",
702 let peer_addr = peer_addr_str.unwrap().to_socket_addrs().map(|mut r| r.next());
703 if peer_addr.is_err() || peer_addr.as_ref().unwrap().is_none() {
704 return Err(std::io::Error::new(
705 std::io::ErrorKind::Other,
706 "ERROR: couldn't parse pubkey@host:port into a socket address",
710 let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
711 if pubkey.is_none() {
712 return Err(std::io::Error::new(
713 std::io::ErrorKind::Other,
714 "ERROR: unable to parse given pubkey for node",
718 Ok((pubkey.unwrap(), peer_addr.unwrap().unwrap()))