f - Default amount_penalty_multiplier_msat to 256

Author: jkczyz

lightning/src/routing/scoring.rs

@@ -572,7 +572,7 @@ pub struct ProbabilisticScoringParameters {
 	/// probabilities, the multiplier will have a decreasing effect as the negative `log10` will
 	/// fall below `1`.
 	///
-	/// Default value: 0
+	/// Default value: 256
 	pub amount_penalty_multiplier_msat: u64,
 }
 
@@ -621,13 +621,25 @@ impl<G: Deref<Target = NetworkGraph>, T: Time> ProbabilisticScorerUsingTime<G, T
 	}
 }
 
+impl ProbabilisticScoringParameters {
+	#[cfg(test)]
+	fn zero_penalty() -> Self {
+		Self {
+			base_penalty_msat: 0,
+			liquidity_penalty_multiplier_msat: 0,
+			liquidity_offset_half_life: Duration::from_secs(3600),
+			amount_penalty_multiplier_msat: 0,
+		}
+	}
+}
+
 impl Default for ProbabilisticScoringParameters {
 	fn default() -> Self {
 		Self {
 			base_penalty_msat: 500,
 			liquidity_penalty_multiplier_msat: 40_000,
 			liquidity_offset_half_life: Duration::from_secs(3600),
-			amount_penalty_multiplier_msat: 0,
+			amount_penalty_multiplier_msat: 256,
 		}
 	}
 }
