4 ChannelManager, FilesystemLogger, HTLCDirection, HTLCStatus, PaymentInfoStorage, PeerManager,
7 use bitcoin::hashes::sha256::Hash as Sha256Hash;
8 use bitcoin::hashes::Hash;
9 use bitcoin::network::constants::Network;
10 use bitcoin::secp256k1::key::{PublicKey, SecretKey};
11 use bitcoin::secp256k1::Secp256k1;
13 use lightning::ln::channelmanager::{PaymentHash, PaymentPreimage, PaymentSecret};
14 use lightning::ln::features::InvoiceFeatures;
15 use lightning::routing::network_graph::NetGraphMsgHandler;
16 use lightning::routing::router;
17 use lightning::util::config::UserConfig;
22 use std::io::{BufRead, Write};
23 use std::net::{SocketAddr, TcpStream};
26 use std::str::FromStr;
28 use std::time::Duration;
29 use tokio::sync::mpsc;
31 pub(crate) struct LdkUserInfo {
32 pub(crate) bitcoind_rpc_username: String,
33 pub(crate) bitcoind_rpc_password: String,
34 pub(crate) bitcoind_rpc_port: u16,
35 pub(crate) bitcoind_rpc_host: String,
36 pub(crate) ldk_storage_dir_path: String,
37 pub(crate) ldk_peer_listening_port: u16,
38 pub(crate) network: Network,
41 pub(crate) fn parse_startup_args() -> Result<LdkUserInfo, ()> {
42 if env::args().len() < 4 {
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]`");
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 bitcoind_rpc_username,
91 bitcoind_rpc_password,
95 ldk_peer_listening_port,
100 pub(crate) async fn poll_for_user_input(
101 peer_manager: Arc<PeerManager>, channel_manager: Arc<ChannelManager>,
102 router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access>, Arc<FilesystemLogger>>>,
103 payment_storage: PaymentInfoStorage, node_privkey: SecretKey, event_notifier: mpsc::Sender<()>,
104 ldk_data_dir: String, logger: Arc<FilesystemLogger>, network: Network,
106 println!("LDK startup successful. To view available commands: \"help\".\nLDK logs are available at <your-supplied-ldk-data-dir-path>/.ldk/logs");
107 let stdin = io::stdin();
109 io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
110 for line in stdin.lock().lines() {
111 let _ = event_notifier.try_send(());
112 let line = line.unwrap();
113 let mut words = line.split_whitespace();
114 if let Some(word) = words.next() {
118 let peer_pubkey_and_ip_addr = words.next();
119 let channel_value_sat = words.next();
120 if peer_pubkey_and_ip_addr.is_none() || channel_value_sat.is_none() {
121 println!("ERROR: openchannel has 2 required arguments: `openchannel pubkey@host:port channel_amt_satoshis` [--public]");
123 io::stdout().flush().unwrap();
126 let peer_pubkey_and_ip_addr = peer_pubkey_and_ip_addr.unwrap();
127 let (pubkey, peer_addr) =
128 match parse_peer_info(peer_pubkey_and_ip_addr.to_string()) {
131 println!("{:?}", e.into_inner().unwrap());
133 io::stdout().flush().unwrap();
138 let chan_amt_sat: Result<u64, _> = channel_value_sat.unwrap().parse();
139 if chan_amt_sat.is_err() {
140 println!("ERROR: channel amount must be a number");
142 io::stdout().flush().unwrap();
146 if connect_peer_if_necessary(
149 peer_manager.clone(),
150 event_notifier.clone(),
155 io::stdout().flush().unwrap();
159 let announce_channel = match words.next() {
160 Some("--public") | Some("--public=true") => true,
161 Some("--public=false") => false,
163 println!("ERROR: invalid `--public` command format. Valid formats: `--public`, `--public=true` `--public=false`");
165 io::stdout().flush().unwrap();
173 chan_amt_sat.unwrap(),
175 channel_manager.clone(),
179 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
180 let _ = disk::persist_channel_peer(
181 Path::new(&peer_data_path),
182 peer_pubkey_and_ip_addr,
187 let invoice_str = words.next();
188 if invoice_str.is_none() {
189 println!("ERROR: sendpayment requires an invoice: `sendpayment <invoice>`");
191 io::stdout().flush().unwrap();
195 let invoice_res = lightning_invoice::Invoice::from_str(invoice_str.unwrap());
196 if invoice_res.is_err() {
197 println!("ERROR: invalid invoice: {:?}", invoice_res.unwrap_err());
199 io::stdout().flush().unwrap();
202 let invoice = invoice_res.unwrap();
204 let amt_pico_btc = invoice.amount_pico_btc();
205 if amt_pico_btc.is_none() {
206 println!("ERROR: invalid invoice: must contain amount to pay");
208 io::stdout().flush().unwrap();
211 let amt_msat = amt_pico_btc.unwrap() / 10;
213 let payee_pubkey = invoice.recover_payee_pub_key();
214 let final_cltv = *invoice.min_final_cltv_expiry().unwrap_or(&9) as u32;
216 let mut payment_hash = PaymentHash([0; 32]);
217 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
219 let payment_secret = match invoice.payment_secret() {
221 let mut payment_secret = PaymentSecret([0; 32]);
222 payment_secret.0.copy_from_slice(&secret.0);
228 // rust-lightning-invoice doesn't currently support features, so we parse features
229 // manually from the invoice.
230 let mut invoice_features = InvoiceFeatures::empty();
231 for field in &invoice.into_signed_raw().raw_invoice().data.tagged_fields {
233 lightning_invoice::RawTaggedField::UnknownSemantics(vec) => {
234 if vec[0] == bech32::u5::try_from_u8(5).unwrap() {
235 if vec.len() >= 6 && vec[5].to_u8() & 0b10000 != 0 {
237 invoice_features.set_variable_length_onion_optional();
239 if vec.len() >= 6 && vec[5].to_u8() & 0b01000 != 0 {
241 invoice_features.set_variable_length_onion_required();
243 if vec.len() >= 4 && vec[3].to_u8() & 0b00001 != 0 {
245 invoice_features.set_payment_secret_optional();
247 if vec.len() >= 5 && vec[4].to_u8() & 0b10000 != 0 {
249 invoice_features.set_payment_secret_required();
251 if vec.len() >= 4 && vec[3].to_u8() & 0b00100 != 0 {
253 invoice_features.set_basic_mpp_optional();
255 if vec.len() >= 4 && vec[3].to_u8() & 0b00010 != 0 {
257 invoice_features.set_basic_mpp_required();
264 let invoice_features_opt = match invoice_features == InvoiceFeatures::empty() {
266 false => Some(invoice_features),
274 invoice_features_opt,
276 channel_manager.clone(),
277 payment_storage.clone(),
282 let amt_str = words.next();
283 if amt_str.is_none() {
284 println!("ERROR: getinvoice requires an amount in satoshis");
286 io::stdout().flush().unwrap();
290 let amt_sat: Result<u64, _> = amt_str.unwrap().parse();
291 if amt_sat.is_err() {
292 println!("ERROR: getinvoice provided payment amount was not a number");
294 io::stdout().flush().unwrap();
299 payment_storage.clone(),
300 node_privkey.clone(),
301 channel_manager.clone(),
306 let peer_pubkey_and_ip_addr = words.next();
307 if peer_pubkey_and_ip_addr.is_none() {
308 println!("ERROR: connectpeer requires peer connection info: `connectpeer pubkey@host:port`");
310 io::stdout().flush().unwrap();
313 let (pubkey, peer_addr) =
314 match parse_peer_info(peer_pubkey_and_ip_addr.unwrap().to_string()) {
317 println!("{:?}", e.into_inner().unwrap());
319 io::stdout().flush().unwrap();
323 if connect_peer_if_necessary(
326 peer_manager.clone(),
327 event_notifier.clone(),
331 println!("SUCCESS: connected to peer {}", pubkey);
334 "listchannels" => list_channels(channel_manager.clone()),
335 "listpayments" => list_payments(payment_storage.clone()),
337 let channel_id_str = words.next();
338 if channel_id_str.is_none() {
339 println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id>`");
341 io::stdout().flush().unwrap();
344 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
345 if channel_id_vec.is_none() {
346 println!("ERROR: couldn't parse channel_id as hex");
348 io::stdout().flush().unwrap();
351 let mut channel_id = [0; 32];
352 channel_id.copy_from_slice(&channel_id_vec.unwrap());
353 close_channel(channel_id, channel_manager.clone());
355 "forceclosechannel" => {
356 let channel_id_str = words.next();
357 if channel_id_str.is_none() {
358 println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id>`");
360 io::stdout().flush().unwrap();
363 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
364 if channel_id_vec.is_none() {
365 println!("ERROR: couldn't parse channel_id as hex");
367 io::stdout().flush().unwrap();
370 let mut channel_id = [0; 32];
371 channel_id.copy_from_slice(&channel_id_vec.unwrap());
372 force_close_channel(channel_id, channel_manager.clone());
374 _ => println!("Unknown command. See `\"help\" for available commands."),
378 io::stdout().flush().unwrap();
383 println!("openchannel pubkey@host:port <channel_amt_satoshis>");
384 println!("sendpayment <invoice>");
385 println!("getinvoice <amt_in_satoshis>");
386 println!("connectpeer pubkey@host:port");
387 println!("listchannels");
388 println!("listpayments");
389 println!("closechannel <channel_id>");
390 println!("forceclosechannel <channel_id>");
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[..]));
400 "\t\tpeer_pubkey: {},",
401 hex_utils::hex_str(&chan_info.remote_network_id.serialize())
403 let mut pending_channel = false;
404 match chan_info.short_channel_id {
405 Some(id) => println!("\t\tshort_channel_id: {},", id),
407 pending_channel = true;
410 println!("\t\tpending_open: {},", pending_channel);
411 println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
412 println!("\t\tchannel_can_send_payments: {},", chan_info.is_live);
418 fn list_payments(payment_storage: PaymentInfoStorage) {
419 let payments = payment_storage.lock().unwrap();
421 for (payment_hash, payment_info) in payments.deref() {
422 let direction_str = match payment_info.1 {
423 HTLCDirection::Inbound => "inbound",
424 HTLCDirection::Outbound => "outbound",
428 println!("\t\tamount_satoshis: {},", payment_info.3);
429 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
430 println!("\t\thtlc_direction: {},", direction_str);
432 "\t\thtlc_status: {},",
433 match payment_info.2 {
434 HTLCStatus::Pending => "pending",
435 HTLCStatus::Succeeded => "succeeded",
436 HTLCStatus::Failed => "failed",
445 pub(crate) fn connect_peer_if_necessary(
446 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
447 event_notifier: mpsc::Sender<()>,
448 ) -> Result<(), ()> {
449 for node_pubkey in peer_manager.get_peer_node_ids() {
450 if node_pubkey == pubkey {
454 match TcpStream::connect_timeout(&peer_addr, Duration::from_secs(10)) {
456 let peer_mgr = peer_manager.clone();
457 let event_ntfns = event_notifier.clone();
458 tokio::spawn(async move {
459 lightning_net_tokio::setup_outbound(peer_mgr, event_ntfns, pubkey, stream).await;
461 let mut peer_connected = false;
462 while !peer_connected {
463 for node_pubkey in peer_manager.get_peer_node_ids() {
464 if node_pubkey == pubkey {
465 peer_connected = true;
471 println!("ERROR: failed to connect to peer: {:?}", e);
479 peer_pubkey: PublicKey, channel_amt_sat: u64, announce_channel: bool,
480 channel_manager: Arc<ChannelManager>,
481 ) -> Result<(), ()> {
482 let mut config = UserConfig::default();
483 if announce_channel {
484 config.channel_options.announced_channel = true;
486 // lnd's max to_self_delay is 2016, so we want to be compatible.
487 config.peer_channel_config_limits.their_to_self_delay = 2016;
488 match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, None) {
490 println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
494 println!("ERROR: failed to open channel: {:?}", e);
501 payee: PublicKey, amt_msat: u64, final_cltv: u32, payment_hash: PaymentHash,
502 payment_secret: Option<PaymentSecret>, payee_features: Option<InvoiceFeatures>,
503 router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access>, Arc<FilesystemLogger>>>,
504 channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
505 logger: Arc<FilesystemLogger>,
507 let network_graph = router.network_graph.read().unwrap();
508 let first_hops = channel_manager.list_usable_channels();
509 let payer_pubkey = channel_manager.get_our_node_id();
511 let route = router::get_route(
516 Some(&first_hops.iter().collect::<Vec<_>>()),
522 if let Err(e) = route {
523 println!("ERROR: failed to find route: {}", e.err);
526 let status = match channel_manager.send_payment(&route.unwrap(), payment_hash, &payment_secret)
529 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee);
533 println!("ERROR: failed to send payment: {:?}", e);
537 let mut payments = payment_storage.lock().unwrap();
540 (None, HTLCDirection::Outbound, status, SatoshiAmount(Some(amt_msat / 1000))),
545 amt_sat: u64, payment_storage: PaymentInfoStorage, our_node_privkey: SecretKey,
546 channel_manager: Arc<ChannelManager>, network: Network,
548 let mut payments = payment_storage.lock().unwrap();
549 let secp_ctx = Secp256k1::new();
551 let mut preimage = [0; 32];
552 rand::thread_rng().fill_bytes(&mut preimage);
553 let payment_hash = Sha256Hash::hash(&preimage);
555 let our_node_pubkey = channel_manager.get_our_node_id();
556 let mut invoice = lightning_invoice::InvoiceBuilder::new(match network {
557 Network::Bitcoin => lightning_invoice::Currency::Bitcoin,
558 Network::Testnet => lightning_invoice::Currency::BitcoinTestnet,
559 Network::Regtest => lightning_invoice::Currency::Regtest,
560 Network::Signet => panic!("Signet invoices not supported"),
562 .payment_hash(payment_hash)
563 .description("rust-lightning-bitcoinrpc invoice".to_string())
564 .amount_pico_btc(amt_sat * 10_000)
566 .payee_pub_key(our_node_pubkey);
568 // Add route hints to the invoice.
569 let our_channels = channel_manager.list_usable_channels();
570 for channel in our_channels {
571 let short_channel_id = match channel.short_channel_id {
572 Some(id) => id.to_be_bytes(),
575 let forwarding_info = match channel.counterparty_forwarding_info {
579 invoice = invoice.route(vec![lightning_invoice::RouteHop {
580 pubkey: channel.remote_network_id,
582 fee_base_msat: forwarding_info.fee_base_msat,
583 fee_proportional_millionths: forwarding_info.fee_proportional_millionths,
584 cltv_expiry_delta: forwarding_info.cltv_expiry_delta,
590 invoice.build_signed(|msg_hash| secp_ctx.sign_recoverable(msg_hash, &our_node_privkey));
593 Ok(invoice) => println!("SUCCESS: generated invoice: {}", invoice),
594 Err(e) => println!("ERROR: failed to create invoice: {:?}", e),
598 PaymentHash(payment_hash.into_inner()),
600 Some(PaymentPreimage(preimage)),
601 HTLCDirection::Inbound,
603 SatoshiAmount(Some(amt_sat)),
608 fn close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
609 match channel_manager.close_channel(&channel_id) {
610 Ok(()) => println!("EVENT: initiating channel close"),
611 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
615 fn force_close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
616 match channel_manager.force_close_channel(&channel_id) {
617 Ok(()) => println!("EVENT: initiating channel force-close"),
618 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
622 pub(crate) fn parse_peer_info(
623 peer_pubkey_and_ip_addr: String,
624 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
625 let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
626 let pubkey = pubkey_and_addr.next();
627 let peer_addr_str = pubkey_and_addr.next();
628 if peer_addr_str.is_none() || peer_addr_str.is_none() {
629 return Err(std::io::Error::new(
630 std::io::ErrorKind::Other,
631 "ERROR: incorrectly formatted peer
632 info. Should be formatted as: `pubkey@host:port`",
636 let peer_addr: Result<SocketAddr, _> = peer_addr_str.unwrap().parse();
637 if peer_addr.is_err() {
638 return Err(std::io::Error::new(
639 std::io::ErrorKind::Other,
640 "ERROR: couldn't parse pubkey@host:port into a socket address",
644 let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
645 if pubkey.is_none() {
646 return Err(std::io::Error::new(
647 std::io::ErrorKind::Other,
648 "ERROR: unable to parse given pubkey for node",
652 Ok((pubkey.unwrap(), peer_addr.unwrap()))