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();
154 let mut line_reader = stdin.lock().lines();
157 io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
158 let line = match line_reader.next() {
159 Some(l) => l.unwrap(),
162 let mut words = line.split_whitespace();
163 if let Some(word) = words.next() {
167 let peer_pubkey_and_ip_addr = words.next();
168 let channel_value_sat = words.next();
169 if peer_pubkey_and_ip_addr.is_none() || channel_value_sat.is_none() {
170 println!("ERROR: openchannel has 2 required arguments: `openchannel pubkey@host:port channel_amt_satoshis` [--public]");
173 let peer_pubkey_and_ip_addr = peer_pubkey_and_ip_addr.unwrap();
174 let (pubkey, peer_addr) =
175 match parse_peer_info(peer_pubkey_and_ip_addr.to_string()) {
178 println!("{:?}", e.into_inner().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");
189 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
196 let announce_channel = match words.next() {
197 Some("--public") | Some("--public=true") => true,
198 Some("--public=false") => false,
200 println!("ERROR: invalid `--public` command format. Valid formats: `--public`, `--public=true` `--public=false`");
208 chan_amt_sat.unwrap(),
210 channel_manager.clone(),
214 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
215 let _ = disk::persist_channel_peer(
216 Path::new(&peer_data_path),
217 peer_pubkey_and_ip_addr,
222 let invoice_str = words.next();
223 if invoice_str.is_none() {
224 println!("ERROR: sendpayment requires an invoice: `sendpayment <invoice>`");
228 let invoice = match Invoice::from_str(invoice_str.unwrap()) {
231 println!("ERROR: invalid invoice: {:?}", e);
236 send_payment(&*invoice_payer, &invoice, outbound_payments.clone());
239 let dest_pubkey = match words.next() {
240 Some(dest) => match hex_utils::to_compressed_pubkey(dest) {
243 println!("ERROR: couldn't parse destination pubkey");
248 println!("ERROR: keysend requires a destination pubkey: `keysend <dest_pubkey> <amt_msat>`");
252 let amt_msat_str = match words.next() {
255 println!("ERROR: keysend requires an amount in millisatoshis: `keysend <dest_pubkey> <amt_msat>`");
260 let amt_msat: u64 = match amt_msat_str.parse() {
263 println!("ERROR: couldn't parse amount_msat: {}", e);
270 network_graph.clone(),
271 channel_manager.clone(),
272 outbound_payments.clone(),
278 let amt_str = words.next();
279 if amt_str.is_none() {
280 println!("ERROR: getinvoice requires an amount in millisatoshis");
284 let amt_msat: Result<u64, _> = amt_str.unwrap().parse();
285 if amt_msat.is_err() {
286 println!("ERROR: getinvoice provided payment amount was not a number");
291 inbound_payments.clone(),
292 channel_manager.clone(),
293 keys_manager.clone(),
298 let peer_pubkey_and_ip_addr = words.next();
299 if peer_pubkey_and_ip_addr.is_none() {
300 println!("ERROR: connectpeer requires peer connection info: `connectpeer pubkey@host:port`");
303 let (pubkey, peer_addr) =
304 match parse_peer_info(peer_pubkey_and_ip_addr.unwrap().to_string()) {
307 println!("{:?}", e.into_inner().unwrap());
311 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
315 println!("SUCCESS: connected to peer {}", pubkey);
318 "listchannels" => list_channels(channel_manager.clone()),
320 list_payments(inbound_payments.clone(), outbound_payments.clone())
323 let channel_id_str = words.next();
324 if channel_id_str.is_none() {
325 println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id>`");
328 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
329 if channel_id_vec.is_none() {
330 println!("ERROR: couldn't parse channel_id as hex");
333 let mut channel_id = [0; 32];
334 channel_id.copy_from_slice(&channel_id_vec.unwrap());
335 close_channel(channel_id, channel_manager.clone());
337 "forceclosechannel" => {
338 let channel_id_str = words.next();
339 if channel_id_str.is_none() {
340 println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id>`");
343 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
344 if channel_id_vec.is_none() {
345 println!("ERROR: couldn't parse channel_id as hex");
348 let mut channel_id = [0; 32];
349 channel_id.copy_from_slice(&channel_id_vec.unwrap());
350 force_close_channel(channel_id, channel_manager.clone());
352 "nodeinfo" => node_info(channel_manager.clone(), peer_manager.clone()),
353 "listpeers" => list_peers(peer_manager.clone()),
355 const MSG_STARTPOS: usize = "signmsg".len() + 1;
356 if line.as_bytes().len() <= MSG_STARTPOS {
357 println!("ERROR: signmsg requires a message");
362 lightning::util::message_signing::sign(
363 &line.as_bytes()[MSG_STARTPOS..],
364 &keys_manager.get_node_secret()
368 _ => println!("Unknown command. See `\"help\" for available commands."),
375 println!("openchannel pubkey@host:port <amt_satoshis>");
376 println!("sendpayment <invoice>");
377 println!("getinvoice <amt_millisatoshis>");
378 println!("connectpeer pubkey@host:port");
379 println!("listchannels");
380 println!("listpayments");
381 println!("closechannel <channel_id>");
382 println!("forceclosechannel <channel_id>");
383 println!("nodeinfo");
384 println!("listpeers");
385 println!("signmessage <message>");
388 fn node_info(channel_manager: Arc<ChannelManager>, peer_manager: Arc<PeerManager>) {
390 println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
391 let chans = channel_manager.list_channels();
392 println!("\t\t num_channels: {}", chans.len());
393 println!("\t\t num_usable_channels: {}", chans.iter().filter(|c| c.is_usable).count());
394 let local_balance_msat = chans
396 .map(|c| c.unspendable_punishment_reserve.unwrap_or(0) * 1000 + c.outbound_capacity_msat)
398 println!("\t\t local_balance_msat: {}", local_balance_msat);
399 println!("\t\t num_peers: {}", peer_manager.get_peer_node_ids().len());
403 fn list_peers(peer_manager: Arc<PeerManager>) {
405 for pubkey in peer_manager.get_peer_node_ids() {
406 println!("\t\t pubkey: {}", pubkey);
411 fn list_channels(channel_manager: Arc<ChannelManager>) {
413 for chan_info in channel_manager.list_channels() {
416 println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..]));
417 if let Some(funding_txo) = chan_info.funding_txo {
418 println!("\t\tfunding_txid: {},", funding_txo.txid);
421 "\t\tpeer_pubkey: {},",
422 hex_utils::hex_str(&chan_info.counterparty.node_id.serialize())
424 if let Some(id) = chan_info.short_channel_id {
425 println!("\t\tshort_channel_id: {},", id);
427 println!("\t\tis_confirmed_onchain: {},", chan_info.is_funding_locked);
428 println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
430 "\t\tlocal_balance_msat: {},",
431 chan_info.outbound_capacity_msat
432 + chan_info.unspendable_punishment_reserve.unwrap_or(0) * 1000
434 if chan_info.is_usable {
435 println!("\t\tavailable_balance_for_send_msat: {},", chan_info.outbound_capacity_msat);
436 println!("\t\tavailable_balance_for_recv_msat: {},", chan_info.inbound_capacity_msat);
438 println!("\t\tchannel_can_send_payments: {},", chan_info.is_usable);
439 println!("\t\tpublic: {},", chan_info.is_public);
445 fn list_payments(inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage) {
446 let inbound = inbound_payments.lock().unwrap();
447 let outbound = outbound_payments.lock().unwrap();
449 for (payment_hash, payment_info) in inbound.deref() {
452 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
453 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
454 println!("\t\thtlc_direction: inbound,");
456 "\t\thtlc_status: {},",
457 match payment_info.status {
458 HTLCStatus::Pending => "pending",
459 HTLCStatus::Succeeded => "succeeded",
460 HTLCStatus::Failed => "failed",
467 for (payment_hash, payment_info) in outbound.deref() {
470 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
471 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
472 println!("\t\thtlc_direction: outbound,");
474 "\t\thtlc_status: {},",
475 match payment_info.status {
476 HTLCStatus::Pending => "pending",
477 HTLCStatus::Succeeded => "succeeded",
478 HTLCStatus::Failed => "failed",
487 pub(crate) async fn connect_peer_if_necessary(
488 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
489 ) -> Result<(), ()> {
490 for node_pubkey in peer_manager.get_peer_node_ids() {
491 if node_pubkey == pubkey {
495 match lightning_net_tokio::connect_outbound(Arc::clone(&peer_manager), pubkey, peer_addr).await
497 Some(connection_closed_future) => {
498 let mut connection_closed_future = Box::pin(connection_closed_future);
500 match futures::poll!(&mut connection_closed_future) {
501 std::task::Poll::Ready(_) => {
502 println!("ERROR: Peer disconnected before we finished the handshake");
505 std::task::Poll::Pending => {}
507 // Avoid blocking the tokio context by sleeping a bit
508 match peer_manager.get_peer_node_ids().iter().find(|id| **id == pubkey) {
510 None => tokio::time::sleep(Duration::from_millis(10)).await,
515 println!("ERROR: failed to connect to peer");
523 peer_pubkey: PublicKey, channel_amt_sat: u64, announced_channel: bool,
524 channel_manager: Arc<ChannelManager>,
525 ) -> Result<(), ()> {
526 let config = UserConfig {
527 peer_channel_config_limits: ChannelHandshakeLimits {
528 // lnd's max to_self_delay is 2016, so we want to be compatible.
529 their_to_self_delay: 2016,
532 channel_options: ChannelConfig { announced_channel, ..Default::default() },
536 match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, Some(config)) {
538 println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
542 println!("ERROR: failed to open channel: {:?}", e);
548 fn send_payment<E: EventHandler>(
549 invoice_payer: &InvoicePayer<E>, invoice: &Invoice, payment_storage: PaymentInfoStorage,
551 let status = match invoice_payer.pay_invoice(invoice) {
553 let payee_pubkey = invoice.recover_payee_pub_key();
554 let amt_msat = invoice.amount_milli_satoshis().unwrap();
555 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
559 Err(PaymentError::Invoice(e)) => {
560 println!("ERROR: invalid invoice: {}", e);
564 Err(PaymentError::Routing(e)) => {
565 println!("ERROR: failed to find route: {}", e.err);
569 Err(PaymentError::Sending(e)) => {
570 println!("ERROR: failed to send payment: {:?}", e);
575 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
576 let payment_secret = Some(invoice.payment_secret().clone());
578 let mut payments = payment_storage.lock().unwrap();
583 secret: payment_secret,
585 amt_msat: MillisatAmount(invoice.amount_milli_satoshis()),
591 payee_pubkey: PublicKey, amt_msat: u64, network_graph: Arc<NetworkGraph>,
592 channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
593 logger: Arc<FilesystemLogger>, scorer: Arc<Mutex<Scorer>>,
595 let first_hops = channel_manager.list_usable_channels();
596 let payer_pubkey = channel_manager.get_our_node_id();
598 let payee = Payee::for_keysend(payee_pubkey);
599 let params = RouteParameters { payee, final_value_msat: amt_msat, final_cltv_expiry_delta: 40 };
601 let route = match router::find_route(
605 Some(&first_hops.iter().collect::<Vec<_>>()),
607 &scorer.lock().unwrap(),
611 println!("ERROR: failed to find route: {}", e.err);
616 let mut payments = payment_storage.lock().unwrap();
617 let payment_hash = channel_manager.send_spontaneous_payment(&route, None).unwrap().0;
623 status: HTLCStatus::Pending,
624 amt_msat: MillisatAmount(Some(amt_msat)),
630 amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: Arc<ChannelManager>,
631 keys_manager: Arc<KeysManager>, network: Network,
633 let mut payments = payment_storage.lock().unwrap();
634 let currency = match network {
635 Network::Bitcoin => Currency::Bitcoin,
636 Network::Testnet => Currency::BitcoinTestnet,
637 Network::Regtest => Currency::Regtest,
638 Network::Signet => panic!("Signet unsupported"),
640 let invoice = match utils::create_invoice_from_channelmanager(
645 "ldk-tutorial-node".to_string(),
648 println!("SUCCESS: generated invoice: {}", inv);
652 println!("ERROR: failed to create invoice: {:?}", e);
657 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
662 secret: Some(invoice.payment_secret().clone()),
663 status: HTLCStatus::Pending,
664 amt_msat: MillisatAmount(Some(amt_msat)),
669 fn close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
670 match channel_manager.close_channel(&channel_id) {
671 Ok(()) => println!("EVENT: initiating channel close"),
672 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
676 fn force_close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
677 match channel_manager.force_close_channel(&channel_id) {
678 Ok(()) => println!("EVENT: initiating channel force-close"),
679 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
683 pub(crate) fn parse_peer_info(
684 peer_pubkey_and_ip_addr: String,
685 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
686 let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
687 let pubkey = pubkey_and_addr.next();
688 let peer_addr_str = pubkey_and_addr.next();
689 if peer_addr_str.is_none() || peer_addr_str.is_none() {
690 return Err(std::io::Error::new(
691 std::io::ErrorKind::Other,
692 "ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`",
696 let peer_addr = peer_addr_str.unwrap().to_socket_addrs().map(|mut r| r.next());
697 if peer_addr.is_err() || peer_addr.as_ref().unwrap().is_none() {
698 return Err(std::io::Error::new(
699 std::io::ErrorKind::Other,
700 "ERROR: couldn't parse pubkey@host:port into a socket address",
704 let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
705 if pubkey.is_none() {
706 return Err(std::io::Error::new(
707 std::io::ErrorKind::Other,
708 "ERROR: unable to parse given pubkey for node",
712 Ok((pubkey.unwrap(), peer_addr.unwrap().unwrap()))