4 ChannelManager, HTLCStatus, InvoicePayer, MillisatAmount, NetworkGraph, OnionMessenger,
5 PaymentInfo, PaymentInfoStorage, PeerManager,
7 use bitcoin::hashes::sha256::Hash as Sha256;
8 use bitcoin::hashes::Hash;
9 use bitcoin::network::constants::Network;
10 use bitcoin::secp256k1::PublicKey;
11 use lightning::chain::keysinterface::{KeysInterface, KeysManager, Recipient};
12 use lightning::ln::msgs::{DecodeError, NetAddress};
13 use lightning::ln::{PaymentHash, PaymentPreimage};
14 use lightning::onion_message::{CustomOnionMessageContents, Destination, OnionMessageContents};
15 use lightning::routing::gossip::NodeId;
16 use lightning::util::config::{ChannelHandshakeConfig, ChannelHandshakeLimits, UserConfig};
17 use lightning::util::events::EventHandler;
18 use lightning::util::ser::{Writeable, Writer};
19 use lightning_invoice::payment::PaymentError;
20 use lightning_invoice::{utils, Currency, Invoice};
24 use std::net::{SocketAddr, ToSocketAddrs};
27 use std::str::FromStr;
29 use std::time::Duration;
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) ldk_announced_listen_addr: Vec<NetAddress>,
39 pub(crate) ldk_announced_node_name: [u8; 32],
40 pub(crate) network: Network,
43 struct UserOnionMessageContents {
48 impl CustomOnionMessageContents for UserOnionMessageContents {
49 fn tlv_type(&self) -> u64 {
54 impl Writeable for UserOnionMessageContents {
55 fn write<W: Writer>(&self, w: &mut W) -> Result<(), std::io::Error> {
56 w.write_all(&self.data)
60 pub(crate) async fn poll_for_user_input<E: EventHandler>(
61 invoice_payer: Arc<InvoicePayer<E>>, peer_manager: Arc<PeerManager>,
62 channel_manager: Arc<ChannelManager>, keys_manager: Arc<KeysManager>,
63 network_graph: Arc<NetworkGraph>, onion_messenger: Arc<OnionMessenger>,
64 inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage,
65 ldk_data_dir: String, network: Network, logger: Arc<disk::FilesystemLogger>,
68 "LDK startup successful. Enter \"help\" to view available commands. Press Ctrl-D to quit."
70 println!("LDK logs are available at <your-supplied-ldk-data-dir-path>/.ldk/logs");
71 println!("Local Node ID is {}.", channel_manager.get_our_node_id());
74 io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
75 let mut line = String::new();
76 if let Err(e) = io::stdin().read_line(&mut line) {
77 break println!("ERROR: {}", e);
81 // We hit EOF / Ctrl-D
85 let mut words = line.split_whitespace();
86 if let Some(word) = words.next() {
90 let peer_pubkey_and_ip_addr = words.next();
91 let channel_value_sat = words.next();
92 if peer_pubkey_and_ip_addr.is_none() || channel_value_sat.is_none() {
93 println!("ERROR: openchannel has 2 required arguments: `openchannel pubkey@host:port channel_amt_satoshis` [--public]");
96 let peer_pubkey_and_ip_addr = peer_pubkey_and_ip_addr.unwrap();
97 let (pubkey, peer_addr) =
98 match parse_peer_info(peer_pubkey_and_ip_addr.to_string()) {
101 println!("{:?}", e.into_inner().unwrap());
106 let chan_amt_sat: Result<u64, _> = channel_value_sat.unwrap().parse();
107 if chan_amt_sat.is_err() {
108 println!("ERROR: channel amount must be a number");
112 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
119 let announce_channel = match words.next() {
120 Some("--public") | Some("--public=true") => true,
121 Some("--public=false") => false,
123 println!("ERROR: invalid `--public` command format. Valid formats: `--public`, `--public=true` `--public=false`");
131 chan_amt_sat.unwrap(),
133 channel_manager.clone(),
137 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
138 let _ = disk::persist_channel_peer(
139 Path::new(&peer_data_path),
140 peer_pubkey_and_ip_addr,
145 let invoice_str = words.next();
146 if invoice_str.is_none() {
147 println!("ERROR: sendpayment requires an invoice: `sendpayment <invoice>`");
151 let invoice = match Invoice::from_str(invoice_str.unwrap()) {
154 println!("ERROR: invalid invoice: {:?}", e);
159 send_payment(&*invoice_payer, &invoice, outbound_payments.clone());
162 let dest_pubkey = match words.next() {
163 Some(dest) => match hex_utils::to_compressed_pubkey(dest) {
166 println!("ERROR: couldn't parse destination pubkey");
171 println!("ERROR: keysend requires a destination pubkey: `keysend <dest_pubkey> <amt_msat>`");
175 let amt_msat_str = match words.next() {
178 println!("ERROR: keysend requires an amount in millisatoshis: `keysend <dest_pubkey> <amt_msat>`");
182 let amt_msat: u64 = match amt_msat_str.parse() {
185 println!("ERROR: couldn't parse amount_msat: {}", e);
194 outbound_payments.clone(),
198 let amt_str = words.next();
199 if amt_str.is_none() {
200 println!("ERROR: getinvoice requires an amount in millisatoshis");
204 let amt_msat: Result<u64, _> = amt_str.unwrap().parse();
205 if amt_msat.is_err() {
206 println!("ERROR: getinvoice provided payment amount was not a number");
210 let expiry_secs_str = words.next();
211 if expiry_secs_str.is_none() {
212 println!("ERROR: getinvoice requires an expiry in seconds");
216 let expiry_secs: Result<u32, _> = expiry_secs_str.unwrap().parse();
217 if expiry_secs.is_err() {
218 println!("ERROR: getinvoice provided expiry was not a number");
224 Arc::clone(&inbound_payments),
226 Arc::clone(&keys_manager),
228 expiry_secs.unwrap(),
233 let peer_pubkey_and_ip_addr = words.next();
234 if peer_pubkey_and_ip_addr.is_none() {
235 println!("ERROR: connectpeer requires peer connection info: `connectpeer pubkey@host:port`");
238 let (pubkey, peer_addr) =
239 match parse_peer_info(peer_pubkey_and_ip_addr.unwrap().to_string()) {
242 println!("{:?}", e.into_inner().unwrap());
246 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
250 println!("SUCCESS: connected to peer {}", pubkey);
253 "listchannels" => list_channels(&channel_manager, &network_graph),
255 list_payments(inbound_payments.clone(), outbound_payments.clone())
258 let channel_id_str = words.next();
259 if channel_id_str.is_none() {
260 println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id> <peer_pubkey>`");
263 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
264 if channel_id_vec.is_none() || channel_id_vec.as_ref().unwrap().len() != 32 {
265 println!("ERROR: couldn't parse channel_id");
268 let mut channel_id = [0; 32];
269 channel_id.copy_from_slice(&channel_id_vec.unwrap());
271 let peer_pubkey_str = words.next();
272 if peer_pubkey_str.is_none() {
273 println!("ERROR: closechannel requires a peer pubkey: `closechannel <channel_id> <peer_pubkey>`");
276 let peer_pubkey_vec = match hex_utils::to_vec(peer_pubkey_str.unwrap()) {
277 Some(peer_pubkey_vec) => peer_pubkey_vec,
279 println!("ERROR: couldn't parse peer_pubkey");
283 let peer_pubkey = match PublicKey::from_slice(&peer_pubkey_vec) {
284 Ok(peer_pubkey) => peer_pubkey,
286 println!("ERROR: couldn't parse peer_pubkey");
291 close_channel(channel_id, peer_pubkey, channel_manager.clone());
293 "forceclosechannel" => {
294 let channel_id_str = words.next();
295 if channel_id_str.is_none() {
296 println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id> <peer_pubkey>`");
299 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
300 if channel_id_vec.is_none() || channel_id_vec.as_ref().unwrap().len() != 32 {
301 println!("ERROR: couldn't parse channel_id");
304 let mut channel_id = [0; 32];
305 channel_id.copy_from_slice(&channel_id_vec.unwrap());
307 let peer_pubkey_str = words.next();
308 if peer_pubkey_str.is_none() {
309 println!("ERROR: forceclosechannel requires a peer pubkey: `forceclosechannel <channel_id> <peer_pubkey>`");
312 let peer_pubkey_vec = match hex_utils::to_vec(peer_pubkey_str.unwrap()) {
313 Some(peer_pubkey_vec) => peer_pubkey_vec,
315 println!("ERROR: couldn't parse peer_pubkey");
319 let peer_pubkey = match PublicKey::from_slice(&peer_pubkey_vec) {
320 Ok(peer_pubkey) => peer_pubkey,
322 println!("ERROR: couldn't parse peer_pubkey");
327 force_close_channel(channel_id, peer_pubkey, channel_manager.clone());
329 "nodeinfo" => node_info(&channel_manager, &peer_manager),
330 "listpeers" => list_peers(peer_manager.clone()),
332 const MSG_STARTPOS: usize = "signmessage".len() + 1;
333 if line.as_bytes().len() <= MSG_STARTPOS {
334 println!("ERROR: signmsg requires a message");
339 lightning::util::message_signing::sign(
340 &line.as_bytes()[MSG_STARTPOS..],
341 &keys_manager.get_node_secret(Recipient::Node).unwrap()
345 "sendonionmessage" => {
346 let path_pks_str = words.next();
347 if path_pks_str.is_none() {
349 "ERROR: sendonionmessage requires at least one node id for the path"
353 let mut node_pks = Vec::new();
354 let mut errored = false;
355 for pk_str in path_pks_str.unwrap().split(",") {
356 let node_pubkey_vec = match hex_utils::to_vec(pk_str) {
357 Some(peer_pubkey_vec) => peer_pubkey_vec,
359 println!("ERROR: couldn't parse peer_pubkey");
364 let node_pubkey = match PublicKey::from_slice(&node_pubkey_vec) {
365 Ok(peer_pubkey) => peer_pubkey,
367 println!("ERROR: couldn't parse peer_pubkey");
372 node_pks.push(node_pubkey);
377 let tlv_type = match words.next().map(|ty_str| ty_str.parse()) {
378 Some(Ok(ty)) if ty >= 64 => ty,
380 println!("Need an integral message type above 64");
384 let data = match words.next().map(|s| hex_utils::to_vec(s)) {
385 Some(Some(data)) => data,
387 println!("Need a hex data string");
391 let destination_pk = node_pks.pop().unwrap();
392 match onion_messenger.send_onion_message(
394 Destination::Node(destination_pk),
395 OnionMessageContents::Custom(UserOnionMessageContents { tlv_type, data }),
398 Ok(()) => println!("SUCCESS: forwarded onion message to first hop"),
399 Err(e) => println!("ERROR: failed to send onion message: {:?}", e),
402 "quit" | "exit" => break,
403 _ => println!("Unknown command. See `\"help\" for available commands."),
410 let package_version = env!("CARGO_PKG_VERSION");
411 let package_name = env!("CARGO_PKG_NAME");
412 println!("\nVERSION:");
413 println!(" {} v{}", package_name, package_version);
414 println!("\nUSAGE:");
415 println!(" Command [arguments]");
416 println!("\nCOMMANDS:");
417 println!(" help\tShows a list of commands.");
418 println!(" quit\tClose the application.");
419 println!("\n Channels:");
420 println!(" openchannel pubkey@host:port <amt_satoshis> [--public]");
421 println!(" closechannel <channel_id> <peer_pubkey>");
422 println!(" forceclosechannel <channel_id> <peer_pubkey>");
423 println!(" listchannels");
424 println!("\n Peers:");
425 println!(" connectpeer pubkey@host:port");
426 println!(" listpeers");
427 println!("\n Payments:");
428 println!(" sendpayment <invoice>");
429 println!(" keysend <dest_pubkey> <amt_msats>");
430 println!(" listpayments");
431 println!("\n Invoices:");
432 println!(" getinvoice <amt_msats> <expiry_secs>");
433 println!("\n Other:");
434 println!(" signmessage <message>");
436 " sendonionmessage <node_id_1,node_id_2,..,destination_node_id> <type> <hex_bytes>"
438 println!(" nodeinfo");
441 fn node_info(channel_manager: &Arc<ChannelManager>, peer_manager: &Arc<PeerManager>) {
443 println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
444 let chans = channel_manager.list_channels();
445 println!("\t\t num_channels: {}", chans.len());
446 println!("\t\t num_usable_channels: {}", chans.iter().filter(|c| c.is_usable).count());
447 let local_balance_msat = chans.iter().map(|c| c.balance_msat).sum::<u64>();
448 println!("\t\t local_balance_msat: {}", local_balance_msat);
449 println!("\t\t num_peers: {}", peer_manager.get_peer_node_ids().len());
453 fn list_peers(peer_manager: Arc<PeerManager>) {
455 for pubkey in peer_manager.get_peer_node_ids() {
456 println!("\t\t pubkey: {}", pubkey);
461 fn list_channels(channel_manager: &Arc<ChannelManager>, network_graph: &Arc<NetworkGraph>) {
463 for chan_info in channel_manager.list_channels() {
466 println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..]));
467 if let Some(funding_txo) = chan_info.funding_txo {
468 println!("\t\tfunding_txid: {},", funding_txo.txid);
472 "\t\tpeer_pubkey: {},",
473 hex_utils::hex_str(&chan_info.counterparty.node_id.serialize())
475 if let Some(node_info) = network_graph
478 .get(&NodeId::from_pubkey(&chan_info.counterparty.node_id))
480 if let Some(announcement) = &node_info.announcement_info {
481 println!("\t\tpeer_alias: {}", announcement.alias);
485 if let Some(id) = chan_info.short_channel_id {
486 println!("\t\tshort_channel_id: {},", id);
488 println!("\t\tis_channel_ready: {},", chan_info.is_channel_ready);
489 println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
490 println!("\t\tlocal_balance_msat: {},", chan_info.balance_msat);
491 if chan_info.is_usable {
492 println!("\t\tavailable_balance_for_send_msat: {},", chan_info.outbound_capacity_msat);
493 println!("\t\tavailable_balance_for_recv_msat: {},", chan_info.inbound_capacity_msat);
495 println!("\t\tchannel_can_send_payments: {},", chan_info.is_usable);
496 println!("\t\tpublic: {},", chan_info.is_public);
502 fn list_payments(inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage) {
503 let inbound = inbound_payments.lock().unwrap();
504 let outbound = outbound_payments.lock().unwrap();
506 for (payment_hash, payment_info) in inbound.deref() {
509 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
510 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
511 println!("\t\thtlc_direction: inbound,");
513 "\t\thtlc_status: {},",
514 match payment_info.status {
515 HTLCStatus::Pending => "pending",
516 HTLCStatus::Succeeded => "succeeded",
517 HTLCStatus::Failed => "failed",
524 for (payment_hash, payment_info) in outbound.deref() {
527 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
528 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
529 println!("\t\thtlc_direction: outbound,");
531 "\t\thtlc_status: {},",
532 match payment_info.status {
533 HTLCStatus::Pending => "pending",
534 HTLCStatus::Succeeded => "succeeded",
535 HTLCStatus::Failed => "failed",
544 pub(crate) async fn connect_peer_if_necessary(
545 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
546 ) -> Result<(), ()> {
547 for node_pubkey in peer_manager.get_peer_node_ids() {
548 if node_pubkey == pubkey {
552 let res = do_connect_peer(pubkey, peer_addr, peer_manager).await;
554 println!("ERROR: failed to connect to peer");
559 pub(crate) async fn do_connect_peer(
560 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
561 ) -> Result<(), ()> {
562 match lightning_net_tokio::connect_outbound(Arc::clone(&peer_manager), pubkey, peer_addr).await
564 Some(connection_closed_future) => {
565 let mut connection_closed_future = Box::pin(connection_closed_future);
567 match futures::poll!(&mut connection_closed_future) {
568 std::task::Poll::Ready(_) => {
571 std::task::Poll::Pending => {}
573 // Avoid blocking the tokio context by sleeping a bit
574 match peer_manager.get_peer_node_ids().iter().find(|id| **id == pubkey) {
575 Some(_) => return Ok(()),
576 None => tokio::time::sleep(Duration::from_millis(10)).await,
585 peer_pubkey: PublicKey, channel_amt_sat: u64, announced_channel: bool,
586 channel_manager: Arc<ChannelManager>,
587 ) -> Result<(), ()> {
588 let config = UserConfig {
589 channel_handshake_limits: ChannelHandshakeLimits {
590 // lnd's max to_self_delay is 2016, so we want to be compatible.
591 their_to_self_delay: 2016,
594 channel_handshake_config: ChannelHandshakeConfig {
601 match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, Some(config)) {
603 println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
607 println!("ERROR: failed to open channel: {:?}", e);
613 fn send_payment<E: EventHandler>(
614 invoice_payer: &InvoicePayer<E>, invoice: &Invoice, payment_storage: PaymentInfoStorage,
616 let status = match invoice_payer.pay_invoice(invoice) {
618 let payee_pubkey = invoice.recover_payee_pub_key();
619 let amt_msat = invoice.amount_milli_satoshis().unwrap();
620 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
624 Err(PaymentError::Invoice(e)) => {
625 println!("ERROR: invalid invoice: {}", e);
629 Err(PaymentError::Routing(e)) => {
630 println!("ERROR: failed to find route: {}", e.err);
634 Err(PaymentError::Sending(e)) => {
635 println!("ERROR: failed to send payment: {:?}", e);
640 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
641 let payment_secret = Some(invoice.payment_secret().clone());
643 let mut payments = payment_storage.lock().unwrap();
648 secret: payment_secret,
650 amt_msat: MillisatAmount(invoice.amount_milli_satoshis()),
655 fn keysend<E: EventHandler, K: KeysInterface>(
656 invoice_payer: &InvoicePayer<E>, payee_pubkey: PublicKey, amt_msat: u64, keys: &K,
657 payment_storage: PaymentInfoStorage,
659 let payment_preimage = keys.get_secure_random_bytes();
661 let status = match invoice_payer.pay_pubkey(
663 PaymentPreimage(payment_preimage),
668 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
672 Err(PaymentError::Invoice(e)) => {
673 println!("ERROR: invalid payee: {}", e);
677 Err(PaymentError::Routing(e)) => {
678 println!("ERROR: failed to find route: {}", e.err);
682 Err(PaymentError::Sending(e)) => {
683 println!("ERROR: failed to send payment: {:?}", e);
689 let mut payments = payment_storage.lock().unwrap();
691 PaymentHash(Sha256::hash(&payment_preimage).into_inner()),
696 amt_msat: MillisatAmount(Some(amt_msat)),
702 amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: &ChannelManager,
703 keys_manager: Arc<KeysManager>, network: Network, expiry_secs: u32,
704 logger: Arc<disk::FilesystemLogger>,
706 let mut payments = payment_storage.lock().unwrap();
707 let currency = match network {
708 Network::Bitcoin => Currency::Bitcoin,
709 Network::Testnet => Currency::BitcoinTestnet,
710 Network::Regtest => Currency::Regtest,
711 Network::Signet => Currency::Signet,
713 let invoice = match utils::create_invoice_from_channelmanager(
719 "ldk-tutorial-node".to_string(),
723 println!("SUCCESS: generated invoice: {}", inv);
727 println!("ERROR: failed to create invoice: {:?}", e);
732 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
737 secret: Some(invoice.payment_secret().clone()),
738 status: HTLCStatus::Pending,
739 amt_msat: MillisatAmount(Some(amt_msat)),
745 channel_id: [u8; 32], counterparty_node_id: PublicKey, channel_manager: Arc<ChannelManager>,
747 match channel_manager.close_channel(&channel_id, &counterparty_node_id) {
748 Ok(()) => println!("EVENT: initiating channel close"),
749 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
753 fn force_close_channel(
754 channel_id: [u8; 32], counterparty_node_id: PublicKey, channel_manager: Arc<ChannelManager>,
756 match channel_manager.force_close_broadcasting_latest_txn(&channel_id, &counterparty_node_id) {
757 Ok(()) => println!("EVENT: initiating channel force-close"),
758 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
762 pub(crate) fn parse_peer_info(
763 peer_pubkey_and_ip_addr: String,
764 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
765 let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
766 let pubkey = pubkey_and_addr.next();
767 let peer_addr_str = pubkey_and_addr.next();
768 if peer_addr_str.is_none() {
769 return Err(std::io::Error::new(
770 std::io::ErrorKind::Other,
771 "ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`",
775 let peer_addr = peer_addr_str.unwrap().to_socket_addrs().map(|mut r| r.next());
776 if peer_addr.is_err() || peer_addr.as_ref().unwrap().is_none() {
777 return Err(std::io::Error::new(
778 std::io::ErrorKind::Other,
779 "ERROR: couldn't parse pubkey@host:port into a socket address",
783 let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
784 if pubkey.is_none() {
785 return Err(std::io::Error::new(
786 std::io::ErrorKind::Other,
787 "ERROR: unable to parse given pubkey for node",
791 Ok((pubkey.unwrap(), peer_addr.unwrap().unwrap()))