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::{PaymentHash, PaymentSecret};
13 use lightning::routing::network_graph::NetGraphMsgHandler;
14 use lightning::routing::router;
15 use lightning::routing::router::RouteHintHop;
16 use lightning::util::config::UserConfig;
17 use lightning_invoice::{utils, Currency, Invoice};
20 use std::io::{BufRead, Write};
21 use std::net::{SocketAddr, ToSocketAddrs};
24 use std::str::FromStr;
26 use std::time::Duration;
27 use tokio::sync::mpsc;
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) network: Network,
39 pub(crate) fn parse_startup_args() -> Result<LdkUserInfo, ()> {
40 if env::args().len() < 3 {
41 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]`");
44 let bitcoind_rpc_info = env::args().skip(1).next().unwrap();
45 let bitcoind_rpc_info_parts: Vec<&str> = bitcoind_rpc_info.split("@").collect();
46 if bitcoind_rpc_info_parts.len() != 2 {
47 println!("ERROR: bad bitcoind RPC URL provided");
50 let rpc_user_and_password: Vec<&str> = bitcoind_rpc_info_parts[0].split(":").collect();
51 if rpc_user_and_password.len() != 2 {
52 println!("ERROR: bad bitcoind RPC username/password combo provided");
55 let bitcoind_rpc_username = rpc_user_and_password[0].to_string();
56 let bitcoind_rpc_password = rpc_user_and_password[1].to_string();
57 let bitcoind_rpc_path: Vec<&str> = bitcoind_rpc_info_parts[1].split(":").collect();
58 if bitcoind_rpc_path.len() != 2 {
59 println!("ERROR: bad bitcoind RPC path provided");
62 let bitcoind_rpc_host = bitcoind_rpc_path[0].to_string();
63 let bitcoind_rpc_port = bitcoind_rpc_path[1].parse::<u16>().unwrap();
65 let ldk_storage_dir_path = env::args().skip(2).next().unwrap();
67 let mut ldk_peer_port_set = true;
68 let ldk_peer_listening_port: u16 = match env::args().skip(3).next().map(|p| p.parse()) {
70 Some(Err(e)) => panic!("{}", e),
72 ldk_peer_port_set = false;
77 let arg_idx = match ldk_peer_port_set {
81 let network: Network = match env::args().skip(arg_idx).next().as_ref().map(String::as_str) {
82 Some("testnet") => Network::Testnet,
83 Some("regtest") => Network::Regtest,
84 Some(_) => panic!("Unsupported network provided. Options are: `regtest`, `testnet`"),
85 None => Network::Testnet,
88 bitcoind_rpc_username,
89 bitcoind_rpc_password,
93 ldk_peer_listening_port,
98 pub(crate) async fn poll_for_user_input(
99 peer_manager: Arc<PeerManager>, channel_manager: Arc<ChannelManager>,
100 keys_manager: Arc<KeysManager>,
101 router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access + Send + Sync>, Arc<FilesystemLogger>>>,
102 inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage,
103 event_notifier: mpsc::Sender<()>, ldk_data_dir: String, logger: Arc<FilesystemLogger>,
106 println!("LDK startup successful. To view available commands: \"help\".");
107 println!("LDK logs are available at <your-supplied-ldk-data-dir-path>/.ldk/logs");
108 println!("Local Node ID is {}.", channel_manager.get_our_node_id());
109 let stdin = io::stdin();
111 io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
112 for line in stdin.lock().lines() {
113 let _ = event_notifier.try_send(());
114 let line = line.unwrap();
115 let mut words = line.split_whitespace();
116 if let Some(word) = words.next() {
120 let peer_pubkey_and_ip_addr = words.next();
121 let channel_value_sat = words.next();
122 if peer_pubkey_and_ip_addr.is_none() || channel_value_sat.is_none() {
123 println!("ERROR: openchannel has 2 required arguments: `openchannel pubkey@host:port channel_amt_satoshis` [--public]");
125 io::stdout().flush().unwrap();
128 let peer_pubkey_and_ip_addr = peer_pubkey_and_ip_addr.unwrap();
129 let (pubkey, peer_addr) =
130 match parse_peer_info(peer_pubkey_and_ip_addr.to_string()) {
133 println!("{:?}", e.into_inner().unwrap());
135 io::stdout().flush().unwrap();
140 let chan_amt_sat: Result<u64, _> = channel_value_sat.unwrap().parse();
141 if chan_amt_sat.is_err() {
142 println!("ERROR: channel amount must be a number");
144 io::stdout().flush().unwrap();
148 if connect_peer_if_necessary(
151 peer_manager.clone(),
152 event_notifier.clone(),
158 io::stdout().flush().unwrap();
162 let announce_channel = match words.next() {
163 Some("--public") | Some("--public=true") => true,
164 Some("--public=false") => false,
166 println!("ERROR: invalid `--public` command format. Valid formats: `--public`, `--public=true` `--public=false`");
168 io::stdout().flush().unwrap();
176 chan_amt_sat.unwrap(),
178 channel_manager.clone(),
182 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
183 let _ = disk::persist_channel_peer(
184 Path::new(&peer_data_path),
185 peer_pubkey_and_ip_addr,
190 let invoice_str = words.next();
191 if invoice_str.is_none() {
192 println!("ERROR: sendpayment requires an invoice: `sendpayment <invoice>`");
194 io::stdout().flush().unwrap();
198 let invoice = match Invoice::from_str(invoice_str.unwrap()) {
201 println!("ERROR: invalid invoice: {:?}", e);
203 io::stdout().flush().unwrap();
207 let mut route_hints = invoice.routes().clone();
208 let mut last_hops = Vec::new();
209 for hint in route_hints.drain(..) {
210 last_hops.push(hint[hint.len() - 1].clone());
213 let amt_pico_btc = invoice.amount_pico_btc();
214 if amt_pico_btc.is_none() {
215 println!("ERROR: invalid invoice: must contain amount to pay");
217 io::stdout().flush().unwrap();
220 let amt_msat = amt_pico_btc.unwrap() / 10;
222 let payee_pubkey = invoice.recover_payee_pub_key();
223 let final_cltv = invoice.min_final_cltv_expiry() as u32;
225 let mut payment_hash = PaymentHash([0; 32]);
226 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
228 let payment_secret = match invoice.payment_secret() {
230 let mut payment_secret = PaymentSecret([0; 32]);
231 payment_secret.0.copy_from_slice(&secret.0);
237 let invoice_features = match invoice.features() {
238 Some(feat) => Some(feat.clone()),
251 channel_manager.clone(),
252 outbound_payments.clone(),
257 let amt_str = words.next();
258 if amt_str.is_none() {
259 println!("ERROR: getinvoice requires an amount in millisatoshis");
261 io::stdout().flush().unwrap();
265 let amt_msat: Result<u64, _> = amt_str.unwrap().parse();
266 if amt_msat.is_err() {
267 println!("ERROR: getinvoice provided payment amount was not a number");
269 io::stdout().flush().unwrap();
274 inbound_payments.clone(),
275 channel_manager.clone(),
276 keys_manager.clone(),
281 let peer_pubkey_and_ip_addr = words.next();
282 if peer_pubkey_and_ip_addr.is_none() {
283 println!("ERROR: connectpeer requires peer connection info: `connectpeer pubkey@host:port`");
285 io::stdout().flush().unwrap();
288 let (pubkey, peer_addr) =
289 match parse_peer_info(peer_pubkey_and_ip_addr.unwrap().to_string()) {
292 println!("{:?}", e.into_inner().unwrap());
294 io::stdout().flush().unwrap();
298 if connect_peer_if_necessary(
301 peer_manager.clone(),
302 event_notifier.clone(),
307 println!("SUCCESS: connected to peer {}", pubkey);
310 "listchannels" => list_channels(channel_manager.clone()),
312 list_payments(inbound_payments.clone(), outbound_payments.clone())
315 let channel_id_str = words.next();
316 if channel_id_str.is_none() {
317 println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id>`");
319 io::stdout().flush().unwrap();
322 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
323 if channel_id_vec.is_none() {
324 println!("ERROR: couldn't parse channel_id as hex");
326 io::stdout().flush().unwrap();
329 let mut channel_id = [0; 32];
330 channel_id.copy_from_slice(&channel_id_vec.unwrap());
331 close_channel(channel_id, channel_manager.clone());
333 "forceclosechannel" => {
334 let channel_id_str = words.next();
335 if channel_id_str.is_none() {
336 println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id>`");
338 io::stdout().flush().unwrap();
341 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
342 if channel_id_vec.is_none() {
343 println!("ERROR: couldn't parse channel_id as hex");
345 io::stdout().flush().unwrap();
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()),
354 _ => println!("Unknown command. See `\"help\" for available commands."),
358 io::stdout().flush().unwrap();
363 println!("openchannel pubkey@host:port <channel_amt_satoshis>");
364 println!("sendpayment <invoice>");
365 println!("getinvoice <amt_in_millisatoshis>");
366 println!("connectpeer pubkey@host:port");
367 println!("listchannels");
368 println!("listpayments");
369 println!("closechannel <channel_id>");
370 println!("forceclosechannel <channel_id>");
373 fn node_info(channel_manager: Arc<ChannelManager>, peer_manager: Arc<PeerManager>) {
375 println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
376 println!("\t\t num_channels: {}", channel_manager.list_channels().len());
377 println!("\t\t num_usable_channels: {}", channel_manager.list_usable_channels().len());
378 println!("\t\t num_peers: {}", peer_manager.get_peer_node_ids().len());
382 fn list_peers(peer_manager: Arc<PeerManager>) {
384 for pubkey in peer_manager.get_peer_node_ids() {
385 println!("\t\t pubkey: {}", pubkey);
390 fn list_channels(channel_manager: Arc<ChannelManager>) {
392 for chan_info in channel_manager.list_channels() {
395 println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..]));
397 "\t\tpeer_pubkey: {},",
398 hex_utils::hex_str(&chan_info.remote_network_id.serialize())
400 let mut pending_channel = false;
401 match chan_info.short_channel_id {
402 Some(id) => println!("\t\tshort_channel_id: {},", id),
404 pending_channel = true;
407 println!("\t\tpending_open: {},", pending_channel);
408 println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
409 println!("\t\tchannel_can_send_payments: {},", chan_info.is_live);
415 fn list_payments(inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage) {
416 let inbound = inbound_payments.lock().unwrap();
417 let outbound = outbound_payments.lock().unwrap();
419 for (payment_hash, payment_info) in inbound.deref() {
422 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
423 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
424 println!("\t\thtlc_direction: inbound,");
426 "\t\thtlc_status: {},",
427 match payment_info.status {
428 HTLCStatus::Pending => "pending",
429 HTLCStatus::Succeeded => "succeeded",
430 HTLCStatus::Failed => "failed",
437 for (payment_hash, payment_info) in outbound.deref() {
440 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
441 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
442 println!("\t\thtlc_direction: outbound,");
444 "\t\thtlc_status: {},",
445 match payment_info.status {
446 HTLCStatus::Pending => "pending",
447 HTLCStatus::Succeeded => "succeeded",
448 HTLCStatus::Failed => "failed",
457 pub(crate) async fn connect_peer_if_necessary(
458 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
459 event_notifier: mpsc::Sender<()>,
460 ) -> Result<(), ()> {
461 for node_pubkey in peer_manager.get_peer_node_ids() {
462 if node_pubkey == pubkey {
466 match lightning_net_tokio::connect_outbound(
467 Arc::clone(&peer_manager),
474 Some(conn_closed_fut) => {
475 let mut closed_fut_box = Box::pin(conn_closed_fut);
476 let mut peer_connected = false;
477 while !peer_connected {
478 match futures::poll!(&mut closed_fut_box) {
479 std::task::Poll::Ready(_) => {
480 println!("ERROR: Peer disconnected before we finished the handshake");
483 std::task::Poll::Pending => {}
485 for node_pubkey in peer_manager.get_peer_node_ids() {
486 if node_pubkey == pubkey {
487 peer_connected = true;
490 // Avoid blocking the tokio context by sleeping a bit
491 tokio::time::sleep(Duration::from_millis(10)).await;
495 println!("ERROR: failed to connect to peer");
503 peer_pubkey: PublicKey, channel_amt_sat: u64, announce_channel: bool,
504 channel_manager: Arc<ChannelManager>,
505 ) -> Result<(), ()> {
506 let mut config = UserConfig::default();
507 if announce_channel {
508 config.channel_options.announced_channel = true;
510 // lnd's max to_self_delay is 2016, so we want to be compatible.
511 config.peer_channel_config_limits.their_to_self_delay = 2016;
512 match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, None) {
514 println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
518 println!("ERROR: failed to open channel: {:?}", e);
525 payee: PublicKey, amt_msat: u64, final_cltv: u32, payment_hash: PaymentHash,
526 payment_secret: Option<PaymentSecret>, payee_features: Option<InvoiceFeatures>,
527 route_hints: Vec<RouteHintHop>,
528 router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access + Send + Sync>, Arc<FilesystemLogger>>>,
529 channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
530 logger: Arc<FilesystemLogger>,
532 let network_graph = router.network_graph.read().unwrap();
533 let first_hops = channel_manager.list_usable_channels();
534 let payer_pubkey = channel_manager.get_our_node_id();
536 let route = router::get_route(
541 Some(&first_hops.iter().collect::<Vec<_>>()),
542 &route_hints.iter().collect::<Vec<_>>(),
547 if let Err(e) = route {
548 println!("ERROR: failed to find route: {}", e.err);
551 let status = match channel_manager.send_payment(&route.unwrap(), payment_hash, &payment_secret)
554 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee);
558 println!("ERROR: failed to send payment: {:?}", e);
562 let mut payments = payment_storage.lock().unwrap();
567 secret: payment_secret,
569 amt_msat: MillisatAmount(Some(amt_msat)),
575 amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: Arc<ChannelManager>,
576 keys_manager: Arc<KeysManager>, network: Network,
578 let mut payments = payment_storage.lock().unwrap();
579 let currency = match network {
580 Network::Bitcoin => Currency::Bitcoin,
581 Network::Testnet => Currency::BitcoinTestnet,
582 Network::Regtest => Currency::Regtest,
583 Network::Signet => panic!("Signet unsupported"),
585 let invoice = match utils::create_invoice_from_channelmanager(
590 "ldk-tutorial-node".to_string(),
593 println!("SUCCESS: generated invoice: {}", inv);
597 println!("ERROR: failed to create invoice: {:?}", e);
602 let mut payment_hash = PaymentHash([0; 32]);
603 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
608 // We can't add payment secrets to invoices until we support features in invoices.
609 // Otherwise lnd errors with "destination hop doesn't understand payment addresses"
610 // (for context, lnd calls payment secrets "payment addresses").
611 secret: Some(invoice.payment_secret().unwrap().clone()),
612 status: HTLCStatus::Pending,
613 amt_msat: MillisatAmount(Some(amt_msat)),
618 fn close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
619 match channel_manager.close_channel(&channel_id) {
620 Ok(()) => println!("EVENT: initiating channel close"),
621 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
625 fn force_close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
626 match channel_manager.force_close_channel(&channel_id) {
627 Ok(()) => println!("EVENT: initiating channel force-close"),
628 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
632 pub(crate) fn parse_peer_info(
633 peer_pubkey_and_ip_addr: String,
634 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
635 let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
636 let pubkey = pubkey_and_addr.next();
637 let peer_addr_str = pubkey_and_addr.next();
638 if peer_addr_str.is_none() || peer_addr_str.is_none() {
639 return Err(std::io::Error::new(
640 std::io::ErrorKind::Other,
641 "ERROR: incorrectly formatted peer
642 info. Should be formatted as: `pubkey@host:port`",
646 let peer_addr = peer_addr_str.unwrap().to_socket_addrs().map(|mut r| r.next());
647 if peer_addr.is_err() || peer_addr.as_ref().unwrap().is_none() {
648 return Err(std::io::Error::new(
649 std::io::ErrorKind::Other,
650 "ERROR: couldn't parse pubkey@host:port into a socket address",
654 let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
655 if pubkey.is_none() {
656 return Err(std::io::Error::new(
657 std::io::ErrorKind::Other,
658 "ERROR: unable to parse given pubkey for node",
662 Ok((pubkey.unwrap(), peer_addr.unwrap().unwrap()))