_ Git - ldk-sample/blob - src/cli.rs

   1 use crate::disk;
   2 use crate::hex_utils;
   3 use crate::{
   4         ChannelManager, HTLCStatus, InvoicePayer, MillisatAmount, NetworkGraph, OnionMessenger,
   5         PaymentInfo, PaymentInfoStorage, PeerManager,
   6 };
   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::NetAddress;
  13 use lightning::ln::{PaymentHash, PaymentPreimage};
  14 use lightning::onion_message::Destination;
  15 use lightning::routing::gossip::NodeId;
  16 use lightning::util::config::{ChannelHandshakeConfig, ChannelHandshakeLimits, UserConfig};
  17 use lightning::util::events::EventHandler;
  18 use lightning_invoice::payment::PaymentError;
  19 use lightning_invoice::{utils, Currency, Invoice};
  20 use std::env;
  21 use std::io;
  22 use std::io::Write;
  23 use std::net::{IpAddr, SocketAddr, ToSocketAddrs};
  24 use std::ops::Deref;
  25 use std::path::Path;
  26 use std::str::FromStr;
  27 use std::sync::Arc;
  28 use std::time::Duration;
  29
  30 pub(crate) struct LdkUserInfo {
  31         pub(crate) bitcoind_rpc_username: String,
  32         pub(crate) bitcoind_rpc_password: String,
  33         pub(crate) bitcoind_rpc_port: u16,
  34         pub(crate) bitcoind_rpc_host: String,
  35         pub(crate) ldk_storage_dir_path: String,
  36         pub(crate) ldk_peer_listening_port: u16,
  37         pub(crate) ldk_announced_listen_addr: Vec<NetAddress>,
  38         pub(crate) ldk_announced_node_name: [u8; 32],
  39         pub(crate) network: Network,
  40 }
  41
  42 pub(crate) fn parse_startup_args() -> Result<LdkUserInfo, ()> {
  43         if env::args().len() < 3 {
  44                 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                 return Err(());
  46         }
  47         let bitcoind_rpc_info = env::args().skip(1).next().unwrap();
  48         let bitcoind_rpc_info_parts: Vec<&str> = bitcoind_rpc_info.rsplitn(2, "@").collect();
  49         if bitcoind_rpc_info_parts.len() != 2 {
  50                 println!("ERROR: bad bitcoind RPC URL provided");
  51                 return Err(());
  52         }
  53         let rpc_user_and_password: Vec<&str> = bitcoind_rpc_info_parts[1].split(":").collect();
  54         if rpc_user_and_password.len() != 2 {
  55                 println!("ERROR: bad bitcoind RPC username/password combo provided");
  56                 return Err(());
  57         }
  58         let bitcoind_rpc_username = rpc_user_and_password[0].to_string();
  59         let bitcoind_rpc_password = rpc_user_and_password[1].to_string();
  60         let bitcoind_rpc_path: Vec<&str> = bitcoind_rpc_info_parts[0].split(":").collect();
  61         if bitcoind_rpc_path.len() != 2 {
  62                 println!("ERROR: bad bitcoind RPC path provided");
  63                 return Err(());
  64         }
  65         let bitcoind_rpc_host = bitcoind_rpc_path[0].to_string();
  66         let bitcoind_rpc_port = bitcoind_rpc_path[1].parse::<u16>().unwrap();
  67
  68         let ldk_storage_dir_path = env::args().skip(2).next().unwrap();
  69
  70         let mut ldk_peer_port_set = true;
  71         let ldk_peer_listening_port: u16 = match env::args().skip(3).next().map(|p| p.parse()) {
  72                 Some(Ok(p)) => p,
  73                 Some(Err(_)) => {
  74                         ldk_peer_port_set = false;
  75                         9735
  76                 }
  77                 None => {
  78                         ldk_peer_port_set = false;
  79                         9735
  80                 }
  81         };
  82
  83         let mut arg_idx = match ldk_peer_port_set {
  84                 true => 4,
  85                 false => 3,
  86         };
  87         let network: Network = match env::args().skip(arg_idx).next().as_ref().map(String::as_str) {
  88                 Some("testnet") => Network::Testnet,
  89                 Some("regtest") => Network::Regtest,
  90                 Some("signet") => Network::Signet,
  91                 Some(net) => {
  92                         panic!("Unsupported network provided. Options are: `regtest`, `testnet`, and `signet`. Got {}", net);
  93                 }
  94                 None => Network::Testnet,
  95         };
  96
  97         let ldk_announced_node_name = match env::args().skip(arg_idx + 1).next().as_ref() {
  98                 Some(s) => {
  99                         if s.len() > 32 {
 100                                 panic!("Node Alias can not be longer than 32 bytes");
 101                         }
 102                         arg_idx += 1;
 103                         let mut bytes = [0; 32];
 104                         bytes[..s.len()].copy_from_slice(s.as_bytes());
 105                         bytes
 106                 }
 107                 None => [0; 32],
 108         };
 109
 110         let mut ldk_announced_listen_addr = Vec::new();
 111         loop {
 112                 match env::args().skip(arg_idx + 1).next().as_ref() {
 113                         Some(s) => match IpAddr::from_str(s) {
 114                                 Ok(IpAddr::V4(a)) => {
 115                                         ldk_announced_listen_addr
 116                                                 .push(NetAddress::IPv4 { addr: a.octets(), port: ldk_peer_listening_port });
 117                                         arg_idx += 1;
 118                                 }
 119                                 Ok(IpAddr::V6(a)) => {
 120                                         ldk_announced_listen_addr
 121                                                 .push(NetAddress::IPv6 { addr: a.octets(), port: ldk_peer_listening_port });
 122                                         arg_idx += 1;
 123                                 }
 124                                 Err(_) => panic!("Failed to parse announced-listen-addr into an IP address"),
 125                         },
 126                         None => break,
 127                 }
 128         }
 129
 130         Ok(LdkUserInfo {
 131                 bitcoind_rpc_username,
 132                 bitcoind_rpc_password,
 133                 bitcoind_rpc_host,
 134                 bitcoind_rpc_port,
 135                 ldk_storage_dir_path,
 136                 ldk_peer_listening_port,
 137                 ldk_announced_listen_addr,
 138                 ldk_announced_node_name,
 139                 network,
 140         })
 141 }
 142
 143 pub(crate) async fn poll_for_user_input<E: EventHandler>(
 144         invoice_payer: Arc<InvoicePayer<E>>, peer_manager: Arc<PeerManager>,
 145         channel_manager: Arc<ChannelManager>, keys_manager: Arc<KeysManager>,
 146         network_graph: Arc<NetworkGraph>, onion_messenger: Arc<OnionMessenger>,
 147         inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage,
 148         ldk_data_dir: String, network: Network,
 149 ) {
 150         println!(
 151                 "LDK startup successful. Enter \"help\" to view available commands. Press Ctrl-D to quit."
 152         );
 153         println!("LDK logs are available at <your-supplied-ldk-data-dir-path>/.ldk/logs");
 154         println!("Local Node ID is {}.", channel_manager.get_our_node_id());
 155         loop {
 156                 print!("> ");
 157                 io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
 158                 let mut line = String::new();
 159                 if let Err(e) = io::stdin().read_line(&mut line) {
 160                         break println!("ERROR: {e:#}");
 161                 }
 162
 163                 if line.len() == 0 {
 164                         // We hit EOF / Ctrl-D
 165                         break;
 166                 }
 167
 168                 let mut words = line.split_whitespace();
 169                 if let Some(word) = words.next() {
 170                         match word {
 171                                 "help" => help(),
 172                                 "openchannel" => {
 173                                         let peer_pubkey_and_ip_addr = words.next();
 174                                         let channel_value_sat = words.next();
 175                                         if peer_pubkey_and_ip_addr.is_none() || channel_value_sat.is_none() {
 176                                                 println!("ERROR: openchannel has 2 required arguments: `openchannel pubkey@host:port channel_amt_satoshis` [--public]");
 177                                                 continue;
 178                                         }
 179                                         let peer_pubkey_and_ip_addr = peer_pubkey_and_ip_addr.unwrap();
 180                                         let (pubkey, peer_addr) =
 181                                                 match parse_peer_info(peer_pubkey_and_ip_addr.to_string()) {
 182                                                         Ok(info) => info,
 183                                                         Err(e) => {
 184                                                                 println!("{:?}", e.into_inner().unwrap());
 185                                                                 continue;
 186                                                         }
 187                                                 };
 188
 189                                         let chan_amt_sat: Result<u64, _> = channel_value_sat.unwrap().parse();
 190                                         if chan_amt_sat.is_err() {
 191                                                 println!("ERROR: channel amount must be a number");
 192                                                 continue;
 193                                         }
 194
 195                                         if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
 196                                                 .await
 197                                                 .is_err()
 198                                         {
 199                                                 continue;
 200                                         };
 201
 202                                         let announce_channel = match words.next() {
 203                                                 Some("--public") | Some("--public=true") => true,
 204                                                 Some("--public=false") => false,
 205                                                 Some(_) => {
 206                                                         println!("ERROR: invalid `--public` command format. Valid formats: `--public`, `--public=true` `--public=false`");
 207                                                         continue;
 208                                                 }
 209                                                 None => false,
 210                                         };
 211
 212                                         if open_channel(
 213                                                 pubkey,
 214                                                 chan_amt_sat.unwrap(),
 215                                                 announce_channel,
 216                                                 channel_manager.clone(),
 217                                         )
 218                                         .is_ok()
 219                                         {
 220                                                 let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
 221                                                 let _ = disk::persist_channel_peer(
 222                                                         Path::new(&peer_data_path),
 223                                                         peer_pubkey_and_ip_addr,
 224                                                 );
 225                                         }
 226                                 }
 227                                 "sendpayment" => {
 228                                         let invoice_str = words.next();
 229                                         if invoice_str.is_none() {
 230                                                 println!("ERROR: sendpayment requires an invoice: `sendpayment <invoice>`");
 231                                                 continue;
 232                                         }
 233
 234                                         let invoice = match Invoice::from_str(invoice_str.unwrap()) {
 235                                                 Ok(inv) => inv,
 236                                                 Err(e) => {
 237                                                         println!("ERROR: invalid invoice: {:?}", e);
 238                                                         continue;
 239                                                 }
 240                                         };
 241
 242                                         send_payment(&*invoice_payer, &invoice, outbound_payments.clone());
 243                                 }
 244                                 "keysend" => {
 245                                         let dest_pubkey = match words.next() {
 246                                                 Some(dest) => match hex_utils::to_compressed_pubkey(dest) {
 247                                                         Some(pk) => pk,
 248                                                         None => {
 249                                                                 println!("ERROR: couldn't parse destination pubkey");
 250                                                                 continue;
 251                                                         }
 252                                                 },
 253                                                 None => {
 254                                                         println!("ERROR: keysend requires a destination pubkey: `keysend <dest_pubkey> <amt_msat>`");
 255                                                         continue;
 256                                                 }
 257                                         };
 258                                         let amt_msat_str = match words.next() {
 259                                                 Some(amt) => amt,
 260                                                 None => {
 261                                                         println!("ERROR: keysend requires an amount in millisatoshis: `keysend <dest_pubkey> <amt_msat>`");
 262                                                         continue;
 263                                                 }
 264                                         };
 265                                         let amt_msat: u64 = match amt_msat_str.parse() {
 266                                                 Ok(amt) => amt,
 267                                                 Err(e) => {
 268                                                         println!("ERROR: couldn't parse amount_msat: {}", e);
 269                                                         continue;
 270                                                 }
 271                                         };
 272                                         keysend(
 273                                                 &*invoice_payer,
 274                                                 dest_pubkey,
 275                                                 amt_msat,
 276                                                 &*keys_manager,
 277                                                 outbound_payments.clone(),
 278                                         );
 279                                 }
 280                                 "getinvoice" => {
 281                                         let amt_str = words.next();
 282                                         if amt_str.is_none() {
 283                                                 println!("ERROR: getinvoice requires an amount in millisatoshis");
 284                                                 continue;
 285                                         }
 286
 287                                         let amt_msat: Result<u64, _> = amt_str.unwrap().parse();
 288                                         if amt_msat.is_err() {
 289                                                 println!("ERROR: getinvoice provided payment amount was not a number");
 290                                                 continue;
 291                                         }
 292
 293                                         let expiry_secs_str = words.next();
 294                                         if expiry_secs_str.is_none() {
 295                                                 println!("ERROR: getinvoice requires an expiry in seconds");
 296                                                 continue;
 297                                         }
 298
 299                                         let expiry_secs: Result<u32, _> = expiry_secs_str.unwrap().parse();
 300                                         if expiry_secs.is_err() {
 301                                                 println!("ERROR: getinvoice provided expiry was not a number");
 302                                                 continue;
 303                                         }
 304
 305                                         get_invoice(
 306                                                 amt_msat.unwrap(),
 307                                                 inbound_payments.clone(),
 308                                                 channel_manager.clone(),
 309                                                 keys_manager.clone(),
 310                                                 network,
 311                                                 expiry_secs.unwrap(),
 312                                         );
 313                                 }
 314                                 "connectpeer" => {
 315                                         let peer_pubkey_and_ip_addr = words.next();
 316                                         if peer_pubkey_and_ip_addr.is_none() {
 317                                                 println!("ERROR: connectpeer requires peer connection info: `connectpeer pubkey@host:port`");
 318                                                 continue;
 319                                         }
 320                                         let (pubkey, peer_addr) =
 321                                                 match parse_peer_info(peer_pubkey_and_ip_addr.unwrap().to_string()) {
 322                                                         Ok(info) => info,
 323                                                         Err(e) => {
 324                                                                 println!("{:?}", e.into_inner().unwrap());
 325                                                                 continue;
 326                                                         }
 327                                                 };
 328                                         if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
 329                                                 .await
 330                                                 .is_ok()
 331                                         {
 332                                                 println!("SUCCESS: connected to peer {}", pubkey);
 333                                         }
 334                                 }
 335                                 "listchannels" => list_channels(&channel_manager, &network_graph),
 336                                 "listpayments" => {
 337                                         list_payments(inbound_payments.clone(), outbound_payments.clone())
 338                                 }
 339                                 "closechannel" => {
 340                                         let channel_id_str = words.next();
 341                                         if channel_id_str.is_none() {
 342                                                 println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id> <peer_pubkey>`");
 343                                                 continue;
 344                                         }
 345                                         let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
 346                                         if channel_id_vec.is_none() || channel_id_vec.as_ref().unwrap().len() != 32 {
 347                                                 println!("ERROR: couldn't parse channel_id");
 348                                                 continue;
 349                                         }
 350                                         let mut channel_id = [0; 32];
 351                                         channel_id.copy_from_slice(&channel_id_vec.unwrap());
 352
 353                                         let peer_pubkey_str = words.next();
 354                                         if peer_pubkey_str.is_none() {
 355                                                 println!("ERROR: closechannel requires a peer pubkey: `closechannel <channel_id> <peer_pubkey>`");
 356                                                 continue;
 357                                         }
 358                                         let peer_pubkey_vec = match hex_utils::to_vec(peer_pubkey_str.unwrap()) {
 359                                                 Some(peer_pubkey_vec) => peer_pubkey_vec,
 360                                                 None => {
 361                                                         println!("ERROR: couldn't parse peer_pubkey");
 362                                                         continue;
 363                                                 }
 364                                         };
 365                                         let peer_pubkey = match PublicKey::from_slice(&peer_pubkey_vec) {
 366                                                 Ok(peer_pubkey) => peer_pubkey,
 367                                                 Err(_) => {
 368                                                         println!("ERROR: couldn't parse peer_pubkey");
 369                                                         continue;
 370                                                 }
 371                                         };
 372
 373                                         close_channel(channel_id, peer_pubkey, channel_manager.clone());
 374                                 }
 375                                 "forceclosechannel" => {
 376                                         let channel_id_str = words.next();
 377                                         if channel_id_str.is_none() {
 378                                                 println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id> <peer_pubkey>`");
 379                                                 continue;
 380                                         }
 381                                         let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
 382                                         if channel_id_vec.is_none() || channel_id_vec.as_ref().unwrap().len() != 32 {
 383                                                 println!("ERROR: couldn't parse channel_id");
 384                                                 continue;
 385                                         }
 386                                         let mut channel_id = [0; 32];
 387                                         channel_id.copy_from_slice(&channel_id_vec.unwrap());
 388
 389                                         let peer_pubkey_str = words.next();
 390                                         if peer_pubkey_str.is_none() {
 391                                                 println!("ERROR: forceclosechannel requires a peer pubkey: `forceclosechannel <channel_id> <peer_pubkey>`");
 392                                                 continue;
 393                                         }
 394                                         let peer_pubkey_vec = match hex_utils::to_vec(peer_pubkey_str.unwrap()) {
 395                                                 Some(peer_pubkey_vec) => peer_pubkey_vec,
 396                                                 None => {
 397                                                         println!("ERROR: couldn't parse peer_pubkey");
 398                                                         continue;
 399                                                 }
 400                                         };
 401                                         let peer_pubkey = match PublicKey::from_slice(&peer_pubkey_vec) {
 402                                                 Ok(peer_pubkey) => peer_pubkey,
 403                                                 Err(_) => {
 404                                                         println!("ERROR: couldn't parse peer_pubkey");
 405                                                         continue;
 406                                                 }
 407                                         };
 408
 409                                         force_close_channel(channel_id, peer_pubkey, channel_manager.clone());
 410                                 }
 411                                 "nodeinfo" => node_info(&channel_manager, &peer_manager),
 412                                 "listpeers" => list_peers(peer_manager.clone()),
 413                                 "signmessage" => {
 414                                         const MSG_STARTPOS: usize = "signmessage".len() + 1;
 415                                         if line.as_bytes().len() <= MSG_STARTPOS {
 416                                                 println!("ERROR: signmsg requires a message");
 417                                                 continue;
 418                                         }
 419                                         println!(
 420                                                 "{:?}",
 421                                                 lightning::util::message_signing::sign(
 422                                                         &line.as_bytes()[MSG_STARTPOS..],
 423                                                         &keys_manager.get_node_secret(Recipient::Node).unwrap()
 424                                                 )
 425                                         );
 426                                 }
 427                                 "sendonionmessage" => {
 428                                         let path_pks_str = words.next();
 429                                         if path_pks_str.is_none() {
 430                                                 println!(
 431                                                         "ERROR: sendonionmessage requires at least one node id for the path"
 432                                                 );
 433                                                 continue;
 434                                         }
 435                                         let mut node_pks = Vec::new();
 436                                         let mut errored = false;
 437                                         for pk_str in path_pks_str.unwrap().split(",") {
 438                                                 let node_pubkey_vec = match hex_utils::to_vec(pk_str) {
 439                                                         Some(peer_pubkey_vec) => peer_pubkey_vec,
 440                                                         None => {
 441                                                                 println!("ERROR: couldn't parse peer_pubkey");
 442                                                                 errored = true;
 443                                                                 break;
 444                                                         }
 445                                                 };
 446                                                 let node_pubkey = match PublicKey::from_slice(&node_pubkey_vec) {
 447                                                         Ok(peer_pubkey) => peer_pubkey,
 448                                                         Err(_) => {
 449                                                                 println!("ERROR: couldn't parse peer_pubkey");
 450                                                                 errored = true;
 451                                                                 break;
 452                                                         }
 453                                                 };
 454                                                 node_pks.push(node_pubkey);
 455                                         }
 456                                         if errored {
 457                                                 continue;
 458                                         }
 459                                         let destination_pk = node_pks.pop().unwrap();
 460                                         match onion_messenger.send_onion_message(
 461                                                 &node_pks,
 462                                                 Destination::Node(destination_pk),
 463                                                 None,
 464                                         ) {
 465                                                 Ok(()) => println!("SUCCESS: forwarded onion message to first hop"),
 466                                                 Err(e) => println!("ERROR: failed to send onion message: {:?}", e),
 467                                         }
 468                                 }
 469                                 "quit" | "exit" => break,
 470                                 _ => println!("Unknown command. See `\"help\" for available commands."),
 471                         }
 472                 }
 473         }
 474 }
 475
 476 fn help() {
 477         let package_version = env!("CARGO_PKG_VERSION");
 478         let package_name = env!("CARGO_PKG_NAME");
 479         println!("\nVERSION:");
 480         println!("  {} v{}", package_name, package_version);
 481         println!("\nUSAGE:");
 482         println!("  Command [arguments]");
 483         println!("\nCOMMANDS:");
 484         println!("  help\tShows a list of commands.");
 485         println!("  quit\tClose the application.");
 486         println!("\n  Channels:");
 487         println!("      openchannel pubkey@host:port <amt_satoshis> [--public]");
 488         println!("      closechannel <channel_id> <peer_pubkey>");
 489         println!("      forceclosechannel <channel_id> <peer_pubkey>");
 490         println!("      listchannels");
 491         println!("\n  Peers:");
 492         println!("      connectpeer pubkey@host:port");
 493         println!("      listpeers");
 494         println!("\n  Payments:");
 495         println!("      sendpayment <invoice>");
 496         println!("      keysend <dest_pubkey> <amt_msats>");
 497         println!("      listpayments");
 498         println!("\n  Invoices:");
 499         println!("      getinvoice <amt_msats> <expiry_secs>");
 500         println!("\n  Other:");
 501         println!("      signmessage <message>");
 502         println!("      sendonionmessage <node_id_1,node_id_2,..,destination_node_id>");
 503         println!("      nodeinfo");
 504 }
 505
 506 fn node_info(channel_manager: &Arc<ChannelManager>, peer_manager: &Arc<PeerManager>) {
 507         println!("\t{{");
 508         println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
 509         let chans = channel_manager.list_channels();
 510         println!("\t\t num_channels: {}", chans.len());
 511         println!("\t\t num_usable_channels: {}", chans.iter().filter(|c| c.is_usable).count());
 512         let local_balance_msat = chans.iter().map(|c| c.balance_msat).sum::<u64>();
 513         println!("\t\t local_balance_msat: {}", local_balance_msat);
 514         println!("\t\t num_peers: {}", peer_manager.get_peer_node_ids().len());
 515         println!("\t}},");
 516 }
 517
 518 fn list_peers(peer_manager: Arc<PeerManager>) {
 519         println!("\t{{");
 520         for pubkey in peer_manager.get_peer_node_ids() {
 521                 println!("\t\t pubkey: {}", pubkey);
 522         }
 523         println!("\t}},");
 524 }
 525
 526 fn list_channels(channel_manager: &Arc<ChannelManager>, network_graph: &Arc<NetworkGraph>) {
 527         print!("[");
 528         for chan_info in channel_manager.list_channels() {
 529                 println!("");
 530                 println!("\t{{");
 531                 println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..]));
 532                 if let Some(funding_txo) = chan_info.funding_txo {
 533                         println!("\t\tfunding_txid: {},", funding_txo.txid);
 534                 }
 535
 536                 println!(
 537                         "\t\tpeer_pubkey: {},",
 538                         hex_utils::hex_str(&chan_info.counterparty.node_id.serialize())
 539                 );
 540                 if let Some(node_info) = network_graph
 541                         .read_only()
 542                         .nodes()
 543                         .get(&NodeId::from_pubkey(&chan_info.counterparty.node_id))
 544                 {
 545                         if let Some(announcement) = &node_info.announcement_info {
 546                                 println!("\t\tpeer_alias: {}", announcement.alias);
 547                         }
 548                 }
 549
 550                 if let Some(id) = chan_info.short_channel_id {
 551                         println!("\t\tshort_channel_id: {},", id);
 552                 }
 553                 println!("\t\tis_channel_ready: {},", chan_info.is_channel_ready);
 554                 println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
 555                 println!("\t\tlocal_balance_msat: {},", chan_info.balance_msat);
 556                 if chan_info.is_usable {
 557                         println!("\t\tavailable_balance_for_send_msat: {},", chan_info.outbound_capacity_msat);
 558                         println!("\t\tavailable_balance_for_recv_msat: {},", chan_info.inbound_capacity_msat);
 559                 }
 560                 println!("\t\tchannel_can_send_payments: {},", chan_info.is_usable);
 561                 println!("\t\tpublic: {},", chan_info.is_public);
 562                 println!("\t}},");
 563         }
 564         println!("]");
 565 }
 566
 567 fn list_payments(inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage) {
 568         let inbound = inbound_payments.lock().unwrap();
 569         let outbound = outbound_payments.lock().unwrap();
 570         print!("[");
 571         for (payment_hash, payment_info) in inbound.deref() {
 572                 println!("");
 573                 println!("\t{{");
 574                 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
 575                 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
 576                 println!("\t\thtlc_direction: inbound,");
 577                 println!(
 578                         "\t\thtlc_status: {},",
 579                         match payment_info.status {
 580                                 HTLCStatus::Pending => "pending",
 581                                 HTLCStatus::Succeeded => "succeeded",
 582                                 HTLCStatus::Failed => "failed",
 583                         }
 584                 );
 585
 586                 println!("\t}},");
 587         }
 588
 589         for (payment_hash, payment_info) in outbound.deref() {
 590                 println!("");
 591                 println!("\t{{");
 592                 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
 593                 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
 594                 println!("\t\thtlc_direction: outbound,");
 595                 println!(
 596                         "\t\thtlc_status: {},",
 597                         match payment_info.status {
 598                                 HTLCStatus::Pending => "pending",
 599                                 HTLCStatus::Succeeded => "succeeded",
 600                                 HTLCStatus::Failed => "failed",
 601                         }
 602                 );
 603
 604                 println!("\t}},");
 605         }
 606         println!("]");
 607 }
 608
 609 pub(crate) async fn connect_peer_if_necessary(
 610         pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
 611 ) -> Result<(), ()> {
 612         for node_pubkey in peer_manager.get_peer_node_ids() {
 613                 if node_pubkey == pubkey {
 614                         return Ok(());
 615                 }
 616         }
 617         let res = do_connect_peer(pubkey, peer_addr, peer_manager).await;
 618         if res.is_err() {
 619                 println!("ERROR: failed to connect to peer");
 620         }
 621         res
 622 }
 623
 624 pub(crate) async fn do_connect_peer(
 625         pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
 626 ) -> Result<(), ()> {
 627         match lightning_net_tokio::connect_outbound(Arc::clone(&peer_manager), pubkey, peer_addr).await
 628         {
 629                 Some(connection_closed_future) => {
 630                         let mut connection_closed_future = Box::pin(connection_closed_future);
 631                         loop {
 632                                 match futures::poll!(&mut connection_closed_future) {
 633                                         std::task::Poll::Ready(_) => {
 634                                                 return Err(());
 635                                         }
 636                                         std::task::Poll::Pending => {}
 637                                 }
 638                                 // Avoid blocking the tokio context by sleeping a bit
 639                                 match peer_manager.get_peer_node_ids().iter().find(|id| **id == pubkey) {
 640                                         Some(_) => return Ok(()),
 641                                         None => tokio::time::sleep(Duration::from_millis(10)).await,
 642                                 }
 643                         }
 644                 }
 645                 None => Err(()),
 646         }
 647 }
 648
 649 fn open_channel(
 650         peer_pubkey: PublicKey, channel_amt_sat: u64, announced_channel: bool,
 651         channel_manager: Arc<ChannelManager>,
 652 ) -> Result<(), ()> {
 653         let config = UserConfig {
 654                 channel_handshake_limits: ChannelHandshakeLimits {
 655                         // lnd's max to_self_delay is 2016, so we want to be compatible.
 656                         their_to_self_delay: 2016,
 657                         ..Default::default()
 658                 },
 659                 channel_handshake_config: ChannelHandshakeConfig {
 660                         announced_channel,
 661                         ..Default::default()
 662                 },
 663                 ..Default::default()
 664         };
 665
 666         match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, Some(config)) {
 667                 Ok(_) => {
 668                         println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
 669                         return Ok(());
 670                 }
 671                 Err(e) => {
 672                         println!("ERROR: failed to open channel: {:?}", e);
 673                         return Err(());
 674                 }
 675         }
 676 }
 677
 678 fn send_payment<E: EventHandler>(
 679         invoice_payer: &InvoicePayer<E>, invoice: &Invoice, payment_storage: PaymentInfoStorage,
 680 ) {
 681         let status = match invoice_payer.pay_invoice(invoice) {
 682                 Ok(_payment_id) => {
 683                         let payee_pubkey = invoice.recover_payee_pub_key();
 684                         let amt_msat = invoice.amount_milli_satoshis().unwrap();
 685                         println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
 686                         print!("> ");
 687                         HTLCStatus::Pending
 688                 }
 689                 Err(PaymentError::Invoice(e)) => {
 690                         println!("ERROR: invalid invoice: {}", e);
 691                         print!("> ");
 692                         return;
 693                 }
 694                 Err(PaymentError::Routing(e)) => {
 695                         println!("ERROR: failed to find route: {}", e.err);
 696                         print!("> ");
 697                         return;
 698                 }
 699                 Err(PaymentError::Sending(e)) => {
 700                         println!("ERROR: failed to send payment: {:?}", e);
 701                         print!("> ");
 702                         HTLCStatus::Failed
 703                 }
 704         };
 705         let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
 706         let payment_secret = Some(invoice.payment_secret().clone());
 707
 708         let mut payments = payment_storage.lock().unwrap();
 709         payments.insert(
 710                 payment_hash,
 711                 PaymentInfo {
 712                         preimage: None,
 713                         secret: payment_secret,
 714                         status,
 715                         amt_msat: MillisatAmount(invoice.amount_milli_satoshis()),
 716                 },
 717         );
 718 }
 719
 720 fn keysend<E: EventHandler, K: KeysInterface>(
 721         invoice_payer: &InvoicePayer<E>, payee_pubkey: PublicKey, amt_msat: u64, keys: &K,
 722         payment_storage: PaymentInfoStorage,
 723 ) {
 724         let payment_preimage = keys.get_secure_random_bytes();
 725
 726         let status = match invoice_payer.pay_pubkey(
 727                 payee_pubkey,
 728                 PaymentPreimage(payment_preimage),
 729                 amt_msat,
 730                 40,
 731         ) {
 732                 Ok(_payment_id) => {
 733                         println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
 734                         print!("> ");
 735                         HTLCStatus::Pending
 736                 }
 737                 Err(PaymentError::Invoice(e)) => {
 738                         println!("ERROR: invalid payee: {}", e);
 739                         print!("> ");
 740                         return;
 741                 }
 742                 Err(PaymentError::Routing(e)) => {
 743                         println!("ERROR: failed to find route: {}", e.err);
 744                         print!("> ");
 745                         return;
 746                 }
 747                 Err(PaymentError::Sending(e)) => {
 748                         println!("ERROR: failed to send payment: {:?}", e);
 749                         print!("> ");
 750                         HTLCStatus::Failed
 751                 }
 752         };
 753
 754         let mut payments = payment_storage.lock().unwrap();
 755         payments.insert(
 756                 PaymentHash(Sha256::hash(&payment_preimage).into_inner()),
 757                 PaymentInfo {
 758                         preimage: None,
 759                         secret: None,
 760                         status,
 761                         amt_msat: MillisatAmount(Some(amt_msat)),
 762                 },
 763         );
 764 }
 765
 766 fn get_invoice(
 767         amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: Arc<ChannelManager>,
 768         keys_manager: Arc<KeysManager>, network: Network, expiry_secs: u32,
 769 ) {
 770         let mut payments = payment_storage.lock().unwrap();
 771         let currency = match network {
 772                 Network::Bitcoin => Currency::Bitcoin,
 773                 Network::Testnet => Currency::BitcoinTestnet,
 774                 Network::Regtest => Currency::Regtest,
 775                 Network::Signet => Currency::Signet,
 776         };
 777         let invoice = match utils::create_invoice_from_channelmanager(
 778                 &channel_manager,
 779                 keys_manager,
 780                 currency,
 781                 Some(amt_msat),
 782                 "ldk-tutorial-node".to_string(),
 783                 expiry_secs,
 784         ) {
 785                 Ok(inv) => {
 786                         println!("SUCCESS: generated invoice: {}", inv);
 787                         inv
 788                 }
 789                 Err(e) => {
 790                         println!("ERROR: failed to create invoice: {:?}", e);
 791                         return;
 792                 }
 793         };
 794
 795         let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
 796         payments.insert(
 797                 payment_hash,
 798                 PaymentInfo {
 799                         preimage: None,
 800                         secret: Some(invoice.payment_secret().clone()),
 801                         status: HTLCStatus::Pending,
 802                         amt_msat: MillisatAmount(Some(amt_msat)),
 803                 },
 804         );
 805 }
 806
 807 fn close_channel(
 808         channel_id: [u8; 32], counterparty_node_id: PublicKey, channel_manager: Arc<ChannelManager>,
 809 ) {
 810         match channel_manager.close_channel(&channel_id, &counterparty_node_id) {
 811                 Ok(()) => println!("EVENT: initiating channel close"),
 812                 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
 813         }
 814 }
 815
 816 fn force_close_channel(
 817         channel_id: [u8; 32], counterparty_node_id: PublicKey, channel_manager: Arc<ChannelManager>,
 818 ) {
 819         match channel_manager.force_close_broadcasting_latest_txn(&channel_id, &counterparty_node_id) {
 820                 Ok(()) => println!("EVENT: initiating channel force-close"),
 821                 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
 822         }
 823 }
 824
 825 pub(crate) fn parse_peer_info(
 826         peer_pubkey_and_ip_addr: String,
 827 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
 828         let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
 829         let pubkey = pubkey_and_addr.next();
 830         let peer_addr_str = pubkey_and_addr.next();
 831         if peer_addr_str.is_none() {
 832                 return Err(std::io::Error::new(
 833                         std::io::ErrorKind::Other,
 834                         "ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`",
 835                 ));
 836         }
 837
 838         let peer_addr = peer_addr_str.unwrap().to_socket_addrs().map(|mut r| r.next());
 839         if peer_addr.is_err() || peer_addr.as_ref().unwrap().is_none() {
 840                 return Err(std::io::Error::new(
 841                         std::io::ErrorKind::Other,
 842                         "ERROR: couldn't parse pubkey@host:port into a socket address",
 843                 ));
 844         }
 845
 846         let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
 847         if pubkey.is_none() {
 848                 return Err(std::io::Error::new(
 849                         std::io::ErrorKind::Other,
 850                         "ERROR: unable to parse given pubkey for node",
 851                 ));
 852         }
 853
 854         Ok((pubkey.unwrap(), peer_addr.unwrap().unwrap()))
 855 }