Skip to content

Commit 8e9f6ac

Browse files
committed
f a bit more docs
1 parent 957f93f commit 8e9f6ac

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

lightning/src/routing/scoring.rs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -654,6 +654,13 @@ pub struct ProbabilisticScoringFeeParameters {
654654
/// Specifically, the following penalty is applied
655655
/// `probing_diversity_penalty_msat * max(0, (86400 - current time + last update))^2 / 86400^2` is
656656
///
657+
/// As this is a maximum value, when setting this you should consider it in relation to the
658+
/// other values set to ensure that, at maximum, we strongly avoid paths which we recently
659+
/// tried (similar to if they have a low success probability). For example, you might set this
660+
/// to be the sum of [`Self::base_penalty_msat`] and
661+
/// [`Self::historical_liquidity_penalty_multiplier_msat`] (plus some multiple of their
662+
/// corresponding `amount_multiplier`s).
663+
///
657664
/// Default value: 0
658665
pub probing_diversity_penalty_msat: u64,
659666
}

0 commit comments

Comments
 (0)