Skip to content

Commit e3e7ead

Browse files
committed
f clarify that the base penalties are cumulative
1 parent 113504e commit e3e7ead

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

lightning/src/routing/scoring.rs

+4-1
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,8 @@ pub struct ProbabilisticScoringParameters {
331331
/// Default value: 500 msat
332332
pub base_penalty_msat: u64,
333333

334-
/// A fixed penalty in msats to apply to each channel, multiplied by the payment amount.
334+
/// A fixed penalty in msats to apply to each channel, multiplied by the payment amount, in
335+
/// excess of the [`base_penalty_msat`].
335336
///
336337
/// The purpose of the amount penalty is to avoid having fees dominate the channel cost (i.e.,
337338
/// fees plus penalty) for large payments. The penalty is computed as the product of this
@@ -340,6 +341,8 @@ pub struct ProbabilisticScoringParameters {
340341
/// ie `amount_penalty_multiplier_msat * amount_msat / 2^30`
341342
///
342343
/// Default value: 8,192 msat
344+
///
345+
/// [`base_penalty_msat`]: Self::base_penalty_msat
343346
pub base_penalty_amount_multiplier_msat: u64,
344347

345348
/// A multiplier used in conjunction with the negative `log10` of the channel's success

0 commit comments

Comments
 (0)