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