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 private_channel = match words.next().as_ref().map(String::as_str) {
160 let announce_channel = match words.next() {
161 Some("--public") | Some("--public=true") => true,
162 Some("--public=false") => false,
164 println!("ERROR: invalid `--public` command format. Valid formats: `--public`, `--public=true` `--public=false`");
166 io::stdout().flush().unwrap();
174 chan_amt_sat.unwrap(),
176 channel_manager.clone(),
180 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
181 let _ = disk::persist_channel_peer(
182 Path::new(&peer_data_path),
183 peer_pubkey_and_ip_addr,
188 let invoice_str = words.next();
189 if invoice_str.is_none() {
190 println!("ERROR: sendpayment requires an invoice: `sendpayment <invoice>`");
192 io::stdout().flush().unwrap();
196 let invoice_res = lightning_invoice::Invoice::from_str(invoice_str.unwrap());
197 if invoice_res.is_err() {
198 println!("ERROR: invalid invoice: {:?}", invoice_res.unwrap_err());
200 io::stdout().flush().unwrap();
203 let invoice = invoice_res.unwrap();
205 let amt_pico_btc = invoice.amount_pico_btc();
206 if amt_pico_btc.is_none() {
207 println!("ERROR: invalid invoice: must contain amount to pay");
209 io::stdout().flush().unwrap();
212 let amt_msat = amt_pico_btc.unwrap() / 10;
214 let payee_pubkey = invoice.recover_payee_pub_key();
215 let final_cltv = *invoice.min_final_cltv_expiry().unwrap_or(&9) as u32;
217 let mut payment_hash = PaymentHash([0; 32]);
218 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
220 let payment_secret = match invoice.payment_secret() {
222 let mut payment_secret = PaymentSecret([0; 32]);
223 payment_secret.0.copy_from_slice(&secret.0);
229 // rust-lightning-invoice doesn't currently support features, so we parse features
230 // manually from the invoice.
231 let mut invoice_features = InvoiceFeatures::empty();
232 for field in &invoice.into_signed_raw().raw_invoice().data.tagged_fields {
234 lightning_invoice::RawTaggedField::UnknownSemantics(vec) => {
235 if vec[0] == bech32::u5::try_from_u8(5).unwrap() {
236 if vec.len() >= 6 && vec[5].to_u8() & 0b10000 != 0 {
238 invoice_features.set_variable_length_onion_optional();
240 if vec.len() >= 6 && vec[5].to_u8() & 0b01000 != 0 {
242 invoice_features.set_variable_length_onion_required();
244 if vec.len() >= 4 && vec[3].to_u8() & 0b00001 != 0 {
246 invoice_features.set_payment_secret_optional();
248 if vec.len() >= 5 && vec[4].to_u8() & 0b10000 != 0 {
250 invoice_features.set_payment_secret_required();
252 if vec.len() >= 4 && vec[3].to_u8() & 0b00100 != 0 {
254 invoice_features.set_basic_mpp_optional();
256 if vec.len() >= 4 && vec[3].to_u8() & 0b00010 != 0 {
258 invoice_features.set_basic_mpp_required();
265 let invoice_features_opt = match invoice_features == InvoiceFeatures::empty() {
267 false => Some(invoice_features),
275 invoice_features_opt,
277 channel_manager.clone(),
278 payment_storage.clone(),
283 let amt_str = words.next();
284 if amt_str.is_none() {
285 println!("ERROR: getinvoice requires an amount in satoshis");
287 io::stdout().flush().unwrap();
291 let amt_sat: Result<u64, _> = amt_str.unwrap().parse();
292 if amt_sat.is_err() {
293 println!("ERROR: getinvoice provided payment amount was not a number");
295 io::stdout().flush().unwrap();
300 payment_storage.clone(),
301 node_privkey.clone(),
302 channel_manager.clone(),
307 let peer_pubkey_and_ip_addr = words.next();
308 if peer_pubkey_and_ip_addr.is_none() {
309 println!("ERROR: connectpeer requires peer connection info: `connectpeer pubkey@host:port`");
311 io::stdout().flush().unwrap();
314 let (pubkey, peer_addr) =
315 match parse_peer_info(peer_pubkey_and_ip_addr.unwrap().to_string()) {
318 println!("{:?}", e.into_inner().unwrap());
320 io::stdout().flush().unwrap();
324 if connect_peer_if_necessary(
327 peer_manager.clone(),
328 event_notifier.clone(),
332 println!("SUCCESS: connected to peer {}", pubkey);
335 "listchannels" => list_channels(channel_manager.clone()),
336 "listpayments" => list_payments(payment_storage.clone()),
338 let channel_id_str = words.next();
339 if channel_id_str.is_none() {
340 println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id>`");
342 io::stdout().flush().unwrap();
345 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
346 if channel_id_vec.is_none() {
347 println!("ERROR: couldn't parse channel_id as hex");
349 io::stdout().flush().unwrap();
352 let mut channel_id = [0; 32];
353 channel_id.copy_from_slice(&channel_id_vec.unwrap());
354 close_channel(channel_id, channel_manager.clone());
356 "forceclosechannel" => {
357 let channel_id_str = words.next();
358 if channel_id_str.is_none() {
359 println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id>`");
361 io::stdout().flush().unwrap();
364 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
365 if channel_id_vec.is_none() {
366 println!("ERROR: couldn't parse channel_id as hex");
368 io::stdout().flush().unwrap();
371 let mut channel_id = [0; 32];
372 channel_id.copy_from_slice(&channel_id_vec.unwrap());
373 force_close_channel(channel_id, channel_manager.clone());
375 _ => println!("Unknown command. See `\"help\" for available commands."),
379 io::stdout().flush().unwrap();
384 println!("openchannel pubkey@host:port <channel_amt_satoshis>");
385 println!("sendpayment <invoice>");
386 println!("getinvoice <amt_in_satoshis>");
387 println!("connectpeer pubkey@host:port");
388 println!("listchannels");
389 println!("listpayments");
390 println!("closechannel <channel_id>");
391 println!("forceclosechannel <channel_id>");
394 fn list_channels(channel_manager: Arc<ChannelManager>) {
396 for chan_info in channel_manager.list_channels() {
399 println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..]));
401 "\t\tpeer_pubkey: {},",
402 hex_utils::hex_str(&chan_info.remote_network_id.serialize())
404 let mut pending_channel = false;
405 match chan_info.short_channel_id {
406 Some(id) => println!("\t\tshort_channel_id: {},", id),
408 pending_channel = true;
411 println!("\t\tpending_open: {},", pending_channel);
412 println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
413 println!("\t\tchannel_can_send_payments: {},", chan_info.is_live);
419 fn list_payments(payment_storage: PaymentInfoStorage) {
420 let payments = payment_storage.lock().unwrap();
422 for (payment_hash, payment_info) in payments.deref() {
423 let direction_str = match payment_info.1 {
424 HTLCDirection::Inbound => "inbound",
425 HTLCDirection::Outbound => "outbound",
429 println!("\t\tamount_satoshis: {},", payment_info.3);
430 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
431 println!("\t\thtlc_direction: {},", direction_str);
433 "\t\thtlc_status: {},",
434 match payment_info.2 {
435 HTLCStatus::Pending => "pending",
436 HTLCStatus::Succeeded => "succeeded",
437 HTLCStatus::Failed => "failed",
446 pub(crate) fn connect_peer_if_necessary(
447 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
448 event_notifier: mpsc::Sender<()>,
449 ) -> Result<(), ()> {
450 for node_pubkey in peer_manager.get_peer_node_ids() {
451 if node_pubkey == pubkey {
455 match TcpStream::connect_timeout(&peer_addr, Duration::from_secs(10)) {
457 let peer_mgr = peer_manager.clone();
458 let event_ntfns = event_notifier.clone();
459 tokio::spawn(async move {
460 lightning_net_tokio::setup_outbound(peer_mgr, event_ntfns, pubkey, stream).await;
462 let mut peer_connected = false;
463 while !peer_connected {
464 for node_pubkey in peer_manager.get_peer_node_ids() {
465 if node_pubkey == pubkey {
466 peer_connected = true;
472 println!("ERROR: failed to connect to peer: {:?}", e);
480 peer_pubkey: PublicKey, channel_amt_sat: u64, announce_channel: bool,
481 channel_manager: Arc<ChannelManager>,
482 ) -> Result<(), ()> {
483 let mut config = UserConfig::default();
484 if announce_channel {
485 config.channel_options.announced_channel = true;
487 // lnd's max to_self_delay is 2016, so we want to be compatible.
488 config.peer_channel_config_limits.their_to_self_delay = 2016;
489 match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, None) {
491 println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
495 println!("ERROR: failed to open channel: {:?}", e);
502 payee: PublicKey, amt_msat: u64, final_cltv: u32, payment_hash: PaymentHash,
503 payment_secret: Option<PaymentSecret>, payee_features: Option<InvoiceFeatures>,
504 router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access>, Arc<FilesystemLogger>>>,
505 channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
506 logger: Arc<FilesystemLogger>,
508 let network_graph = router.network_graph.read().unwrap();
509 let first_hops = channel_manager.list_usable_channels();
510 let payer_pubkey = channel_manager.get_our_node_id();
512 let route = router::get_route(
517 Some(&first_hops.iter().collect::<Vec<_>>()),
523 if let Err(e) = route {
524 println!("ERROR: failed to find route: {}", e.err);
527 let status = match channel_manager.send_payment(&route.unwrap(), payment_hash, &payment_secret)
530 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee);
534 println!("ERROR: failed to send payment: {:?}", e);
538 let mut payments = payment_storage.lock().unwrap();
541 (None, HTLCDirection::Outbound, status, SatoshiAmount(Some(amt_msat / 1000))),
546 amt_sat: u64, payment_storage: PaymentInfoStorage, our_node_privkey: SecretKey,
547 channel_manager: Arc<ChannelManager>, network: Network,
549 let mut payments = payment_storage.lock().unwrap();
550 let secp_ctx = Secp256k1::new();
552 let mut preimage = [0; 32];
553 rand::thread_rng().fill_bytes(&mut preimage);
554 let payment_hash = Sha256Hash::hash(&preimage);
556 let our_node_pubkey = channel_manager.get_our_node_id();
557 let mut invoice = lightning_invoice::InvoiceBuilder::new(match network {
558 Network::Bitcoin => lightning_invoice::Currency::Bitcoin,
559 Network::Testnet => lightning_invoice::Currency::BitcoinTestnet,
560 Network::Regtest => lightning_invoice::Currency::Regtest,
561 Network::Signet => panic!("Signet invoices not supported"),
563 .payment_hash(payment_hash)
564 .description("rust-lightning-bitcoinrpc invoice".to_string())
565 .amount_pico_btc(amt_sat * 10_000)
567 .payee_pub_key(our_node_pubkey);
569 // Add route hints to the invoice.
570 let our_channels = channel_manager.list_usable_channels();
571 for channel in our_channels {
572 let short_channel_id = match channel.short_channel_id {
573 Some(id) => id.to_be_bytes(),
576 let forwarding_info = match channel.counterparty_forwarding_info {
580 println!("VMW: adding routehop, info.fee base: {}", forwarding_info.fee_base_msat);
581 invoice = invoice.route(vec![lightning_invoice::RouteHop {
582 pubkey: channel.remote_network_id,
584 fee_base_msat: forwarding_info.fee_base_msat,
585 fee_proportional_millionths: forwarding_info.fee_proportional_millionths,
586 cltv_expiry_delta: forwarding_info.cltv_expiry_delta,
592 invoice.build_signed(|msg_hash| secp_ctx.sign_recoverable(msg_hash, &our_node_privkey));
595 Ok(invoice) => println!("SUCCESS: generated invoice: {}", invoice),
596 Err(e) => println!("ERROR: failed to create invoice: {:?}", e),
600 PaymentHash(payment_hash.into_inner()),
602 Some(PaymentPreimage(preimage)),
603 HTLCDirection::Inbound,
605 SatoshiAmount(Some(amt_sat)),
610 fn close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
611 match channel_manager.close_channel(&channel_id) {
612 Ok(()) => println!("EVENT: initiating channel close"),
613 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
617 fn force_close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
618 match channel_manager.force_close_channel(&channel_id) {
619 Ok(()) => println!("EVENT: initiating channel force-close"),
620 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
624 pub(crate) fn parse_peer_info(
625 peer_pubkey_and_ip_addr: String,
626 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
627 let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
628 let pubkey = pubkey_and_addr.next();
629 let peer_addr_str = pubkey_and_addr.next();
630 if peer_addr_str.is_none() || peer_addr_str.is_none() {
631 return Err(std::io::Error::new(
632 std::io::ErrorKind::Other,
633 "ERROR: incorrectly formatted peer
634 info. Should be formatted as: `pubkey@host:port`",
638 let peer_addr: Result<SocketAddr, _> = peer_addr_str.unwrap().parse();
639 if peer_addr.is_err() {
640 return Err(std::io::Error::new(
641 std::io::ErrorKind::Other,
642 "ERROR: couldn't parse pubkey@host:port into a socket address",
646 let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
647 if pubkey.is_none() {
648 return Err(std::io::Error::new(
649 std::io::ErrorKind::Other,
650 "ERROR: unable to parse given pubkey for node",
654 Ok((pubkey.unwrap(), peer_addr.unwrap()))