_ 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                                 "disconnectpeer" => {
 361                                         let peer_pubkey = words.next();
 362                                         if peer_pubkey.is_none() {
 363                                                 println!("ERROR: disconnectpeer requires peer public key: `disconnectpeer <peer_pubkey>`");
 364                                                 continue;
 365                                         }
 366
 367                                         let peer_pubkey =
 368                                                 match bitcoin::secp256k1::PublicKey::from_str(peer_pubkey.unwrap()) {
 369                                                         Ok(pubkey) => pubkey,
 370                                                         Err(e) => {
 371                                                                 println!("ERROR: {}", e.to_string());
 372                                                                 continue;
 373                                                         }
 374                                                 };
 375
 376                                         if do_disconnect_peer(
 377                                                 peer_pubkey,
 378                                                 peer_manager.clone(),
 379                                                 channel_manager.clone(),
 380                                         )
 381                                         .is_ok()
 382                                         {
 383                                                 println!("SUCCESS: disconnected from peer {}", peer_pubkey);
 384                                         }
 385                                 }
 386                                 "listchannels" => list_channels(&channel_manager, &network_graph),
 387                                 "listpayments" => {
 388                                         list_payments(inbound_payments.clone(), outbound_payments.clone())
 389                                 }
 390                                 "closechannel" => {
 391                                         let channel_id_str = words.next();
 392                                         if channel_id_str.is_none() {
 393                                                 println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id> <peer_pubkey>`");
 394                                                 continue;
 395                                         }
 396                                         let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
 397                                         if channel_id_vec.is_none() || channel_id_vec.as_ref().unwrap().len() != 32 {
 398                                                 println!("ERROR: couldn't parse channel_id");
 399                                                 continue;
 400                                         }
 401                                         let mut channel_id = [0; 32];
 402                                         channel_id.copy_from_slice(&channel_id_vec.unwrap());
 403
 404                                         let peer_pubkey_str = words.next();
 405                                         if peer_pubkey_str.is_none() {
 406                                                 println!("ERROR: closechannel requires a peer pubkey: `closechannel <channel_id> <peer_pubkey>`");
 407                                                 continue;
 408                                         }
 409                                         let peer_pubkey_vec = match hex_utils::to_vec(peer_pubkey_str.unwrap()) {
 410                                                 Some(peer_pubkey_vec) => peer_pubkey_vec,
 411                                                 None => {
 412                                                         println!("ERROR: couldn't parse peer_pubkey");
 413                                                         continue;
 414                                                 }
 415                                         };
 416                                         let peer_pubkey = match PublicKey::from_slice(&peer_pubkey_vec) {
 417                                                 Ok(peer_pubkey) => peer_pubkey,
 418                                                 Err(_) => {
 419                                                         println!("ERROR: couldn't parse peer_pubkey");
 420                                                         continue;
 421                                                 }
 422                                         };
 423
 424                                         close_channel(channel_id, peer_pubkey, channel_manager.clone());
 425                                 }
 426                                 "forceclosechannel" => {
 427                                         let channel_id_str = words.next();
 428                                         if channel_id_str.is_none() {
 429                                                 println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id> <peer_pubkey>`");
 430                                                 continue;
 431                                         }
 432                                         let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
 433                                         if channel_id_vec.is_none() || channel_id_vec.as_ref().unwrap().len() != 32 {
 434                                                 println!("ERROR: couldn't parse channel_id");
 435                                                 continue;
 436                                         }
 437                                         let mut channel_id = [0; 32];
 438                                         channel_id.copy_from_slice(&channel_id_vec.unwrap());
 439
 440                                         let peer_pubkey_str = words.next();
 441                                         if peer_pubkey_str.is_none() {
 442                                                 println!("ERROR: forceclosechannel requires a peer pubkey: `forceclosechannel <channel_id> <peer_pubkey>`");
 443                                                 continue;
 444                                         }
 445                                         let peer_pubkey_vec = match hex_utils::to_vec(peer_pubkey_str.unwrap()) {
 446                                                 Some(peer_pubkey_vec) => peer_pubkey_vec,
 447                                                 None => {
 448                                                         println!("ERROR: couldn't parse peer_pubkey");
 449                                                         continue;
 450                                                 }
 451                                         };
 452                                         let peer_pubkey = match PublicKey::from_slice(&peer_pubkey_vec) {
 453                                                 Ok(peer_pubkey) => peer_pubkey,
 454                                                 Err(_) => {
 455                                                         println!("ERROR: couldn't parse peer_pubkey");
 456                                                         continue;
 457                                                 }
 458                                         };
 459
 460                                         force_close_channel(channel_id, peer_pubkey, channel_manager.clone());
 461                                 }
 462                                 "nodeinfo" => node_info(&channel_manager, &peer_manager),
 463                                 "listpeers" => list_peers(peer_manager.clone()),
 464                                 "signmessage" => {
 465                                         const MSG_STARTPOS: usize = "signmessage".len() + 1;
 466                                         if line.as_bytes().len() <= MSG_STARTPOS {
 467                                                 println!("ERROR: signmsg requires a message");
 468                                                 continue;
 469                                         }
 470                                         println!(
 471                                                 "{:?}",
 472                                                 lightning::util::message_signing::sign(
 473                                                         &line.as_bytes()[MSG_STARTPOS..],
 474                                                         &keys_manager.get_node_secret(Recipient::Node).unwrap()
 475                                                 )
 476                                         );
 477                                 }
 478                                 "sendonionmessage" => {
 479                                         let path_pks_str = words.next();
 480                                         if path_pks_str.is_none() {
 481                                                 println!(
 482                                                         "ERROR: sendonionmessage requires at least one node id for the path"
 483                                                 );
 484                                                 continue;
 485                                         }
 486                                         let mut node_pks = Vec::new();
 487                                         let mut errored = false;
 488                                         for pk_str in path_pks_str.unwrap().split(",") {
 489                                                 let node_pubkey_vec = match hex_utils::to_vec(pk_str) {
 490                                                         Some(peer_pubkey_vec) => peer_pubkey_vec,
 491                                                         None => {
 492                                                                 println!("ERROR: couldn't parse peer_pubkey");
 493                                                                 errored = true;
 494                                                                 break;
 495                                                         }
 496                                                 };
 497                                                 let node_pubkey = match PublicKey::from_slice(&node_pubkey_vec) {
 498                                                         Ok(peer_pubkey) => peer_pubkey,
 499                                                         Err(_) => {
 500                                                                 println!("ERROR: couldn't parse peer_pubkey");
 501                                                                 errored = true;
 502                                                                 break;
 503                                                         }
 504                                                 };
 505                                                 node_pks.push(node_pubkey);
 506                                         }
 507                                         if errored {
 508                                                 continue;
 509                                         }
 510                                         let tlv_type = match words.next().map(|ty_str| ty_str.parse()) {
 511                                                 Some(Ok(ty)) if ty >= 64 => ty,
 512                                                 _ => {
 513                                                         println!("Need an integral message type above 64");
 514                                                         continue;
 515                                                 }
 516                                         };
 517                                         let data = match words.next().map(|s| hex_utils::to_vec(s)) {
 518                                                 Some(Some(data)) => data,
 519                                                 _ => {
 520                                                         println!("Need a hex data string");
 521                                                         continue;
 522                                                 }
 523                                         };
 524                                         let destination_pk = node_pks.pop().unwrap();
 525                                         match onion_messenger.send_onion_message(
 526                                                 &node_pks,
 527                                                 Destination::Node(destination_pk),
 528                                                 OnionMessageContents::Custom(UserOnionMessageContents { tlv_type, data }),
 529                                                 None,
 530                                         ) {
 531                                                 Ok(()) => println!("SUCCESS: forwarded onion message to first hop"),
 532                                                 Err(e) => println!("ERROR: failed to send onion message: {:?}", e),
 533                                         }
 534                                 }
 535                                 "quit" | "exit" => break,
 536                                 _ => println!("Unknown command. See `\"help\" for available commands."),
 537                         }
 538                 }
 539         }
 540 }
 541
 542 fn help() {
 543         let package_version = env!("CARGO_PKG_VERSION");
 544         let package_name = env!("CARGO_PKG_NAME");
 545         println!("\nVERSION:");
 546         println!("  {} v{}", package_name, package_version);
 547         println!("\nUSAGE:");
 548         println!("  Command [arguments]");
 549         println!("\nCOMMANDS:");
 550         println!("  help\tShows a list of commands.");
 551         println!("  quit\tClose the application.");
 552         println!("\n  Channels:");
 553         println!("      openchannel pubkey@host:port <amt_satoshis> [--public]");
 554         println!("      closechannel <channel_id> <peer_pubkey>");
 555         println!("      forceclosechannel <channel_id> <peer_pubkey>");
 556         println!("      listchannels");
 557         println!("\n  Peers:");
 558         println!("      connectpeer pubkey@host:port");
 559         println!("      disconnectpeer <peer_pubkey>");
 560         println!("      listpeers");
 561         println!("\n  Payments:");
 562         println!("      sendpayment <invoice>");
 563         println!("      keysend <dest_pubkey> <amt_msats>");
 564         println!("      listpayments");
 565         println!("\n  Invoices:");
 566         println!("      getinvoice <amt_msats> <expiry_secs>");
 567         println!("\n  Other:");
 568         println!("      signmessage <message>");
 569         println!(
 570                 "      sendonionmessage <node_id_1,node_id_2,..,destination_node_id> <type> <hex_bytes>"
 571         );
 572         println!("      nodeinfo");
 573 }
 574
 575 fn node_info(channel_manager: &Arc<ChannelManager>, peer_manager: &Arc<PeerManager>) {
 576         println!("\t{{");
 577         println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
 578         let chans = channel_manager.list_channels();
 579         println!("\t\t num_channels: {}", chans.len());
 580         println!("\t\t num_usable_channels: {}", chans.iter().filter(|c| c.is_usable).count());
 581         let local_balance_msat = chans.iter().map(|c| c.balance_msat).sum::<u64>();
 582         println!("\t\t local_balance_msat: {}", local_balance_msat);
 583         println!("\t\t num_peers: {}", peer_manager.get_peer_node_ids().len());
 584         println!("\t}},");
 585 }
 586
 587 fn list_peers(peer_manager: Arc<PeerManager>) {
 588         println!("\t{{");
 589         for pubkey in peer_manager.get_peer_node_ids() {
 590                 println!("\t\t pubkey: {}", pubkey);
 591         }
 592         println!("\t}},");
 593 }
 594
 595 fn list_channels(channel_manager: &Arc<ChannelManager>, network_graph: &Arc<NetworkGraph>) {
 596         print!("[");
 597         for chan_info in channel_manager.list_channels() {
 598                 println!("");
 599                 println!("\t{{");
 600                 println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..]));
 601                 if let Some(funding_txo) = chan_info.funding_txo {
 602                         println!("\t\tfunding_txid: {},", funding_txo.txid);
 603                 }
 604
 605                 println!(
 606                         "\t\tpeer_pubkey: {},",
 607                         hex_utils::hex_str(&chan_info.counterparty.node_id.serialize())
 608                 );
 609                 if let Some(node_info) = network_graph
 610                         .read_only()
 611                         .nodes()
 612                         .get(&NodeId::from_pubkey(&chan_info.counterparty.node_id))
 613                 {
 614                         if let Some(announcement) = &node_info.announcement_info {
 615                                 println!("\t\tpeer_alias: {}", announcement.alias);
 616                         }
 617                 }
 618
 619                 if let Some(id) = chan_info.short_channel_id {
 620                         println!("\t\tshort_channel_id: {},", id);
 621                 }
 622                 println!("\t\tis_channel_ready: {},", chan_info.is_channel_ready);
 623                 println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
 624                 println!("\t\tlocal_balance_msat: {},", chan_info.balance_msat);
 625                 if chan_info.is_usable {
 626                         println!("\t\tavailable_balance_for_send_msat: {},", chan_info.outbound_capacity_msat);
 627                         println!("\t\tavailable_balance_for_recv_msat: {},", chan_info.inbound_capacity_msat);
 628                 }
 629                 println!("\t\tchannel_can_send_payments: {},", chan_info.is_usable);
 630                 println!("\t\tpublic: {},", chan_info.is_public);
 631                 println!("\t}},");
 632         }
 633         println!("]");
 634 }
 635
 636 fn list_payments(inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage) {
 637         let inbound = inbound_payments.lock().unwrap();
 638         let outbound = outbound_payments.lock().unwrap();
 639         print!("[");
 640         for (payment_hash, payment_info) in inbound.deref() {
 641                 println!("");
 642                 println!("\t{{");
 643                 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
 644                 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
 645                 println!("\t\thtlc_direction: inbound,");
 646                 println!(
 647                         "\t\thtlc_status: {},",
 648                         match payment_info.status {
 649                                 HTLCStatus::Pending => "pending",
 650                                 HTLCStatus::Succeeded => "succeeded",
 651                                 HTLCStatus::Failed => "failed",
 652                         }
 653                 );
 654
 655                 println!("\t}},");
 656         }
 657
 658         for (payment_hash, payment_info) in outbound.deref() {
 659                 println!("");
 660                 println!("\t{{");
 661                 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
 662                 println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
 663                 println!("\t\thtlc_direction: outbound,");
 664                 println!(
 665                         "\t\thtlc_status: {},",
 666                         match payment_info.status {
 667                                 HTLCStatus::Pending => "pending",
 668                                 HTLCStatus::Succeeded => "succeeded",
 669                                 HTLCStatus::Failed => "failed",
 670                         }
 671                 );
 672
 673                 println!("\t}},");
 674         }
 675         println!("]");
 676 }
 677
 678 pub(crate) async fn connect_peer_if_necessary(
 679         pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
 680 ) -> Result<(), ()> {
 681         for node_pubkey in peer_manager.get_peer_node_ids() {
 682                 if node_pubkey == pubkey {
 683                         return Ok(());
 684                 }
 685         }
 686         let res = do_connect_peer(pubkey, peer_addr, peer_manager).await;
 687         if res.is_err() {
 688                 println!("ERROR: failed to connect to peer");
 689         }
 690         res
 691 }
 692
 693 pub(crate) async fn do_connect_peer(
 694         pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
 695 ) -> Result<(), ()> {
 696         match lightning_net_tokio::connect_outbound(Arc::clone(&peer_manager), pubkey, peer_addr).await
 697         {
 698                 Some(connection_closed_future) => {
 699                         let mut connection_closed_future = Box::pin(connection_closed_future);
 700                         loop {
 701                                 match futures::poll!(&mut connection_closed_future) {
 702                                         std::task::Poll::Ready(_) => {
 703                                                 return Err(());
 704                                         }
 705                                         std::task::Poll::Pending => {}
 706                                 }
 707                                 // Avoid blocking the tokio context by sleeping a bit
 708                                 match peer_manager.get_peer_node_ids().iter().find(|id| **id == pubkey) {
 709                                         Some(_) => return Ok(()),
 710                                         None => tokio::time::sleep(Duration::from_millis(10)).await,
 711                                 }
 712                         }
 713                 }
 714                 None => Err(()),
 715         }
 716 }
 717
 718 fn do_disconnect_peer(
 719         pubkey: bitcoin::secp256k1::PublicKey, peer_manager: Arc<PeerManager>,
 720         channel_manager: Arc<ChannelManager>,
 721 ) -> Result<(), ()> {
 722         //check for open channels with peer
 723         for channel in channel_manager.list_channels() {
 724                 if channel.counterparty.node_id == pubkey {
 725                         println!("Error: Node has an active channel with this peer, close any channels first");
 726                         return Err(());
 727                 }
 728         }
 729
 730         //check the pubkey matches a valid connected peer
 731         let peers = peer_manager.get_peer_node_ids();
 732         if !peers.contains(&pubkey) {
 733                 println!("Error: Could not find peer {}", pubkey);
 734                 return Err(());
 735         }
 736
 737         peer_manager.disconnect_by_node_id(pubkey, false);
 738         Ok(())
 739 }
 740
 741 fn open_channel(
 742         peer_pubkey: PublicKey, channel_amt_sat: u64, announced_channel: bool,
 743         channel_manager: Arc<ChannelManager>,
 744 ) -> Result<(), ()> {
 745         let config = UserConfig {
 746                 channel_handshake_limits: ChannelHandshakeLimits {
 747                         // lnd's max to_self_delay is 2016, so we want to be compatible.
 748                         their_to_self_delay: 2016,
 749                         ..Default::default()
 750                 },
 751                 channel_handshake_config: ChannelHandshakeConfig {
 752                         announced_channel,
 753                         ..Default::default()
 754                 },
 755                 ..Default::default()
 756         };
 757
 758         match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, Some(config)) {
 759                 Ok(_) => {
 760                         println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
 761                         return Ok(());
 762                 }
 763                 Err(e) => {
 764                         println!("ERROR: failed to open channel: {:?}", e);
 765                         return Err(());
 766                 }
 767         }
 768 }
 769
 770 fn send_payment<E: EventHandler>(
 771         invoice_payer: &InvoicePayer<E>, invoice: &Invoice, payment_storage: PaymentInfoStorage,
 772 ) {
 773         let status = match invoice_payer.pay_invoice(invoice) {
 774                 Ok(_payment_id) => {
 775                         let payee_pubkey = invoice.recover_payee_pub_key();
 776                         let amt_msat = invoice.amount_milli_satoshis().unwrap();
 777                         println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
 778                         print!("> ");
 779                         HTLCStatus::Pending
 780                 }
 781                 Err(PaymentError::Invoice(e)) => {
 782                         println!("ERROR: invalid invoice: {}", e);
 783                         print!("> ");
 784                         return;
 785                 }
 786                 Err(PaymentError::Routing(e)) => {
 787                         println!("ERROR: failed to find route: {}", e.err);
 788                         print!("> ");
 789                         return;
 790                 }
 791                 Err(PaymentError::Sending(e)) => {
 792                         println!("ERROR: failed to send payment: {:?}", e);
 793                         print!("> ");
 794                         HTLCStatus::Failed
 795                 }
 796         };
 797         let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
 798         let payment_secret = Some(invoice.payment_secret().clone());
 799
 800         let mut payments = payment_storage.lock().unwrap();
 801         payments.insert(
 802                 payment_hash,
 803                 PaymentInfo {
 804                         preimage: None,
 805                         secret: payment_secret,
 806                         status,
 807                         amt_msat: MillisatAmount(invoice.amount_milli_satoshis()),
 808                 },
 809         );
 810 }
 811
 812 fn keysend<E: EventHandler, K: KeysInterface>(
 813         invoice_payer: &InvoicePayer<E>, payee_pubkey: PublicKey, amt_msat: u64, keys: &K,
 814         payment_storage: PaymentInfoStorage,
 815 ) {
 816         let payment_preimage = keys.get_secure_random_bytes();
 817
 818         let status = match invoice_payer.pay_pubkey(
 819                 payee_pubkey,
 820                 PaymentPreimage(payment_preimage),
 821                 amt_msat,
 822                 40,
 823         ) {
 824                 Ok(_payment_id) => {
 825                         println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
 826                         print!("> ");
 827                         HTLCStatus::Pending
 828                 }
 829                 Err(PaymentError::Invoice(e)) => {
 830                         println!("ERROR: invalid payee: {}", e);
 831                         print!("> ");
 832                         return;
 833                 }
 834                 Err(PaymentError::Routing(e)) => {
 835                         println!("ERROR: failed to find route: {}", e.err);
 836                         print!("> ");
 837                         return;
 838                 }
 839                 Err(PaymentError::Sending(e)) => {
 840                         println!("ERROR: failed to send payment: {:?}", e);
 841                         print!("> ");
 842                         HTLCStatus::Failed
 843                 }
 844         };
 845
 846         let mut payments = payment_storage.lock().unwrap();
 847         payments.insert(
 848                 PaymentHash(Sha256::hash(&payment_preimage).into_inner()),
 849                 PaymentInfo {
 850                         preimage: None,
 851                         secret: None,
 852                         status,
 853                         amt_msat: MillisatAmount(Some(amt_msat)),
 854                 },
 855         );
 856 }
 857
 858 fn get_invoice(
 859         amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: &ChannelManager,
 860         keys_manager: Arc<KeysManager>, network: Network, expiry_secs: u32,
 861         logger: Arc<disk::FilesystemLogger>,
 862 ) {
 863         let mut payments = payment_storage.lock().unwrap();
 864         let currency = match network {
 865                 Network::Bitcoin => Currency::Bitcoin,
 866                 Network::Testnet => Currency::BitcoinTestnet,
 867                 Network::Regtest => Currency::Regtest,
 868                 Network::Signet => Currency::Signet,
 869         };
 870         let invoice = match utils::create_invoice_from_channelmanager(
 871                 channel_manager,
 872                 keys_manager,
 873                 logger,
 874                 currency,
 875                 Some(amt_msat),
 876                 "ldk-tutorial-node".to_string(),
 877                 expiry_secs,
 878         ) {
 879                 Ok(inv) => {
 880                         println!("SUCCESS: generated invoice: {}", inv);
 881                         inv
 882                 }
 883                 Err(e) => {
 884                         println!("ERROR: failed to create invoice: {:?}", e);
 885                         return;
 886                 }
 887         };
 888
 889         let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
 890         payments.insert(
 891                 payment_hash,
 892                 PaymentInfo {
 893                         preimage: None,
 894                         secret: Some(invoice.payment_secret().clone()),
 895                         status: HTLCStatus::Pending,
 896                         amt_msat: MillisatAmount(Some(amt_msat)),
 897                 },
 898         );
 899 }
 900
 901 fn close_channel(
 902         channel_id: [u8; 32], counterparty_node_id: PublicKey, channel_manager: Arc<ChannelManager>,
 903 ) {
 904         match channel_manager.close_channel(&channel_id, &counterparty_node_id) {
 905                 Ok(()) => println!("EVENT: initiating channel close"),
 906                 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
 907         }
 908 }
 909
 910 fn force_close_channel(
 911         channel_id: [u8; 32], counterparty_node_id: PublicKey, channel_manager: Arc<ChannelManager>,
 912 ) {
 913         match channel_manager.force_close_broadcasting_latest_txn(&channel_id, &counterparty_node_id) {
 914                 Ok(()) => println!("EVENT: initiating channel force-close"),
 915                 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
 916         }
 917 }
 918
 919 pub(crate) fn parse_peer_info(
 920         peer_pubkey_and_ip_addr: String,
 921 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
 922         let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
 923         let pubkey = pubkey_and_addr.next();
 924         let peer_addr_str = pubkey_and_addr.next();
 925         if peer_addr_str.is_none() {
 926                 return Err(std::io::Error::new(
 927                         std::io::ErrorKind::Other,
 928                         "ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`",
 929                 ));
 930         }
 931
 932         let peer_addr = peer_addr_str.unwrap().to_socket_addrs().map(|mut r| r.next());
 933         if peer_addr.is_err() || peer_addr.as_ref().unwrap().is_none() {
 934                 return Err(std::io::Error::new(
 935                         std::io::ErrorKind::Other,
 936                         "ERROR: couldn't parse pubkey@host:port into a socket address",
 937                 ));
 938         }
 939
 940         let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
 941         if pubkey.is_none() {
 942                 return Err(std::io::Error::new(
 943                         std::io::ErrorKind::Other,
 944                         "ERROR: unable to parse given pubkey for node",
 945                 ));
 946         }
 947
 948         Ok((pubkey.unwrap(), peer_addr.unwrap().unwrap()))
 949 }