Make cli output json

Previously we would output the debug format of each of our return times
which worked, but was not very usable. You could not easily pipe results
with cli tools or anything like that. This changes the results to be
output to json to make it easier to use and more similiar to what people
expect.

This had one annoyance because since our structs are generated using
prost, we cannot just simply add the serde traits to the structs, so
instead we recreate the types we are going to output in the cli and
covert them.

Author: benthecarman

Cargo.lock

@@ -7,4 +7,6 @@ edition = "2021"
 ldk-server-client = { path = "../ldk-server-client" }
 clap = { version = "4.0.5", default-features = false, features = ["derive", "std", "error-context", "suggestions", "help"] }
 tokio = { version = "1.38.0", default-features = false, features = ["rt-multi-thread", "macros"] }
-prost = { version = "0.11.6", default-features = false}
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
+hex-conservative = "0.2.1"

ldk-server-cli/Cargo.toml

@@ -1,3 +1,5 @@
+mod types;
+
 use clap::{Parser, Subcommand};
 use ldk_server_client::client::LdkServerClient;
 use ldk_server_client::error::LdkServerError;
@@ -13,7 +15,7 @@ use ldk_server_client::ldk_server_protos::api::{
 use ldk_server_client::ldk_server_protos::types::{
 	bolt11_invoice_description, Bolt11InvoiceDescription, PageToken, Payment,
 };
-use std::fmt::Debug;
+use serde::Serialize;
 
 #[derive(Parser, Debug)]
 #[command(version, about, long_about = None)]
@@ -119,16 +121,22 @@ async fn main() {
 
 	match cli.command {
 		Commands::GetNodeInfo => {
-			handle_response_result(client.get_node_info(GetNodeInfoRequest {}).await);
+			handle_response_result::<_, types::GetNodeInfoResponse>(
+				client.get_node_info(GetNodeInfoRequest {}).await,
+			);
 		},
 		Commands::GetBalances => {
-			handle_response_result(client.get_balances(GetBalancesRequest {}).await);
+			handle_response_result::<_, types::GetBalancesResponse>(
+				client.get_balances(GetBalancesRequest {}).await,
+			);
 		},
 		Commands::OnchainReceive => {
-			handle_response_result(client.onchain_receive(OnchainReceiveRequest {}).await);
+			handle_response_result::<_, types::OnchainReceiveResponse>(
+				client.onchain_receive(OnchainReceiveRequest {}).await,
+			);
 		},
 		Commands::OnchainSend { address, amount_sats, send_all, fee_rate_sat_per_vb } => {
-			handle_response_result(
+			handle_response_result::<_, types::OnchainSendResponse>(
 				client
 					.onchain_send(OnchainSendRequest {
 						address,
@@ -159,15 +167,17 @@ async fn main() {
 			let request =
 				Bolt11ReceiveRequest { description: invoice_description, expiry_secs, amount_msat };
 
-			handle_response_result(client.bolt11_receive(request).await);
+			handle_response_result::<_, types::Bolt11ReceiveResponse>(
+				client.bolt11_receive(request).await,
+			);
 		},
 		Commands::Bolt11Send { invoice, amount_msat } => {
-			handle_response_result(
+			handle_response_result::<_, types::Bolt11SendResponse>(
 				client.bolt11_send(Bolt11SendRequest { invoice, amount_msat }).await,
 			);
 		},
 		Commands::Bolt12Receive { description, amount_msat, expiry_secs, quantity } => {
-			handle_response_result(
+			handle_response_result::<_, types::Bolt12ReceiveResponse>(
 				client
 					.bolt12_receive(Bolt12ReceiveRequest {
 						description,
@@ -179,14 +189,14 @@ async fn main() {
 			);
 		},
 		Commands::Bolt12Send { offer, amount_msat, quantity, payer_note } => {
-			handle_response_result(
+			handle_response_result::<_, types::Bolt12SendResponse>(
 				client
 					.bolt12_send(Bolt12SendRequest { offer, amount_msat, quantity, payer_note })
 					.await,
 			);
 		},
 		Commands::CloseChannel { user_channel_id, counterparty_node_id } => {
-			handle_response_result(
+			handle_response_result::<_, types::CloseChannelResponse>(
 				client
 					.close_channel(CloseChannelRequest { user_channel_id, counterparty_node_id })
 					.await,
@@ -197,7 +207,7 @@ async fn main() {
 			counterparty_node_id,
 			force_close_reason,
 		} => {
-			handle_response_result(
+			handle_response_result::<_, types::ForceCloseChannelResponse>(
 				client
 					.force_close_channel(ForceCloseChannelRequest {
 						user_channel_id,
@@ -214,7 +224,7 @@ async fn main() {
 			push_to_counterparty_msat,
 			announce_channel,
 		} => {
-			handle_response_result(
+			handle_response_result::<_, types::OpenChannelResponse>(
 				client
 					.open_channel(OpenChannelRequest {
 						node_pubkey,
@@ -228,10 +238,14 @@ async fn main() {
 			);
 		},
 		Commands::ListChannels => {
-			handle_response_result(client.list_channels(ListChannelsRequest {}).await);
+			handle_response_result::<_, types::ListChannelsResponse>(
+				client.list_channels(ListChannelsRequest {}).await,
+			);
 		},
 		Commands::ListPayments { number_of_payments } => {
-			handle_response_result(list_n_payments(client, number_of_payments).await);
+			handle_response_result::<_, types::ListPaymentsResponse>(
+				list_n_payments(client, number_of_payments).await,
+			);
 		},
 	}
 }
@@ -256,10 +270,21 @@ async fn list_n_payments(
 	Ok(payments)
 }
 
-fn handle_response_result<Rs: Debug>(response: Result<Rs, LdkServerError>) {
+fn handle_response_result<Rs, Js>(response: Result<Rs, LdkServerError>)
+where
+	Rs: Into<Js>,
+	Js: Serialize + std::fmt::Debug,
+{
 	match response {
 		Ok(response) => {
-			println!("Success: {:?}", response);
+			let json_response: Js = response.into();
+			match serde_json::to_string_pretty(&json_response) {
+				Ok(json) => println!("{json}"),
+				Err(e) => {
+					eprintln!("Error serializing response ({json_response:?}) to JSON: {e}");
+					std::process::exit(1);
+				},
+			}
 		},
 		Err(e) => {
 			handle_error(e);