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