4 ChannelManager, FilesystemLogger, HTLCStatus, MillisatAmount, PaymentInfo, PaymentInfoStorage,
7 use bitcoin::hashes::Hash;
8 use bitcoin::network::constants::Network;
9 use bitcoin::secp256k1::key::PublicKey;
11 use lightning::chain::keysinterface::KeysManager;
12 use lightning::ln::features::InvoiceFeatures;
13 use lightning::ln::msgs::NetAddress;
14 use lightning::ln::{PaymentHash, PaymentSecret};
15 use lightning::routing::network_graph::NetGraphMsgHandler;
16 use lightning::routing::router;
17 use lightning::routing::router::RouteHint;
18 use lightning::util::config::{ChannelConfig, ChannelHandshakeLimits, UserConfig};
19 use lightning_invoice::{utils, Currency, Invoice};
22 use std::io::{BufRead, Write};
23 use std::net::{IpAddr, SocketAddr, ToSocketAddrs};
26 use std::str::FromStr;
28 use std::time::Duration;
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 ldk_data_dir: String, logger: Arc<FilesystemLogger>, network: Network,
136 println!("LDK startup successful. To view available commands: \"help\".");
137 println!("LDK logs are available at <your-supplied-ldk-data-dir-path>/.ldk/logs");
138 println!("Local Node ID is {}.", channel_manager.get_our_node_id());
139 let stdin = io::stdin();
141 io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
142 for line in stdin.lock().lines() {
143 let line = line.unwrap();
144 let mut words = line.split_whitespace();
145 if let Some(word) = words.next() {
149 let peer_pubkey_and_ip_addr = words.next();
150 let channel_value_sat = words.next();
151 if peer_pubkey_and_ip_addr.is_none() || channel_value_sat.is_none() {
152 println!("ERROR: openchannel has 2 required arguments: `openchannel pubkey@host:port channel_amt_satoshis` [--public]");
154 io::stdout().flush().unwrap();
157 let peer_pubkey_and_ip_addr = peer_pubkey_and_ip_addr.unwrap();
158 let (pubkey, peer_addr) =
159 match parse_peer_info(peer_pubkey_and_ip_addr.to_string()) {
162 println!("{:?}", e.into_inner().unwrap());
164 io::stdout().flush().unwrap();
169 let chan_amt_sat: Result<u64, _> = channel_value_sat.unwrap().parse();
170 if chan_amt_sat.is_err() {
171 println!("ERROR: channel amount must be a number");
173 io::stdout().flush().unwrap();
177 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
182 io::stdout().flush().unwrap();
186 let announce_channel = match words.next() {
187 Some("--public") | Some("--public=true") => true,
188 Some("--public=false") => false,
190 println!("ERROR: invalid `--public` command format. Valid formats: `--public`, `--public=true` `--public=false`");
192 io::stdout().flush().unwrap();
200 chan_amt_sat.unwrap(),
202 channel_manager.clone(),
206 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
207 let _ = disk::persist_channel_peer(
208 Path::new(&peer_data_path),
209 peer_pubkey_and_ip_addr,
214 let invoice_str = words.next();
215 if invoice_str.is_none() {
216 println!("ERROR: sendpayment requires an invoice: `sendpayment <invoice>`");
218 io::stdout().flush().unwrap();
222 let invoice = match Invoice::from_str(invoice_str.unwrap()) {
225 println!("ERROR: invalid invoice: {:?}", e);
227 io::stdout().flush().unwrap();
231 let last_hops = invoice.route_hints();
233 let amt_pico_btc = invoice.amount_pico_btc();
234 if amt_pico_btc.is_none() {
235 println!("ERROR: invalid invoice: must contain amount to pay");
237 io::stdout().flush().unwrap();
240 let amt_msat = amt_pico_btc.unwrap() / 10;
242 let payee_pubkey = invoice.recover_payee_pub_key();
243 let final_cltv = invoice.min_final_cltv_expiry() as u32;
244 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
245 let payment_secret = invoice.payment_secret().cloned();
246 let invoice_features = invoice.features().cloned();
257 channel_manager.clone(),
258 outbound_payments.clone(),
263 let amt_str = words.next();
264 if amt_str.is_none() {
265 println!("ERROR: getinvoice requires an amount in millisatoshis");
267 io::stdout().flush().unwrap();
271 let amt_msat: Result<u64, _> = amt_str.unwrap().parse();
272 if amt_msat.is_err() {
273 println!("ERROR: getinvoice provided payment amount was not a number");
275 io::stdout().flush().unwrap();
280 inbound_payments.clone(),
281 channel_manager.clone(),
282 keys_manager.clone(),
287 let peer_pubkey_and_ip_addr = words.next();
288 if peer_pubkey_and_ip_addr.is_none() {
289 println!("ERROR: connectpeer requires peer connection info: `connectpeer pubkey@host:port`");
291 io::stdout().flush().unwrap();
294 let (pubkey, peer_addr) =
295 match parse_peer_info(peer_pubkey_and_ip_addr.unwrap().to_string()) {
298 println!("{:?}", e.into_inner().unwrap());
300 io::stdout().flush().unwrap();
304 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
308 println!("SUCCESS: connected to peer {}", pubkey);
311 "listchannels" => list_channels(channel_manager.clone()),
313 list_payments(inbound_payments.clone(), outbound_payments.clone())
316 let channel_id_str = words.next();
317 if channel_id_str.is_none() {
318 println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id>`");
320 io::stdout().flush().unwrap();
323 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
324 if channel_id_vec.is_none() {
325 println!("ERROR: couldn't parse channel_id as hex");
327 io::stdout().flush().unwrap();
330 let mut channel_id = [0; 32];
331 channel_id.copy_from_slice(&channel_id_vec.unwrap());
332 close_channel(channel_id, channel_manager.clone());
334 "forceclosechannel" => {
335 let channel_id_str = words.next();
336 if channel_id_str.is_none() {
337 println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id>`");
339 io::stdout().flush().unwrap();
342 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
343 if channel_id_vec.is_none() {
344 println!("ERROR: couldn't parse channel_id as hex");
346 io::stdout().flush().unwrap();
349 let mut channel_id = [0; 32];
350 channel_id.copy_from_slice(&channel_id_vec.unwrap());
351 force_close_channel(channel_id, channel_manager.clone());
353 "nodeinfo" => node_info(channel_manager.clone(), peer_manager.clone()),
354 "listpeers" => list_peers(peer_manager.clone()),
355 _ => println!("Unknown command. See `\"help\" for available commands."),
359 io::stdout().flush().unwrap();
364 println!("openchannel pubkey@host:port <amt_satoshis>");
365 println!("sendpayment <invoice>");
366 println!("getinvoice <amt_millisatoshis>");
367 println!("connectpeer pubkey@host:port");
368 println!("listchannels");
369 println!("listpayments");
370 println!("closechannel <channel_id>");
371 println!("forceclosechannel <channel_id>");
372 println!("nodeinfo");
373 println!("listpeers");
376 fn node_info(channel_manager: Arc<ChannelManager>, peer_manager: Arc<PeerManager>) {
378 println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
379 println!("\t\t num_channels: {}", channel_manager.list_channels().len());
380 println!("\t\t num_usable_channels: {}", channel_manager.list_usable_channels().len());
381 println!("\t\t num_peers: {}", peer_manager.get_peer_node_ids().len());
385 fn list_peers(peer_manager: Arc<PeerManager>) {
387 for pubkey in peer_manager.get_peer_node_ids() {
388 println!("\t\t pubkey: {}", pubkey);
393 fn list_channels(channel_manager: Arc<ChannelManager>) {
395 for chan_info in channel_manager.list_channels() {
398 println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..]));
399 if let Some(funding_txo) = chan_info.funding_txo {
400 println!("\t\tfunding_txid: {},", funding_txo.txid);
403 "\t\tpeer_pubkey: {},",
404 hex_utils::hex_str(&chan_info.counterparty.node_id.serialize())
406 if let Some(id) = chan_info.short_channel_id {
407 println!("\t\tshort_channel_id: {},", id);
409 println!("\t\tis_confirmed_onchain: {},", chan_info.is_funding_locked);
410 println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
411 if chan_info.is_usable {
412 println!("\t\tavailable_balance_for_send_msat: {},", chan_info.outbound_capacity_msat);
413 println!("\t\tavailable_balance_for_recv_msat: {},", chan_info.inbound_capacity_msat);
415 println!("\t\tchannel_can_send_payments: {},", chan_info.is_usable);
416 println!("\t\tpublic: {},", chan_info.is_public);
422 fn list_payments(inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage) {
423 let inbound = inbound_payments.lock().unwrap();
424 let outbound = outbound_payments.lock().unwrap();
426 for (payment_hash, payment_info) in inbound.deref() {
429 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
430 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
431 println!("\t\thtlc_direction: inbound,");
433 "\t\thtlc_status: {},",
434 match payment_info.status {
435 HTLCStatus::Pending => "pending",
436 HTLCStatus::Succeeded => "succeeded",
437 HTLCStatus::Failed => "failed",
444 for (payment_hash, payment_info) in outbound.deref() {
447 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
448 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
449 println!("\t\thtlc_direction: outbound,");
451 "\t\thtlc_status: {},",
452 match payment_info.status {
453 HTLCStatus::Pending => "pending",
454 HTLCStatus::Succeeded => "succeeded",
455 HTLCStatus::Failed => "failed",
464 pub(crate) async fn connect_peer_if_necessary(
465 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
466 ) -> Result<(), ()> {
467 for node_pubkey in peer_manager.get_peer_node_ids() {
468 if node_pubkey == pubkey {
472 match lightning_net_tokio::connect_outbound(Arc::clone(&peer_manager), pubkey, peer_addr).await
474 Some(connection_closed_future) => {
475 let mut connection_closed_future = Box::pin(connection_closed_future);
477 match futures::poll!(&mut connection_closed_future) {
478 std::task::Poll::Ready(_) => {
479 println!("ERROR: Peer disconnected before we finished the handshake");
482 std::task::Poll::Pending => {}
484 // Avoid blocking the tokio context by sleeping a bit
485 match peer_manager.get_peer_node_ids().iter().find(|id| **id == pubkey) {
487 None => tokio::time::sleep(Duration::from_millis(10)).await,
492 println!("ERROR: failed to connect to peer");
500 peer_pubkey: PublicKey, channel_amt_sat: u64, announced_channel: bool,
501 channel_manager: Arc<ChannelManager>,
502 ) -> Result<(), ()> {
503 let config = UserConfig {
504 peer_channel_config_limits: ChannelHandshakeLimits {
505 // lnd's max to_self_delay is 2016, so we want to be compatible.
506 their_to_self_delay: 2016,
509 channel_options: ChannelConfig { announced_channel, ..Default::default() },
513 match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, Some(config)) {
515 println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
519 println!("ERROR: failed to open channel: {:?}", e);
526 payee: PublicKey, amt_msat: u64, final_cltv: u32, payment_hash: PaymentHash,
527 payment_secret: Option<PaymentSecret>, payee_features: Option<InvoiceFeatures>,
528 route_hints: Vec<&RouteHint>,
529 router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access + Send + Sync>, Arc<FilesystemLogger>>>,
530 channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
531 logger: Arc<FilesystemLogger>,
533 let network_graph = router.network_graph.read().unwrap();
534 let first_hops = channel_manager.list_usable_channels();
535 let payer_pubkey = channel_manager.get_our_node_id();
537 let route = router::get_route(
542 Some(&first_hops.iter().collect::<Vec<_>>()),
548 if let Err(e) = route {
549 println!("ERROR: failed to find route: {}", e.err);
552 let status = match channel_manager.send_payment(&route.unwrap(), payment_hash, &payment_secret)
555 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee);
559 println!("ERROR: failed to send payment: {:?}", e);
563 let mut payments = payment_storage.lock().unwrap();
568 secret: payment_secret,
570 amt_msat: MillisatAmount(Some(amt_msat)),
576 amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: Arc<ChannelManager>,
577 keys_manager: Arc<KeysManager>, network: Network,
579 let mut payments = payment_storage.lock().unwrap();
580 let currency = match network {
581 Network::Bitcoin => Currency::Bitcoin,
582 Network::Testnet => Currency::BitcoinTestnet,
583 Network::Regtest => Currency::Regtest,
584 Network::Signet => panic!("Signet unsupported"),
586 let invoice = match utils::create_invoice_from_channelmanager(
591 "ldk-tutorial-node".to_string(),
594 println!("SUCCESS: generated invoice: {}", inv);
598 println!("ERROR: failed to create invoice: {:?}", e);
603 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
608 secret: invoice.payment_secret().cloned(),
609 status: HTLCStatus::Pending,
610 amt_msat: MillisatAmount(Some(amt_msat)),
615 fn close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
616 match channel_manager.close_channel(&channel_id) {
617 Ok(()) => println!("EVENT: initiating channel close"),
618 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
622 fn force_close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
623 match channel_manager.force_close_channel(&channel_id) {
624 Ok(()) => println!("EVENT: initiating channel force-close"),
625 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
629 pub(crate) fn parse_peer_info(
630 peer_pubkey_and_ip_addr: String,
631 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
632 let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
633 let pubkey = pubkey_and_addr.next();
634 let peer_addr_str = pubkey_and_addr.next();
635 if peer_addr_str.is_none() || peer_addr_str.is_none() {
636 return Err(std::io::Error::new(
637 std::io::ErrorKind::Other,
638 "ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`",
642 let peer_addr = peer_addr_str.unwrap().to_socket_addrs().map(|mut r| r.next());
643 if peer_addr.is_err() || peer_addr.as_ref().unwrap().is_none() {
644 return Err(std::io::Error::new(
645 std::io::ErrorKind::Other,
646 "ERROR: couldn't parse pubkey@host:port into a socket address",
650 let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
651 if pubkey.is_none() {
652 return Err(std::io::Error::new(
653 std::io::ErrorKind::Other,
654 "ERROR: unable to parse given pubkey for node",
658 Ok((pubkey.unwrap(), peer_addr.unwrap().unwrap()))