@@ -1101,11 +1101,22 @@ pub enum Event {
11011101 ///
11021102 /// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
11031103 path : Path ,
1104- /// The hold times as reported by each hop. The unit in which the hold times are expressed are 100's of
1105- /// milliseconds. So a hop reporting 2 is a hold time that corresponds to roughly 200 milliseconds. As earlier
1106- /// hops hold on to an HTLC for longer, the hold times in the list are expected to decrease. When our peer
1107- /// didn't provide attribution data, the list is empty. The same applies to HTLCs that were resolved onchain.
1108- /// Because of unavailability of hold times, the list may be shorter than the number of hops in the path.
1104+ /// The time that each hop indicated it held the HTLC.
1105+ ///
1106+ /// The unit in which the hold times are expressed are 100's of milliseconds. So a hop
1107+ /// reporting 2 is a hold time that corresponds to between 200 and 299 milliseconds.
1108+ ///
1109+ /// We expect that at each hop the actual hold time will be strictly greater than the hold
1110+ /// time of the following hops, as a node along the path shouldn't have completed the HTLC
1111+ /// until the next node has completed it. Note that because hold times are in 100's of ms,
1112+ /// hold times as reported are likely to often be equal across hops.
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.
11091120 hold_times : Vec < u32 > ,
11101121 } ,
11111122 /// Indicates an outbound HTLC we sent failed, likely due to an intermediary node being unable to
@@ -1158,11 +1169,22 @@ pub enum Event {
11581169 error_code : Option < u16 > ,
11591170 #[ cfg( any( test, feature = "_test_utils" ) ) ]
11601171 error_data : Option < Vec < u8 > > ,
1161- /// The hold times as reported by each hop. The unit in which the hold times are expressed are 100's of
1162- /// milliseconds. So a hop reporting 2 is a hold time that corresponds to roughly 200 milliseconds. As earlier
1163- /// hops hold on to an HTLC for longer, the hold times in the list are expected to decrease. When our peer
1164- /// didn't provide attribution data, the list is empty. The same applies to HTLCs that were resolved onchain.
1165- /// 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+ /// The unit in which the hold times are expressed are 100's of milliseconds. So a hop
1175+ /// reporting 2 is a hold time that corresponds to between 200 and 299 milliseconds.
1176+ ///
1177+ /// We expect that at each hop the actual hold time will be strictly greater than the hold
1178+ /// time of the following hops, as a node along the path shouldn't have completed the HTLC
1179+ /// until the next node has completed it. Note that because hold times are in 100's of ms,
1180+ /// hold times as reported are likely to often be equal across hops.
1181+ ///
1182+ /// If our peer didn't provide attribution data or the HTLC resolved on chain, the list
1183+ /// will be empty.
1184+ ///
1185+ /// Each entry will correspond with one entry in [`Path::hops`], or, thereafter, the
1186+ /// [`BlindedTail::trampoline_hops`] in [`Path::blinded_tail`]. Because not all nodes
1187+ /// support hold times, the list may be shorter than the number of hops in the path.
11661188 hold_times : Vec < u32 > ,
11671189 } ,
11681190 /// Indicates that a probe payment we sent returned successful, i.e., only failed at the destination.
0 commit comments