From e3e7ead0a391a6796a32aa0b91deca40be063ec1 Mon Sep 17 00:00:00 2001 From: Matt Corallo Date: Fri, 15 Jul 2022 03:45:11 +0000 Subject: [PATCH] f clarify that the base penalties are cumulative --- lightning/src/routing/scoring.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/lightning/src/routing/scoring.rs b/lightning/src/routing/scoring.rs index 979b1930983..fb5b5bc65c1 100644 --- a/lightning/src/routing/scoring.rs +++ b/lightning/src/routing/scoring.rs @@ -331,7 +331,8 @@ pub struct ProbabilisticScoringParameters { /// Default value: 500 msat pub base_penalty_msat: u64, - /// A fixed penalty in msats to apply to each channel, multiplied by the payment amount. + /// A fixed penalty in msats to apply to each channel, multiplied by the payment amount, in + /// excess of the [`base_penalty_msat`]. /// /// The purpose of the amount penalty is to avoid having fees dominate the channel cost (i.e., /// fees plus penalty) for large payments. The penalty is computed as the product of this @@ -340,6 +341,8 @@ pub struct ProbabilisticScoringParameters { /// ie `amount_penalty_multiplier_msat * amount_msat / 2^30` /// /// Default value: 8,192 msat + /// + /// [`base_penalty_msat`]: Self::base_penalty_msat pub base_penalty_amount_multiplier_msat: u64, /// A multiplier used in conjunction with the negative `log10` of the channel's success