@@ -1102,11 +1102,21 @@ pub enum Event {
1102
1102
///
1103
1103
/// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
1104
1104
path : Path ,
1105
- /// The hold times as reported by each hop. The unit in which the hold times are expressed are 100's of
1106
- /// milliseconds. So a hop reporting 2 is a hold time that corresponds to roughly 200 milliseconds. As earlier
1107
- /// hops hold on to an HTLC for longer, the hold times in the list are expected to decrease. When our peer
1108
- /// didn't provide attribution data, the list is empty. The same applies to HTLCs that were resolved onchain.
1109
- /// Because of unavailability of hold times, the list may be shorter than the number of hops in the path.
1105
+ /// The time that each hop indicated it held the HTLC.
1106
+ ///
1107
+ /// We expect that at each hop the hold time will be strictly greater than the hold time of
1108
+ /// the following hops, as a node along the path shouldn't have completed the HTLC until
1109
+ /// the next node has completed it.
1110
+ ///
1111
+ /// The unit in which the hold times are expressed are 100's of milliseconds. So a hop
1112
+ /// reporting 2 is a hold time that corresponds to between 200 and 299 milliseconds.
1113
+ ///
1114
+ /// If our peer didn't provide attribution data or the HTLC resolved on chain, the list
1115
+ /// will be empty.
1116
+ ///
1117
+ /// Each entry will correspond with one entry in [`Path::hops`], or, thereafter, the
1118
+ /// [`BlindedTail::trampoline_hops`] in [`Path::blinded_tail`]. Because not all nodes
1119
+ /// support hold times, the list may be shorter than the number of hops in the path.
1110
1120
hold_times : Vec < u32 > ,
1111
1121
} ,
1112
1122
/// Indicates an outbound HTLC we sent failed, likely due to an intermediary node being unable to
@@ -1159,11 +1169,21 @@ pub enum Event {
1159
1169
error_code : Option < u16 > ,
1160
1170
#[ cfg( any( test, feature = "_test_utils" ) ) ]
1161
1171
error_data : Option < Vec < u8 > > ,
1162
- /// The hold times as reported by each hop. The unit in which the hold times are expressed are 100's of
1163
- /// milliseconds. So a hop reporting 2 is a hold time that corresponds to roughly 200 milliseconds. As earlier
1164
- /// hops hold on to an HTLC for longer, the hold times in the list are expected to decrease. When our peer
1165
- /// didn't provide attribution data, the list is empty. The same applies to HTLCs that were resolved onchain.
1166
- /// Because of unavailability of hold times, the list may be shorter than the number of hops in the path.
1172
+ /// The time that each hop indicated it held the HTLC.
1173
+ ///
1174
+ /// We expect that at each hop the hold time will be strictly greater than the hold time of
1175
+ /// the following hops, as a node along the path shouldn't have completed the HTLC until
1176
+ /// the next node has completed it.
1177
+ ///
1178
+ /// The unit in which the hold times are expressed are 100's of milliseconds. So a hop
1179
+ /// reporting 2 is a hold time that corresponds to between 200 and 299 milliseconds.
1180
+ ///
1181
+ /// If our peer didn't provide attribution data or the HTLC resolved on chain, the list
1182
+ /// will be empty.
1183
+ ///
1184
+ /// Each entry will correspond with one entry in [`Path::hops`], or, thereafter, the
1185
+ /// [`BlindedTail::trampoline_hops`] in [`Path::blinded_tail`]. Because not all nodes
1186
+ /// support hold times, the list may be shorter than the number of hops in the path.
1167
1187
hold_times : Vec < u32 > ,
1168
1188
} ,
1169
1189
/// Indicates that a probe payment we sent returned successful, i.e., only failed at the destination.
0 commit comments