f improve comments

Author: valentinewallace

lightning/src/blinded_path/payment.rs

@@ -15,20 +15,21 @@ use crate::util::ser::{Readable, Writeable, Writer};
 
 /// Data to construct a [`BlindedHop`] for forwarding a payment.
 pub struct ForwardTlvs {
-	/// The short channel id this payment is being forwarded over.
+	/// The short channel id this payment should be forwarded out over.
 	short_channel_id: u64,
-	/// Payment parameters for relaying over this channel.
+	/// Payment parameters for relaying over [`Self::short_channel_id`].
 	payment_relay: PaymentRelay,
-	/// Payment constraints when relaying over this channel.
+	/// Payment constraints for relaying over [`Self::short_channel_id`].
 	payment_constraints: PaymentConstraints,
 	/// Supported and required features when relaying a payment onion containing this object's
-	/// corresponding [`BlindedHop`].
+	/// corresponding [`BlindedHop::encrypted_payload`].
 	///
-	/// [`BlindedHop`]: crate::blinded_path::BlindedHop
+	/// [`BlindedHop::encrypted_payload`]: crate::blinded_path::BlindedHop::encrypted_payload
 	features: BlindedHopFeatures,
 }
 
-/// Data to construct a [`BlindedHop`] for receiving a payment.
+/// Data to construct a [`BlindedHop`] for receiving a payment. This payload is custom to LDK and
+/// may not be valid if received by another lightning implementation.
 pub struct ReceiveTlvs {
 	/// Used to authenticate the sender of a payment to the receiver and tie MPP HTLCs together.
 	payment_secret: PaymentSecret,
@@ -40,9 +41,9 @@ pub struct ReceiveTlvs {
 ///
 /// [`BlindedHop`]: crate::blinded_path::BlindedHop
 pub(crate) enum BlindedPaymentTlvs {
-	/// This blinded payment data is to be forwarded.
+	/// This blinded payment data is for a forwarding node.
 	Forward(ForwardTlvs),
-	/// This blinded payment data is to be received.
+	/// This blinded payment data is for the receiving node.
 	Receive(ReceiveTlvs),
 }
 
@@ -112,10 +113,10 @@ impl Readable for BlindedPaymentTlvs {
 		_init_and_read_tlv_stream!(r, {
 			(1, _padding, option),
 			(2, scid, option),
-			(6, payment_secret, option),
 			(10, payment_relay, option),
 			(12, payment_constraints, required),
 			(14, features, option),
+			(65536, payment_secret, option),
 		});
 		if let Some(short_channel_id) = scid {
 			if payment_secret.is_some() { return Err(DecodeError::InvalidValue) }