use optional_vec for Vec<CustomTlvRecord>

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_tlvs(u64 amount_msat, PublicKey node_id, SendingParameters? sending_parameters, sequence<TlvEntry> custom_tlvs);
+	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);
 };
@@ -278,8 +278,8 @@ enum VssHeaderProviderError {
 interface Event {
 	PaymentSuccessful(PaymentId? payment_id, PaymentHash payment_hash, PaymentPreimage? payment_preimage, u64? fee_paid_msat);
 	PaymentFailed(PaymentId? payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
-	PaymentReceived(PaymentId? payment_id, PaymentHash payment_hash, u64 amount_msat, TlvEntries? custom_records);
-	PaymentClaimable(PaymentId payment_id, PaymentHash payment_hash, u64 claimable_amount_msat, u32? claim_deadline, TlvEntries? custom_records);
+	PaymentReceived(PaymentId? payment_id, PaymentHash payment_hash, u64 amount_msat, sequence<CustomTlvRecord>? custom_records);
+	PaymentClaimable(PaymentId payment_id, PaymentHash payment_hash, u64 claimable_amount_msat, u32? claim_deadline, sequence<CustomTlvRecord>? custom_records);
 	PaymentForwarded(ChannelId prev_channel_id, ChannelId next_channel_id, UserChannelId? prev_user_channel_id, UserChannelId? next_user_channel_id, u64? total_fee_earned_msat, u64? skimmed_fee_msat, boolean claim_from_onchain_tx, u64? outbound_amount_forwarded_msat);
 	ChannelPending(ChannelId channel_id, UserChannelId user_channel_id, ChannelId former_temporary_channel_id, PublicKey counterparty_node_id, OutPoint funding_txo);
 	ChannelReady(ChannelId channel_id, UserChannelId user_channel_id, PublicKey? counterparty_node_id);
@@ -365,8 +365,8 @@ dictionary SendingParameters {
 	u8? max_channel_saturation_power_of_half;
 };
 
-dictionary TlvEntry {
-	u64 type;
+dictionary CustomTlvRecord {
+	u64 kind;
 	sequence<u8> value;
 };
 
@@ -622,6 +622,3 @@ typedef string UntrustedString;
 
 [Custom]
 typedef string NodeAlias;
-
-[Custom]
-typedef sequence<TlvEntry> TlvEntries;

src/error.rs

@@ -34,7 +34,7 @@ pub enum Error {
 	RefundCreationFailed,
 	/// Sending a payment has failed.
 	PaymentSendingFailed,
-	/// Construction of spontaneous payment with custom TLVs failed.
+	/// Sending of spontaneous payment with custom TLVs failed.
 	InvalidCustomTlvs,
 	/// Sending a payment probe has failed.
 	ProbeSendingFailed,

src/event.rs

@@ -5,7 +5,7 @@
 // http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
 // accordance with one or both of these licenses.
 
-use crate::types::{DynStore, Sweeper, TlvEntries, Wallet};
+use crate::types::{CustomTlvRecord, DynStore, Sweeper, Wallet};
 
 use crate::{
 	hex_utils, BumpTransactionEventHandler, ChannelManager, Config, Error, Graph, PeerInfo,
@@ -103,7 +103,7 @@ pub enum Event {
 		/// The value, in thousandths of a satoshi, that has been received.
 		amount_msat: u64,
 		/// Custom TLV records received on the payment
-		custom_records: Option<TlvEntries>,
+		custom_records: Vec<CustomTlvRecord>,
 	},
 	/// A payment has been forwarded.
 	PaymentForwarded {
@@ -171,7 +171,7 @@ pub enum Event {
 		/// eligible for claiming.
 		claim_deadline: Option<u32>,
 		/// Custom TLV records attached to the payment
-		custom_records: Option<TlvEntries>,
+		custom_records: Vec<CustomTlvRecord>,
 	},
 	/// A channel has been created and is pending confirmation on-chain.
 	ChannelPending {
@@ -228,7 +228,7 @@ impl_writeable_tlv_based_enum!(Event,
 		(0, payment_hash, required),
 		(1, payment_id, option),
 		(2, amount_msat, required),
-		(3, custom_records, option),
+		(3, custom_records, optional_vec),
 	},
 	(3, ChannelReady) => {
 		(0, channel_id, required),
@@ -253,7 +253,7 @@ impl_writeable_tlv_based_enum!(Event,
 		(2, payment_id, required),
 		(4, claimable_amount_msat, required),
 		(6, claim_deadline, option),
-		(8, custom_records, option),
+		(8, custom_records, optional_vec),
 	},
 	(7, PaymentForwarded) => {
 		(0, prev_channel_id, required),
@@ -650,19 +650,17 @@ where
 									"We would have registered the preimage if we knew"
 								);
 
+								let custom_records = onion_fields
+									.map(|cf| {
+										cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect()
+									})
+									.unwrap_or_default();
 								let event = Event::PaymentClaimable {
 									payment_id,
 									payment_hash,
 									claimable_amount_msat: amount_msat,
 									claim_deadline,
-									custom_records: onion_fields.map(|cf| {
-										TlvEntries(
-											cf.custom_tlvs()
-												.into_iter()
-												.map(|tlv| tlv.into())
-												.collect(),
-										)
-									}),
+									custom_records,
 								};
 								match self.event_queue.add_event(event) {
 									Ok(_) => return Ok(()),
@@ -889,9 +887,9 @@ where
 					payment_id: Some(payment_id),
 					payment_hash,
 					amount_msat,
-					custom_records: onion_fields.map(|cf| {
-						TlvEntries(cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect())
-					}),
+					custom_records: onion_fields
+						.map(|cf| cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect())
+						.unwrap_or_default(),
 				};
 				match self.event_queue.add_event(event) {
 					Ok(_) => return Ok(()),

src/lib.rs

@@ -140,7 +140,7 @@ use types::{
 	Broadcaster, BumpTransactionEventHandler, ChainMonitor, ChannelManager, DynStore, Graph,
 	KeysManager, OnionMessenger, PeerManager, Router, Scorer, Sweeper, Wallet,
 };
-pub use types::{ChannelDetails, PeerDetails, TlvEntry, UserChannelId};
+pub use types::{ChannelDetails, PeerDetails, CustomTlvRecord, UserChannelId};
 
 use logger::{log_error, log_info, log_trace, FilesystemLogger, Logger};
 

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, TlvEntry};
+use crate::types::{ChannelManager, CustomTlvRecord, KeysManager};
 
 use lightning::ln::channelmanager::{PaymentId, RecipientOnionFields, Retry, RetryableSendFailure};
 use lightning::ln::{PaymentHash, PaymentPreimage};
@@ -65,14 +65,14 @@ impl SpontaneousPayment {
 	/// 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<TlvEntry>,
+		custom_tlvs: Vec<CustomTlvRecord>,
 	) -> Result<PaymentId, Error> {
 		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<TlvEntry>>,
+		custom_tlvs: Option<Vec<CustomTlvRecord>>,
 	) -> Result<PaymentId, Error> {
 		let rt_lock = self.runtime.read().unwrap();
 		if rt_lock.is_none() {
@@ -114,7 +114,7 @@ impl SpontaneousPayment {
 
 		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())
+				.with_custom_tlvs(tlvs.into_iter().map(|tlv| (tlv.kind, tlv.value)).collect())
 				.map_err(|e| {
 					log_error!(self.logger, "Failed to send payment with custom TLVs: {:?}", e);
 					Error::InvalidCustomTlvs

src/types.rs

@@ -350,49 +350,22 @@ pub struct PeerDetails {
 	pub is_connected: bool,
 }
 
-/// List of Custom TLV entries.
-#[derive(Debug, Clone, PartialEq, Eq)]
-pub struct TlvEntries(pub Vec<TlvEntry>);
-
 /// Custom TLV entry.
 #[derive(Debug, Clone, PartialEq, Eq)]
-pub struct TlvEntry {
+pub struct CustomTlvRecord {
 	/// Type number.
-	pub r#type: u64,
+	pub kind: u64,
 	/// Serialized value.
 	pub value: Vec<u8>,
 }
 
-impl_writeable_tlv_based!(TlvEntry, {
-	(0, r#type, required),
+impl_writeable_tlv_based!(CustomTlvRecord, {
+	(0, kind, required),
 	(1, value, required),
 });
 
-impl From<&(u64, Vec<u8>)> for TlvEntry {
+impl From<&(u64, Vec<u8>)> for CustomTlvRecord {
 	fn from(tlv: &(u64, Vec<u8>)) -> Self {
-		TlvEntry { r#type: tlv.0, value: tlv.1.clone() }
-	}
-}
-
-impl Readable for TlvEntries {
-	fn read<R: lightning::io::Read>(
-		reader: &mut R,
-	) -> Result<Self, lightning::ln::msgs::DecodeError> {
-		let len: u16 = Readable::read(reader)?;
-		let mut queue = Vec::with_capacity(len as usize);
-		for _ in 0..len {
-			queue.push(Readable::read(reader)?);
-		}
-		Ok(Self(queue))
-	}
-}
-
-impl Writeable for TlvEntries {
-	fn write<W: Writer>(&self, writer: &mut W) -> Result<(), lightning::io::Error> {
-		(self.0.len() as u16).write(writer)?;
-		for e in self.0.iter() {
-			e.write(writer)?;
-		}
-		Ok(())
+		CustomTlvRecord { kind: tlv.0, value: tlv.1.clone() }
 	}
 }

src/uniffi_types.rs

@@ -16,7 +16,7 @@ pub use crate::config::{
 pub use crate::graph::{ChannelInfo, ChannelUpdateInfo, NodeAnnouncementInfo, NodeInfo};
 pub use crate::payment::store::{LSPFeeLimits, PaymentDirection, PaymentKind, PaymentStatus};
 pub use crate::payment::{MaxTotalRoutingFeeLimit, QrPaymentResult, SendingParameters};
-pub use crate::types::{TlvEntries, TlvEntry};
+pub use crate::types::CustomTlvRecord;
 
 pub use lightning::chain::channelmonitor::BalanceSource;
 pub use lightning::events::{ClosureReason, PaymentFailureReason};
@@ -344,15 +344,3 @@ impl UniffiCustomTypeConverter for NodeAlias {
 		obj.to_string()
 	}
 }
-
-impl UniffiCustomTypeConverter for TlvEntries {
-	type Builtin = Vec<TlvEntry>;
-
-	fn into_custom(val: Self::Builtin) -> uniffi::Result<Self> {
-		Ok(TlvEntries(val))
-	}
-
-	fn from_custom(obj: Self) -> Self::Builtin {
-		obj.0
-	}
-}

tests/common/mod.rs

@@ -12,7 +12,8 @@ use ldk_node::config::{Config, EsploraSyncConfig};
 use ldk_node::io::sqlite_store::SqliteStore;
 use ldk_node::payment::{PaymentDirection, PaymentKind, PaymentStatus};
 use ldk_node::{
-	Builder, Event, LightningBalance, LogLevel, Node, NodeError, PendingSweepBalance, TlvEntry,
+	Builder, CustomTlvRecord, Event, LightningBalance, LogLevel, Node, NodeError,
+	PendingSweepBalance,
 };
 
 use lightning::ln::msgs::SocketAddress;
@@ -753,7 +754,7 @@ pub(crate) fn do_channel_full_cycle<E: ElectrumApi>(
 	// Test spontaneous/keysend payments
 	println!("\nA send_spontaneous_payment");
 	let keysend_amount_msat = 2500_000;
-	let custom_tlvs = vec![TlvEntry { r#type: 13377331, value: vec![1, 2, 3] }];
+	let custom_tlvs = vec![CustomTlvRecord { kind: 13377331, value: vec![1, 2, 3] }];
 	let keysend_payment_id = node_a
 		.spontaneous_payment()
 		.send_with_custom_tlvs(keysend_amount_msat, node_b.node_id(), None, custom_tlvs.clone())
@@ -778,7 +779,7 @@ pub(crate) fn do_channel_full_cycle<E: ElectrumApi>(
 		node_a.payment(&keysend_payment_id).unwrap().kind,
 		PaymentKind::Spontaneous { .. }
 	));
-	assert_eq!(received_custom_records.as_ref().unwrap().0, custom_tlvs);
+	assert_eq!(received_custom_records, &custom_tlvs);
 	assert_eq!(node_b.payment(&keysend_payment_id).unwrap().status, PaymentStatus::Succeeded);
 	assert_eq!(node_b.payment(&keysend_payment_id).unwrap().direction, PaymentDirection::Inbound);
 	assert_eq!(node_b.payment(&keysend_payment_id).unwrap().amount_msat, Some(keysend_amount_msat));