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