Add Amount type for CLI amount arguments

Replace raw u64 amount fields with an Amount type that requires a
denomination suffix (e.g. 50sat, 50000msat). This removes ambiguity
about whether positional arguments are in sats or msats.

Author: benthecarman

ldk-server-cli/src/main.rs

@@ -40,7 +40,9 @@ use ldk_server_client::ldk_server_protos::types::{
 };
 use serde::Serialize;
 use serde_json::{json, Value};
-use types::{CliListForwardedPaymentsResponse, CliListPaymentsResponse, CliPaginatedResponse};
+use types::{
+	Amount, CliListForwardedPaymentsResponse, CliListPaymentsResponse, CliPaginatedResponse,
+};
 
 mod config;
 mod types;
@@ -97,10 +99,8 @@ enum Commands {
 	OnchainSend {
 		#[arg(help = "The address to send coins to")]
 		address: String,
-		#[arg(
-			help = "The amount in satoshis to send. Will respect any on-chain reserve needed for anchor channels"
-		)]
-		amount_sats: Option<u64>,
+		#[arg(help = "The amount to send, e.g. 50sat or 50000msat")]
+		amount: Option<Amount>,
 		#[arg(
 			long,
 			help = "Send full balance to the address. Warning: will not retain on-chain reserves for anchor channels"
@@ -115,9 +115,9 @@ enum Commands {
 	#[command(about = "Create a BOLT11 invoice to receive a payment")]
 	Bolt11Receive {
 		#[arg(
-			help = "Amount in millisatoshis to request. If unset, a variable-amount invoice is returned"
+			help = "Amount to request, e.g. 50sat or 50000msat. If unset, a variable-amount invoice is returned"
 		)]
-		amount_msat: Option<u64>,
+		amount: Option<Amount>,
 		#[arg(short, long, help = "Description to attach along with the invoice")]
 		description: Option<String>,
 		#[arg(
@@ -132,13 +132,15 @@ enum Commands {
 	Bolt11Send {
 		#[arg(help = "A BOLT11 invoice for a payment within the Lightning Network")]
 		invoice: String,
-		#[arg(help = "Amount in millisatoshis. Required when paying a zero-amount invoice")]
-		amount_msat: Option<u64>,
+		#[arg(
+			help = "Amount to send, e.g. 50sat or 50000msat. Required when paying a zero-amount invoice"
+		)]
+		amount: Option<Amount>,
 		#[arg(
 			long,
-			help = "Maximum total fees in millisatoshis that may accrue during route finding. Defaults to 1% of payment + 50 sats"
+			help = "Maximum total routing fee, e.g. 50sat or 50000msat. Defaults to 1% of payment + 50 sats"
 		)]
-		max_total_routing_fee_msat: Option<u64>,
+		max_total_routing_fee: Option<Amount>,
 		#[arg(long, help = "Maximum total CLTV delta we accept for the route (default: 1008)")]
 		max_total_cltv_expiry_delta: Option<u32>,
 		#[arg(
@@ -155,9 +157,9 @@ enum Commands {
 	#[command(about = "Return a BOLT12 offer for receiving payments")]
 	Bolt12Receive {
 		#[arg(
-			help = "Amount in millisatoshis to request. If unset, a variable-amount offer is returned"
+			help = "Amount to request, e.g. 50sat or 50000msat. If unset, a variable-amount offer is returned"
 		)]
-		amount_msat: Option<u64>,
+		amount: Option<Amount>,
 		#[arg(help = "Description to attach along with the offer")]
 		description: String,
 		#[arg(long, help = "Offer expiry time in seconds")]
@@ -169,8 +171,10 @@ enum Commands {
 	Bolt12Send {
 		#[arg(help = "A BOLT12 offer for a payment within the Lightning Network")]
 		offer: String,
-		#[arg(help = "Amount in millisatoshis. Required when paying a zero-amount offer")]
-		amount_msat: Option<u64>,
+		#[arg(
+			help = "Amount to send, e.g. 50sat or 50000msat. Required when paying a zero-amount offer"
+		)]
+		amount: Option<Amount>,
 		#[arg(short, long, help = "Number of items requested")]
 		quantity: Option<u64>,
 		#[arg(
@@ -181,9 +185,9 @@ enum Commands {
 		payer_note: Option<String>,
 		#[arg(
 			long,
-			help = "Maximum total fees, in millisatoshi, that may accrue during route finding, Defaults to 1% of the payment amount + 50 sats"
+			help = "Maximum total routing fee, e.g. 50sat or 50000msat. Defaults to 1% of the payment amount + 50 sats"
 		)]
