Skip to content

Commit d59d02e

Browse files
committed
f add missing paragraph in docs
1 parent 08d755a commit d59d02e

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

lightning/src/routing/scoring.rs

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -424,9 +424,16 @@ pub struct ProbabilisticScoringParameters {
424424
/// large payments. The penalty is computed as the product of this multiplier and the `2^20`ths
425425
/// of the payment amount, weighted by the negative `log10` of the success probability.
426426
///
427+
/// This penalty is similar to [`liquidity_penalty_amount_multiplier_msat`], however, instead
428+
/// of using only our latest estimate for the current liquidity available in the channel, it
429+
/// estimates success probability based on the estimated liquidity available in the channel
430+
/// through history. Specifically, every time we update our liquidity bounds on a given
431+
/// channel, we track which of several buckets those bounds fall into, exponentially decaying
432+
/// the probability of each bucket as new samples are added.
433+
///
427434
/// Default value: 64 msat
428435
///
429-
/// [`liquidity_penalty_multiplier_msat`]: Self::liquidity_penalty_multiplier_msat
436+
/// [`liquidity_penalty_amount_multiplier_msat`]: Self::liquidity_penalty_amount_multiplier_msat
430437
pub historical_liquidity_penalty_amount_multiplier_msat: u64,
431438

432439
/// Manual penalties used for the given nodes. Allows to set a particular penalty for a given

0 commit comments

Comments
 (0)