X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;ds=sidebyside;f=lightning%2Fsrc%2Frouting%2Fscoring.rs;h=537d75012abc88b9233d403c03aac469b2cf77e4;hb=10be993f9458ff14c2085b1abe53eceb8870ce6a;hp=9f3b7806a991681259deb4ae8655cc060a730382;hpb=2e730cdc9c4eeec3d514ccbe6cb5976f0d8fa40f;p=rust-lightning diff --git a/lightning/src/routing/scoring.rs b/lightning/src/routing/scoring.rs index 9f3b7806..537d7501 100644 --- a/lightning/src/routing/scoring.rs +++ b/lightning/src/routing/scoring.rs @@ -189,6 +189,33 @@ impl<'a, S: Writeable> Writeable for MutexGuard<'a, S> { } } +#[derive(Clone)] +/// [`Score`] implementation that uses a fixed penalty. +pub struct FixedPenaltyScorer { + penalty_msat: u64, +} + +impl_writeable_tlv_based!(FixedPenaltyScorer, { + (0, penalty_msat, required), +}); + +impl FixedPenaltyScorer { + /// Creates a new scorer using `penalty_msat`. + pub fn with_penalty(penalty_msat: u64) -> Self { + Self { penalty_msat } + } +} + +impl Score for FixedPenaltyScorer { + fn channel_penalty_msat(&self, _: u64, _: u64, _: u64, _: &NodeId, _: &NodeId) -> u64 { + self.penalty_msat + } + + fn payment_path_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) {} + + fn payment_path_successful(&mut self, _path: &[&RouteHop]) {} +} + /// [`Score`] implementation that provides reasonable default behavior. /// /// Used to apply a fixed penalty to each channel, thus avoiding long paths when shorter paths with @@ -202,6 +229,10 @@ impl<'a, S: Writeable> Writeable for MutexGuard<'a, S> { /// behavior. /// /// [module-level documentation]: crate::routing::scoring +#[deprecated( + since = "0.0.105", + note = "ProbabilisticScorer should be used instead of Scorer.", +)] pub type Scorer = ScorerUsingTime::; #[cfg(not(feature = "no-std"))] @@ -216,13 +247,13 @@ type ConfiguredTime = time::Eternity; /// [`Score`] implementation. /// /// (C-not exported) generally all users should use the [`Scorer`] type alias. -#[doc(hidden)] pub struct ScorerUsingTime { params: ScoringParameters, // TODO: Remove entries of closed channels. channel_failures: HashMap>, } +#[derive(Clone)] /// Parameters for configuring [`Scorer`]. pub struct ScoringParameters { /// A fixed penalty in msats to apply to each channel. @@ -301,18 +332,6 @@ impl ScorerUsingTime { channel_failures: HashMap::new(), } } - - /// Creates a new scorer using `penalty_msat` as a fixed channel penalty. - #[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))] - pub fn with_fixed_penalty(penalty_msat: u64) -> Self { - Self::new(ScoringParameters { - base_penalty_msat: penalty_msat, - failure_penalty_msat: 0, - failure_penalty_half_life: Duration::from_secs(0), - overuse_penalty_start_1024th: 1024, - overuse_penalty_msat_per_1024th: 0, - }) - } } impl ChannelFailure { @@ -475,7 +494,6 @@ pub type ProbabilisticScorer = ProbabilisticScorerUsingTime::, T: Time> { params: ProbabilisticScoringParameters, network_graph: G,