f - add accessor method for RecipientOnionFields::custom_tlvs

Author: alecchendev

lightning/src/ln/outbound_payment.rs

@@ -431,14 +431,7 @@ pub struct RecipientOnionFields {
 	/// [`Self::payment_secret`] and while nearly all lightning senders support secrets, metadata
 	/// may not be supported as universally.
 	pub payment_metadata: Option<Vec<u8>>,
-	/// Custom TLVs allow sending extra application-specific data with a payment. They provide
-	/// additional flexibility on top of payment metadata, as while other implementations may
-	/// require payment metadata to reflect metadata provided in an invoice, custom TLVs
-	/// do not have this restriction.
-	///
-	/// Note that the if this field is `Some`, it will contain properly ordered TLVs, each
-	/// represented by a `(u64, Vec<u8>)` for its type number and serialized value respectively.
-	/// This is validated when setting this field using [`Self::with_custom_tlvs`].
+	/// See [`Self::custom_tlvs`] for more info.
 	pub(super) custom_tlvs: Option<Vec<(u64, Vec<u8>)>>,
 }
 
@@ -465,10 +458,11 @@ impl RecipientOnionFields {
 		Self { payment_secret: None, payment_metadata: None, custom_tlvs: None }
 	}
 
-	/// Creates a new [`RecipientOnionFields`], setting `custom_tlvs`. Each TLV is provided as a
-	/// `(u64, Vec<u8>)` for the type number and serialized value respectively. TLV type numbers
-	/// must be unique, in increasing order, and within the range reserved for custom types, i.e.
-	/// >= 2^16, otherwise this method will return `Err(())`.
+	/// Creates a new [`RecipientOnionFields`] from an existing one, adding custom TLVs. Each
+	/// TLV is provided as a `(u64, Vec<u8>)` for the type number and serialized value
+	/// respectively. TLV type numbers must be unique, in increasing order, and within the range
+	/// reserved for custom types, i.e. >= 2^16, otherwise this method will return `Err(())`.
+	/// See [`Self::custom_tlvs`] for more info.
 	pub fn with_custom_tlvs(mut self, custom_tlvs: Vec<(u64, Vec<u8>)>) -> Result<Self, ()> {
 		let mut prev_type = None;
 		for (typ, _) in custom_tlvs.iter() {
@@ -483,6 +477,20 @@ impl RecipientOnionFields {
 		Ok(self)
 	}
 
+	/// Gets the custom TLVs that will be sent or have been received.
+	///
+	/// Custom TLVs allow sending extra application-specific data with a payment. They provide
+	/// additional flexibility on top of payment metadata, as while other implementations may
+	/// require `payment_metadata` to reflect metadata provided in an invoice, custom TLVs
+	/// do not have this restriction.
+	///
+	/// Note that if this field is `Some`, it will contain properly ordered TLVs, each
+	/// represented by a `(u64, Vec<u8>)` for its type number and serialized value respectively.
+	/// This is validated when setting this field using [`Self::with_custom_tlvs`].
+	pub fn custom_tlvs(&self) -> &Option<Vec<(u64, Vec<u8>)>> {
+		&self.custom_tlvs
+	}
+
 	/// When we have received some HTLC(s) towards an MPP payment, as we receive further HTLC(s) we
 	/// have to make sure that some fields match exactly across the parts. For those that aren't
 	/// required to match, if they don't match we should remove them so as to not expose data