Rename sending_paramters_config field to sending_parameters

Author: tnull

bindings/ldk_node.udl

@@ -16,7 +16,7 @@ dictionary Config {
 	u64 probing_liquidity_limit_multiplier;
 	LogLevel log_level;
 	AnchorChannelsConfig? anchor_channels_config;
-	SendingParameters? sending_parameters_config;
+	SendingParameters? sending_parameters;
 };
 
 dictionary AnchorChannelsConfig {

src/config.rs

@@ -88,9 +88,10 @@ pub(crate) const WALLET_KEYS_SEED_LEN: usize = 64;
 /// | `probing_liquidity_limit_multiplier`   | 3                  |
 /// | `log_level`                            | Debug              |
 /// | `anchor_channels_config`               | Some(..)           |
-/// | `sending_parameters_config`            | None               |
+/// | `sending_parameters`                   | None               |
 ///
-/// See [`AnchorChannelsConfig`] for more information on its respective default values.
+/// See [`AnchorChannelsConfig`] and [`SendingParameters`] for more information regarding their
+/// respective default values.
 ///
 /// [`Node`]: crate::Node
 pub struct Config {
@@ -150,12 +151,14 @@ pub struct Config {
 	/// closure. We *will* however still try to get the Anchor spending transactions confirmed
 	/// on-chain with the funds available.
 	pub anchor_channels_config: Option<AnchorChannelsConfig>,
-
 	/// Configuration options for payment routing and pathfinding.
 	///
 	/// Setting the `SendingParameters` provides flexibility to customize how payments are routed,
 	/// including setting limits on routing fees, CLTV expiry, and channel utilization.
-	pub sending_parameters_config: Option<SendingParameters>,
+	///
+	/// **Note:** If unset, default parameters will be used, and you will be able to override the
+	/// parameters on a per-payment basis in the corresponding method calls.
+	pub sending_parameters: Option<SendingParameters>,
 }
 
 impl Default for Config {
@@ -173,7 +176,7 @@ impl Default for Config {
 			probing_liquidity_limit_multiplier: DEFAULT_PROBING_LIQUIDITY_LIMIT_MULTIPLIER,
 			log_level: DEFAULT_LOG_LEVEL,
 			anchor_channels_config: Some(AnchorChannelsConfig::default()),
-			sending_parameters_config: None,
+			sending_parameters: None,
 		}
 	}
 }

src/payment/bolt11.rs

@@ -71,10 +71,8 @@ impl Bolt11Payment {
 
 	/// Send a payment given an invoice.
 	///
-	/// If [`SendingParameters`] are provided they will override the node's default routing parameters
-	/// on a per-field basis. Each field in `SendingParameters` that is set replaces the corresponding
-	/// default value. Fields that are not set fall back to the node's configured defaults. If no
-	/// `SendingParameters` are provided, the method fully relies on these defaults.
+	/// If `sending_parameters` are provided they will override the default as well as the
+	/// node-wide parameters configured via [`Config::sending_parameters`] on a per-field basis.
 	pub fn send(
 		&self, invoice: &Bolt11Invoice, sending_parameters: Option<SendingParameters>,
 	) -> Result<PaymentId, Error> {
@@ -99,9 +97,7 @@ impl Bolt11Payment {
 		}
 
 		if let Some(user_set_params) = sending_parameters {
-			if let Some(mut default_params) =
-				self.config.sending_parameters_config.as_ref().cloned()
-			{
+			if let Some(mut default_params) = self.config.sending_parameters.as_ref().cloned() {
 				default_params.max_total_routing_fee_msat = user_set_params
 					.max_total_routing_fee_msat
 					.or(default_params.max_total_routing_fee_msat);
@@ -122,7 +118,7 @@ impl Bolt11Payment {
 				route_params.payment_params.max_channel_saturation_power_of_half =
 					default_params.max_channel_saturation_power_of_half.unwrap_or_default();
 			}
-		} else if let Some(default_params) = &self.config.sending_parameters_config {
+		} else if let Some(default_params) = &self.config.sending_parameters {
 			route_params.max_total_routing_fee_msat = default_params.max_total_routing_fee_msat;
 			route_params.payment_params.max_total_cltv_expiry_delta =
 				default_params.max_total_cltv_expiry_delta.unwrap_or_default();
@@ -197,10 +193,8 @@ impl Bolt11Payment {
 	/// This can be used to pay a so-called "zero-amount" invoice, i.e., an invoice that leaves the
 	/// amount paid to be determined by the user.
 	///
-	/// If [`SendingParameters`] are provided they will override the node's default routing parameters
-	/// on a per-field basis. Each field in `SendingParameters` that is set replaces the corresponding
-	/// default value. Fields that are not set fall back to the node's configured defaults. If no
-	/// `SendingParameters` are provided, the method fully relies on these defaults.
+	/// If `sending_parameters` are provided they will override the default as well as the
+	/// node-wide parameters configured via [`Config::sending_parameters`] on a per-field basis.
 	pub fn send_using_amount(
 		&self, invoice: &Bolt11Invoice, amount_msat: u64,
 		sending_parameters: Option<SendingParameters>,
@@ -248,9 +242,7 @@ impl Bolt11Payment {
 			RouteParameters::from_payment_params_and_value(payment_params, amount_msat);
 
 		if let Some(user_set_params) = sending_parameters {
-			if let Some(mut default_params) =
-				self.config.sending_parameters_config.as_ref().cloned()
-			{
+			if let Some(mut default_params) = self.config.sending_parameters.as_ref().cloned() {
 				default_params.max_total_routing_fee_msat = user_set_params
 					.max_total_routing_fee_msat
 					.or(default_params.max_total_routing_fee_msat);
@@ -271,7 +263,7 @@ impl Bolt11Payment {
 				route_params.payment_params.max_channel_saturation_power_of_half =
 					default_params.max_channel_saturation_power_of_half.unwrap_or_default();
 			}
-		} else if let Some(default_params) = &self.config.sending_parameters_config {
+		} else if let Some(default_params) = &self.config.sending_parameters {
 			route_params.max_total_routing_fee_msat = default_params.max_total_routing_fee_msat;
 			route_params.payment_params.max_total_cltv_expiry_delta =
 				default_params.max_total_cltv_expiry_delta.unwrap_or_default();

src/payment/mod.rs

@@ -14,7 +14,7 @@ pub use spontaneous::SpontaneousPayment;
 pub use store::{LSPFeeLimits, PaymentDetails, PaymentDirection, PaymentKind, PaymentStatus};
 pub use unified_qr::{QrPaymentResult, UnifiedQrPayment};
 
-/// Represents information used to route a payment.
+/// Represents information used to send a payment.
 #[derive(Clone, Debug, PartialEq)]
 pub struct SendingParameters {
 	/// The maximum total fees, in millisatoshi, that may accrue during route finding.
@@ -24,21 +24,18 @@ pub struct SendingParameters {
 	///
 	/// Note that values below a few sats may result in some paths being spuriously ignored.
 	pub max_total_routing_fee_msat: Option<u64>,
-
 	/// The maximum total CLTV delta we accept for the route.
 	///
 	/// Defaults to [`DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA`].
 	///
 	/// [`DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA`]: lightning::routing::router::DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA
 	pub max_total_cltv_expiry_delta: Option<u32>,
-
 	/// The maximum number of paths that may be used by (MPP) payments.
 	///
 	/// Defaults to [`DEFAULT_MAX_PATH_COUNT`].
 	///
 	/// [`DEFAULT_MAX_PATH_COUNT`]: lightning::routing::router::DEFAULT_MAX_PATH_COUNT
 	pub max_path_count: Option<u8>,
-
 	/// Selects the maximum share of a channel's total capacity which will be sent over a channel,
 	/// as a power of 1/2.
 	///

src/payment/spontaneous.rs

@@ -44,10 +44,8 @@ impl SpontaneousPayment {
 
 	/// Send a spontaneous aka. "keysend", payment.
 	///
-	/// If [`SendingParameters`] are provided they will override the node's default routing parameters
-	/// on a per-field basis. Each field in `SendingParameters` that is set replaces the corresponding
-	/// default value. Fields that are not set fall back to the node's configured defaults. If no
-	/// `SendingParameters` are provided, the method fully relies on these defaults.
+	/// If `sending_parameters` are provided they will override the default as well as the
+	/// node-wide parameters configured via [`Config::sending_parameters`] on a per-field basis.
 	pub fn send(
 		&self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
 	) -> Result<PaymentId, Error> {
@@ -75,9 +73,7 @@ impl SpontaneousPayment {
 		);
 
 		if let Some(user_set_params) = sending_parameters {
-			if let Some(mut default_params) =
-				self.config.sending_parameters_config.as_ref().cloned()
-			{
+			if let Some(mut default_params) = self.config.sending_parameters.as_ref().cloned() {
 				default_params.max_total_routing_fee_msat = user_set_params
 					.max_total_routing_fee_msat
 					.or(default_params.max_total_routing_fee_msat);
@@ -98,7 +94,7 @@ impl SpontaneousPayment {
 				route_params.payment_params.max_channel_saturation_power_of_half =
 					default_params.max_channel_saturation_power_of_half.unwrap_or_default();
 			}
-		} else if let Some(default_params) = &self.config.sending_parameters_config {
+		} else if let Some(default_params) = &self.config.sending_parameters {
 			route_params.max_total_routing_fee_msat = default_params.max_total_routing_fee_msat;
 			route_params.payment_params.max_total_cltv_expiry_delta =
 				default_params.max_total_cltv_expiry_delta.unwrap_or_default();