f pendingHtlcRouting

Author: TheBlueMatt

lightning/src/ln/channelmanager.rs

@@ -130,25 +130,27 @@ pub enum PendingHTLCRouting {
 	/// generated by us, but rather it's claiming to pay an invoice of ours.
 	Receive {
 		/// Information about the amount the sender intended to pay and (potential) proof that this
-		/// is a payment for an invoice we generated, which is also used to associate MPP parts of
-		/// a larger payment.
+		/// is a payment for an invoice we generated. This proof of payment is is also used for
+		/// linking MPP parts of a larger payment.
 		payment_data: msgs::FinalOnionHopData,
 		/// Additional data which we (allegedly) instructed the sender to include in the onion.
 		///
-		/// For HTLCs received by LDK, this will ultimately bubble back up as
+		/// For HTLCs received by LDK, this will ultimately be exposed in
+		/// [`Event::PaymentClaimable::onion_fields`] as
 		/// [`RecipientOnionFields::payment_metadata`].
 		payment_metadata: Option<Vec<u8>>,
 		/// CLTV expiry of the received HTLC.
 		///
 		/// Used to track when we should expire pending HTLCs that go unclaimed.
 		incoming_cltv_expiry: u32,
 		/// If the onion had forwarding instructions to one of our phantom node SCIDs, this will
-		/// provide the onion shared secret used to decrypt the second level of forwarding
+		/// provide the onion shared secret used to decrypt the next level of forwarding
 		/// instructions.
 		phantom_shared_secret: Option<[u8; 32]>,
 		/// Custom TLVs which were set by the sender.
 		///
-		/// For HTLCs received by LDK, these will ultimately bubble back up as
+		/// For HTLCs received by LDK, this will ultimately be exposed in
+		/// [`Event::PaymentClaimable::onion_fields`] as
 		/// [`RecipientOnionFields::custom_tlvs`].
 		custom_tlvs: Vec<(u64, Vec<u8>)>,
 	},
@@ -160,7 +162,7 @@ pub enum PendingHTLCRouting {
 		/// associate MPP parts of a larger payment.
 		///
 		/// This will only be filled in if receiving MPP keysend payments is enabled, and it being
-		/// present may break downgrades to versions of LDK prior to 0.0.116.
+		/// present will cause deserialization to fail on versions of LDK prior to 0.0.116.
 		payment_data: Option<msgs::FinalOnionHopData>,
 		/// Preimage for this onion payment. This preimage is provided by the sender and will be
 		/// used to settle the spontaneous payment.
@@ -171,6 +173,7 @@ pub enum PendingHTLCRouting {
 		/// [`RecipientOnionFields::payment_metadata`].
 		payment_metadata: Option<Vec<u8>>,
 		/// CLTV expiry of the received HTLC.
+		///
 		/// Used to track when we should expire pending HTLCs that go unclaimed.
 		incoming_cltv_expiry: u32,
 		/// Custom TLVs which were set by the sender.