-		max_total_routing_fee_msat: Option<u64>,
+		max_total_routing_fee: Option<Amount>,
 		#[arg(long, help = "Maximum total CLTV delta we accept for the route (default: 1008)")]
 		max_total_cltv_expiry_delta: Option<u32>,
 		#[arg(
@@ -201,13 +205,13 @@ enum Commands {
 	SpontaneousSend {
 		#[arg(help = "The hex-encoded public key of the node to send the payment to")]
 		node_id: String,
-		#[arg(help = "The amount in millisatoshis to send")]
-		amount_msat: u64,
+		#[arg(help = "The amount to send, e.g. 50sat or 50000msat")]
+		amount: Amount,
 		#[arg(
 			long,
-			help = "Maximum total fees in millisatoshis that may accrue during route finding. Defaults to 1% of payment + 50 sats"
+			help = "Maximum total routing fee, e.g. 50sat or 50000msat. Defaults to 1% of payment + 50 sats"
 		)]
-		max_total_routing_fee_msat: Option<u64>,
+		max_total_routing_fee: Option<Amount>,
 		#[arg(long, help = "Maximum total CLTV delta we accept for the route (default: 1008)")]
 		max_total_cltv_expiry_delta: Option<u32>,
 		#[arg(
@@ -245,13 +249,10 @@ enum Commands {
 			help = "Address to connect to remote peer (IPv4:port, IPv6:port, OnionV3:port, or hostname:port)"
 		)]
 		address: String,
-		#[arg(help = "The amount of satoshis to commit to the channel")]
-		channel_amount_sats: u64,
-		#[arg(
-			long,
-			help = "Amount of satoshis to push to the remote side as part of the initial commitment state"
-		)]
-		push_to_counterparty_msat: Option<u64>,
+		#[arg(help = "The amount to commit to the channel, e.g. 100sat or 100000msat")]
+		channel_amount: Amount,
+		#[arg(long, help = "Amount to push to the remote side, e.g. 50sat or 50000msat")]
+		push_to_counterparty: Option<Amount>,
 		#[arg(long, help = "Whether the channel should be public")]
 		announce_channel: bool,
 		// Channel config options
@@ -279,17 +280,17 @@ enum Commands {
 		user_channel_id: String,
 		#[arg(help = "The hex-encoded public key of the channel's counterparty node")]
 		counterparty_node_id: String,
-		#[arg(help = "The amount of sats to splice into the channel")]
-		splice_amount_sats: u64,
+		#[arg(help = "The amount to splice into the channel, e.g. 50sat or 50000msat")]
+		splice_amount: Amount,
 	},
 	#[command(about = "Decrease the channel balance by the given amount")]
 	SpliceOut {
 		#[arg(help = "The local user_channel_id of this channel")]
 		user_channel_id: String,
 		#[arg(help = "The hex-encoded public key of the channel's counterparty node")]
 		counterparty_node_id: String,
-		#[arg(help = "The amount of sats to splice out of the channel")]
-		splice_amount_sats: u64,
+		#[arg(help = "The amount to splice out of the channel, e.g. 50sat or 50000msat")]
+		splice_amount: Amount,
 		#[arg(
 			short,
 			long,
@@ -464,7 +465,8 @@ async fn main() {
 				client.onchain_receive(OnchainReceiveRequest {}).await,
 			);
 		},
