4 ChannelManager, HTLCStatus, InvoicePayer, MillisatAmount, PaymentInfo, PaymentInfoStorage,
7 use bitcoin::hashes::sha256::Hash as Sha256;
8 use bitcoin::hashes::Hash;
9 use bitcoin::network::constants::Network;
10 use bitcoin::secp256k1::key::PublicKey;
11 use lightning::chain::keysinterface::{KeysInterface, KeysManager};
12 use lightning::ln::msgs::NetAddress;
13 use lightning::ln::{PaymentHash, PaymentPreimage};
14 use lightning::util::config::{ChannelConfig, ChannelHandshakeLimits, UserConfig};
15 use lightning::util::events::EventHandler;
16 use lightning_invoice::payment::PaymentError;
17 use lightning_invoice::{utils, Currency, Invoice};
20 use std::io::{BufRead, Write};
21 use std::net::{IpAddr, SocketAddr, ToSocketAddrs};
24 use std::str::FromStr;
26 use std::time::Duration;
28 pub(crate) struct LdkUserInfo {
29 pub(crate) bitcoind_rpc_username: String,
30 pub(crate) bitcoind_rpc_password: String,
31 pub(crate) bitcoind_rpc_port: u16,
32 pub(crate) bitcoind_rpc_host: String,
33 pub(crate) ldk_storage_dir_path: String,
34 pub(crate) ldk_peer_listening_port: u16,
35 pub(crate) ldk_announced_listen_addr: Vec<NetAddress>,
36 pub(crate) ldk_announced_node_name: [u8; 32],
37 pub(crate) network: Network,
40 pub(crate) fn parse_startup_args() -> Result<LdkUserInfo, ()> {
41 if env::args().len() < 3 {
42 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-node-name announced-listen-addr*]`");
45 let bitcoind_rpc_info = env::args().skip(1).next().unwrap();
46 let bitcoind_rpc_info_parts: Vec<&str> = bitcoind_rpc_info.rsplitn(2, "@").collect();
47 if bitcoind_rpc_info_parts.len() != 2 {
48 println!("ERROR: bad bitcoind RPC URL provided");
51 let rpc_user_and_password: Vec<&str> = bitcoind_rpc_info_parts[1].split(":").collect();
52 if rpc_user_and_password.len() != 2 {
53 println!("ERROR: bad bitcoind RPC username/password combo provided");
56 let bitcoind_rpc_username = rpc_user_and_password[0].to_string();
57 let bitcoind_rpc_password = rpc_user_and_password[1].to_string();
58 let bitcoind_rpc_path: Vec<&str> = bitcoind_rpc_info_parts[0].split(":").collect();
59 if bitcoind_rpc_path.len() != 2 {
60 println!("ERROR: bad bitcoind RPC path provided");
63 let bitcoind_rpc_host = bitcoind_rpc_path[0].to_string();
64 let bitcoind_rpc_port = bitcoind_rpc_path[1].parse::<u16>().unwrap();
66 let ldk_storage_dir_path = env::args().skip(2).next().unwrap();
68 let mut ldk_peer_port_set = true;
69 let ldk_peer_listening_port: u16 = match env::args().skip(3).next().map(|p| p.parse()) {
72 ldk_peer_port_set = false;
76 ldk_peer_port_set = false;
81 let mut arg_idx = match ldk_peer_port_set {
85 let network: Network = match env::args().skip(arg_idx).next().as_ref().map(String::as_str) {
86 Some("testnet") => Network::Testnet,
87 Some("regtest") => Network::Regtest,
89 panic!("Unsupported network provided. Options are: `regtest`, `testnet`. Got {}", net);
91 None => Network::Testnet,
94 let ldk_announced_node_name = match env::args().skip(arg_idx + 1).next().as_ref() {
97 panic!("Node Alias can not be longer than 32 bytes");
100 let mut bytes = [0; 32];
101 bytes[..s.len()].copy_from_slice(s.as_bytes());
107 let mut ldk_announced_listen_addr = Vec::new();
109 match env::args().skip(arg_idx + 1).next().as_ref() {
110 Some(s) => match IpAddr::from_str(s) {
111 Ok(IpAddr::V4(a)) => {
112 ldk_announced_listen_addr
113 .push(NetAddress::IPv4 { addr: a.octets(), port: ldk_peer_listening_port });
116 Ok(IpAddr::V6(a)) => {
117 ldk_announced_listen_addr
118 .push(NetAddress::IPv6 { addr: a.octets(), port: ldk_peer_listening_port });
121 Err(_) => panic!("Failed to parse announced-listen-addr into an IP address"),
128 bitcoind_rpc_username,
129 bitcoind_rpc_password,
132 ldk_storage_dir_path,
133 ldk_peer_listening_port,
134 ldk_announced_listen_addr,
135 ldk_announced_node_name,
140 pub(crate) async fn poll_for_user_input<E: EventHandler>(
141 invoice_payer: Arc<InvoicePayer<E>>, peer_manager: Arc<PeerManager>,
142 channel_manager: Arc<ChannelManager>, keys_manager: Arc<KeysManager>,
143 inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage,
144 ldk_data_dir: String, network: Network,
146 println!("LDK startup successful. To view available commands: \"help\".");
147 println!("LDK logs are available at <your-supplied-ldk-data-dir-path>/.ldk/logs");
148 println!("Local Node ID is {}.", channel_manager.get_our_node_id());
149 let stdin = io::stdin();
150 let mut line_reader = stdin.lock().lines();
153 io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
154 let line = match line_reader.next() {
155 Some(l) => l.unwrap(),
158 let mut words = line.split_whitespace();
159 if let Some(word) = words.next() {
163 let peer_pubkey_and_ip_addr = words.next();
164 let channel_value_sat = words.next();
165 if peer_pubkey_and_ip_addr.is_none() || channel_value_sat.is_none() {
166 println!("ERROR: openchannel has 2 required arguments: `openchannel pubkey@host:port channel_amt_satoshis` [--public]");
169 let peer_pubkey_and_ip_addr = peer_pubkey_and_ip_addr.unwrap();
170 let (pubkey, peer_addr) =
171 match parse_peer_info(peer_pubkey_and_ip_addr.to_string()) {
174 println!("{:?}", e.into_inner().unwrap());
179 let chan_amt_sat: Result<u64, _> = channel_value_sat.unwrap().parse();
180 if chan_amt_sat.is_err() {
181 println!("ERROR: channel amount must be a number");
185 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
192 let announce_channel = match words.next() {
193 Some("--public") | Some("--public=true") => true,
194 Some("--public=false") => false,
196 println!("ERROR: invalid `--public` command format. Valid formats: `--public`, `--public=true` `--public=false`");
204 chan_amt_sat.unwrap(),
206 channel_manager.clone(),
210 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
211 let _ = disk::persist_channel_peer(
212 Path::new(&peer_data_path),
213 peer_pubkey_and_ip_addr,
218 let invoice_str = words.next();
219 if invoice_str.is_none() {
220 println!("ERROR: sendpayment requires an invoice: `sendpayment <invoice>`");
224 let invoice = match Invoice::from_str(invoice_str.unwrap()) {
227 println!("ERROR: invalid invoice: {:?}", e);
232 send_payment(&*invoice_payer, &invoice, outbound_payments.clone());
235 let dest_pubkey = match words.next() {
236 Some(dest) => match hex_utils::to_compressed_pubkey(dest) {
239 println!("ERROR: couldn't parse destination pubkey");
244 println!("ERROR: keysend requires a destination pubkey: `keysend <dest_pubkey> <amt_msat>`");
248 let amt_msat_str = match words.next() {
251 println!("ERROR: keysend requires an amount in millisatoshis: `keysend <dest_pubkey> <amt_msat>`");
255 let amt_msat: u64 = match amt_msat_str.parse() {
258 println!("ERROR: couldn't parse amount_msat: {}", e);
267 outbound_payments.clone(),
271 let amt_str = words.next();
272 if amt_str.is_none() {
273 println!("ERROR: getinvoice requires an amount in millisatoshis");
277 let amt_msat: Result<u64, _> = amt_str.unwrap().parse();
278 if amt_msat.is_err() {
279 println!("ERROR: getinvoice provided payment amount was not a number");
284 inbound_payments.clone(),
285 channel_manager.clone(),
286 keys_manager.clone(),
291 let peer_pubkey_and_ip_addr = words.next();
292 if peer_pubkey_and_ip_addr.is_none() {
293 println!("ERROR: connectpeer requires peer connection info: `connectpeer pubkey@host:port`");
296 let (pubkey, peer_addr) =
297 match parse_peer_info(peer_pubkey_and_ip_addr.unwrap().to_string()) {
300 println!("{:?}", e.into_inner().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>`");
321 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
322 if channel_id_vec.is_none() {
323 println!("ERROR: couldn't parse channel_id as hex");
326 let mut channel_id = [0; 32];
327 channel_id.copy_from_slice(&channel_id_vec.unwrap());
328 close_channel(channel_id, channel_manager.clone());
330 "forceclosechannel" => {
331 let channel_id_str = words.next();
332 if channel_id_str.is_none() {
333 println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id>`");
336 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
337 if channel_id_vec.is_none() {
338 println!("ERROR: couldn't parse channel_id as hex");
341 let mut channel_id = [0; 32];
342 channel_id.copy_from_slice(&channel_id_vec.unwrap());
343 force_close_channel(channel_id, channel_manager.clone());
345 "nodeinfo" => node_info(channel_manager.clone(), peer_manager.clone()),
346 "listpeers" => list_peers(peer_manager.clone()),
348 const MSG_STARTPOS: usize = "signmessage".len() + 1;
349 if line.as_bytes().len() <= MSG_STARTPOS {
350 println!("ERROR: signmsg requires a message");
355 lightning::util::message_signing::sign(
356 &line.as_bytes()[MSG_STARTPOS..],
357 &keys_manager.get_node_secret()
361 _ => println!("Unknown command. See `\"help\" for available commands."),
368 println!("openchannel pubkey@host:port <amt_satoshis>");
369 println!("sendpayment <invoice>");
370 println!("getinvoice <amt_millisatoshis>");
371 println!("connectpeer pubkey@host:port");
372 println!("listchannels");
373 println!("listpayments");
374 println!("closechannel <channel_id>");
375 println!("forceclosechannel <channel_id>");
376 println!("nodeinfo");
377 println!("listpeers");
378 println!("signmessage <message>");
381 fn node_info(channel_manager: Arc<ChannelManager>, peer_manager: Arc<PeerManager>) {
383 println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
384 let chans = channel_manager.list_channels();
385 println!("\t\t num_channels: {}", chans.len());
386 println!("\t\t num_usable_channels: {}", chans.iter().filter(|c| c.is_usable).count());
387 let local_balance_msat = chans
389 .map(|c| c.unspendable_punishment_reserve.unwrap_or(0) * 1000 + c.outbound_capacity_msat)
391 println!("\t\t local_balance_msat: {}", local_balance_msat);
392 println!("\t\t num_peers: {}", peer_manager.get_peer_node_ids().len());
396 fn list_peers(peer_manager: Arc<PeerManager>) {
398 for pubkey in peer_manager.get_peer_node_ids() {
399 println!("\t\t pubkey: {}", pubkey);
404 fn list_channels(channel_manager: Arc<ChannelManager>) {
406 for chan_info in channel_manager.list_channels() {
409 println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..]));
410 if let Some(funding_txo) = chan_info.funding_txo {
411 println!("\t\tfunding_txid: {},", funding_txo.txid);
414 "\t\tpeer_pubkey: {},",
415 hex_utils::hex_str(&chan_info.counterparty.node_id.serialize())
417 if let Some(id) = chan_info.short_channel_id {
418 println!("\t\tshort_channel_id: {},", id);
420 println!("\t\tis_confirmed_onchain: {},", chan_info.is_funding_locked);
421 println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
423 "\t\tlocal_balance_msat: {},",
424 chan_info.outbound_capacity_msat
425 + chan_info.unspendable_punishment_reserve.unwrap_or(0) * 1000
427 if chan_info.is_usable {
428 println!("\t\tavailable_balance_for_send_msat: {},", chan_info.outbound_capacity_msat);
429 println!("\t\tavailable_balance_for_recv_msat: {},", chan_info.inbound_capacity_msat);
431 println!("\t\tchannel_can_send_payments: {},", chan_info.is_usable);
432 println!("\t\tpublic: {},", chan_info.is_public);
438 fn list_payments(inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage) {
439 let inbound = inbound_payments.lock().unwrap();
440 let outbound = outbound_payments.lock().unwrap();
442 for (payment_hash, payment_info) in inbound.deref() {
445 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
446 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
447 println!("\t\thtlc_direction: inbound,");
449 "\t\thtlc_status: {},",
450 match payment_info.status {
451 HTLCStatus::Pending => "pending",
452 HTLCStatus::Succeeded => "succeeded",
453 HTLCStatus::Failed => "failed",
460 for (payment_hash, payment_info) in outbound.deref() {
463 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
464 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
465 println!("\t\thtlc_direction: outbound,");
467 "\t\thtlc_status: {},",
468 match payment_info.status {
469 HTLCStatus::Pending => "pending",
470 HTLCStatus::Succeeded => "succeeded",
471 HTLCStatus::Failed => "failed",
480 pub(crate) async fn connect_peer_if_necessary(
481 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
482 ) -> Result<(), ()> {
483 for node_pubkey in peer_manager.get_peer_node_ids() {
484 if node_pubkey == pubkey {
488 let res = do_connect_peer(pubkey, peer_addr, peer_manager).await;
490 println!("ERROR: failed to connect to peer");
495 pub(crate) async fn do_connect_peer(
496 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
497 ) -> Result<(), ()> {
498 match lightning_net_tokio::connect_outbound(Arc::clone(&peer_manager), pubkey, peer_addr).await
500 Some(connection_closed_future) => {
501 let mut connection_closed_future = Box::pin(connection_closed_future);
503 match futures::poll!(&mut connection_closed_future) {
504 std::task::Poll::Ready(_) => {
507 std::task::Poll::Pending => {}
509 // Avoid blocking the tokio context by sleeping a bit
510 match peer_manager.get_peer_node_ids().iter().find(|id| **id == pubkey) {
511 Some(_) => return Ok(()),
512 None => tokio::time::sleep(Duration::from_millis(10)).await,
521 peer_pubkey: PublicKey, channel_amt_sat: u64, announced_channel: bool,
522 channel_manager: Arc<ChannelManager>,
523 ) -> Result<(), ()> {
524 let config = UserConfig {
525 peer_channel_config_limits: ChannelHandshakeLimits {
526 // lnd's max to_self_delay is 2016, so we want to be compatible.
527 their_to_self_delay: 2016,
530 channel_options: ChannelConfig { announced_channel, ..Default::default() },
534 match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, Some(config)) {
536 println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
540 println!("ERROR: failed to open channel: {:?}", e);
546 fn send_payment<E: EventHandler>(
547 invoice_payer: &InvoicePayer<E>, invoice: &Invoice, payment_storage: PaymentInfoStorage,
549 let status = match invoice_payer.pay_invoice(invoice) {
551 let payee_pubkey = invoice.recover_payee_pub_key();
552 let amt_msat = invoice.amount_milli_satoshis().unwrap();
553 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
557 Err(PaymentError::Invoice(e)) => {
558 println!("ERROR: invalid invoice: {}", e);
562 Err(PaymentError::Routing(e)) => {
563 println!("ERROR: failed to find route: {}", e.err);
567 Err(PaymentError::Sending(e)) => {
568 println!("ERROR: failed to send payment: {:?}", e);
573 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
574 let payment_secret = Some(invoice.payment_secret().clone());
576 let mut payments = payment_storage.lock().unwrap();
581 secret: payment_secret,
583 amt_msat: MillisatAmount(invoice.amount_milli_satoshis()),
588 fn keysend<E: EventHandler, K: KeysInterface>(
589 invoice_payer: &InvoicePayer<E>, payee_pubkey: PublicKey, amt_msat: u64, keys: &K,
590 payment_storage: PaymentInfoStorage,
592 let payment_preimage = keys.get_secure_random_bytes();
594 let status = match invoice_payer.pay_pubkey(
596 PaymentPreimage(payment_preimage),
601 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
605 Err(PaymentError::Invoice(e)) => {
606 println!("ERROR: invalid payee: {}", e);
610 Err(PaymentError::Routing(e)) => {
611 println!("ERROR: failed to find route: {}", e.err);
615 Err(PaymentError::Sending(e)) => {
616 println!("ERROR: failed to send payment: {:?}", e);
622 let mut payments = payment_storage.lock().unwrap();
624 PaymentHash(Sha256::hash(&payment_preimage).into_inner()),
629 amt_msat: MillisatAmount(Some(amt_msat)),
635 amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: Arc<ChannelManager>,
636 keys_manager: Arc<KeysManager>, network: Network,
638 let mut payments = payment_storage.lock().unwrap();
639 let currency = match network {
640 Network::Bitcoin => Currency::Bitcoin,
641 Network::Testnet => Currency::BitcoinTestnet,
642 Network::Regtest => Currency::Regtest,
643 Network::Signet => panic!("Signet unsupported"),
645 let invoice = match utils::create_invoice_from_channelmanager(
650 "ldk-tutorial-node".to_string(),
653 println!("SUCCESS: generated invoice: {}", inv);
657 println!("ERROR: failed to create invoice: {:?}", e);
662 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
667 secret: Some(invoice.payment_secret().clone()),
668 status: HTLCStatus::Pending,
669 amt_msat: MillisatAmount(Some(amt_msat)),
674 fn close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
675 match channel_manager.close_channel(&channel_id) {
676 Ok(()) => println!("EVENT: initiating channel close"),
677 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
681 fn force_close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
682 match channel_manager.force_close_channel(&channel_id) {
683 Ok(()) => println!("EVENT: initiating channel force-close"),
684 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
688 pub(crate) fn parse_peer_info(
689 peer_pubkey_and_ip_addr: String,
690 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
691 let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
692 let pubkey = pubkey_and_addr.next();
693 let peer_addr_str = pubkey_and_addr.next();
694 if peer_addr_str.is_none() || peer_addr_str.is_none() {
695 return Err(std::io::Error::new(
696 std::io::ErrorKind::Other,
697 "ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`",
701 let peer_addr = peer_addr_str.unwrap().to_socket_addrs().map(|mut r| r.next());
702 if peer_addr.is_err() || peer_addr.as_ref().unwrap().is_none() {
703 return Err(std::io::Error::new(
704 std::io::ErrorKind::Other,
705 "ERROR: couldn't parse pubkey@host:port into a socket address",
709 let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
710 if pubkey.is_none() {
711 return Err(std::io::Error::new(
712 std::io::ErrorKind::Other,
713 "ERROR: unable to parse given pubkey for node",
717 Ok((pubkey.unwrap(), peer_addr.unwrap().unwrap()))