From 7fa6770a7af85580802a3c356d0990e44db4ac67 Mon Sep 17 00:00:00 2001 From: Jeffrey Czyz Date: Thu, 10 Oct 2024 18:20:25 -0500 Subject: [PATCH] Correct base_penalty_amount_multiplier_msat docs Commit df52da7b31494c7ec77a705cca4c44bc840f8a95 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. --- lightning/src/routing/scoring.rs | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/lightning/src/routing/scoring.rs b/lightning/src/routing/scoring.rs index e915f392d..de89dd966 100644 --- a/lightning/src/routing/scoring.rs +++ b/lightning/src/routing/scoring.rs @@ -491,13 +491,12 @@ pub struct ProbabilisticScoringFeeParameters { /// Default value: 500 msat pub base_penalty_msat: u64, - /// A multiplier used with the total amount flowing over a channel to calculate a fixed penalty - /// applied to each channel, in excess of the [`base_penalty_msat`]. + /// A multiplier used with the payment amount to calculate a fixed penalty applied to each + /// channel, 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 - /// multiplier and `2^30`ths of the total amount flowing over a channel (i.e. the payment - /// amount plus the amount of any other HTLCs flowing we sent over the same channel). + /// multiplier and `2^30`ths of the payment amount. /// /// ie `base_penalty_amount_multiplier_msat * amount_msat / 2^30` /// -- 2.39.5