Skip to content

Commit

Permalink
f cleaner docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TheBlueMatt committed Jul 20, 2022
1 parent 09e0ad5 commit 3c98ae1
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions lightning/src/routing/scoring.rs
Original file line number Diff line number Diff line change
Expand Up @@ -334,14 +334,14 @@ 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, 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 payment amount.
///
/// ie `amount_penalty_multiplier_msat * amount_msat / 2^30`
/// ie `base_penalty_amount_multiplier_msat * amount_msat / 2^30`
///
/// Default value: 8,192 msat
///
Expand Down

0 comments on commit 3c98ae1

Please sign in to comment.