4 ChannelManager, FilesystemLogger, HTLCStatus, InvoicePayer, MillisatAmount, PaymentInfo,
5 PaymentInfoStorage, PeerManager,
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::msgs::NetAddress;
12 use lightning::ln::PaymentHash;
13 use lightning::routing::network_graph::NetworkGraph;
14 use lightning::routing::router;
15 use lightning::routing::router::{Payee, RouteParameters};
16 use lightning::routing::scorer::Scorer;
17 use lightning::util::config::{ChannelConfig, ChannelHandshakeLimits, UserConfig};
18 use lightning::util::events::EventHandler;
19 use lightning_invoice::payment::PaymentError;
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;
28 use std::sync::{Arc, Mutex};
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.rsplitn(2, "@").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[1].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[0].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<E: EventHandler>(
144 invoice_payer: Arc<InvoicePayer<E>>, peer_manager: Arc<PeerManager>,
145 channel_manager: Arc<ChannelManager>, keys_manager: Arc<KeysManager>,
146 network_graph: Arc<NetworkGraph>, scorer: Arc<Mutex<Scorer>>,
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();
246 send_payment(&*invoice_payer, &invoice, outbound_payments.clone());
249 let dest_pubkey = match words.next() {
250 Some(dest) => match hex_utils::to_compressed_pubkey(dest) {
253 println!("ERROR: couldn't parse destination pubkey");
255 io::stdout().flush().unwrap();
260 println!("ERROR: keysend requires a destination pubkey: `keysend <dest_pubkey> <amt_msat>`");
262 io::stdout().flush().unwrap();
266 let amt_msat_str = match words.next() {
269 println!("ERROR: keysend requires an amount in millisatoshis: `keysend <dest_pubkey> <amt_msat>`");
272 io::stdout().flush().unwrap();
276 let amt_msat: u64 = match amt_msat_str.parse() {
279 println!("ERROR: couldn't parse amount_msat: {}", e);
281 io::stdout().flush().unwrap();
288 network_graph.clone(),
289 channel_manager.clone(),
290 outbound_payments.clone(),
296 let amt_str = words.next();
297 if amt_str.is_none() {
298 println!("ERROR: getinvoice requires an amount in millisatoshis");
300 io::stdout().flush().unwrap();
304 let amt_msat: Result<u64, _> = amt_str.unwrap().parse();
305 if amt_msat.is_err() {
306 println!("ERROR: getinvoice provided payment amount was not a number");
308 io::stdout().flush().unwrap();
313 inbound_payments.clone(),
314 channel_manager.clone(),
315 keys_manager.clone(),
320 let peer_pubkey_and_ip_addr = words.next();
321 if peer_pubkey_and_ip_addr.is_none() {
322 println!("ERROR: connectpeer requires peer connection info: `connectpeer pubkey@host:port`");
324 io::stdout().flush().unwrap();
327 let (pubkey, peer_addr) =
328 match parse_peer_info(peer_pubkey_and_ip_addr.unwrap().to_string()) {
331 println!("{:?}", e.into_inner().unwrap());
333 io::stdout().flush().unwrap();
337 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
341 println!("SUCCESS: connected to peer {}", pubkey);
344 "listchannels" => list_channels(channel_manager.clone()),
346 list_payments(inbound_payments.clone(), outbound_payments.clone())
349 let channel_id_str = words.next();
350 if channel_id_str.is_none() {
351 println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id>`");
353 io::stdout().flush().unwrap();
356 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
357 if channel_id_vec.is_none() {
358 println!("ERROR: couldn't parse channel_id as hex");
360 io::stdout().flush().unwrap();
363 let mut channel_id = [0; 32];
364 channel_id.copy_from_slice(&channel_id_vec.unwrap());
365 close_channel(channel_id, channel_manager.clone());
367 "forceclosechannel" => {
368 let channel_id_str = words.next();
369 if channel_id_str.is_none() {
370 println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id>`");
372 io::stdout().flush().unwrap();
375 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
376 if channel_id_vec.is_none() {
377 println!("ERROR: couldn't parse channel_id as hex");
379 io::stdout().flush().unwrap();
382 let mut channel_id = [0; 32];
383 channel_id.copy_from_slice(&channel_id_vec.unwrap());
384 force_close_channel(channel_id, channel_manager.clone());
386 "nodeinfo" => node_info(channel_manager.clone(), peer_manager.clone()),
387 "listpeers" => list_peers(peer_manager.clone()),
389 const MSG_STARTPOS: usize = "signmsg".len() + 1;
390 if line.as_bytes().len() <= MSG_STARTPOS {
391 println!("ERROR: signmsg requires a message");
393 io::stdout().flush().unwrap();
398 lightning::util::message_signing::sign(
399 &line.as_bytes()[MSG_STARTPOS..],
400 &keys_manager.get_node_secret()
404 io::stdout().flush().unwrap();
406 _ => println!("Unknown command. See `\"help\" for available commands."),
410 io::stdout().flush().unwrap();
415 println!("openchannel pubkey@host:port <amt_satoshis>");
416 println!("sendpayment <invoice>");
417 println!("getinvoice <amt_millisatoshis>");
418 println!("connectpeer pubkey@host:port");
419 println!("listchannels");
420 println!("listpayments");
421 println!("closechannel <channel_id>");
422 println!("forceclosechannel <channel_id>");
423 println!("nodeinfo");
424 println!("listpeers");
425 println!("signmessage <message>");
428 fn node_info(channel_manager: Arc<ChannelManager>, peer_manager: Arc<PeerManager>) {
430 println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
431 println!("\t\t num_channels: {}", channel_manager.list_channels().len());
432 println!("\t\t num_usable_channels: {}", channel_manager.list_usable_channels().len());
433 println!("\t\t num_peers: {}", peer_manager.get_peer_node_ids().len());
437 fn list_peers(peer_manager: Arc<PeerManager>) {
439 for pubkey in peer_manager.get_peer_node_ids() {
440 println!("\t\t pubkey: {}", pubkey);
445 fn list_channels(channel_manager: Arc<ChannelManager>) {
447 for chan_info in channel_manager.list_channels() {
450 println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..]));
451 if let Some(funding_txo) = chan_info.funding_txo {
452 println!("\t\tfunding_txid: {},", funding_txo.txid);
455 "\t\tpeer_pubkey: {},",
456 hex_utils::hex_str(&chan_info.counterparty.node_id.serialize())
458 if let Some(id) = chan_info.short_channel_id {
459 println!("\t\tshort_channel_id: {},", id);
461 println!("\t\tis_confirmed_onchain: {},", chan_info.is_funding_locked);
462 println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
464 "\t\tlocal_balance_msat: {},",
465 chan_info.outbound_capacity_msat
466 + chan_info.unspendable_punishment_reserve.unwrap_or(0) * 1000
468 if chan_info.is_usable {
469 println!("\t\tavailable_balance_for_send_msat: {},", chan_info.outbound_capacity_msat);
470 println!("\t\tavailable_balance_for_recv_msat: {},", chan_info.inbound_capacity_msat);
472 println!("\t\tchannel_can_send_payments: {},", chan_info.is_usable);
473 println!("\t\tpublic: {},", chan_info.is_public);
479 fn list_payments(inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage) {
480 let inbound = inbound_payments.lock().unwrap();
481 let outbound = outbound_payments.lock().unwrap();
483 for (payment_hash, payment_info) in inbound.deref() {
486 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
487 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
488 println!("\t\thtlc_direction: inbound,");
490 "\t\thtlc_status: {},",
491 match payment_info.status {
492 HTLCStatus::Pending => "pending",
493 HTLCStatus::Succeeded => "succeeded",
494 HTLCStatus::Failed => "failed",
501 for (payment_hash, payment_info) in outbound.deref() {
504 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
505 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
506 println!("\t\thtlc_direction: outbound,");
508 "\t\thtlc_status: {},",
509 match payment_info.status {
510 HTLCStatus::Pending => "pending",
511 HTLCStatus::Succeeded => "succeeded",
512 HTLCStatus::Failed => "failed",
521 pub(crate) async fn connect_peer_if_necessary(
522 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
523 ) -> Result<(), ()> {
524 for node_pubkey in peer_manager.get_peer_node_ids() {
525 if node_pubkey == pubkey {
529 match lightning_net_tokio::connect_outbound(Arc::clone(&peer_manager), pubkey, peer_addr).await
531 Some(connection_closed_future) => {
532 let mut connection_closed_future = Box::pin(connection_closed_future);
534 match futures::poll!(&mut connection_closed_future) {
535 std::task::Poll::Ready(_) => {
536 println!("ERROR: Peer disconnected before we finished the handshake");
539 std::task::Poll::Pending => {}
541 // Avoid blocking the tokio context by sleeping a bit
542 match peer_manager.get_peer_node_ids().iter().find(|id| **id == pubkey) {
544 None => tokio::time::sleep(Duration::from_millis(10)).await,
549 println!("ERROR: failed to connect to peer");
557 peer_pubkey: PublicKey, channel_amt_sat: u64, announced_channel: bool,
558 channel_manager: Arc<ChannelManager>,
559 ) -> Result<(), ()> {
560 let config = UserConfig {
561 peer_channel_config_limits: ChannelHandshakeLimits {
562 // lnd's max to_self_delay is 2016, so we want to be compatible.
563 their_to_self_delay: 2016,
566 channel_options: ChannelConfig { announced_channel, ..Default::default() },
570 match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, Some(config)) {
572 println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
576 println!("ERROR: failed to open channel: {:?}", e);
582 fn send_payment<E: EventHandler>(
583 invoice_payer: &InvoicePayer<E>, invoice: &Invoice, payment_storage: PaymentInfoStorage,
585 let status = match invoice_payer.pay_invoice(invoice) {
587 let payee_pubkey = invoice.recover_payee_pub_key();
588 let amt_msat = invoice.amount_milli_satoshis().unwrap();
589 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
593 Err(PaymentError::Invoice(e)) => {
594 println!("ERROR: invalid invoice: {}", e);
598 Err(PaymentError::Routing(e)) => {
599 println!("ERROR: failed to find route: {}", e.err);
603 Err(PaymentError::Sending(e)) => {
604 println!("ERROR: failed to send payment: {:?}", e);
609 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
610 let payment_secret = Some(invoice.payment_secret().clone());
612 let mut payments = payment_storage.lock().unwrap();
617 secret: payment_secret,
619 amt_msat: MillisatAmount(invoice.amount_milli_satoshis()),
625 payee_pubkey: PublicKey, amt_msat: u64, network_graph: Arc<NetworkGraph>,
626 channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
627 logger: Arc<FilesystemLogger>, scorer: Arc<Mutex<Scorer>>,
629 let first_hops = channel_manager.list_usable_channels();
630 let payer_pubkey = channel_manager.get_our_node_id();
632 let payee = Payee::for_keysend(payee_pubkey);
633 let params = RouteParameters { payee, final_value_msat: amt_msat, final_cltv_expiry_delta: 40 };
635 let route = match router::find_route(
639 Some(&first_hops.iter().collect::<Vec<_>>()),
641 &scorer.lock().unwrap(),
645 println!("ERROR: failed to find route: {}", e.err);
650 let mut payments = payment_storage.lock().unwrap();
651 let payment_hash = channel_manager.send_spontaneous_payment(&route, None).unwrap().0;
657 status: HTLCStatus::Pending,
658 amt_msat: MillisatAmount(Some(amt_msat)),
664 amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: Arc<ChannelManager>,
665 keys_manager: Arc<KeysManager>, network: Network,
667 let mut payments = payment_storage.lock().unwrap();
668 let currency = match network {
669 Network::Bitcoin => Currency::Bitcoin,
670 Network::Testnet => Currency::BitcoinTestnet,
671 Network::Regtest => Currency::Regtest,
672 Network::Signet => panic!("Signet unsupported"),
674 let invoice = match utils::create_invoice_from_channelmanager(
679 "ldk-tutorial-node".to_string(),
682 println!("SUCCESS: generated invoice: {}", inv);
686 println!("ERROR: failed to create invoice: {:?}", e);
691 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
696 secret: Some(invoice.payment_secret().clone()),
697 status: HTLCStatus::Pending,
698 amt_msat: MillisatAmount(Some(amt_msat)),
703 fn close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
704 match channel_manager.close_channel(&channel_id) {
705 Ok(()) => println!("EVENT: initiating channel close"),
706 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
710 fn force_close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
711 match channel_manager.force_close_channel(&channel_id) {
712 Ok(()) => println!("EVENT: initiating channel force-close"),
713 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
717 pub(crate) fn parse_peer_info(
718 peer_pubkey_and_ip_addr: String,
719 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
720 let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
721 let pubkey = pubkey_and_addr.next();
722 let peer_addr_str = pubkey_and_addr.next();
723 if peer_addr_str.is_none() || peer_addr_str.is_none() {
724 return Err(std::io::Error::new(
725 std::io::ErrorKind::Other,
726 "ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`",
730 let peer_addr = peer_addr_str.unwrap().to_socket_addrs().map(|mut r| r.next());
731 if peer_addr.is_err() || peer_addr.as_ref().unwrap().is_none() {
732 return Err(std::io::Error::new(
733 std::io::ErrorKind::Other,
734 "ERROR: couldn't parse pubkey@host:port into a socket address",
738 let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
739 if pubkey.is_none() {
740 return Err(std::io::Error::new(
741 std::io::ErrorKind::Other,
742 "ERROR: unable to parse given pubkey for node",
746 Ok((pubkey.unwrap(), peer_addr.unwrap().unwrap()))