9cb0f174fa70b3be67d13c4438e2bc011554dcb4
[ldk-sample] / 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, MillisatAmount, NetworkGraph, OnionMessenger, PaymentInfo,
5         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::ln::channelmanager::{PaymentId, RecipientOnionFields, Retry};
12 use lightning::ln::msgs::SocketAddress;
13 use lightning::ln::{ChannelId, PaymentHash, PaymentPreimage};
14 use lightning::onion_message::OnionMessagePath;
15 use lightning::onion_message::{CustomOnionMessageContents, Destination, 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::payment::pay_invoice;
23 use lightning_invoice::{utils, Bolt11Invoice, Currency};
24 use lightning_persister::fs_store::FilesystemStore;
25 use std::env;
26 use std::io;
27 use std::io::Write;
28 use std::net::{SocketAddr, ToSocketAddrs};
29 use std::path::Path;
30 use std::str::FromStr;
31 use std::sync::{Arc, Mutex};
32 use std::time::Duration;
33
34 pub(crate) struct LdkUserInfo {
35         pub(crate) bitcoind_rpc_username: String,
36         pub(crate) bitcoind_rpc_password: String,
37         pub(crate) bitcoind_rpc_port: u16,
38         pub(crate) bitcoind_rpc_host: String,
39         pub(crate) ldk_storage_dir_path: String,
40         pub(crate) ldk_peer_listening_port: u16,
41         pub(crate) ldk_announced_listen_addr: Vec<SocketAddress>,
42         pub(crate) ldk_announced_node_name: [u8; 32],
43         pub(crate) network: Network,
44 }
45
46 struct UserOnionMessageContents {
47         tlv_type: u64,
48         data: Vec<u8>,
49 }
50
51 impl CustomOnionMessageContents 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<PaymentInfoStorage>>,
67         outbound_payments: Arc<Mutex<PaymentInfoStorage>>, ldk_data_dir: String, network: Network,
68         logger: Arc<disk::FilesystemLogger>, persister: 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                                                 persister.clone(),
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                                                 persister.clone(),
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                                         persister
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                                         let message_path = OnionMessagePath { intermediate_nodes, destination };
446                                         match onion_messenger.send_onion_message(
447                                                 message_path,
448                                                 OnionMessageContents::Custom(UserOnionMessageContents { tlv_type, data }),
449                                                 None,
450                                         ) {
451                                                 Ok(()) => println!("SUCCESS: forwarded onion message to first hop"),
452                                                 Err(e) => println!("ERROR: failed to send onion message: {:?}", e),
453                                         }
454                                 }
455                                 "quit" | "exit" => break,
456                                 _ => println!("Unknown command. See `\"help\" for available commands."),
457                         }
458                 }
459         }
460 }
461
462 fn help() {
463         let package_version = env!("CARGO_PKG_VERSION");
464         let package_name = env!("CARGO_PKG_NAME");
465         println!("\nVERSION:");
466         println!("  {} v{}", package_name, package_version);
467         println!("\nUSAGE:");
468         println!("  Command [arguments]");
469         println!("\nCOMMANDS:");
470         println!("  help\tShows a list of commands.");
471         println!("  quit\tClose the application.");
472         println!("\n  Channels:");
473         println!("      openchannel pubkey@host:port <amt_satoshis> [--public] [--with-anchors]");
474         println!("      closechannel <channel_id> <peer_pubkey>");
475         println!("      forceclosechannel <channel_id> <peer_pubkey>");
476         println!("      listchannels");
477         println!("\n  Peers:");
478         println!("      connectpeer pubkey@host:port");
479         println!("      disconnectpeer <peer_pubkey>");
480         println!("      listpeers");
481         println!("\n  Payments:");
482         println!("      sendpayment <invoice>");
483         println!("      keysend <dest_pubkey> <amt_msats>");
484         println!("      listpayments");
485         println!("\n  Invoices:");
486         println!("      getinvoice <amt_msats> <expiry_secs>");
487         println!("\n  Other:");
488         println!("      signmessage <message>");
489         println!(
490                 "      sendonionmessage <node_id_1,node_id_2,..,destination_node_id> <type> <hex_bytes>"
491         );
492         println!("      nodeinfo");
493 }
494
495 fn node_info(channel_manager: &Arc<ChannelManager>, peer_manager: &Arc<PeerManager>) {
496         println!("\t{{");
497         println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
498         let chans = channel_manager.list_channels();
499         println!("\t\t num_channels: {}", chans.len());
500         println!("\t\t num_usable_channels: {}", chans.iter().filter(|c| c.is_usable).count());
501         let local_balance_msat = chans.iter().map(|c| c.balance_msat).sum::<u64>();
502         println!("\t\t local_balance_msat: {}", local_balance_msat);
503         println!("\t\t num_peers: {}", peer_manager.get_peer_node_ids().len());
504         println!("\t}},");
505 }
506
507 fn list_peers(peer_manager: Arc<PeerManager>) {
508         println!("\t{{");
509         for (pubkey, _) in peer_manager.get_peer_node_ids() {
510                 println!("\t\t pubkey: {}", pubkey);
511         }
512         println!("\t}},");
513 }
514
515 fn list_channels(channel_manager: &Arc<ChannelManager>, network_graph: &Arc<NetworkGraph>) {
516         print!("[");
517         for chan_info in channel_manager.list_channels() {
518                 println!("");
519                 println!("\t{{");
520                 println!("\t\tchannel_id: {},", chan_info.channel_id);
521                 if let Some(funding_txo) = chan_info.funding_txo {
522                         println!("\t\tfunding_txid: {},", funding_txo.txid);
523                 }
524
525                 println!(
526                         "\t\tpeer_pubkey: {},",
527                         hex_utils::hex_str(&chan_info.counterparty.node_id.serialize())
528                 );
529                 if let Some(node_info) = network_graph
530                         .read_only()
531                         .nodes()
532                         .get(&NodeId::from_pubkey(&chan_info.counterparty.node_id))
533                 {
534                         if let Some(announcement) = &node_info.announcement_info {
535                                 println!("\t\tpeer_alias: {}", announcement.alias);
536                         }
537                 }
538
539                 if let Some(id) = chan_info.short_channel_id {
540                         println!("\t\tshort_channel_id: {},", id);
541                 }
542                 println!("\t\tis_channel_ready: {},", chan_info.is_channel_ready);
543                 println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
544                 println!("\t\toutbound_capacity_msat: {},", chan_info.outbound_capacity_msat);
545                 if chan_info.is_usable {
546                         println!("\t\tavailable_balance_for_send_msat: {},", chan_info.outbound_capacity_msat);
547                         println!("\t\tavailable_balance_for_recv_msat: {},", chan_info.inbound_capacity_msat);
548                 }
549                 println!("\t\tchannel_can_send_payments: {},", chan_info.is_usable);
550                 println!("\t\tpublic: {},", chan_info.is_public);
551                 println!("\t}},");
552         }
553         println!("]");
554 }
555
556 fn list_payments(inbound_payments: &PaymentInfoStorage, outbound_payments: &PaymentInfoStorage) {
557         print!("[");
558         for (payment_hash, payment_info) in &inbound_payments.payments {
559                 println!("");
560                 println!("\t{{");
561                 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
562                 println!("\t\tpayment_hash: {},", payment_hash);
563                 println!("\t\thtlc_direction: inbound,");
564                 println!(
565                         "\t\thtlc_status: {},",
566                         match payment_info.status {
567                                 HTLCStatus::Pending => "pending",
568                                 HTLCStatus::Succeeded => "succeeded",
569                                 HTLCStatus::Failed => "failed",
570                         }
571                 );
572
573                 println!("\t}},");
574         }
575
576         for (payment_hash, payment_info) in &outbound_payments.payments {
577                 println!("");
578                 println!("\t{{");
579                 println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
580                 println!("\t\tpayment_hash: {},", payment_hash);
581                 println!("\t\thtlc_direction: outbound,");
582                 println!(
583                         "\t\thtlc_status: {},",
584                         match payment_info.status {
585                                 HTLCStatus::Pending => "pending",
586                                 HTLCStatus::Succeeded => "succeeded",
587                                 HTLCStatus::Failed => "failed",
588                         }
589                 );
590
591                 println!("\t}},");
592         }
593         println!("]");
594 }
595
596 pub(crate) async fn connect_peer_if_necessary(
597         pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
598 ) -> Result<(), ()> {
599         for (node_pubkey, _) in peer_manager.get_peer_node_ids() {
600                 if node_pubkey == pubkey {
601                         return Ok(());
602                 }
603         }
604         let res = do_connect_peer(pubkey, peer_addr, peer_manager).await;
605         if res.is_err() {
606                 println!("ERROR: failed to connect to peer");
607         }
608         res
609 }
610
611 pub(crate) async fn do_connect_peer(
612         pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
613 ) -> Result<(), ()> {
614         match lightning_net_tokio::connect_outbound(Arc::clone(&peer_manager), pubkey, peer_addr).await
615         {
616                 Some(connection_closed_future) => {
617                         let mut connection_closed_future = Box::pin(connection_closed_future);
618                         loop {
619                                 tokio::select! {
620                                         _ = &mut connection_closed_future => return Err(()),
621                                         _ = tokio::time::sleep(Duration::from_millis(10)) => {},
622                                 };
623                                 if peer_manager.get_peer_node_ids().iter().find(|(id, _)| *id == pubkey).is_some() {
624                                         return Ok(());
625                                 }
626                         }
627                 }
628                 None => Err(()),
629         }
630 }
631
632 fn do_disconnect_peer(
633         pubkey: bitcoin::secp256k1::PublicKey, peer_manager: Arc<PeerManager>,
634         channel_manager: Arc<ChannelManager>,
635 ) -> Result<(), ()> {
636         //check for open channels with peer
637         for channel in channel_manager.list_channels() {
638                 if channel.counterparty.node_id == pubkey {
639                         println!("Error: Node has an active channel with this peer, close any channels first");
640                         return Err(());
641                 }
642         }
643
644         //check the pubkey matches a valid connected peer
645         let peers = peer_manager.get_peer_node_ids();
646         if !peers.iter().any(|(pk, _)| &pubkey == pk) {
647                 println!("Error: Could not find peer {}", pubkey);
648                 return Err(());
649         }
650
651         peer_manager.disconnect_by_node_id(pubkey);
652         Ok(())
653 }
654
655 fn open_channel(
656         peer_pubkey: PublicKey, channel_amt_sat: u64, announced_channel: bool, with_anchors: bool,
657         channel_manager: Arc<ChannelManager>,
658 ) -> Result<(), ()> {
659         let config = UserConfig {
660                 channel_handshake_limits: ChannelHandshakeLimits {
661                         // lnd's max to_self_delay is 2016, so we want to be compatible.
662                         their_to_self_delay: 2016,
663                         ..Default::default()
664                 },
665                 channel_handshake_config: ChannelHandshakeConfig {
666                         announced_channel,
667                         negotiate_anchors_zero_fee_htlc_tx: with_anchors,
668                         ..Default::default()
669                 },
670                 ..Default::default()
671         };
672
673         match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, Some(config)) {
674                 Ok(_) => {
675                         println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
676                         return Ok(());
677                 }
678                 Err(e) => {
679                         println!("ERROR: failed to open channel: {:?}", e);
680                         return Err(());
681                 }
682         }
683 }
684
685 fn send_payment(
686         channel_manager: &ChannelManager, invoice: &Bolt11Invoice,
687         outbound_payments: &mut PaymentInfoStorage, persister: Arc<FilesystemStore>,
688 ) {
689         let payment_hash = PaymentHash((*invoice.payment_hash()).into_inner());
690         let payment_secret = Some(*invoice.payment_secret());
691         outbound_payments.payments.insert(
692                 payment_hash,
693                 PaymentInfo {
694                         preimage: None,
695                         secret: payment_secret,
696                         status: HTLCStatus::Pending,
697                         amt_msat: MillisatAmount(invoice.amount_milli_satoshis()),
698                 },
699         );
700         persister.write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound_payments.encode()).unwrap();
701         match pay_invoice(invoice, Retry::Timeout(Duration::from_secs(10)), channel_manager) {
702                 Ok(_payment_id) => {
703                         let payee_pubkey = invoice.recover_payee_pub_key();
704                         let amt_msat = invoice.amount_milli_satoshis().unwrap();
705                         println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
706                         print!("> ");
707                 }
708                 Err(e) => {
709                         println!("ERROR: failed to send payment: {:?}", e);
710                         print!("> ");
711                         outbound_payments.payments.get_mut(&payment_hash).unwrap().status = HTLCStatus::Failed;
712                         persister.write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound_payments.encode()).unwrap();
713                 }
714         };
715 }
716
717 fn keysend<E: EntropySource>(
718         channel_manager: &ChannelManager, payee_pubkey: PublicKey, amt_msat: u64, entropy_source: &E,
719         outbound_payments: &mut PaymentInfoStorage, persister: Arc<FilesystemStore>,
720 ) {
721         let payment_preimage = PaymentPreimage(entropy_source.get_secure_random_bytes());
722         let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
723
724         let route_params = RouteParameters::from_payment_params_and_value(
725                 PaymentParameters::for_keysend(payee_pubkey, 40, false),
726                 amt_msat,
727         );
728         outbound_payments.payments.insert(
729                 payment_hash,
730                 PaymentInfo {
731                         preimage: None,
732                         secret: None,
733                         status: HTLCStatus::Pending,
734                         amt_msat: MillisatAmount(Some(amt_msat)),
735                 },
736         );
737         persister.write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound_payments.encode()).unwrap();
738         match channel_manager.send_spontaneous_payment_with_retry(
739                 Some(payment_preimage),
740                 RecipientOnionFields::spontaneous_empty(),
741                 PaymentId(payment_hash.0),
742                 route_params,
743                 Retry::Timeout(Duration::from_secs(10)),
744         ) {
745                 Ok(_payment_hash) => {
746                         println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
747                         print!("> ");
748                 }
749                 Err(e) => {
750                         println!("ERROR: failed to send payment: {:?}", e);
751                         print!("> ");
752                         outbound_payments.payments.get_mut(&payment_hash).unwrap().status = HTLCStatus::Failed;
753                         persister.write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound_payments.encode()).unwrap();
754                 }
755         };
756 }
757
758 fn get_invoice(
759         amt_msat: u64, inbound_payments: &mut PaymentInfoStorage, channel_manager: &ChannelManager,
760         keys_manager: Arc<KeysManager>, network: Network, expiry_secs: u32,
761         logger: Arc<disk::FilesystemLogger>,
762 ) {
763         let currency = match network {
764                 Network::Bitcoin => Currency::Bitcoin,
765                 Network::Testnet => Currency::BitcoinTestnet,
766                 Network::Regtest => Currency::Regtest,
767                 Network::Signet => Currency::Signet,
768         };
769         let invoice = match utils::create_invoice_from_channelmanager(
770                 channel_manager,
771                 keys_manager,
772                 logger,
773                 currency,
774                 Some(amt_msat),
775                 "ldk-tutorial-node".to_string(),
776                 expiry_secs,
777                 None,
778         ) {
779                 Ok(inv) => {
780                         println!("SUCCESS: generated invoice: {}", inv);
781                         inv
782                 }
783                 Err(e) => {
784                         println!("ERROR: failed to create invoice: {:?}", e);
785                         return;
786                 }
787         };
788
789         let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
790         inbound_payments.payments.insert(
791                 payment_hash,
792                 PaymentInfo {
793                         preimage: None,
794                         secret: Some(invoice.payment_secret().clone()),
795                         status: HTLCStatus::Pending,
796                         amt_msat: MillisatAmount(Some(amt_msat)),
797                 },
798         );
799 }
800
801 fn close_channel(
802         channel_id: [u8; 32], counterparty_node_id: PublicKey, channel_manager: Arc<ChannelManager>,
803 ) {
804         match channel_manager.close_channel(&ChannelId(channel_id), &counterparty_node_id) {
805                 Ok(()) => println!("EVENT: initiating channel close"),
806                 Err(e) => println!("ERROR: failed to close channel: {:?}", e),
807         }
808 }
809
810 fn force_close_channel(
811         channel_id: [u8; 32], counterparty_node_id: PublicKey, channel_manager: Arc<ChannelManager>,
812 ) {
813         match channel_manager
814                 .force_close_broadcasting_latest_txn(&ChannelId(channel_id), &counterparty_node_id)
815         {
816                 Ok(()) => println!("EVENT: initiating channel force-close"),
817                 Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
818         }
819 }
820
821 pub(crate) fn parse_peer_info(
822         peer_pubkey_and_ip_addr: String,
823 ) -> Result<(PublicKey, SocketAddr), std::io::Error> {
824         let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
825         let pubkey = pubkey_and_addr.next();
826         let peer_addr_str = pubkey_and_addr.next();
827         if peer_addr_str.is_none() {
828                 return Err(std::io::Error::new(
829                         std::io::ErrorKind::Other,
830                         "ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`",
831                 ));
832         }
833
834         let peer_addr = peer_addr_str.unwrap().to_socket_addrs().map(|mut r| r.next());
835         if peer_addr.is_err() || peer_addr.as_ref().unwrap().is_none() {
836                 return Err(std::io::Error::new(
837                         std::io::ErrorKind::Other,
838                         "ERROR: couldn't parse pubkey@host:port into a socket address",
839                 ));
840         }
841
842         let pubkey = hex_utils::to_compressed_pubkey(pubkey.unwrap());
843         if pubkey.is_none() {
844                 return Err(std::io::Error::new(
845                         std::io::ErrorKind::Other,
846                         "ERROR: unable to parse given pubkey for node",
847                 ));
848         }
849
850         Ok((pubkey.unwrap(), peer_addr.unwrap().unwrap()))
851 }