@@ -1137,7 +1137,11 @@ impl<'a> CandidateRouteHop<'a> {
1137
1137
}
1138
1138
}
1139
1139
1140
- /// Returns cltv_expiry_delta for this hop.
1140
+ /// Returns the required difference in HTLC CLTV expiry between the [`Self::source`] and the
1141
+ /// next-hop for an HTLC taking this hop.
1142
+ ///
1143
+ /// This is the time that the node(s) in this hop have to claim the HTLC on-chain if the
1144
+ /// next-hop goes on chain with a payment preimage.
1141
1145
#[ inline]
1142
1146
pub fn cltv_expiry_delta ( & self ) -> u32 {
1143
1147
match self {
@@ -1149,7 +1153,7 @@ impl<'a> CandidateRouteHop<'a> {
1149
1153
}
1150
1154
}
1151
1155
1152
- /// Returns the htlc_minimum_msat for this hop.
1156
+ /// Returns the minimum amount which can be sent over this hop, in millisatoshis .
1153
1157
#[ inline]
1154
1158
pub fn htlc_minimum_msat ( & self ) -> u64 {
1155
1159
match self {
@@ -1161,7 +1165,7 @@ impl<'a> CandidateRouteHop<'a> {
1161
1165
}
1162
1166
}
1163
1167
1164
- /// Returns the fees for this hop .
1168
+ /// Returns the fees which must be paid to route an HTLC over this channel .
1165
1169
#[ inline]
1166
1170
pub fn fees ( & self ) -> RoutingFees {
1167
1171
match self {
@@ -1218,9 +1222,9 @@ impl<'a> CandidateRouteHop<'a> {
1218
1222
}
1219
1223
/// Returns the source node id of current hop.
1220
1224
///
1221
- /// Source node id refers to the hop forwarding the payment .
1225
+ /// Source node id refers to the node forwarding the HTLC through this hop .
1222
1226
///
1223
- /// For ` FirstHop` we return payer's node id.
1227
+ /// For [`Self:: FirstHop`] we return payer's node id.
1224
1228
#[ inline]
1225
1229
pub fn source ( & self ) -> NodeId {
1226
1230
match self {
@@ -1233,9 +1237,13 @@ impl<'a> CandidateRouteHop<'a> {
1233
1237
}
1234
1238
/// Returns the target node id of this hop, if known.
1235
1239
///
1236
- /// Target node id refers to the hop receiving the payment.
1240
+ /// Target node id refers to the node receiving the HTLC after this hop.
1241
+ ///
1242
+ /// For [`Self::Blinded`] we return `None` because the ultimate destination after the blinded
1243
+ /// path is unknown.
1237
1244
///
1238
- /// For `Blinded` and `OneHopBlinded` we return `None` because next hop is blinded.
1245
+ /// For [`Self::OneHopBlinded`] we return `None` because the target is the same as the source,
1246
+ /// and such a return value would be somewhat nonsensical.
1239
1247
#[ inline]
1240
1248
pub fn target ( & self ) -> Option < NodeId > {
1241
1249
match self {
0 commit comments