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;
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: Option<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-listen-addr announced-node-name]`");
46 let bitcoind_rpc_info = env::args().skip(1).next().unwrap();
47 let bitcoind_rpc_info_parts: Vec<&str> = bitcoind_rpc_info.split("@").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[0].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[1].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()) {
72 Some(Err(e)) => panic!("{}", e),
74 ldk_peer_port_set = false;
79 let arg_idx = match ldk_peer_port_set {
83 let network: Network = match env::args().skip(arg_idx).next().as_ref().map(String::as_str) {
84 Some("testnet") => Network::Testnet,
85 Some("regtest") => Network::Regtest,
86 Some(_) => panic!("Unsupported network provided. Options are: `regtest`, `testnet`"),
87 None => Network::Testnet,
90 let ldk_announced_listen_addr = match env::args().skip(arg_idx + 1).next().as_ref() {
91 Some(s) => match IpAddr::from_str(s) {
92 Ok(IpAddr::V4(a)) => {
93 Some(NetAddress::IPv4 { addr: a.octets(), port: ldk_peer_listening_port })
95 Ok(IpAddr::V6(a)) => {
96 Some(NetAddress::IPv6 { addr: a.octets(), port: ldk_peer_listening_port })
98 Err(_) => panic!("Failed to parse announced-listen-addr into an IP address"),
103 let ldk_announced_node_name = match env::args().skip(arg_idx + 2).next().as_ref() {
106 panic!("Node Alias can not be longer than 32 bytes");
108 let mut bytes = [0; 32];
109 bytes[..s.len()].copy_from_slice(s.as_bytes());
116 bitcoind_rpc_username,
117 bitcoind_rpc_password,
120 ldk_storage_dir_path,
121 ldk_peer_listening_port,
122 ldk_announced_listen_addr,
123 ldk_announced_node_name,
128 pub(crate) async fn poll_for_user_input(
129 peer_manager: Arc<PeerManager>, channel_manager: Arc<ChannelManager>,
130 keys_manager: Arc<KeysManager>,
131 router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access + Send + Sync>, Arc<FilesystemLogger>>>,
132 inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage,
133 ldk_data_dir: String, logger: Arc<FilesystemLogger>, network: Network,
135 println!("LDK startup successful. To view available commands: \"help\".");
136 println!("LDK logs are available at <your-supplied-ldk-data-dir-path>/.ldk/logs");
137 println!("Local Node ID is {}.", channel_manager.get_our_node_id());
138 let stdin = io::stdin();
140 io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
141 for line in stdin.lock().lines() {
142 let line = line.unwrap();
143 let mut words = line.split_whitespace();
144 if let Some(word) = words.next() {
148 let peer_pubkey_and_ip_addr = words.next();
149 let channel_value_sat = words.next();
150 if peer_pubkey_and_ip_addr.is_none() || channel_value_sat.is_none() {
151 println!("ERROR: openchannel has 2 required arguments: `openchannel pubkey@host:port channel_amt_satoshis` [--public]");
153 io::stdout().flush().unwrap();
156 let peer_pubkey_and_ip_addr = peer_pubkey_and_ip_addr.unwrap();
157 let (pubkey, peer_addr) =
158 match parse_peer_info(peer_pubkey_and_ip_addr.to_string()) {
161 println!("{:?}", e.into_inner().unwrap());
163 io::stdout().flush().unwrap();
168 let chan_amt_sat: Result<u64, _> = channel_value_sat.unwrap().parse();
169 if chan_amt_sat.is_err() {
170 println!("ERROR: channel amount must be a number");
172 io::stdout().flush().unwrap();
176 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
181 io::stdout().flush().unwrap();
185 let announce_channel = match words.next() {
186 Some("--public") | Some("--public=true") => true,
187 Some("--public=false") => false,
189 println!("ERROR: invalid `--public` command format. Valid formats: `--public`, `--public=true` `--public=false`");
191 io::stdout().flush().unwrap();
199 chan_amt_sat.unwrap(),
201 channel_manager.clone(),
205 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
206 let _ = disk::persist_channel_peer(
207 Path::new(&peer_data_path),
208 peer_pubkey_and_ip_addr,
213 let invoice_str = words.next();
214 if invoice_str.is_none() {
215 println!("ERROR: sendpayment requires an invoice: `sendpayment <invoice>`");
217 io::stdout().flush().unwrap();
221 let invoice = match Invoice::from_str(invoice_str.unwrap()) {
224 println!("ERROR: invalid invoice: {:?}", e);
226 io::stdout().flush().unwrap();
230 let mut route_hints = invoice.routes().clone();
231 let mut last_hops = Vec::new();
232 for hint in route_hints.drain(..) {
233 last_hops.push(hint[hint.len() - 1].clone());
236 let amt_pico_btc = invoice.amount_pico_btc();
237 if amt_pico_btc.is_none() {
238 println!("ERROR: invalid invoice: must contain amount to pay");
240 io::stdout().flush().unwrap();
243 let amt_msat = amt_pico_btc.unwrap() / 10;
245 let payee_pubkey = invoice.recover_payee_pub_key();
246 let final_cltv = invoice.min_final_cltv_expiry() as u32;
248 let mut payment_hash = PaymentHash([0; 32]);
249 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
251 let payment_secret = match invoice.payment_secret() {
253 let mut payment_secret = PaymentSecret([0; 32]);
254 payment_secret.0.copy_from_slice(&secret.0);
260 let invoice_features = match invoice.features() {
261 Some(feat) => Some(feat.clone()),
274 channel_manager.clone(),
275 outbound_payments.clone(),
280 let amt_str = words.next();
281 if amt_str.is_none() {
282 println!("ERROR: getinvoice requires an amount in millisatoshis");
284 io::stdout().flush().unwrap();
288 let amt_msat: Result<u64, _> = amt_str.unwrap().parse();
289 if amt_msat.is_err() {
290 println!("ERROR: getinvoice provided payment amount was not a number");
292 io::stdout().flush().unwrap();
297 inbound_payments.clone(),
298 channel_manager.clone(),
299 keys_manager.clone(),
304 let peer_pubkey_and_ip_addr = words.next();
305 if peer_pubkey_and_ip_addr.is_none() {
306 println!("ERROR: connectpeer requires peer connection info: `connectpeer pubkey@host:port`");
308 io::stdout().flush().unwrap();
311 let (pubkey, peer_addr) =
312 match parse_peer_info(peer_pubkey_and_ip_addr.unwrap().to_string()) {
315 println!("{:?}", e.into_inner().unwrap());
317 io::stdout().flush().unwrap();
321 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
325 println!("SUCCESS: connected to peer {}", pubkey);
328 "listchannels" => list_channels(channel_manager.clone()),
330 list_payments(inbound_payments.clone(), outbound_payments.clone())
333 let channel_id_str = words.next();
334 if channel_id_str.is_none() {
335 println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id>`");
337 io::stdout().flush().unwrap();
340 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
341 if channel_id_vec.is_none() {
342 println!("ERROR: couldn't parse channel_id as hex");
344 io::stdout().flush().unwrap();
347 let mut channel_id = [0; 32];
348 channel_id.copy_from_slice(&channel_id_vec.unwrap());
349 close_channel(channel_id, channel_manager.clone());
351 "forceclosechannel" => {
352 let channel_id_str = words.next();
353 if channel_id_str.is_none() {
354 println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id>`");
356 io::stdout().flush().unwrap();
359 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
360 if channel_id_vec.is_none() {
361 println!("ERROR: couldn't parse channel_id as hex");
363 io::stdout().flush().unwrap();
366 let mut channel_id = [0; 32];
367 channel_id.copy_from_slice(&channel_id_vec.unwrap());
368 force_close_channel(channel_id, channel_manager.clone());
370 "nodeinfo" => node_info(channel_manager.clone(), peer_manager.clone()),
371 "listpeers" => list_peers(peer_manager.clone()),
372 _ => println!("Unknown command. See `\"help\" for available commands."),
376 io::stdout().flush().unwrap();
381 println!("openchannel pubkey@host:port <amt_satoshis>");
382 println!("sendpayment <invoice>");
383 println!("getinvoice <amt_millisatoshis>");
384 println!("connectpeer pubkey@host:port");
385 println!("listchannels");
386 println!("listpayments");
387 println!("closechannel <channel_id>");
388 println!("forceclosechannel <channel_id>");
389 println!("nodeinfo");
390 println!("listpeers");
393 fn node_info(channel_manager: Arc<ChannelManager>, peer_manager: Arc<PeerManager>) {
395 println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
396 println!("\t\t num_channels: {}", channel_manager.list_channels().len());
397 println!("\t\t num_usable_channels: {}", channel_manager.list_usable_channels().len());
398 println!("\t\t num_peers: {}", peer_manager.get_peer_node_ids().len());
402 fn list_peers(peer_manager: Arc<PeerManager>) {
404 for pubkey in peer_manager.get_peer_node_ids() {
405 println!("\t\t pubkey: {}", pubkey);
410 fn list_channels(channel_manager: Arc<ChannelManager>) {
412 for chan_info in channel_manager.list_channels() {
415 println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..]));
416 if let Some(funding_txo) = chan_info.funding_txo {
417 println!("\t\tfunding_txid: {},", funding_txo.txid);
420 "\t\tpeer_pubkey: {},",
421 hex_utils::hex_str(&chan_info.remote_network_id.serialize())
423 if let Some(id) = chan_info.short_channel_id {
424 println!("\t\tshort_channel_id: {},", id);
426 println!("\t\tis_confirmed_onchain: {},", chan_info.is_funding_locked);
427 println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
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 match lightning_net_tokio::connect_outbound(Arc::clone(&peer_manager), pubkey, peer_addr).await
491 Some(conn_closed_fut) => {
492 let mut closed_fut_box = Box::pin(conn_closed_fut);
493 let mut peer_connected = false;
494 while !peer_connected {
495 match futures::poll!(&mut closed_fut_box) {
496 std::task::Poll::Ready(_) => {
497 println!("ERROR: Peer disconnected before we finished the handshake");
500 std::task::Poll::Pending => {}
502 for node_pubkey in peer_manager.get_peer_node_ids() {
503 if node_pubkey == pubkey {
504 peer_connected = true;
507 // Avoid blocking the tokio context by sleeping a bit
508 tokio::time::sleep(Duration::from_millis(10)).await;
512 println!("ERROR: failed to connect to peer");
520 peer_pubkey: PublicKey, channel_amt_sat: u64, announce_channel: bool,
521 channel_manager: Arc<ChannelManager>,
522 ) -> Result<(), ()> {
523 let mut config = UserConfig::default();
524 if announce_channel {
525 config.channel_options.announced_channel = true;
527 // lnd's max to_self_delay is 2016, so we want to be compatible.
528 config.peer_channel_config_limits.their_to_self_delay = 2016;
529 match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, Some(config)) {
531 println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
535 println!("ERROR: failed to open channel: {:?}", e);
542 payee: PublicKey, amt_msat: u64, final_cltv: u32, payment_hash: PaymentHash,
543 payment_secret: Option<PaymentSecret>, payee_features: Option<InvoiceFeatures>,
544 route_hints: Vec<RouteHintHop>,
545 router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access + Send + Sync>, Arc<FilesystemLogger>>>,
546 channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
547 logger: Arc<FilesystemLogger>,
549 let network_graph = router.network_graph.read().unwrap();
550 let first_hops = channel_manager.list_usable_channels();
551 let payer_pubkey = channel_manager.get_our_node_id();
553 let route = router::get_route(
558 Some(&first_hops.iter().collect::<Vec<_>>()),
559 &route_hints.iter().collect::<Vec<_>>(),
564 if let Err(e) = route {
565 println!("ERROR: failed to find route: {}", e.err);
568 let status = match channel_manager.send_payment(&route.unwrap(), payment_hash, &payment_secret)
571 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee);
575 println!("ERROR: failed to send payment: {:?}", e);
579 let mut payments = payment_storage.lock().unwrap();
584 secret: payment_secret,
586 amt_msat: MillisatAmount(Some(amt_msat)),
592 amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: Arc<ChannelManager>,
593 keys_manager: Arc<KeysManager>, network: Network,
595 let mut payments = payment_storage.lock().unwrap();
596 let currency = match network {
597 Network::Bitcoin => Currency::Bitcoin,
598 Network::Testnet => Currency::BitcoinTestnet,
599 Network::Regtest => Currency::Regtest,
600 Network::Signet => panic!("Signet unsupported"),
602 let invoice = match utils::create_invoice_from_channelmanager(
607 "ldk-tutorial-node".to_string(),
610 println!("SUCCESS: generated invoice: {}", inv);
614 println!("ERROR: failed to create invoice: {:?}", e);
619 let mut payment_hash = PaymentHash([0; 32]);
620 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
625 // We can't add payment secrets to invoices until we support features in invoices.
626 // Otherwise lnd errors with "destination hop doesn't understand payment addresses"
627 // (for context, lnd calls payment secrets "payment addresses").
628 secret: Some(invoice.payment_secret().unwrap().clone()),
629 status: HTLCStatus::Pending,
630 amt_msat: MillisatAmount(Some(amt_msat)),
635 fn close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
636 match channel_manager.close_channel(&channel_id) {
637 Ok(()) => println!("EVENT: initiating channel close"),
638 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
642 fn force_close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
643 match channel_manager.force_close_channel(&channel_id) {
644 Ok(()) => println!("EVENT: initiating channel force-close"),
645 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
649 pub(crate) fn parse_peer_info(
650 peer_pubkey_and_ip_addr: String,
651 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
652 let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
653 let pubkey = pubkey_and_addr.next();
654 let peer_addr_str = pubkey_and_addr.next();
655 if peer_addr_str.is_none() || peer_addr_str.is_none() {
656 return Err(std::io::Error::new(
657 std::io::ErrorKind::Other,
658 "ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`",
662 let peer_addr = peer_addr_str.unwrap().to_socket_addrs().map(|mut r| r.next());
663 if peer_addr.is_err() || peer_addr.as_ref().unwrap().is_none() {
664 return Err(std::io::Error::new(
665 std::io::ErrorKind::Other,
666 "ERROR: couldn't parse pubkey@host:port into a socket address",
670 let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
671 if pubkey.is_none() {
672 return Err(std::io::Error::new(
673 std::io::ErrorKind::Other,
674 "ERROR: unable to parse given pubkey for node",
678 Ok((pubkey.unwrap(), peer_addr.unwrap().unwrap()))