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

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