Merge pull request #3061 from TheBlueMatt/2024-05-bindings-upstream

[rust-lightning] / lightning / src / ln / types.rs

diff --git a/lightning/src/ln/types.rs b/lightning/src/ln/types.rs
index d3eb20479bf3e32bd72bf8c55ff08d1e23b962f7..5966b37116479abad227d5c896784ca2c028584f 100644 (file)
--- a/lightning/src/ln/types.rs
+++ b/lightning/src/ln/types.rs
@@ -35,8 +35,6 @@ use core::ops::Deref;
 /// A _temporary_ ID is generated randomly.
 /// (Later revocation-point-based _v2_ is a possibility.)
 /// The variety (context) is not stored, it is relevant only at creation.
-///
-/// This is not exported to bindings users as we just use [u8; 32] directly.
 #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
 pub struct ChannelId(pub [u8; 32]);
 
@@ -124,7 +122,8 @@ impl fmt::Display for ChannelId {
 }
 
 
-/// payment_hash type, use to cross-lock hop
+/// The payment hash is the hash of the [`PaymentPreimage`] which is the value used to lock funds
+/// in HTLCs while they transit the lightning network.
 ///
 /// This is not exported to bindings users as we just use [u8; 32] directly
 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug, Ord, PartialOrd)]
@@ -136,7 +135,8 @@ impl core::fmt::Display for PaymentHash {
        }
 }
 
-/// payment_preimage type, use to route payment between hop
+/// The payment preimage is the "secret key" which is used to claim the funds of an HTLC on-chain
+/// or in a lightning channel.
 ///
 /// This is not exported to bindings users as we just use [u8; 32] directly
 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug, Ord, PartialOrd)]
@@ -155,7 +155,8 @@ impl From<PaymentPreimage> for PaymentHash {
        }
 }
 
-/// payment_secret type, use to authenticate sender to the receiver and tie MPP HTLCs together
+/// The payment secret is used to authenticate the sender of an HTLC to the recipient and tie
+/// multi-part HTLCs together into a single payment.
 ///
 /// This is not exported to bindings users as we just use [u8; 32] directly
 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug, Ord, PartialOrd)]