4 ChannelManager, FilesystemLogger, HTLCStatus, MillisatAmount, PaymentInfo, PaymentInfoStorage,
7 use bitcoin::network::constants::Network;
8 use bitcoin::secp256k1::key::PublicKey;
10 use lightning::chain::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::NetGraphMsgHandler;
15 use lightning::routing::router;
16 use lightning::routing::router::RouteHintHop;
17 use lightning::util::config::UserConfig;
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;
28 use tokio::sync::mpsc;
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: Option<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-listen-addr announced-node-name]`");
47 let bitcoind_rpc_info = env::args().skip(1).next().unwrap();
48 let bitcoind_rpc_info_parts: Vec<&str> = bitcoind_rpc_info.split("@").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[0].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[1].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()) {
73 Some(Err(e)) => panic!("{}", e),
75 ldk_peer_port_set = false;
80 let arg_idx = match ldk_peer_port_set {
84 let network: Network = match env::args().skip(arg_idx).next().as_ref().map(String::as_str) {
85 Some("testnet") => Network::Testnet,
86 Some("regtest") => Network::Regtest,
87 Some(_) => panic!("Unsupported network provided. Options are: `regtest`, `testnet`"),
88 None => Network::Testnet,
91 let ldk_announced_listen_addr = match env::args().skip(arg_idx + 1).next().as_ref() {
92 Some(s) => match IpAddr::from_str(s) {
93 Ok(IpAddr::V4(a)) => {
94 Some(NetAddress::IPv4 { addr: a.octets(), port: ldk_peer_listening_port })
96 Ok(IpAddr::V6(a)) => {
97 Some(NetAddress::IPv6 { addr: a.octets(), port: ldk_peer_listening_port })
99 Err(_) => panic!("Failed to parse announced-listen-addr into an IP address"),
104 let ldk_announced_node_name = match env::args().skip(arg_idx + 2).next().as_ref() {
107 panic!("Node Alias can not be longer than 32 bytes");
109 let mut bytes = [0; 32];
110 bytes[..s.len()].copy_from_slice(s.as_bytes());
117 bitcoind_rpc_username,
118 bitcoind_rpc_password,
121 ldk_storage_dir_path,
122 ldk_peer_listening_port,
123 ldk_announced_listen_addr,
124 ldk_announced_node_name,
129 pub(crate) async fn poll_for_user_input(
130 peer_manager: Arc<PeerManager>, channel_manager: Arc<ChannelManager>,
131 keys_manager: Arc<KeysManager>,
132 router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access + Send + Sync>, Arc<FilesystemLogger>>>,
133 inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage,
134 event_notifier: mpsc::Sender<()>, ldk_data_dir: String, logger: Arc<FilesystemLogger>,
137 println!("LDK startup successful. To view available commands: \"help\".");
138 println!("LDK logs are available at <your-supplied-ldk-data-dir-path>/.ldk/logs");
139 println!("Local Node ID is {}.", channel_manager.get_our_node_id());
140 let stdin = io::stdin();
142 io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
143 for line in stdin.lock().lines() {
144 let _ = event_notifier.try_send(());
145 let line = line.unwrap();
146 let mut words = line.split_whitespace();
147 if let Some(word) = words.next() {
151 let peer_pubkey_and_ip_addr = words.next();
152 let channel_value_sat = words.next();
153 if peer_pubkey_and_ip_addr.is_none() || channel_value_sat.is_none() {
154 println!("ERROR: openchannel has 2 required arguments: `openchannel pubkey@host:port channel_amt_satoshis` [--public]");
156 io::stdout().flush().unwrap();
159 let peer_pubkey_and_ip_addr = peer_pubkey_and_ip_addr.unwrap();
160 let (pubkey, peer_addr) =
161 match parse_peer_info(peer_pubkey_and_ip_addr.to_string()) {
164 println!("{:?}", e.into_inner().unwrap());
166 io::stdout().flush().unwrap();
171 let chan_amt_sat: Result<u64, _> = channel_value_sat.unwrap().parse();
172 if chan_amt_sat.is_err() {
173 println!("ERROR: channel amount must be a number");
175 io::stdout().flush().unwrap();
179 if connect_peer_if_necessary(
182 peer_manager.clone(),
183 event_notifier.clone(),
189 io::stdout().flush().unwrap();
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`");
199 io::stdout().flush().unwrap();
207 chan_amt_sat.unwrap(),
209 channel_manager.clone(),
213 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
214 let _ = disk::persist_channel_peer(
215 Path::new(&peer_data_path),
216 peer_pubkey_and_ip_addr,
221 let invoice_str = words.next();
222 if invoice_str.is_none() {
223 println!("ERROR: sendpayment requires an invoice: `sendpayment <invoice>`");
225 io::stdout().flush().unwrap();
229 let invoice = match Invoice::from_str(invoice_str.unwrap()) {
232 println!("ERROR: invalid invoice: {:?}", e);
234 io::stdout().flush().unwrap();
238 let mut route_hints = invoice.routes().clone();
239 let mut last_hops = Vec::new();
240 for hint in route_hints.drain(..) {
241 last_hops.push(hint[hint.len() - 1].clone());
244 let amt_pico_btc = invoice.amount_pico_btc();
245 if amt_pico_btc.is_none() {
246 println!("ERROR: invalid invoice: must contain amount to pay");
248 io::stdout().flush().unwrap();
251 let amt_msat = amt_pico_btc.unwrap() / 10;
253 let payee_pubkey = invoice.recover_payee_pub_key();
254 let final_cltv = invoice.min_final_cltv_expiry() as u32;
256 let mut payment_hash = PaymentHash([0; 32]);
257 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
259 let payment_secret = match invoice.payment_secret() {
261 let mut payment_secret = PaymentSecret([0; 32]);
262 payment_secret.0.copy_from_slice(&secret.0);
268 let invoice_features = match invoice.features() {
269 Some(feat) => Some(feat.clone()),
282 channel_manager.clone(),
283 outbound_payments.clone(),
288 let amt_str = words.next();
289 if amt_str.is_none() {
290 println!("ERROR: getinvoice requires an amount in millisatoshis");
292 io::stdout().flush().unwrap();
296 let amt_msat: Result<u64, _> = amt_str.unwrap().parse();
297 if amt_msat.is_err() {
298 println!("ERROR: getinvoice provided payment amount was not a number");
300 io::stdout().flush().unwrap();
305 inbound_payments.clone(),
306 channel_manager.clone(),
307 keys_manager.clone(),
312 let peer_pubkey_and_ip_addr = words.next();
313 if peer_pubkey_and_ip_addr.is_none() {
314 println!("ERROR: connectpeer requires peer connection info: `connectpeer pubkey@host:port`");
316 io::stdout().flush().unwrap();
319 let (pubkey, peer_addr) =
320 match parse_peer_info(peer_pubkey_and_ip_addr.unwrap().to_string()) {
323 println!("{:?}", e.into_inner().unwrap());
325 io::stdout().flush().unwrap();
329 if connect_peer_if_necessary(
332 peer_manager.clone(),
333 event_notifier.clone(),
338 println!("SUCCESS: connected to peer {}", pubkey);
341 "listchannels" => list_channels(channel_manager.clone()),
343 list_payments(inbound_payments.clone(), outbound_payments.clone())
346 let channel_id_str = words.next();
347 if channel_id_str.is_none() {
348 println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id>`");
350 io::stdout().flush().unwrap();
353 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
354 if channel_id_vec.is_none() {
355 println!("ERROR: couldn't parse channel_id as hex");
357 io::stdout().flush().unwrap();
360 let mut channel_id = [0; 32];
361 channel_id.copy_from_slice(&channel_id_vec.unwrap());
362 close_channel(channel_id, channel_manager.clone());
364 "forceclosechannel" => {
365 let channel_id_str = words.next();
366 if channel_id_str.is_none() {
367 println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id>`");
369 io::stdout().flush().unwrap();
372 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
373 if channel_id_vec.is_none() {
374 println!("ERROR: couldn't parse channel_id as hex");
376 io::stdout().flush().unwrap();
379 let mut channel_id = [0; 32];
380 channel_id.copy_from_slice(&channel_id_vec.unwrap());
381 force_close_channel(channel_id, channel_manager.clone());
383 "nodeinfo" => node_info(channel_manager.clone(), peer_manager.clone()),
384 "listpeers" => list_peers(peer_manager.clone()),
385 _ => println!("Unknown command. See `\"help\" for available commands."),
389 io::stdout().flush().unwrap();
394 println!("openchannel pubkey@host:port <channel_amt_satoshis>");
395 println!("sendpayment <invoice>");
396 println!("getinvoice <amt_in_millisatoshis>");
397 println!("connectpeer pubkey@host:port");
398 println!("listchannels");
399 println!("listpayments");
400 println!("closechannel <channel_id>");
401 println!("forceclosechannel <channel_id>");
404 fn node_info(channel_manager: Arc<ChannelManager>, peer_manager: Arc<PeerManager>) {
406 println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
407 println!("\t\t num_channels: {}", channel_manager.list_channels().len());
408 println!("\t\t num_usable_channels: {}", channel_manager.list_usable_channels().len());
409 println!("\t\t num_peers: {}", peer_manager.get_peer_node_ids().len());
413 fn list_peers(peer_manager: Arc<PeerManager>) {
415 for pubkey in peer_manager.get_peer_node_ids() {
416 println!("\t\t pubkey: {}", pubkey);
421 fn list_channels(channel_manager: Arc<ChannelManager>) {
423 for chan_info in channel_manager.list_channels() {
426 println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..]));
427 if let Some(funding_txo) = chan_info.funding_txo {
428 println!("\t\tfunding_txid: {},", funding_txo.txid);
431 "\t\tpeer_pubkey: {},",
432 hex_utils::hex_str(&chan_info.remote_network_id.serialize())
434 if let Some(id) = chan_info.short_channel_id {
435 println!("\t\tshort_channel_id: {},", id);
437 println!("\t\tis_confirmed_onchain: {},", chan_info.is_funding_locked);
438 println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
439 if chan_info.is_usable {
440 println!("\t\tavailable_balance_for_send_msat: {},", chan_info.outbound_capacity_msat);
441 println!("\t\tavailable_balance_for_recv_msat: {},", chan_info.inbound_capacity_msat);
443 println!("\t\tchannel_can_send_payments: {},", chan_info.is_usable);
449 fn list_payments(inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage) {
450 let inbound = inbound_payments.lock().unwrap();
451 let outbound = outbound_payments.lock().unwrap();
453 for (payment_hash, payment_info) in inbound.deref() {
456 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
457 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
458 println!("\t\thtlc_direction: inbound,");
460 "\t\thtlc_status: {},",
461 match payment_info.status {
462 HTLCStatus::Pending => "pending",
463 HTLCStatus::Succeeded => "succeeded",
464 HTLCStatus::Failed => "failed",
471 for (payment_hash, payment_info) in outbound.deref() {
474 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
475 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
476 println!("\t\thtlc_direction: outbound,");
478 "\t\thtlc_status: {},",
479 match payment_info.status {
480 HTLCStatus::Pending => "pending",
481 HTLCStatus::Succeeded => "succeeded",
482 HTLCStatus::Failed => "failed",
491 pub(crate) async fn connect_peer_if_necessary(
492 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
493 event_notifier: mpsc::Sender<()>,
494 ) -> Result<(), ()> {
495 for node_pubkey in peer_manager.get_peer_node_ids() {
496 if node_pubkey == pubkey {
500 match lightning_net_tokio::connect_outbound(
501 Arc::clone(&peer_manager),
508 Some(conn_closed_fut) => {
509 let mut closed_fut_box = Box::pin(conn_closed_fut);
510 let mut peer_connected = false;
511 while !peer_connected {
512 match futures::poll!(&mut closed_fut_box) {
513 std::task::Poll::Ready(_) => {
514 println!("ERROR: Peer disconnected before we finished the handshake");
517 std::task::Poll::Pending => {}
519 for node_pubkey in peer_manager.get_peer_node_ids() {
520 if node_pubkey == pubkey {
521 peer_connected = true;
524 // Avoid blocking the tokio context by sleeping a bit
525 tokio::time::sleep(Duration::from_millis(10)).await;
529 println!("ERROR: failed to connect to peer");
537 peer_pubkey: PublicKey, channel_amt_sat: u64, announce_channel: bool,
538 channel_manager: Arc<ChannelManager>,
539 ) -> Result<(), ()> {
540 let mut config = UserConfig::default();
541 if announce_channel {
542 config.channel_options.announced_channel = true;
544 // lnd's max to_self_delay is 2016, so we want to be compatible.
545 config.peer_channel_config_limits.their_to_self_delay = 2016;
546 match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, None) {
548 println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
552 println!("ERROR: failed to open channel: {:?}", e);
559 payee: PublicKey, amt_msat: u64, final_cltv: u32, payment_hash: PaymentHash,
560 payment_secret: Option<PaymentSecret>, payee_features: Option<InvoiceFeatures>,
561 route_hints: Vec<RouteHintHop>,
562 router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access + Send + Sync>, Arc<FilesystemLogger>>>,
563 channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
564 logger: Arc<FilesystemLogger>,
566 let network_graph = router.network_graph.read().unwrap();
567 let first_hops = channel_manager.list_usable_channels();
568 let payer_pubkey = channel_manager.get_our_node_id();
570 let route = router::get_route(
575 Some(&first_hops.iter().collect::<Vec<_>>()),
576 &route_hints.iter().collect::<Vec<_>>(),
581 if let Err(e) = route {
582 println!("ERROR: failed to find route: {}", e.err);
585 let status = match channel_manager.send_payment(&route.unwrap(), payment_hash, &payment_secret)
588 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee);
592 println!("ERROR: failed to send payment: {:?}", e);
596 let mut payments = payment_storage.lock().unwrap();
601 secret: payment_secret,
603 amt_msat: MillisatAmount(Some(amt_msat)),
609 amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: Arc<ChannelManager>,
610 keys_manager: Arc<KeysManager>, network: Network,
612 let mut payments = payment_storage.lock().unwrap();
613 let currency = match network {
614 Network::Bitcoin => Currency::Bitcoin,
615 Network::Testnet => Currency::BitcoinTestnet,
616 Network::Regtest => Currency::Regtest,
617 Network::Signet => panic!("Signet unsupported"),
619 let invoice = match utils::create_invoice_from_channelmanager(
624 "ldk-tutorial-node".to_string(),
627 println!("SUCCESS: generated invoice: {}", inv);
631 println!("ERROR: failed to create invoice: {:?}", e);
636 let mut payment_hash = PaymentHash([0; 32]);
637 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
642 // We can't add payment secrets to invoices until we support features in invoices.
643 // Otherwise lnd errors with "destination hop doesn't understand payment addresses"
644 // (for context, lnd calls payment secrets "payment addresses").
645 secret: Some(invoice.payment_secret().unwrap().clone()),
646 status: HTLCStatus::Pending,
647 amt_msat: MillisatAmount(Some(amt_msat)),
652 fn close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
653 match channel_manager.close_channel(&channel_id) {
654 Ok(()) => println!("EVENT: initiating channel close"),
655 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
659 fn force_close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
660 match channel_manager.force_close_channel(&channel_id) {
661 Ok(()) => println!("EVENT: initiating channel force-close"),
662 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
666 pub(crate) fn parse_peer_info(
667 peer_pubkey_and_ip_addr: String,
668 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
669 let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
670 let pubkey = pubkey_and_addr.next();
671 let peer_addr_str = pubkey_and_addr.next();
672 if peer_addr_str.is_none() || peer_addr_str.is_none() {
673 return Err(std::io::Error::new(
674 std::io::ErrorKind::Other,
675 "ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`",
679 let peer_addr = peer_addr_str.unwrap().to_socket_addrs().map(|mut r| r.next());
680 if peer_addr.is_err() || peer_addr.as_ref().unwrap().is_none() {
681 return Err(std::io::Error::new(
682 std::io::ErrorKind::Other,
683 "ERROR: couldn't parse pubkey@host:port into a socket address",
687 let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
688 if pubkey.is_none() {
689 return Err(std::io::Error::new(
690 std::io::ErrorKind::Other,
691 "ERROR: unable to parse given pubkey for node",
695 Ok((pubkey.unwrap(), peer_addr.unwrap().unwrap()))