Skip to content

Commit 0677c21

Browse files
committed
Correct base_penalty_amount_multiplier_msat docs
Commit df52da7 modified ProbabilisticScorer to apply some penalty amount multipliers to the total amount flowing over the channel. However, the commit updated the docs for base_penalty_amount_multiplier_msat even though that behavior didn't change. This commit reverts those docs.
1 parent 8f7cbc3 commit 0677c21

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

lightning/src/routing/scoring.rs

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -491,13 +491,12 @@ pub struct ProbabilisticScoringFeeParameters {
491491
/// Default value: 500 msat
492492
pub base_penalty_msat: u64,
493493

494-
/// A multiplier used with the total amount flowing over a channel to calculate a fixed penalty
495-
/// applied to each channel, in excess of the [`base_penalty_msat`].
494+
/// A multiplier used with the payment amount to calculate a fixed penalty applied to each
495+
/// channel, in excess of the [`base_penalty_msat`].
496496
///
497497
/// The purpose of the amount penalty is to avoid having fees dominate the channel cost (i.e.,
498498
/// fees plus penalty) for large payments. The penalty is computed as the product of this
499-
/// multiplier and `2^30`ths of the total amount flowing over a channel (i.e. the payment
500-
/// amount plus the amount of any other HTLCs flowing we sent over the same channel).
499+
/// multiplier and `2^30`ths of the payment amount.
501500
///
502501
/// ie `base_penalty_amount_multiplier_msat * amount_msat / 2^30`
503502
///

0 commit comments

Comments
 (0)