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