allow route_parameters in BOLT12 send API

Author: Anyitechs

ldk-server-cli/src/main.rs

@@ -84,6 +84,14 @@ enum Commands {
 		quantity: Option<u64>,
 		#[arg(short, long)]
 		payer_note: Option<String>,
+		#[arg(long)]
+		max_total_routing_fee_msat: Option<u64>,
+		#[arg(long)]
+		max_total_cltv_expiry_delta: Option<u32>,
+		#[arg(long)]
+		max_path_count: Option<u32>,
+		#[arg(long)]
+		max_channel_saturation_power_of_half: Option<u32>,
 	},
 	CloseChannel {
 		#[arg(short, long)]
@@ -207,10 +215,33 @@ async fn main() {
 					.await,
 			);
 		},
-		Commands::Bolt12Send { offer, amount_msat, quantity, payer_note } => {
+		Commands::Bolt12Send {
+			offer,
+			amount_msat,
+			quantity,
+			payer_note,
+			max_total_routing_fee_msat,
+			max_total_cltv_expiry_delta,
+			max_path_count,
+			max_channel_saturation_power_of_half,
+		} => {
+			let route_parameters = RouteParametersConfig {
+				max_total_routing_fee_msat,
+				max_total_cltv_expiry_delta: max_total_cltv_expiry_delta.unwrap_or_default(),
+				max_path_count: max_path_count.unwrap_or_default(),
+				max_channel_saturation_power_of_half: max_channel_saturation_power_of_half
+					.unwrap_or_default(),
+			};
+
 			handle_response_result(
 				client
-					.bolt12_send(Bolt12SendRequest { offer, amount_msat, quantity, payer_note })
+					.bolt12_send(Bolt12SendRequest {
+						offer,
+						amount_msat,
+						quantity,
+						payer_note,
+						route_parameters: Some(route_parameters),
+					})
 					.await,
 			);
 		},

ldk-server-protos/src/api.rs

@@ -133,17 +133,17 @@ pub struct Bolt11ReceiveResponse {
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct Bolt11SendRequest {
-    /// An invoice for a payment within the Lightning Network.
-    #[prost(string, tag = "1")]
-    pub invoice: ::prost::alloc::string::String,
-    /// Set this field when paying a so-called "zero-amount" invoice, i.e., an invoice that leaves the
-    /// amount paid to be determined by the user.
-    /// This operation will fail if the amount specified is less than the value required by the given invoice.
-    #[prost(uint64, optional, tag = "2")]
-    pub amount_msat: ::core::option::Option<u64>,
-    /// Configuration options for payment routing and pathfinding.
-    #[prost(message, optional, tag = "3")]
-    pub route_parameters: ::core::option::Option<super::types::RouteParametersConfig>,
+	/// An invoice for a payment within the Lightning Network.
+	#[prost(string, tag = "1")]
+	pub invoice: ::prost::alloc::string::String,
+	/// Set this field when paying a so-called "zero-amount" invoice, i.e., an invoice that leaves the
+	/// amount paid to be determined by the user.
+	/// This operation will fail if the amount specified is less than the value required by the given invoice.
+	#[prost(uint64, optional, tag = "2")]
+	pub amount_msat: ::core::option::Option<u64>,
+	/// Configuration options for payment routing and pathfinding.
+	#[prost(message, optional, tag = "3")]
+	pub route_parameters: ::core::option::Option<super::types::RouteParametersConfig>,
 }
 /// The response `content` for the `Bolt11Send` API, when HttpStatusCode is OK (200).
 /// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
@@ -208,6 +208,9 @@ pub struct Bolt12SendRequest {
 	/// If set, it will be seen by the recipient and reflected back in the invoice.
 	#[prost(string, optional, tag = "4")]
 	pub payer_note: ::core::option::Option<::prost::alloc::string::String>,
+	/// Configuration options for payment routing and pathfinding.
+	#[prost(message, optional, tag = "5")]
+	pub route_parameters: ::core::option::Option<super::types::RouteParametersConfig>,
 }
 /// The response `content` for the `Bolt12Send` API, when HttpStatusCode is OK (200).
 /// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.

ldk-server-protos/src/proto/api.proto

@@ -202,6 +202,9 @@ message Bolt12SendRequest {
 
   // If set, it will be seen by the recipient and reflected back in the invoice.
   optional string payer_note = 4;
+
+  // Configuration options for payment routing and pathfinding.
+  optional types.RouteParametersConfig route_parameters = 5;
 }
 
 // The response `content` for the `Bolt12Send` API, when HttpStatusCode is OK (200).

ldk-server-protos/src/types.rs

@@ -784,23 +784,23 @@ pub mod bolt11_invoice_description {
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct RouteParametersConfig {
-    /// The maximum total fees, in millisatoshi, that may accrue during route finding.
-    /// Defaults to 1% of the payment amount + 50 sats
-    #[prost(uint64, optional, tag = "1")]
-    pub max_total_routing_fee_msat: ::core::option::Option<u64>,
-    /// The maximum total CLTV delta we accept for the route.
-    /// Defaults to \[`DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA`\].
-    #[prost(uint32, tag = "2")]
-    pub max_total_cltv_expiry_delta: u32,
-    /// The maximum number of paths that may be used by (MPP) payments.
-    /// Defaults to \[`DEFAULT_MAX_PATH_COUNT`\].
-    #[prost(uint32, tag = "3")]
-    pub max_path_count: u32,
-    /// Selects the maximum share of a channel's total capacity which will be
-    /// sent over a channel, as a power of 1/2.
-    /// Default value: 2
-    #[prost(uint32, tag = "4")]
-    pub max_channel_saturation_power_of_half: u32,
+	/// The maximum total fees, in millisatoshi, that may accrue during route finding.
+	/// Defaults to 1% of the payment amount + 50 sats
+	#[prost(uint64, optional, tag = "1")]
+	pub max_total_routing_fee_msat: ::core::option::Option<u64>,
+	/// The maximum total CLTV delta we accept for the route.
+	/// Defaults to \[`DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA`\].
+	#[prost(uint32, tag = "2")]
+	pub max_total_cltv_expiry_delta: u32,
+	/// The maximum number of paths that may be used by (MPP) payments.
+	/// Defaults to \[`DEFAULT_MAX_PATH_COUNT`\].
+	#[prost(uint32, tag = "3")]
+	pub max_path_count: u32,
+	/// Selects the maximum share of a channel's total capacity which will be
+	/// sent over a channel, as a power of 1/2.
+	/// Default value: 2
+	#[prost(uint32, tag = "4")]
+	pub max_channel_saturation_power_of_half: u32,
 }
 /// Represents the direction of a payment.
 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]

ldk-server/src/api/bolt12_send.rs

@@ -1,6 +1,7 @@
 use crate::api::error::LdkServerError;
 use crate::service::Context;
 use ldk_node::lightning::offers::offer::Offer;
+use ldk_node::lightning::routing::router::RouteParametersConfig;
 use ldk_server_protos::api::{Bolt12SendRequest, Bolt12SendResponse};
 use std::str::FromStr;
 
@@ -12,16 +13,26 @@ pub(crate) fn handle_bolt12_send_request(
 	let offer =
 		Offer::from_str(&request.offer.as_str()).map_err(|_| ldk_node::NodeError::InvalidOffer)?;
 
+	let route_parameters = request.route_parameters.map(|params| RouteParametersConfig {
+		max_total_routing_fee_msat: params.max_total_routing_fee_msat,
+		max_total_cltv_expiry_delta: params.max_total_cltv_expiry_delta,
+		max_path_count: params.max_path_count as u8,
+		max_channel_saturation_power_of_half: params.max_channel_saturation_power_of_half as u8,
+	});
+
 	let payment_id = match request.amount_msat {
-		None => {
-			context.node.bolt12_payment().send(&offer, request.quantity, request.payer_note, None)
-		},
+		None => context.node.bolt12_payment().send(
+			&offer,
+			request.quantity,
+			request.payer_note,
+			route_parameters,
+		),
 		Some(amount_msat) => context.node.bolt12_payment().send_using_amount(
 			&offer,
 			amount_msat,
 			request.quantity,
 			request.payer_note,
-			None,
+			route_parameters,
 		),
 	}?;