File tree Expand file tree Collapse file tree 1 file changed +7
-0
lines changed Expand file tree Collapse file tree 1 file changed +7
-0
lines changed Original file line number Diff line number Diff 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}
You can’t perform that action at this time.
0 commit comments