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::{MaybeReadableArgs, 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 {
53 impl MaybeReadableArgs<u64> for UserOnionMessageContents {
54 fn read<R: std::io::Read>(_r: &mut R, _args: u64) -> Result<Option<Self>, DecodeError> {
55 // UserOnionMessageContents is only ever passed to `send_onion_message`, never to an
56 // `OnionMessageHandler`, thus it does not need to implement the read side here.
60 impl Writeable for UserOnionMessageContents {
61 fn write<W: Writer>(&self, w: &mut W) -> Result<(), std::io::Error> {
62 w.write_all(&self.data)
66 pub(crate) async fn poll_for_user_input<E: EventHandler>(
67 invoice_payer: Arc<InvoicePayer<E>>, peer_manager: Arc<PeerManager>,
68 channel_manager: Arc<ChannelManager>, keys_manager: Arc<KeysManager>,
69 network_graph: Arc<NetworkGraph>, onion_messenger: Arc<OnionMessenger>,
70 inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage,
71 ldk_data_dir: String, network: Network, logger: Arc<disk::FilesystemLogger>,
74 "LDK startup successful. Enter \"help\" to view available commands. Press Ctrl-D to quit."
76 println!("LDK logs are available at <your-supplied-ldk-data-dir-path>/.ldk/logs");
77 println!("Local Node ID is {}.", channel_manager.get_our_node_id());
80 io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
81 let mut line = String::new();
82 if let Err(e) = io::stdin().read_line(&mut line) {
83 break println!("ERROR: {}", e);
87 // We hit EOF / Ctrl-D
91 let mut words = line.split_whitespace();
92 if let Some(word) = words.next() {
96 let peer_pubkey_and_ip_addr = words.next();
97 let channel_value_sat = words.next();
98 if peer_pubkey_and_ip_addr.is_none() || channel_value_sat.is_none() {
99 println!("ERROR: openchannel has 2 required arguments: `openchannel pubkey@host:port channel_amt_satoshis` [--public]");
102 let peer_pubkey_and_ip_addr = peer_pubkey_and_ip_addr.unwrap();
103 let (pubkey, peer_addr) =
104 match parse_peer_info(peer_pubkey_and_ip_addr.to_string()) {
107 println!("{:?}", e.into_inner().unwrap());
112 let chan_amt_sat: Result<u64, _> = channel_value_sat.unwrap().parse();
113 if chan_amt_sat.is_err() {
114 println!("ERROR: channel amount must be a number");
118 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
125 let announce_channel = match words.next() {
126 Some("--public") | Some("--public=true") => true,
127 Some("--public=false") => false,
129 println!("ERROR: invalid `--public` command format. Valid formats: `--public`, `--public=true` `--public=false`");
137 chan_amt_sat.unwrap(),
139 channel_manager.clone(),
143 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
144 let _ = disk::persist_channel_peer(
145 Path::new(&peer_data_path),
146 peer_pubkey_and_ip_addr,
151 let invoice_str = words.next();
152 if invoice_str.is_none() {
153 println!("ERROR: sendpayment requires an invoice: `sendpayment <invoice>`");
157 let invoice = match Invoice::from_str(invoice_str.unwrap()) {
160 println!("ERROR: invalid invoice: {:?}", e);
165 send_payment(&*invoice_payer, &invoice, outbound_payments.clone());
168 let dest_pubkey = match words.next() {
169 Some(dest) => match hex_utils::to_compressed_pubkey(dest) {
172 println!("ERROR: couldn't parse destination pubkey");
177 println!("ERROR: keysend requires a destination pubkey: `keysend <dest_pubkey> <amt_msat>`");
181 let amt_msat_str = match words.next() {
184 println!("ERROR: keysend requires an amount in millisatoshis: `keysend <dest_pubkey> <amt_msat>`");
188 let amt_msat: u64 = match amt_msat_str.parse() {
191 println!("ERROR: couldn't parse amount_msat: {}", e);
200 outbound_payments.clone(),
204 let amt_str = words.next();
205 if amt_str.is_none() {
206 println!("ERROR: getinvoice requires an amount in millisatoshis");
210 let amt_msat: Result<u64, _> = amt_str.unwrap().parse();
211 if amt_msat.is_err() {
212 println!("ERROR: getinvoice provided payment amount was not a number");
216 let expiry_secs_str = words.next();
217 if expiry_secs_str.is_none() {
218 println!("ERROR: getinvoice requires an expiry in seconds");
222 let expiry_secs: Result<u32, _> = expiry_secs_str.unwrap().parse();
223 if expiry_secs.is_err() {
224 println!("ERROR: getinvoice provided expiry was not a number");
230 Arc::clone(&inbound_payments),
232 Arc::clone(&keys_manager),
234 expiry_secs.unwrap(),
239 let peer_pubkey_and_ip_addr = words.next();
240 if peer_pubkey_and_ip_addr.is_none() {
241 println!("ERROR: connectpeer requires peer connection info: `connectpeer pubkey@host:port`");
244 let (pubkey, peer_addr) =
245 match parse_peer_info(peer_pubkey_and_ip_addr.unwrap().to_string()) {
248 println!("{:?}", e.into_inner().unwrap());
252 if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
256 println!("SUCCESS: connected to peer {}", pubkey);
259 "listchannels" => list_channels(&channel_manager, &network_graph),
261 list_payments(inbound_payments.clone(), outbound_payments.clone())
264 let channel_id_str = words.next();
265 if channel_id_str.is_none() {
266 println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id> <peer_pubkey>`");
269 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
270 if channel_id_vec.is_none() || channel_id_vec.as_ref().unwrap().len() != 32 {
271 println!("ERROR: couldn't parse channel_id");
274 let mut channel_id = [0; 32];
275 channel_id.copy_from_slice(&channel_id_vec.unwrap());
277 let peer_pubkey_str = words.next();
278 if peer_pubkey_str.is_none() {
279 println!("ERROR: closechannel requires a peer pubkey: `closechannel <channel_id> <peer_pubkey>`");
282 let peer_pubkey_vec = match hex_utils::to_vec(peer_pubkey_str.unwrap()) {
283 Some(peer_pubkey_vec) => peer_pubkey_vec,
285 println!("ERROR: couldn't parse peer_pubkey");
289 let peer_pubkey = match PublicKey::from_slice(&peer_pubkey_vec) {
290 Ok(peer_pubkey) => peer_pubkey,
292 println!("ERROR: couldn't parse peer_pubkey");
297 close_channel(channel_id, peer_pubkey, channel_manager.clone());
299 "forceclosechannel" => {
300 let channel_id_str = words.next();
301 if channel_id_str.is_none() {
302 println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id> <peer_pubkey>`");
305 let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
306 if channel_id_vec.is_none() || channel_id_vec.as_ref().unwrap().len() != 32 {
307 println!("ERROR: couldn't parse channel_id");
310 let mut channel_id = [0; 32];
311 channel_id.copy_from_slice(&channel_id_vec.unwrap());
313 let peer_pubkey_str = words.next();
314 if peer_pubkey_str.is_none() {
315 println!("ERROR: forceclosechannel requires a peer pubkey: `forceclosechannel <channel_id> <peer_pubkey>`");
318 let peer_pubkey_vec = match hex_utils::to_vec(peer_pubkey_str.unwrap()) {
319 Some(peer_pubkey_vec) => peer_pubkey_vec,
321 println!("ERROR: couldn't parse peer_pubkey");
325 let peer_pubkey = match PublicKey::from_slice(&peer_pubkey_vec) {
326 Ok(peer_pubkey) => peer_pubkey,
328 println!("ERROR: couldn't parse peer_pubkey");
333 force_close_channel(channel_id, peer_pubkey, channel_manager.clone());
335 "nodeinfo" => node_info(&channel_manager, &peer_manager),
336 "listpeers" => list_peers(peer_manager.clone()),
338 const MSG_STARTPOS: usize = "signmessage".len() + 1;
339 if line.as_bytes().len() <= MSG_STARTPOS {
340 println!("ERROR: signmsg requires a message");
345 lightning::util::message_signing::sign(
346 &line.as_bytes()[MSG_STARTPOS..],
347 &keys_manager.get_node_secret(Recipient::Node).unwrap()
351 "sendonionmessage" => {
352 let path_pks_str = words.next();
353 if path_pks_str.is_none() {
355 "ERROR: sendonionmessage requires at least one node id for the path"
359 let mut node_pks = Vec::new();
360 let mut errored = false;
361 for pk_str in path_pks_str.unwrap().split(",") {
362 let node_pubkey_vec = match hex_utils::to_vec(pk_str) {
363 Some(peer_pubkey_vec) => peer_pubkey_vec,
365 println!("ERROR: couldn't parse peer_pubkey");
370 let node_pubkey = match PublicKey::from_slice(&node_pubkey_vec) {
371 Ok(peer_pubkey) => peer_pubkey,
373 println!("ERROR: couldn't parse peer_pubkey");
378 node_pks.push(node_pubkey);
383 let tlv_type = match words.next().map(|ty_str| ty_str.parse()) {
384 Some(Ok(ty)) if ty >= 64 => ty,
386 println!("Need an integral message type above 64");
390 let data = match words.next().map(|s| hex_utils::to_vec(s)) {
391 Some(Some(data)) => data,
393 println!("Need a hex data string");
397 let destination_pk = node_pks.pop().unwrap();
398 match onion_messenger.send_onion_message(
400 Destination::Node(destination_pk),
401 OnionMessageContents::Custom(UserOnionMessageContents { tlv_type, data }),
404 Ok(()) => println!("SUCCESS: forwarded onion message to first hop"),
405 Err(e) => println!("ERROR: failed to send onion message: {:?}", e),
408 "quit" | "exit" => break,
409 _ => println!("Unknown command. See `\"help\" for available commands."),
416 let package_version = env!("CARGO_PKG_VERSION");
417 let package_name = env!("CARGO_PKG_NAME");
418 println!("\nVERSION:");
419 println!(" {} v{}", package_name, package_version);
420 println!("\nUSAGE:");
421 println!(" Command [arguments]");
422 println!("\nCOMMANDS:");
423 println!(" help\tShows a list of commands.");
424 println!(" quit\tClose the application.");
425 println!("\n Channels:");
426 println!(" openchannel pubkey@host:port <amt_satoshis> [--public]");
427 println!(" closechannel <channel_id> <peer_pubkey>");
428 println!(" forceclosechannel <channel_id> <peer_pubkey>");
429 println!(" listchannels");
430 println!("\n Peers:");
431 println!(" connectpeer pubkey@host:port");
432 println!(" listpeers");
433 println!("\n Payments:");
434 println!(" sendpayment <invoice>");
435 println!(" keysend <dest_pubkey> <amt_msats>");
436 println!(" listpayments");
437 println!("\n Invoices:");
438 println!(" getinvoice <amt_msats> <expiry_secs>");
439 println!("\n Other:");
440 println!(" signmessage <message>");
442 " sendonionmessage <node_id_1,node_id_2,..,destination_node_id> <type> <hex_bytes>"
444 println!(" nodeinfo");
447 fn node_info(channel_manager: &Arc<ChannelManager>, peer_manager: &Arc<PeerManager>) {
449 println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
450 let chans = channel_manager.list_channels();
451 println!("\t\t num_channels: {}", chans.len());
452 println!("\t\t num_usable_channels: {}", chans.iter().filter(|c| c.is_usable).count());
453 let local_balance_msat = chans.iter().map(|c| c.balance_msat).sum::<u64>();
454 println!("\t\t local_balance_msat: {}", local_balance_msat);
455 println!("\t\t num_peers: {}", peer_manager.get_peer_node_ids().len());
459 fn list_peers(peer_manager: Arc<PeerManager>) {
461 for pubkey in peer_manager.get_peer_node_ids() {
462 println!("\t\t pubkey: {}", pubkey);
467 fn list_channels(channel_manager: &Arc<ChannelManager>, network_graph: &Arc<NetworkGraph>) {
469 for chan_info in channel_manager.list_channels() {
472 println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..]));
473 if let Some(funding_txo) = chan_info.funding_txo {
474 println!("\t\tfunding_txid: {},", funding_txo.txid);
478 "\t\tpeer_pubkey: {},",
479 hex_utils::hex_str(&chan_info.counterparty.node_id.serialize())
481 if let Some(node_info) = network_graph
484 .get(&NodeId::from_pubkey(&chan_info.counterparty.node_id))
486 if let Some(announcement) = &node_info.announcement_info {
487 println!("\t\tpeer_alias: {}", announcement.alias);
491 if let Some(id) = chan_info.short_channel_id {
492 println!("\t\tshort_channel_id: {},", id);
494 println!("\t\tis_channel_ready: {},", chan_info.is_channel_ready);
495 println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
496 println!("\t\tlocal_balance_msat: {},", chan_info.balance_msat);
497 if chan_info.is_usable {
498 println!("\t\tavailable_balance_for_send_msat: {},", chan_info.outbound_capacity_msat);
499 println!("\t\tavailable_balance_for_recv_msat: {},", chan_info.inbound_capacity_msat);
501 println!("\t\tchannel_can_send_payments: {},", chan_info.is_usable);
502 println!("\t\tpublic: {},", chan_info.is_public);
508 fn list_payments(inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage) {
509 let inbound = inbound_payments.lock().unwrap();
510 let outbound = outbound_payments.lock().unwrap();
512 for (payment_hash, payment_info) in inbound.deref() {
515 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
516 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
517 println!("\t\thtlc_direction: inbound,");
519 "\t\thtlc_status: {},",
520 match payment_info.status {
521 HTLCStatus::Pending => "pending",
522 HTLCStatus::Succeeded => "succeeded",
523 HTLCStatus::Failed => "failed",
530 for (payment_hash, payment_info) in outbound.deref() {
533 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
534 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
535 println!("\t\thtlc_direction: outbound,");
537 "\t\thtlc_status: {},",
538 match payment_info.status {
539 HTLCStatus::Pending => "pending",
540 HTLCStatus::Succeeded => "succeeded",
541 HTLCStatus::Failed => "failed",
550 pub(crate) async fn connect_peer_if_necessary(
551 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
552 ) -> Result<(), ()> {
553 for node_pubkey in peer_manager.get_peer_node_ids() {
554 if node_pubkey == pubkey {
558 let res = do_connect_peer(pubkey, peer_addr, peer_manager).await;
560 println!("ERROR: failed to connect to peer");
565 pub(crate) async fn do_connect_peer(
566 pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
567 ) -> Result<(), ()> {
568 match lightning_net_tokio::connect_outbound(Arc::clone(&peer_manager), pubkey, peer_addr).await
570 Some(connection_closed_future) => {
571 let mut connection_closed_future = Box::pin(connection_closed_future);
573 match futures::poll!(&mut connection_closed_future) {
574 std::task::Poll::Ready(_) => {
577 std::task::Poll::Pending => {}
579 // Avoid blocking the tokio context by sleeping a bit
580 match peer_manager.get_peer_node_ids().iter().find(|id| **id == pubkey) {
581 Some(_) => return Ok(()),
582 None => tokio::time::sleep(Duration::from_millis(10)).await,
591 peer_pubkey: PublicKey, channel_amt_sat: u64, announced_channel: bool,
592 channel_manager: Arc<ChannelManager>,
593 ) -> Result<(), ()> {
594 let config = UserConfig {
595 channel_handshake_limits: ChannelHandshakeLimits {
596 // lnd's max to_self_delay is 2016, so we want to be compatible.
597 their_to_self_delay: 2016,
600 channel_handshake_config: ChannelHandshakeConfig {
607 match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, Some(config)) {
609 println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
613 println!("ERROR: failed to open channel: {:?}", e);
619 fn send_payment<E: EventHandler>(
620 invoice_payer: &InvoicePayer<E>, invoice: &Invoice, payment_storage: PaymentInfoStorage,
622 let status = match invoice_payer.pay_invoice(invoice) {
624 let payee_pubkey = invoice.recover_payee_pub_key();
625 let amt_msat = invoice.amount_milli_satoshis().unwrap();
626 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
630 Err(PaymentError::Invoice(e)) => {
631 println!("ERROR: invalid invoice: {}", e);
635 Err(PaymentError::Routing(e)) => {
636 println!("ERROR: failed to find route: {}", e.err);
640 Err(PaymentError::Sending(e)) => {
641 println!("ERROR: failed to send payment: {:?}", e);
646 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
647 let payment_secret = Some(invoice.payment_secret().clone());
649 let mut payments = payment_storage.lock().unwrap();
654 secret: payment_secret,
656 amt_msat: MillisatAmount(invoice.amount_milli_satoshis()),
661 fn keysend<E: EventHandler, K: KeysInterface>(
662 invoice_payer: &InvoicePayer<E>, payee_pubkey: PublicKey, amt_msat: u64, keys: &K,
663 payment_storage: PaymentInfoStorage,
665 let payment_preimage = keys.get_secure_random_bytes();
667 let status = match invoice_payer.pay_pubkey(
669 PaymentPreimage(payment_preimage),
674 println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
678 Err(PaymentError::Invoice(e)) => {
679 println!("ERROR: invalid payee: {}", e);
683 Err(PaymentError::Routing(e)) => {
684 println!("ERROR: failed to find route: {}", e.err);
688 Err(PaymentError::Sending(e)) => {
689 println!("ERROR: failed to send payment: {:?}", e);
695 let mut payments = payment_storage.lock().unwrap();
697 PaymentHash(Sha256::hash(&payment_preimage).into_inner()),
702 amt_msat: MillisatAmount(Some(amt_msat)),
708 amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: &ChannelManager,
709 keys_manager: Arc<KeysManager>, network: Network, expiry_secs: u32,
710 logger: Arc<disk::FilesystemLogger>,
712 let mut payments = payment_storage.lock().unwrap();
713 let currency = match network {
714 Network::Bitcoin => Currency::Bitcoin,
715 Network::Testnet => Currency::BitcoinTestnet,
716 Network::Regtest => Currency::Regtest,
717 Network::Signet => Currency::Signet,
719 let invoice = match utils::create_invoice_from_channelmanager(
725 "ldk-tutorial-node".to_string(),
729 println!("SUCCESS: generated invoice: {}", inv);
733 println!("ERROR: failed to create invoice: {:?}", e);
738 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
743 secret: Some(invoice.payment_secret().clone()),
744 status: HTLCStatus::Pending,
745 amt_msat: MillisatAmount(Some(amt_msat)),
751 channel_id: [u8; 32], counterparty_node_id: PublicKey, channel_manager: Arc<ChannelManager>,
753 match channel_manager.close_channel(&channel_id, &counterparty_node_id) {
754 Ok(()) => println!("EVENT: initiating channel close"),
755 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
759 fn force_close_channel(
760 channel_id: [u8; 32], counterparty_node_id: PublicKey, channel_manager: Arc<ChannelManager>,
762 match channel_manager.force_close_broadcasting_latest_txn(&channel_id, &counterparty_node_id) {
763 Ok(()) => println!("EVENT: initiating channel force-close"),
764 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
768 pub(crate) fn parse_peer_info(
769 peer_pubkey_and_ip_addr: String,
770 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
771 let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
772 let pubkey = pubkey_and_addr.next();
773 let peer_addr_str = pubkey_and_addr.next();
774 if peer_addr_str.is_none() {
775 return Err(std::io::Error::new(
776 std::io::ErrorKind::Other,
777 "ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`",
781 let peer_addr = peer_addr_str.unwrap().to_socket_addrs().map(|mut r| r.next());
782 if peer_addr.is_err() || peer_addr.as_ref().unwrap().is_none() {
783 return Err(std::io::Error::new(
784 std::io::ErrorKind::Other,
785 "ERROR: couldn't parse pubkey@host:port into a socket address",
789 let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
790 if pubkey.is_none() {
791 return Err(std::io::Error::new(
792 std::io::ErrorKind::Other,
793 "ERROR: unable to parse given pubkey for node",
797 Ok((pubkey.unwrap(), peer_addr.unwrap().unwrap()))