@@ -121,7 +121,8 @@ impl fmt::Display for ChannelId {
121
121
}
122
122
123
123
124
- /// payment_hash type, use to cross-lock hop
124
+ /// The payment hash is the hash of the [`PaymentPreimage`] which is the value used to lock funds
125
+ /// in HTLCs while they transit the lightning network.
125
126
///
126
127
/// This is not exported to bindings users as we just use [u8; 32] directly
127
128
#[ derive( Hash , Copy , Clone , PartialEq , Eq , Debug , Ord , PartialOrd ) ]
@@ -133,7 +134,8 @@ impl core::fmt::Display for PaymentHash {
133
134
}
134
135
}
135
136
136
- /// payment_preimage type, use to route payment between hop
137
+ /// The payment preimage is the "secret key" which is used to claim the funds of an HTLC on-chain
138
+ /// or in a lightning channel.
137
139
///
138
140
/// This is not exported to bindings users as we just use [u8; 32] directly
139
141
#[ derive( Hash , Copy , Clone , PartialEq , Eq , Debug , Ord , PartialOrd ) ]
@@ -152,7 +154,8 @@ impl From<PaymentPreimage> for PaymentHash {
152
154
}
153
155
}
154
156
155
- /// payment_secret type, use to authenticate sender to the receiver and tie MPP HTLCs together
157
+ /// The payment secret is used to authenticate the sender of an HTLC to the recipient and tie
158
+ /// multi-part HTLCs together into a single payment.
156
159
///
157
160
/// This is not exported to bindings users as we just use [u8; 32] directly
158
161
#[ derive( Hash , Copy , Clone , PartialEq , Eq , Debug , Ord , PartialOrd ) ]
0 commit comments