Skip to content

Commit a7502e0

Browse files
committed
f point to params for formulas
1 parent 56d91c2 commit a7502e0

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

lightning/src/routing/scoring.rs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -323,9 +323,10 @@ type ConfiguredTime = Eternity;
323323
/// *Optimally Reliable & Cheap Payment Flows on the Lightning Network* by Rene Pickhardt
324324
/// and Stefan Richter [[1]] (i.e. `(payment amount + lower-bound) / (upper-bound - lower-bound)`).
325325
///
326-
/// This probability is converted into a linear score by `log10`'ing it and multiplying it with the
326+
/// This probability is converted into a linear score and multiplying it with the
327327
/// [`liquidity_penalty_multiplier_msat`] and [`liquidity_penalty_amount_multiplier_msat`]
328-
/// parameters to get a concrete msat value.
328+
/// parameters to get a concrete msat value. See the documentation for those parameters for the
329+
/// exact formulas.
329330
///
330331
/// The liquidity bounds are then decayed by halving them every [`liquidity_offset_half_life`].
331332
///
@@ -397,6 +398,8 @@ pub struct ProbabilisticScoringParameters {
397398
/// uncertainty bounds of the channel liquidity balance. Amounts above the upper bound will
398399
/// result in a `u64::max_value` penalty, however.
399400
///
401+
/// `-log10(success_probability) * liquidity_penalty_multiplier_msat`
402+
///
400403
/// Default value: 40,000 msat
401404
///
402405
/// [`liquidity_offset_half_life`]: Self::liquidity_offset_half_life

0 commit comments

Comments
 (0)