-		Commands::OnchainSend { address, amount_sats, send_all, fee_rate_sat_per_vb } => {
+		Commands::OnchainSend { address, amount, send_all, fee_rate_sat_per_vb } => {
+			let amount_sats = amount.map(|a| a.to_sat().unwrap_or_else(|e| handle_error_msg(&e)));
 			handle_response_result::<_, OnchainSendResponse>(
 				client
 					.onchain_send(OnchainSendRequest {
@@ -476,7 +478,8 @@ async fn main() {
 					.await,
 			);
 		},
-		Commands::Bolt11Receive { description, description_hash, expiry_secs, amount_msat } => {
+		Commands::Bolt11Receive { description, description_hash, expiry_secs, amount } => {
+			let amount_msat = amount.map(|a| a.to_msat());
 			let invoice_description = match (description, description_hash) {
 				(Some(desc), None) => Some(Bolt11InvoiceDescription {
 					kind: Some(bolt11_invoice_description::Kind::Direct(desc)),
@@ -503,12 +506,14 @@ async fn main() {
 		},
 		Commands::Bolt11Send {
 			invoice,
-			amount_msat,
-			max_total_routing_fee_msat,
+			amount,
+			max_total_routing_fee,
 			max_total_cltv_expiry_delta,
 			max_path_count,
 			max_channel_saturation_power_of_half,
 		} => {
+			let amount_msat = amount.map(|a| a.to_msat());
+			let max_total_routing_fee_msat = max_total_routing_fee.map(|a| a.to_msat());
 			let route_parameters = RouteParametersConfig {
 				max_total_routing_fee_msat,
 				max_total_cltv_expiry_delta: max_total_cltv_expiry_delta
@@ -527,7 +532,8 @@ async fn main() {
 					.await,
 			);
 		},
-		Commands::Bolt12Receive { description, amount_msat, expiry_secs, quantity } => {
+		Commands::Bolt12Receive { description, amount, expiry_secs, quantity } => {
+			let amount_msat = amount.map(|a| a.to_msat());
 			handle_response_result::<_, Bolt12ReceiveResponse>(
 				client
 					.bolt12_receive(Bolt12ReceiveRequest {
@@ -541,14 +547,16 @@ async fn main() {
 		},
 		Commands::Bolt12Send {
 			offer,
-			amount_msat,
+			amount,
 			quantity,
 			payer_note,
-			max_total_routing_fee_msat,
+			max_total_routing_fee,
 			max_total_cltv_expiry_delta,
 			max_path_count,
 			max_channel_saturation_power_of_half,
 		} => {
+			let amount_msat = amount.map(|a| a.to_msat());
+			let max_total_routing_fee_msat = max_total_routing_fee.map(|a| a.to_msat());
 			let route_parameters = RouteParametersConfig {
 				max_total_routing_fee_msat,
 				max_total_cltv_expiry_delta: max_total_cltv_expiry_delta
@@ -572,12 +580,14 @@ async fn main() {
 		},
 		Commands::SpontaneousSend {
 			node_id,
-			amount_msat,
-			max_total_routing_fee_msat,
+			amount,
+			max_total_routing_fee,
 			max_total_cltv_expiry_delta,
 			max_path_count,
 			max_channel_saturation_power_of_half,
 		} => {
+			let amount_msat = amount.to_msat();
+			let max_total_routing_fee_msat = max_total_routing_fee.map(|a| a.to_msat());
 			let route_parameters = RouteParametersConfig {
 				max_total_routing_fee_msat,
 				max_total_cltv_expiry_delta: max_total_cltv_expiry_delta
@@ -622,13 +632,16 @@ async fn main() {
 		Commands::OpenChannel {
 			node_pubkey,
 			address,
-			channel_amount_sats,
-			push_to_counterparty_msat,
+			channel_amount,
+			push_to_counterparty,
 			announce_channel,
 			forwarding_fee_proportional_millionths,
 			forwarding_fee_base_msat,
 			cltv_expiry_delta,
 		} => {
+			let channel_amount_sats =
+				channel_amount.to_sat().unwrap_or_else(|e| handle_error_msg(&e));
+			let push_to_counterparty_msat = push_to_counterparty.map(|a| a.to_msat());
 			let channel_config = build_open_channel_config(
 				forwarding_fee_proportional_millionths,
 				forwarding_fee_base_msat,
@@ -648,7 +661,9 @@ async fn main() {
 					.await,
 			);
 		},
-		Commands::SpliceIn { user_channel_id, counterparty_node_id, splice_amount_sats } => {
+		Commands::SpliceIn { user_channel_id, counterparty_node_id, splice_amount } => {
+			let splice_amount_sats =
+				splice_amount.to_sat().unwrap_or_else(|e| handle_error_msg(&e));
 			handle_response_result::<_, SpliceInResponse>(
 				client
 					.splice_in(SpliceInRequest {
@@ -659,12 +674,9 @@ async fn main() {
 					.await,
 			);
 		},
-		Commands::SpliceOut {
-			user_channel_id,
-			counterparty_node_id,
-			address,
-			splice_amount_sats,
-		} => {
+		Commands::SpliceOut { user_channel_id, counterparty_node_id, address, splice_amount } => {
+			let splice_amount_sats =
+				splice_amount.to_sat().unwrap_or_else(|e| handle_error_msg(&e));
 			handle_response_result::<_, SpliceOutResponse>(
 				client
 					.splice_out(SpliceOutRequest {
@@ -875,6 +887,11 @@ fn parse_page_token(token_str: &str) -> Result<PageToken, LdkServerError> {
 	Ok(PageToken { token: parts[0].to_string(), index })
 }
 
+fn handle_error_msg(msg: &str) -> ! {
+	eprintln!("Error: {msg}");
+	std::process::exit(1);
+}
+
 fn handle_error(e: LdkServerError) -> ! {
 	let error_type = match e.error_code {
 		InvalidRequestError => "Invalid Request",