vec of custom tlvs, better error logging and msg

Author: Evanfeenstra

bindings/ldk_node.udl

@@ -152,7 +152,7 @@ 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);
+	PaymentId send_with_custom_tlvs(u64 amount_msat, PublicKey node_id, SendingParameters? sending_parameters, sequence<TlvEntry> custom_tlvs);
 	[Throws=NodeError]
 	void send_probes(u64 amount_msat, PublicKey node_id);
 };
@@ -363,6 +363,11 @@ dictionary SendingParameters {
 	u8? max_channel_saturation_power_of_half;
 };
 
+dictionary TlvEntry {
+	u64 type;
+	sequence<u8> value;
+};
+
 [Enum]
 interface MaxTotalRoutingFeeLimit {
 	None ();

src/error.rs

@@ -34,6 +34,8 @@ pub enum Error {
 	RefundCreationFailed,
 	/// Sending a payment has failed.
 	PaymentSendingFailed,
+	/// Construction of spontaneous payment with custom TLVs failed.
+	InvalidCustomTlvs,
 	/// Sending a payment probe has failed.
 	ProbeSendingFailed,
 	/// A channel could not be opened.
@@ -130,6 +132,7 @@ impl fmt::Display for Error {
 			Self::OfferCreationFailed => write!(f, "Failed to create offer."),
 			Self::RefundCreationFailed => write!(f, "Failed to create refund."),
 			Self::PaymentSendingFailed => write!(f, "Failed to send the given payment."),
+			Self::InvalidCustomTlvs => write!(f, "Failed to construct payment with custom TLVs."),
 			Self::ProbeSendingFailed => write!(f, "Failed to send the given payment probe."),
 			Self::ChannelCreationFailed => write!(f, "Failed to create channel."),
 			Self::ChannelClosingFailed => write!(f, "Failed to close channel."),

src/payment/spontaneous.rs

@@ -14,7 +14,7 @@ use crate::payment::store::{
 	PaymentDetails, PaymentDirection, PaymentKind, PaymentStatus, PaymentStore,
 };
 use crate::payment::SendingParameters;
-use crate::types::{ChannelManager, KeysManager};
+use crate::types::{ChannelManager, KeysManager, TlvEntry};
 
 use lightning::ln::channelmanager::{PaymentId, RecipientOnionFields, Retry, RetryableSendFailure};
 use lightning::ln::{PaymentHash, PaymentPreimage};
@@ -63,22 +63,16 @@ impl SpontaneousPayment {
 	}
 
 	/// Send a spontaneous payment including a custom TLV key and value.
-	pub fn send_with_custom_tlv(
+	pub fn send_with_custom_tlvs(
 		&self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
-		custom_tlv_type: u64, custom_tlv_value: Vec<u8>,
+		custom_tlvs: Vec<TlvEntry>,
 	) -> Result<PaymentId, Error> {
-		self.send_inner(
-			amount_msat,
-			node_id,
-			sending_parameters,
-			Some((custom_tlv_type, custom_tlv_value)),
-		)
+		self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs))
 	}
 
-	/// 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>)>,
+		custom_tlvs: Option<Vec<TlvEntry>>,
 	) -> Result<PaymentId, Error> {
 		let rt_lock = self.runtime.read().unwrap();
 		if rt_lock.is_none() {
@@ -118,17 +112,13 @@ impl SpontaneousPayment {
 				.map(|s| route_params.payment_params.max_channel_saturation_power_of_half = s);
 		};
 
-		let recipient_fields = match custom_tlv {
-			Some((tlv_type, tlv_value)) => {
-				if tlv_value.len() > 1300 {
-					// The real limit is lower, but we can't know without the full route.
-					// This is just an early check to avoid trying a payment that will fail.
-					return Err(Error::PaymentSendingFailed);
-				}
-				RecipientOnionFields::spontaneous_empty()
-					.with_custom_tlvs(vec![(tlv_type, tlv_value)])
-					.map_err(|_| Error::PaymentSendingFailed)?
-			},
+		let recipient_fields = match custom_tlvs {
+			Some(tlvs) => RecipientOnionFields::spontaneous_empty()
+				.with_custom_tlvs(tlvs.into_iter().map(|tlv| (tlv.r#type, tlv.value)).collect())
+				.map_err(|e| {
+					log_error!(self.logger, "Failed to send payment with custom TLVs: {:?}", e);
+					Error::InvalidCustomTlvs
+				})?,
 			None => RecipientOnionFields::spontaneous_empty(),
 		};
 

src/types.rs

@@ -12,6 +12,7 @@ use crate::logger::FilesystemLogger;
 use crate::message_handler::NodeCustomMessageHandler;
 
 use lightning::chain::chainmonitor;
+use lightning::impl_writeable_tlv_based;
 use lightning::ln::channel_state::ChannelDetails as LdkChannelDetails;
 use lightning::ln::msgs::RoutingMessageHandler;
 use lightning::ln::msgs::SocketAddress;
@@ -348,3 +349,17 @@ pub struct PeerDetails {
 	/// Indicates whether we currently have an active connection with the peer.
 	pub is_connected: bool,
 }
+
+/// Custom TLV entry.
+#[derive(Debug, Clone, PartialEq, Eq)]
+pub struct TlvEntry {
+	/// Type number.
+	pub r#type: u64,
+	/// Serialized value.
+	pub value: Vec<u8>,
+}
+
+impl_writeable_tlv_based!(TlvEntry, {
+	(0, r#type, required),
+	(1, value, required),
+});