Skip to content

Commit 48976dd

Browse files
committed
f docs
1 parent a982b27 commit 48976dd

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

lightning/src/routing/scoring.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -323,10 +323,11 @@ type ConfiguredTime = Eternity;
323323
/// *Optimally Reliable & Cheap Payment Flows on the Lightning Network* by Rene Pickhardt
324324
/// and Stefan Richter [[1]] (i.e. `(upper_bound - payment_amount) / (upper_bound - lower_bound)`).
325325
///
326-
/// This probability is converted into a linear score and multiplied with the
327-
/// [`liquidity_penalty_multiplier_msat`] and [`liquidity_penalty_amount_multiplier_msat`]
328-
/// parameters to calculate a concrete penalty in milli-satoshis. See the documentation of those
329-
/// parameters for the exact formulas.
326+
/// This probability is combined with the [`liquidity_penalty_multiplier_msat`] and
327+
/// [`liquidity_penalty_amount_multiplier_msat`] parameters to calculate a concrete penalty in
328+
/// milli-satoshis. The penalties, when added across all hops, have the property of being linear in
329+
/// terms of the entire path's success probability. This allows the router to directly compare
330+
/// penalties for different paths. See the documentation of those parameters for the exact formulas.
330331
///
331332
/// The liquidity bounds are decayed by halving them every [`liquidity_offset_half_life`].
332333
///

0 commit comments

Comments
 (0)