@@ -1793,7 +1805,8 @@ mod tests {
 	fn increased_penalty_nearing_liquidity_upper_bound() {
 		let network_graph = network_graph();
 		let params = ProbabilisticScoringParameters {
-			base_penalty_msat: 0, liquidity_penalty_multiplier_msat: 1_000, ..Default::default()
+			liquidity_penalty_multiplier_msat: 1_000,
+			..ProbabilisticScoringParameters::zero_penalty()
 		};
 		let scorer = ProbabilisticScorer::new(params, &network_graph);
 		let source = source_node_id();
@@ -1818,7 +1831,8 @@ mod tests {
 		let last_updated = SinceEpoch::now();
 		let network_graph = network_graph();
 		let params = ProbabilisticScoringParameters {
-			base_penalty_msat: 0, liquidity_penalty_multiplier_msat: 1_000, ..Default::default()
+			liquidity_penalty_multiplier_msat: 1_000,
+			..ProbabilisticScoringParameters::zero_penalty()
 		};
 		let scorer = ProbabilisticScorer::new(params, &network_graph)
 			.with_channel(42,
@@ -1838,7 +1852,8 @@ mod tests {
 	fn does_not_further_penalize_own_channel() {
 		let network_graph = network_graph();
 		let params = ProbabilisticScoringParameters {
-			base_penalty_msat: 0, liquidity_penalty_multiplier_msat: 1_000, ..Default::default()
+			liquidity_penalty_multiplier_msat: 1_000,
+			..ProbabilisticScoringParameters::zero_penalty()
 		};
 		let mut scorer = ProbabilisticScorer::new(params, &network_graph);
 		let sender = sender_node_id();
@@ -1859,7 +1874,8 @@ mod tests {
 	fn sets_liquidity_lower_bound_on_downstream_failure() {
 		let network_graph = network_graph();
 		let params = ProbabilisticScoringParameters {
-			base_penalty_msat: 0, liquidity_penalty_multiplier_msat: 1_000, ..Default::default()
+			liquidity_penalty_multiplier_msat: 1_000,
+			..ProbabilisticScoringParameters::zero_penalty()
 		};
 		let mut scorer = ProbabilisticScorer::new(params, &network_graph);
 		let source = source_node_id();
@@ -1881,7 +1897,8 @@ mod tests {
 	fn sets_liquidity_upper_bound_on_failure() {
 		let network_graph = network_graph();
 		let params = ProbabilisticScoringParameters {
-			base_penalty_msat: 0, liquidity_penalty_multiplier_msat: 1_000, ..Default::default()
+			liquidity_penalty_multiplier_msat: 1_000,
+			..ProbabilisticScoringParameters::zero_penalty()
 		};
 		let mut scorer = ProbabilisticScorer::new(params, &network_graph);
 		let source = source_node_id();
@@ -1903,7 +1920,8 @@ mod tests {
 	fn reduces_liquidity_upper_bound_along_path_on_success() {
 		let network_graph = network_graph();
 		let params = ProbabilisticScoringParameters {
-			base_penalty_msat: 0, liquidity_penalty_multiplier_msat: 1_000, ..Default::default()
+			liquidity_penalty_multiplier_msat: 1_000,
+			..ProbabilisticScoringParameters::zero_penalty()
 		};
 		let mut scorer = ProbabilisticScorer::new(params, &network_graph);
 		let sender = sender_node_id();
@@ -1927,10 +1945,9 @@ mod tests {
 	fn decays_liquidity_bounds_over_time() {
 		let network_graph = network_graph();
 		let params = ProbabilisticScoringParameters {
-			base_penalty_msat: 0,
 			liquidity_penalty_multiplier_msat: 1_000,
 			liquidity_offset_half_life: Duration::from_secs(10),
-			..Default::default()
+			..ProbabilisticScoringParameters::zero_penalty()
 		};
 		let mut scorer = ProbabilisticScorer::new(params, &network_graph);
 		let source = source_node_id();
@@ -1980,10 +1997,9 @@ mod tests {
 	fn decays_liquidity_bounds_without_shift_overflow() {
 		let network_graph = network_graph();
 		let params = ProbabilisticScoringParameters {
-			base_penalty_msat: 0,
 			liquidity_penalty_multiplier_msat: 1_000,
 			liquidity_offset_half_life: Duration::from_secs(10),
-			..Default::default()
+			..ProbabilisticScoringParameters::zero_penalty()
 		};
 		let mut scorer = ProbabilisticScorer::new(params, &network_graph);
 		let source = source_node_id();
@@ -2006,10 +2022,9 @@ mod tests {
 	fn restricts_liquidity_bounds_after_decay() {
 		let network_graph = network_graph();
 		let params = ProbabilisticScoringParameters {
-			base_penalty_msat: 0,
 			liquidity_penalty_multiplier_msat: 1_000,
 			liquidity_offset_half_life: Duration::from_secs(10),
-			..Default::default()
+			..ProbabilisticScoringParameters::zero_penalty()
 		};
 		let mut scorer = ProbabilisticScorer::new(params, &network_graph);
 		let source = source_node_id();
@@ -2045,10 +2060,9 @@ mod tests {
 	fn restores_persisted_liquidity_bounds() {
 		let network_graph = network_graph();
 		let params = ProbabilisticScoringParameters {
-			base_penalty_msat: 0,
 			liquidity_penalty_multiplier_msat: 1_000,
 			liquidity_offset_half_life: Duration::from_secs(10),
-			..Default::default()
+			..ProbabilisticScoringParameters::zero_penalty()
 		};
 		let mut scorer = ProbabilisticScorer::new(params, &network_graph);
 		let source = source_node_id();
@@ -2076,10 +2090,9 @@ mod tests {
 	fn decays_persisted_liquidity_bounds() {
 		let network_graph = network_graph();
 		let params = ProbabilisticScoringParameters {
-			base_penalty_msat: 0,
 			liquidity_penalty_multiplier_msat: 1_000,
 			liquidity_offset_half_life: Duration::from_secs(10),
-			..Default::default()
+			..ProbabilisticScoringParameters::zero_penalty()
 		};
 		let mut scorer = ProbabilisticScorer::new(params, &network_graph);
 		let source = source_node_id();
@@ -2112,7 +2125,8 @@ mod tests {
 		let target = target_node_id();
 
 		let params = ProbabilisticScoringParameters {
-			base_penalty_msat: 0, liquidity_penalty_multiplier_msat: 1_000, ..Default::default()
+			liquidity_penalty_multiplier_msat: 1_000,
+			..ProbabilisticScoringParameters::zero_penalty()
 		};
 		let scorer = ProbabilisticScorer::new(params, &network_graph);
 		assert_eq!(scorer.channel_penalty_msat(42, 128, 1_024, &source, &target), 58);
@@ -2133,18 +2147,18 @@ mod tests {
 		let params = ProbabilisticScoringParameters {
 			liquidity_penalty_multiplier_msat: 1_000,
 			amount_penalty_multiplier_msat: 0,
-			..Default::default()
+			..ProbabilisticScoringParameters::zero_penalty()
 		};
 		let scorer = ProbabilisticScorer::new(params, &network_graph);
-		assert_eq!(scorer.channel_penalty_msat(42, 512_000, 1_024_000, &source, &target), 800);
+		assert_eq!(scorer.channel_penalty_msat(42, 512_000, 1_024_000, &source, &target), 300);
 
 		let params = ProbabilisticScoringParameters {
 			liquidity_penalty_multiplier_msat: 1_000,
 			amount_penalty_multiplier_msat: 256,
-			..Default::default()
+			..ProbabilisticScoringParameters::zero_penalty()
 		};
 		let scorer = ProbabilisticScorer::new(params, &network_graph);
-		assert_eq!(scorer.channel_penalty_msat(42, 512_000, 1_024_000, &source, &target), 837);
+		assert_eq!(scorer.channel_penalty_msat(42, 512_000, 1_024_000, &source, &target), 337);
 	}
 
 	#[test]
@@ -2154,7 +2168,8 @@ mod tests {
 		let target = target_node_id();
 
 		let params = ProbabilisticScoringParameters {
-			base_penalty_msat: 0, ..Default::default()
+			liquidity_penalty_multiplier_msat: 40_000,
+			..ProbabilisticScoringParameters::zero_penalty()
 		};
 		let scorer = ProbabilisticScorer::new(params, &network_graph);
 		assert_eq!(