File tree Expand file tree Collapse file tree 1 file changed +6
-2
lines changed Expand file tree Collapse file tree 1 file changed +6
-2
lines changed Original file line number Diff line number Diff line change @@ -355,8 +355,12 @@ impl Route {
355
355
overpaid_value_msat + self . paths . iter ( ) . map ( |path| path. fee_msat ( ) ) . sum :: < u64 > ( )
356
356
}
357
357
358
- /// Returns the total amount paid on this [`Route`], excluding the fees. Might be more than
359
- /// requested if we had to reach htlc_minimum_msat.
358
+ /// Returns the total amount paid on this [`Route`], excluding the fees.
359
+ ///
360
+ /// Might be more than requested as part of the given [`RouteParameters::final_value_msat`] if
361
+ /// we had to reach the [`htlc_minimum_msat`] limit.
362
+ ///
363
+ /// [`htlc_minimum_msat`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-channel_update-message
360
364
pub fn get_total_amount ( & self ) -> u64 {
361
365
self . paths . iter ( ) . map ( |path| path. final_value_msat ( ) ) . sum ( )
362
366
}
You can’t perform that action at this time.
0 commit comments