refactor: move preimage from method parameter to SendingParameters

Author: aagbotemi

bindings/ldk_node.udl

@@ -213,10 +213,6 @@ interface SpontaneousPayment {
 	PaymentId send_with_custom_tlvs(u64 amount_msat, PublicKey node_id, SendingParameters? sending_parameters, sequence<CustomTlvRecord> custom_tlvs);
 	[Throws=NodeError]
 	void send_probes(u64 amount_msat, PublicKey node_id);
-	[Throws=NodeError]
-	PaymentId send_with_preimage(u64 amount_msat, PublicKey node_id, SendingParameters? sending_parameters, PaymentPreimage preimage);
-	[Throws=NodeError]
-	PaymentId send_with_preimage_and_custom_tlvs(u64 amount_msat, PublicKey node_id, SendingParameters? sending_parameters, sequence<CustomTlvRecord> custom_tlvs, PaymentPreimage preimage);
 };
 
 interface OnchainPayment {
@@ -455,6 +451,7 @@ dictionary SendingParameters {
 	u32? max_total_cltv_expiry_delta;
 	u8? max_path_count;
 	u8? max_channel_saturation_power_of_half;
+	PaymentPreimage? preimage;
 };
 
 dictionary CustomTlvRecord {

src/payment/mod.rs

@@ -16,6 +16,7 @@ mod unified_qr;
 
 pub use bolt11::Bolt11Payment;
 pub use bolt12::Bolt12Payment;
+pub use lightning_types::payment::PaymentPreimage;
 pub use onchain::OnchainPayment;
 pub use spontaneous::SpontaneousPayment;
 pub use store::{
@@ -76,6 +77,8 @@ pub struct SendingParameters {
 	///
 	/// Default value: 2
 	pub max_channel_saturation_power_of_half: Option<u8>,
+	/// Custom preimage to use for the payment.
+	pub preimage: Option<PaymentPreimage>,
 }
 
 /// Represents the possible states of [`SendingParameters::max_total_routing_fee_msat`].

src/payment/spontaneous.rs

@@ -57,43 +57,29 @@ impl SpontaneousPayment {
 	pub fn send(
 		&self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
 	) -> Result<PaymentId, Error> {
-		self.send_inner(amount_msat, node_id, sending_parameters, None, None)
+		self.send_inner(amount_msat, node_id, sending_parameters, None)
 	}
 
 	/// Send a spontaneous payment including a list of custom TLVs.
 	pub fn send_with_custom_tlvs(
 		&self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
 		custom_tlvs: Vec<CustomTlvRecord>,
 	) -> Result<PaymentId, Error> {
-		self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs), None)
-	}
-
-	/// Send a spontaneous with custom preimage
-	pub fn send_with_preimage(
-		&self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
-		preimage: PaymentPreimage,
-	) -> Result<PaymentId, Error> {
-		self.send_inner(amount_msat, node_id, sending_parameters, None, Some(preimage))
-	}
-
-	/// Send a spontaneous payment with custom preimage including a list of custom TLVs.
-	pub fn send_with_preimage_and_custom_tlvs(
-		&self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
-		custom_tlvs: Vec<CustomTlvRecord>, preimage: PaymentPreimage,
-	) -> Result<PaymentId, Error> {
-		self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs), Some(preimage))
+		self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs))
 	}
 
 	fn send_inner(
 		&self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
-		custom_tlvs: Option<Vec<CustomTlvRecord>>, preimage: Option<PaymentPreimage>,
+		custom_tlvs: Option<Vec<CustomTlvRecord>>,
 	) -> Result<PaymentId, Error> {
 		let rt_lock = self.runtime.read().unwrap();
 		if rt_lock.is_none() {
 			return Err(Error::NotRunning);
 		}
 
-		let payment_preimage = preimage
+		let payment_preimage = sending_parameters
+			.as_ref()
+			.and_then(|sp| sp.preimage)
 			.unwrap_or_else(|| PaymentPreimage(self.keys_manager.get_secure_random_bytes()));
 		let payment_hash = PaymentHash::from(payment_preimage);
 		let payment_id = PaymentId(payment_hash.0);

tests/integration_tests_rust.rs

@@ -29,8 +29,6 @@ use lightning::routing::gossip::{NodeAlias, NodeId};
 use lightning::util::persist::KVStore;
 
 use lightning_invoice::{Bolt11InvoiceDescription, Description};
-
-use ldk_node::CustomTlvRecord;
 use lightning_types::payment::PaymentPreimage;
 
 use bitcoin::address::NetworkUnchecked;
@@ -209,6 +207,7 @@ fn multi_hop_sending() {
 		max_total_cltv_expiry_delta: Some(1000),
 		max_path_count: Some(10),
 		max_channel_saturation_power_of_half: Some(2),
+		preimage: None,
 	};
 
 	let invoice_description =
@@ -1414,10 +1413,18 @@ fn spontaneous_send_with_custom_preimage() {
 	let custom_bytes = bytes.to_byte_array();
 	let custom_preimage = PaymentPreimage(custom_bytes);
 
+	let sending_parameters = SendingParameters {
+		max_total_routing_fee_msat: Some(Some(75_000).into()),
+		max_total_cltv_expiry_delta: Some(1000),
+		max_path_count: Some(10),
+		max_channel_saturation_power_of_half: Some(2),
+		preimage: Some(custom_preimage),
+	};
+
 	let amount_msat = 100_000;
 	let payment_id = node_a
 		.spontaneous_payment()
-		.send_with_preimage(amount_msat, node_b.node_id(), None, custom_preimage.clone())
+		.send(amount_msat, node_b.node_id(), Some(sending_parameters))
 		.unwrap();
 
 	// check payment status and verify stored preimage