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, TcpStream};
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(),
157 io::stdout().flush().unwrap();
161 let announce_channel = match words.next() {
162 Some("--public") | Some("--public=true") => true,
163 Some("--public=false") => false,
165 println!("ERROR: invalid `--public` command format. Valid formats: `--public`, `--public=true` `--public=false`");
167 io::stdout().flush().unwrap();
175 chan_amt_sat.unwrap(),
177 channel_manager.clone(),
181 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
182 let _ = disk::persist_channel_peer(
183 Path::new(&peer_data_path),
184 peer_pubkey_and_ip_addr,
189 let invoice_str = words.next();
190 if invoice_str.is_none() {
191 println!("ERROR: sendpayment requires an invoice: `sendpayment <invoice>`");
193 io::stdout().flush().unwrap();
197 let invoice = match Invoice::from_str(invoice_str.unwrap()) {
200 println!("ERROR: invalid invoice: {:?}", e);
202 io::stdout().flush().unwrap();
206 let mut route_hints = invoice.routes().clone();
207 let mut last_hops = Vec::new();
208 for hint in route_hints.drain(..) {
209 last_hops.push(hint[hint.len() - 1].clone());
212 let amt_pico_btc = invoice.amount_pico_btc();
213 if amt_pico_btc.is_none() {
214 println!("ERROR: invalid invoice: must contain amount to pay");
216 io::stdout().flush().unwrap();
219 let amt_msat = amt_pico_btc.unwrap() / 10;
221 let payee_pubkey = invoice.recover_payee_pub_key();
222 let final_cltv = invoice.min_final_cltv_expiry() as u32;
224 let mut payment_hash = PaymentHash([0; 32]);
225 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
227 let payment_secret = match invoice.payment_secret() {
229 let mut payment_secret = PaymentSecret([0; 32]);
230 payment_secret.0.copy_from_slice(&secret.0);
236 let invoice_features = match invoice.features() {
237 Some(feat) => Some(feat.clone()),
250 channel_manager.clone(),
251 outbound_payments.clone(),
256 let amt_str = words.next();
257 if amt_str.is_none() {
258 println!("ERROR: getinvoice requires an amount in millisatoshis");
260 io::stdout().flush().unwrap();
264 let amt_msat: Result<u64, _> = amt_str.unwrap().parse();
265 if amt_msat.is_err() {
266 println!("ERROR: getinvoice provided payment amount was not a number");
268 io::stdout().flush().unwrap();
273 inbound_payments.clone(),
274 channel_manager.clone(),
275 keys_manager.clone(),
280 let peer_pubkey_and_ip_addr = words.next();
281 if peer_pubkey_and_ip_addr.is_none() {
282 println!("ERROR: connectpeer requires peer connection info: `connectpeer pubkey@host:port`");
284 io::stdout().flush().unwrap();
287 let (pubkey, peer_addr) =
288 match parse_peer_info(peer_pubkey_and_ip_addr.unwrap().to_string()) {
291 println!("{:?}", e.into_inner().unwrap());
293 io::stdout().flush().unwrap();
297 if connect_peer_if_necessary(
300 peer_manager.clone(),
301 event_notifier.clone(),
305 println!("SUCCESS: connected to peer {}", pubkey);
308 "listchannels" => list_channels(channel_manager.clone()),
310 list_payments(inbound_payments.clone(), outbound_payments.clone())
313 let channel_id_str = words.next();
314 if channel_id_str.is_none() {
315 println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id>`");
317 io::stdout().flush().unwrap();
320 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
321 if channel_id_vec.is_none() {
322 println!("ERROR: couldn't parse channel_id as hex");
324 io::stdout().flush().unwrap();
327 let mut channel_id = [0; 32];
328 channel_id.copy_from_slice(&channel_id_vec.unwrap());
329 close_channel(channel_id, channel_manager.clone());
331 "forceclosechannel" => {
332 let channel_id_str = words.next();
333 if channel_id_str.is_none() {
334 println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id>`");
336 io::stdout().flush().unwrap();
339 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
340 if channel_id_vec.is_none() {
341 println!("ERROR: couldn't parse channel_id as hex");
343 io::stdout().flush().unwrap();
346 let mut channel_id = [0; 32];
347 channel_id.copy_from_slice(&channel_id_vec.unwrap());
348 force_close_channel(channel_id, channel_manager.clone());
350 "nodeinfo" => node_info(channel_manager.clone(), peer_manager.clone()),
351 "listpeers" => list_peers(peer_manager.clone()),
352 _ => println!("Unknown command. See `\"help\" for available commands."),
356 io::stdout().flush().unwrap();
361 println!("openchannel pubkey@host:port <channel_amt_satoshis>");
362 println!("sendpayment <invoice>");
363 println!("getinvoice <amt_in_millisatoshis>");
364 println!("connectpeer pubkey@host:port");
365 println!("listchannels");
366 println!("listpayments");
367 println!("closechannel <channel_id>");
368 println!("forceclosechannel <channel_id>");
371 fn node_info(channel_manager: Arc<ChannelManager>, peer_manager: Arc<PeerManager>) {
373 println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
374 println!("\t\t num_channels: {}", channel_manager.list_channels().len());
375 println!("\t\t num_usable_channels: {}", channel_manager.list_usable_channels().len());
376 println!("\t\t num_peers: {}", peer_manager.get_peer_node_ids().len());
380 fn list_peers(peer_manager: Arc<PeerManager>) {
382 for pubkey in peer_manager.get_peer_node_ids() {
383 println!("\t\t pubkey: {}", pubkey);
388 fn list_channels(channel_manager: Arc<ChannelManager>) {
390 for chan_info in channel_manager.list_channels() {
393 println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..]));
395 "\t\tpeer_pubkey: {},",
396 hex_utils::hex_str(&chan_info.remote_network_id.serialize())
398 let mut pending_channel = false;
399 match chan_info.short_channel_id {
400 Some(id) => println!("\t\tshort_channel_id: {},", id),
402 pending_channel = true;
405 println!("\t\tpending_open: {},", pending_channel);
406 println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
407 println!("\t\tchannel_can_send_payments: {},", chan_info.is_live);
413 fn list_payments(inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage) {
414 let inbound = inbound_payments.lock().unwrap();
415 let outbound = outbound_payments.lock().unwrap();
417 for (payment_hash, payment_info) in inbound.deref() {
420 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
421 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
422 println!("\t\thtlc_direction: inbound,");
424 "\t\thtlc_status: {},",
425 match payment_info.status {
426 HTLCStatus::Pending => "pending",
427 HTLCStatus::Succeeded => "succeeded",
428 HTLCStatus::Failed => "failed",
435 for (payment_hash, payment_info) in outbound.deref() {
438 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
439 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
440 println!("\t\thtlc_direction: outbound,");
442 "\t\thtlc_status: {},",
443 match payment_info.status {
444 HTLCStatus::Pending => "pending",
445 HTLCStatus::Succeeded => "succeeded",
446 HTLCStatus::Failed => "failed",
455 pub(crate) fn connect_peer_if_necessary(
456 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
457 event_notifier: mpsc::Sender<()>,
458 ) -> Result<(), ()> {
459 for node_pubkey in peer_manager.get_peer_node_ids() {
460 if node_pubkey == pubkey {
464 match TcpStream::connect_timeout(&peer_addr, Duration::from_secs(10)) {
466 let peer_mgr = peer_manager.clone();
467 let event_ntfns = event_notifier.clone();
468 tokio::spawn(async move {
469 lightning_net_tokio::setup_outbound(peer_mgr, event_ntfns, pubkey, stream).await;
471 let mut peer_connected = false;
472 while !peer_connected {
473 for node_pubkey in peer_manager.get_peer_node_ids() {
474 if node_pubkey == pubkey {
475 peer_connected = true;
481 println!("ERROR: failed to connect to peer: {:?}", e);
489 peer_pubkey: PublicKey, channel_amt_sat: u64, announce_channel: bool,
490 channel_manager: Arc<ChannelManager>,
491 ) -> Result<(), ()> {
492 let mut config = UserConfig::default();
493 if announce_channel {
494 config.channel_options.announced_channel = true;
496 // lnd's max to_self_delay is 2016, so we want to be compatible.
497 config.peer_channel_config_limits.their_to_self_delay = 2016;
498 match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, None) {
500 println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
504 println!("ERROR: failed to open channel: {:?}", e);
511 payee: PublicKey, amt_msat: u64, final_cltv: u32, payment_hash: PaymentHash,
512 payment_secret: Option<PaymentSecret>, payee_features: Option<InvoiceFeatures>,
513 route_hints: Vec<RouteHintHop>,
514 router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access + Send + Sync>, Arc<FilesystemLogger>>>,
515 channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
516 logger: Arc<FilesystemLogger>,
518 let network_graph = router.network_graph.read().unwrap();
519 let first_hops = channel_manager.list_usable_channels();
520 let payer_pubkey = channel_manager.get_our_node_id();
522 let route = router::get_route(
527 Some(&first_hops.iter().collect::<Vec<_>>()),
528 &route_hints.iter().collect::<Vec<_>>(),
533 if let Err(e) = route {
534 println!("ERROR: failed to find route: {}", e.err);
537 let status = match channel_manager.send_payment(&route.unwrap(), payment_hash, &payment_secret)
540 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee);
544 println!("ERROR: failed to send payment: {:?}", e);
548 let mut payments = payment_storage.lock().unwrap();
553 secret: payment_secret,
555 amt_msat: MillisatAmount(Some(amt_msat)),
561 amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: Arc<ChannelManager>,
562 keys_manager: Arc<KeysManager>, network: Network,
564 let mut payments = payment_storage.lock().unwrap();
565 let currency = match network {
566 Network::Bitcoin => Currency::Bitcoin,
567 Network::Testnet => Currency::BitcoinTestnet,
568 Network::Regtest => Currency::Regtest,
569 Network::Signet => panic!("Signet unsupported"),
571 let invoice = match utils::create_invoice_from_channelmanager(
576 "ldk-tutorial-node".to_string(),
579 println!("SUCCESS: generated invoice: {}", inv);
583 println!("ERROR: failed to create invoice: {:?}", e);
588 let mut payment_hash = PaymentHash([0; 32]);
589 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
594 // We can't add payment secrets to invoices until we support features in invoices.
595 // Otherwise lnd errors with "destination hop doesn't understand payment addresses"
596 // (for context, lnd calls payment secrets "payment addresses").
597 secret: Some(invoice.payment_secret().unwrap().clone()),
598 status: HTLCStatus::Pending,
599 amt_msat: MillisatAmount(Some(amt_msat)),
604 fn close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
605 match channel_manager.close_channel(&channel_id) {
606 Ok(()) => println!("EVENT: initiating channel close"),
607 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
611 fn force_close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
612 match channel_manager.force_close_channel(&channel_id) {
613 Ok(()) => println!("EVENT: initiating channel force-close"),
614 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
618 pub(crate) fn parse_peer_info(
619 peer_pubkey_and_ip_addr: String,
620 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
621 let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
622 let pubkey = pubkey_and_addr.next();
623 let peer_addr_str = pubkey_and_addr.next();
624 if peer_addr_str.is_none() || peer_addr_str.is_none() {
625 return Err(std::io::Error::new(
626 std::io::ErrorKind::Other,
627 "ERROR: incorrectly formatted peer
628 info. Should be formatted as: `pubkey@host:port`",
632 let peer_addr: Result<SocketAddr, _> = peer_addr_str.unwrap().parse();
633 if peer_addr.is_err() {
634 return Err(std::io::Error::new(
635 std::io::ErrorKind::Other,
636 "ERROR: couldn't parse pubkey@host:port into a socket address",
640 let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
641 if pubkey.is_none() {
642 return Err(std::io::Error::new(
643 std::io::ErrorKind::Other,
644 "ERROR: unable to parse given pubkey for node",
648 Ok((pubkey.unwrap(), peer_addr.unwrap()))