spontaneous payment send_with_custom_tlv

Author: Evanfeenstra

bindings/ldk_node.udl

@@ -152,6 +152,8 @@ interface SpontaneousPayment {
 	[Throws=NodeError]
 	PaymentId send(u64 amount_msat, PublicKey node_id, SendingParameters? sending_parameters);
 	[Throws=NodeError]
+	PaymentId send_with_custom_tlv(u64 amount_msat, PublicKey node_id, SendingParameters? sending_parameters, u64 custom_tlv_key, sequence<u8> custom_tlv_value);
+	[Throws=NodeError]
 	void send_probes(u64 amount_msat, PublicKey node_id);
 };
 

src/payment/spontaneous.rs

@@ -58,6 +58,27 @@ impl SpontaneousPayment {
 	/// 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> {
+		self.send_inner(amount_msat, node_id, sending_parameters, None)
+	}
+
+	/// Send a spontaneous payment including a custom TLV key and value.
+	pub fn send_with_custom_tlv(
+		&self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
+		custom_tlv_type: u64, custom_tlv_value: Vec<u8>,
+	) -> Result<PaymentId, Error> {
+		self.send_inner(
+			amount_msat,
+			node_id,
+			sending_parameters,
+			Some((custom_tlv_type, custom_tlv_value)),
+		)
+	}
+
+	/// Send a spontaneous aka. "keysend", payment.
+	fn send_inner(
+		&self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
+		custom_tlv: Option<(u64, Vec<u8>)>,
 	) -> Result<PaymentId, Error> {
 		let rt_lock = self.runtime.read().unwrap();
 		if rt_lock.is_none() {
@@ -97,7 +118,12 @@ impl SpontaneousPayment {
 				.map(|s| route_params.payment_params.max_channel_saturation_power_of_half = s);
 		};
 
-		let recipient_fields = RecipientOnionFields::spontaneous_empty();
+		let recipient_fields = match custom_tlv {
+			Some((tlv_type, tlv_value)) => RecipientOnionFields::spontaneous_empty()
+				.with_custom_tlvs(vec![(tlv_type, tlv_value)])
+				.map_err(|_| Error::PaymentSendingFailed)?,
+			None => RecipientOnionFields::spontaneous_empty(),
+		};
 
 		match self.channel_manager.send_spontaneous_payment_with_retry(
 			Some(payment_preimage),