allow route_parameters in BOLT11 send API

Author: Anyitechs

ldk-server-cli/src/main.rs

@@ -10,6 +10,7 @@ use ldk_server_client::ldk_server_protos::api::{
 	ListChannelsRequest, ListPaymentsRequest, OnchainReceiveRequest, OnchainSendRequest,
 	OpenChannelRequest,
 };
+use ldk_server_client::ldk_server_protos::types::RouteParametersConfig;
 use ldk_server_client::ldk_server_protos::types::{
 	bolt11_invoice_description, Bolt11InvoiceDescription, PageToken, Payment,
 };
@@ -55,6 +56,14 @@ enum Commands {
 		invoice: String,
 		#[arg(long)]
 		amount_msat: Option<u64>,
+		#[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>,
 	},
 	Bolt12Receive {
 		#[arg(short, long)]
@@ -161,9 +170,29 @@ async fn main() {
 
 			handle_response_result(client.bolt11_receive(request).await);
 		},
-		Commands::Bolt11Send { invoice, amount_msat } => {
+		Commands::Bolt11Send {
+			invoice,
+			amount_msat,
+			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.bolt11_send(Bolt11SendRequest { invoice, amount_msat }).await,
+				client
+					.bolt11_send(Bolt11SendRequest {
+						invoice,
+						amount_msat,
+						route_parameters: Some(route_parameters),
+					})
+					.await,
 			);
 		},
 		Commands::Bolt12Receive { description, amount_msat, expiry_secs, quantity } => {

ldk-server-protos/src/api.rs

@@ -133,14 +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>,
+    /// 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`.

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

@@ -138,6 +138,9 @@ message Bolt11SendRequest {
   // 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.
   optional uint64 amount_msat = 2;
+  
+  // Configuration options for payment routing and pathfinding.
+  optional types.RouteParametersConfig route_parameters = 3;
 
 }
 

ldk-server/src/api/bolt11_send.rs

@@ -1,5 +1,6 @@
 use crate::api::error::LdkServerError;
 use crate::service::Context;
+use ldk_node::lightning::routing::router::RouteParametersConfig;
 use ldk_node::lightning_invoice::Bolt11Invoice;
 use ldk_server_protos::api::{Bolt11SendRequest, Bolt11SendResponse};
 use std::str::FromStr;
@@ -12,10 +13,17 @@ pub(crate) fn handle_bolt11_send_request(
 	let invoice = Bolt11Invoice::from_str(&request.invoice.as_str())
 		.map_err(|_| ldk_node::NodeError::InvalidInvoice)?;
 
+	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.bolt11_payment().send(&invoice, None),
+		None => context.node.bolt11_payment().send(&invoice, route_parameters),
 		Some(amount_msat) => {
-			context.node.bolt11_payment().send_using_amount(&invoice, amount_msat, None)
+			context.node.bolt11_payment().send_using_amount(&invoice, amount_msat, route_parameters)
 		},
 	}?;