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

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