1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Utilities for scoring payment channels.
12 //! [`Scorer`] may be given to [`find_route`] to score payment channels during path finding when a
13 //! custom [`Score`] implementation is not needed.
18 //! # extern crate secp256k1;
20 //! # use lightning::routing::network_graph::NetworkGraph;
21 //! # use lightning::routing::router::{RouteParameters, find_route};
22 //! # use lightning::routing::scoring::{Scorer, ScoringParameters};
23 //! # use lightning::util::logger::{Logger, Record};
24 //! # use secp256k1::key::PublicKey;
26 //! # struct FakeLogger {};
27 //! # impl Logger for FakeLogger {
28 //! # fn log(&self, record: &Record) { unimplemented!() }
30 //! # fn find_scored_route(payer: PublicKey, params: RouteParameters, network_graph: NetworkGraph) {
31 //! # let logger = FakeLogger {};
33 //! // Use the default channel penalties.
34 //! let scorer = Scorer::default();
36 //! // Or use custom channel penalties.
37 //! let scorer = Scorer::new(ScoringParameters {
38 //! base_penalty_msat: 1000,
39 //! failure_penalty_msat: 2 * 1024 * 1000,
40 //! ..ScoringParameters::default()
43 //! let route = find_route(&payer, ¶ms, &network_graph, None, &logger, &scorer);
49 //! Persisting when built with feature `no-std` and restoring without it, or vice versa, uses
50 //! different types and thus is undefined.
52 //! [`find_route`]: crate::routing::router::find_route
54 use ln::msgs::DecodeError;
55 use routing::network_graph::NodeId;
56 use routing::router::RouteHop;
57 use util::ser::{Readable, Writeable, Writer};
60 use core::cell::{RefCell, RefMut};
61 use core::ops::DerefMut;
62 use core::time::Duration;
64 use sync::{Mutex, MutexGuard};
66 /// We define Score ever-so-slightly differently based on whether we are being built for C bindings
67 /// or not. For users, `LockableScore` must somehow be writeable to disk. For Rust users, this is
68 /// no problem - you move a `Score` that implements `Writeable` into a `Mutex`, lock it, and now
69 /// you have the original, concrete, `Score` type, which presumably implements `Writeable`.
71 /// For C users, once you've moved the `Score` into a `LockableScore` all you have after locking it
72 /// is an opaque trait object with an opaque pointer with no type info. Users could take the unsafe
73 /// approach of blindly casting that opaque pointer to a concrete type and calling `Writeable` from
74 /// there, but other languages downstream of the C bindings (e.g. Java) can't even do that.
75 /// Instead, we really want `Score` and `LockableScore` to implement `Writeable` directly, which we
76 /// do here by defining `Score` differently for `cfg(c_bindings)`.
77 macro_rules! define_score { ($($supertrait: path)*) => {
78 /// An interface used to score payment channels for path finding.
80 /// Scoring is in terms of fees willing to be paid in order to avoid routing through a channel.
81 pub trait Score $(: $supertrait)* {
82 /// Returns the fee in msats willing to be paid to avoid routing `send_amt_msat` through the
83 /// given channel in the direction from `source` to `target`.
85 /// The channel's capacity (less any other MPP parts which are also being considered for use in
86 /// the same payment) is given by `channel_capacity_msat`. It may be guessed from various
87 /// sources or assumed from no data at all.
89 /// For hints provided in the invoice, we assume the channel has sufficient capacity to accept
90 /// the invoice's full amount, and provide a `channel_capacity_msat` of `None`. In all other
91 /// cases it is set to `Some`, even if we're guessing at the channel value.
93 /// Your code should be overflow-safe through a `channel_capacity_msat` of 21 million BTC.
94 fn channel_penalty_msat(&self, short_channel_id: u64, send_amt_msat: u64, channel_capacity_msat: Option<u64>, source: &NodeId, target: &NodeId) -> u64;
96 /// Handles updating channel penalties after failing to route through a channel.
97 fn payment_path_failed(&mut self, path: &[&RouteHop], short_channel_id: u64);
99 /// Handles updating channel penalties after successfully routing along a path.
100 fn payment_path_successful(&mut self, path: &[&RouteHop]);
103 impl<S: Score, T: DerefMut<Target=S> $(+ $supertrait)*> Score for T {
104 fn channel_penalty_msat(&self, short_channel_id: u64, send_amt_msat: u64, channel_capacity_msat: Option<u64>, source: &NodeId, target: &NodeId) -> u64 {
105 self.deref().channel_penalty_msat(short_channel_id, send_amt_msat, channel_capacity_msat, source, target)
108 fn payment_path_failed(&mut self, path: &[&RouteHop], short_channel_id: u64) {
109 self.deref_mut().payment_path_failed(path, short_channel_id)
112 fn payment_path_successful(&mut self, path: &[&RouteHop]) {
113 self.deref_mut().payment_path_successful(path)
119 define_score!(Writeable);
120 #[cfg(not(c_bindings))]
123 /// A scorer that is accessed under a lock.
125 /// Needed so that calls to [`Score::channel_penalty_msat`] in [`find_route`] can be made while
126 /// having shared ownership of a scorer but without requiring internal locking in [`Score`]
127 /// implementations. Internal locking would be detrimental to route finding performance and could
128 /// result in [`Score::channel_penalty_msat`] returning a different value for the same channel.
130 /// [`find_route`]: crate::routing::router::find_route
131 pub trait LockableScore<'a> {
132 /// The locked [`Score`] type.
133 type Locked: 'a + Score;
135 /// Returns the locked scorer.
136 fn lock(&'a self) -> Self::Locked;
140 impl<'a, T: 'a + Score> LockableScore<'a> for Mutex<T> {
141 type Locked = MutexGuard<'a, T>;
143 fn lock(&'a self) -> MutexGuard<'a, T> {
144 Mutex::lock(self).unwrap()
148 impl<'a, T: 'a + Score> LockableScore<'a> for RefCell<T> {
149 type Locked = RefMut<'a, T>;
151 fn lock(&'a self) -> RefMut<'a, T> {
157 /// A concrete implementation of [`LockableScore`] which supports multi-threading.
158 pub struct MultiThreadedLockableScore<S: Score> {
163 impl<'a, T: Score + 'a> LockableScore<'a> for MultiThreadedLockableScore<T> {
164 type Locked = MutexGuard<'a, T>;
166 fn lock(&'a self) -> MutexGuard<'a, T> {
167 Mutex::lock(&self.score).unwrap()
172 impl<T: Score> MultiThreadedLockableScore<T> {
173 /// Creates a new [`MultiThreadedLockableScore`] given an underlying [`Score`].
174 pub fn new(score: T) -> Self {
175 MultiThreadedLockableScore { score: Mutex::new(score) }
181 impl<'a, T: Writeable> Writeable for RefMut<'a, T> {
182 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
183 T::write(&**self, writer)
189 impl<'a, S: Writeable> Writeable for MutexGuard<'a, S> {
190 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
191 S::write(&**self, writer)
195 /// [`Score`] implementation that provides reasonable default behavior.
197 /// Used to apply a fixed penalty to each channel, thus avoiding long paths when shorter paths with
198 /// slightly higher fees are available. Will further penalize channels that fail to relay payments.
200 /// See [module-level documentation] for usage.
202 /// [module-level documentation]: crate::routing::scoring
203 #[cfg(not(feature = "no-std"))]
204 pub type Scorer = ScorerUsingTime::<std::time::Instant>;
205 /// [`Score`] implementation that provides reasonable default behavior.
207 /// Used to apply a fixed penalty to each channel, thus avoiding long paths when shorter paths with
208 /// slightly higher fees are available. Will further penalize channels that fail to relay payments.
210 /// See [module-level documentation] for usage and [`ScoringParameters`] for customization.
212 /// [module-level documentation]: crate::routing::scoring
213 #[cfg(feature = "no-std")]
214 pub type Scorer = ScorerUsingTime::<time::Eternity>;
216 // Note that ideally we'd hide ScorerUsingTime from public view by sealing it as well, but rustdoc
217 // doesn't handle this well - instead exposing a `Scorer` which has no trait implementation(s) or
220 /// [`Score`] implementation.
222 /// See [`Scorer`] for details.
226 /// Mixing the `no-std` feature between serialization and deserialization results in undefined
229 /// (C-not exported) generally all users should use the [`Scorer`] type alias.
230 pub struct ScorerUsingTime<T: Time> {
231 params: ScoringParameters,
232 // TODO: Remove entries of closed channels.
233 channel_failures: HashMap<u64, ChannelFailure<T>>,
236 /// Parameters for configuring [`Scorer`].
237 pub struct ScoringParameters {
238 /// A fixed penalty in msats to apply to each channel.
240 /// Default value: 500 msat
241 pub base_penalty_msat: u64,
243 /// A penalty in msats to apply to a channel upon failing to relay a payment.
245 /// This accumulates for each failure but may be reduced over time based on
246 /// [`failure_penalty_half_life`] or when successfully routing through a channel.
248 /// Default value: 1,024,000 msat
250 /// [`failure_penalty_half_life`]: Self::failure_penalty_half_life
251 pub failure_penalty_msat: u64,
253 /// When the amount being sent over a channel is this many 1024ths of the total channel
254 /// capacity, we begin applying [`overuse_penalty_msat_per_1024th`].
256 /// Default value: 128 1024ths (i.e. begin penalizing when an HTLC uses 1/8th of a channel)
258 /// [`overuse_penalty_msat_per_1024th`]: Self::overuse_penalty_msat_per_1024th
259 pub overuse_penalty_start_1024th: u16,
261 /// A penalty applied, per whole 1024ths of the channel capacity which the amount being sent
262 /// over the channel exceeds [`overuse_penalty_start_1024th`] by.
264 /// Default value: 20 msat (i.e. 2560 msat penalty to use 1/4th of a channel, 7680 msat penalty
265 /// to use half a channel, and 12,560 msat penalty to use 3/4ths of a channel)
267 /// [`overuse_penalty_start_1024th`]: Self::overuse_penalty_start_1024th
268 pub overuse_penalty_msat_per_1024th: u64,
270 /// The time required to elapse before any accumulated [`failure_penalty_msat`] penalties are
273 /// Successfully routing through a channel will immediately cut the penalty in half as well.
277 /// When built with the `no-std` feature, time will never elapse. Therefore, this penalty will
280 /// [`failure_penalty_msat`]: Self::failure_penalty_msat
281 pub failure_penalty_half_life: Duration,
284 impl_writeable_tlv_based!(ScoringParameters, {
285 (0, base_penalty_msat, required),
286 (1, overuse_penalty_start_1024th, (default_value, 128)),
287 (2, failure_penalty_msat, required),
288 (3, overuse_penalty_msat_per_1024th, (default_value, 20)),
289 (4, failure_penalty_half_life, required),
292 /// Accounting for penalties against a channel for failing to relay any payments.
294 /// Penalties decay over time, though accumulate as more failures occur.
295 struct ChannelFailure<T: Time> {
296 /// Accumulated penalty in msats for the channel as of `last_updated`.
297 undecayed_penalty_msat: u64,
299 /// Last time the channel either failed to route or successfully routed a payment. Used to decay
300 /// `undecayed_penalty_msat`.
304 impl<T: Time> ScorerUsingTime<T> {
305 /// Creates a new scorer using the given scoring parameters.
306 pub fn new(params: ScoringParameters) -> Self {
309 channel_failures: HashMap::new(),
313 /// Creates a new scorer using `penalty_msat` as a fixed channel penalty.
314 #[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
315 pub fn with_fixed_penalty(penalty_msat: u64) -> Self {
316 Self::new(ScoringParameters {
317 base_penalty_msat: penalty_msat,
318 failure_penalty_msat: 0,
319 failure_penalty_half_life: Duration::from_secs(0),
320 overuse_penalty_start_1024th: 1024,
321 overuse_penalty_msat_per_1024th: 0,
326 impl<T: Time> ChannelFailure<T> {
327 fn new(failure_penalty_msat: u64) -> Self {
329 undecayed_penalty_msat: failure_penalty_msat,
330 last_updated: T::now(),
334 fn add_penalty(&mut self, failure_penalty_msat: u64, half_life: Duration) {
335 self.undecayed_penalty_msat = self.decayed_penalty_msat(half_life) + failure_penalty_msat;
336 self.last_updated = T::now();
339 fn reduce_penalty(&mut self, half_life: Duration) {
340 self.undecayed_penalty_msat = self.decayed_penalty_msat(half_life) >> 1;
341 self.last_updated = T::now();
344 fn decayed_penalty_msat(&self, half_life: Duration) -> u64 {
345 self.last_updated.elapsed().as_secs()
346 .checked_div(half_life.as_secs())
347 .and_then(|decays| self.undecayed_penalty_msat.checked_shr(decays as u32))
352 impl<T: Time> Default for ScorerUsingTime<T> {
353 fn default() -> Self {
354 Self::new(ScoringParameters::default())
358 impl Default for ScoringParameters {
359 fn default() -> Self {
361 base_penalty_msat: 500,
362 failure_penalty_msat: 1024 * 1000,
363 failure_penalty_half_life: Duration::from_secs(3600),
364 overuse_penalty_start_1024th: 1024 / 8,
365 overuse_penalty_msat_per_1024th: 20,
370 impl<T: Time> Score for ScorerUsingTime<T> {
371 fn channel_penalty_msat(
372 &self, short_channel_id: u64, send_amt_msat: u64, chan_capacity_opt: Option<u64>, _source: &NodeId, _target: &NodeId
374 let failure_penalty_msat = self.channel_failures
375 .get(&short_channel_id)
376 .map_or(0, |value| value.decayed_penalty_msat(self.params.failure_penalty_half_life));
378 let mut penalty_msat = self.params.base_penalty_msat + failure_penalty_msat;
380 if let Some(chan_capacity_msat) = chan_capacity_opt {
381 let send_1024ths = send_amt_msat.checked_mul(1024).unwrap_or(u64::max_value()) / chan_capacity_msat;
383 if send_1024ths > self.params.overuse_penalty_start_1024th as u64 {
384 penalty_msat = penalty_msat.checked_add(
385 (send_1024ths - self.params.overuse_penalty_start_1024th as u64)
386 .checked_mul(self.params.overuse_penalty_msat_per_1024th).unwrap_or(u64::max_value()))
387 .unwrap_or(u64::max_value());
394 fn payment_path_failed(&mut self, _path: &[&RouteHop], short_channel_id: u64) {
395 let failure_penalty_msat = self.params.failure_penalty_msat;
396 let half_life = self.params.failure_penalty_half_life;
397 self.channel_failures
398 .entry(short_channel_id)
399 .and_modify(|failure| failure.add_penalty(failure_penalty_msat, half_life))
400 .or_insert_with(|| ChannelFailure::new(failure_penalty_msat));
403 fn payment_path_successful(&mut self, path: &[&RouteHop]) {
404 let half_life = self.params.failure_penalty_half_life;
405 for hop in path.iter() {
406 self.channel_failures
407 .entry(hop.short_channel_id)
408 .and_modify(|failure| failure.reduce_penalty(half_life));
413 impl<T: Time> Writeable for ScorerUsingTime<T> {
415 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
416 self.params.write(w)?;
417 self.channel_failures.write(w)?;
418 write_tlv_fields!(w, {});
423 impl<T: Time> Readable for ScorerUsingTime<T> {
425 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
427 params: Readable::read(r)?,
428 channel_failures: Readable::read(r)?,
430 read_tlv_fields!(r, {});
435 impl<T: Time> Writeable for ChannelFailure<T> {
437 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
438 let duration_since_epoch = T::duration_since_epoch() - self.last_updated.elapsed();
439 write_tlv_fields!(w, {
440 (0, self.undecayed_penalty_msat, required),
441 (2, duration_since_epoch, required),
447 impl<T: Time> Readable for ChannelFailure<T> {
449 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
450 let mut undecayed_penalty_msat = 0;
451 let mut duration_since_epoch = Duration::from_secs(0);
452 read_tlv_fields!(r, {
453 (0, undecayed_penalty_msat, required),
454 (2, duration_since_epoch, required),
457 undecayed_penalty_msat,
458 last_updated: T::now() - (T::duration_since_epoch() - duration_since_epoch),
463 pub(crate) mod time {
465 use core::time::Duration;
466 /// A measurement of time.
467 pub trait Time: Sub<Duration, Output = Self> where Self: Sized {
468 /// Returns an instance corresponding to the current moment.
471 /// Returns the amount of time elapsed since `self` was created.
472 fn elapsed(&self) -> Duration;
474 /// Returns the amount of time passed since the beginning of [`Time`].
476 /// Used during (de-)serialization.
477 fn duration_since_epoch() -> Duration;
480 /// A state in which time has no meaning.
481 #[derive(Debug, PartialEq, Eq)]
484 #[cfg(not(feature = "no-std"))]
485 impl Time for std::time::Instant {
487 std::time::Instant::now()
490 fn duration_since_epoch() -> Duration {
491 use std::time::SystemTime;
492 SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap()
495 fn elapsed(&self) -> Duration {
496 std::time::Instant::elapsed(self)
500 impl Time for Eternity {
505 fn duration_since_epoch() -> Duration {
506 Duration::from_secs(0)
509 fn elapsed(&self) -> Duration {
510 Duration::from_secs(0)
514 impl Sub<Duration> for Eternity {
517 fn sub(self, _other: Duration) -> Self {
523 pub(crate) use self::time::Time;
527 use super::{ScoringParameters, ScorerUsingTime, Time};
528 use super::time::Eternity;
530 use ln::features::{ChannelFeatures, NodeFeatures};
531 use routing::scoring::Score;
532 use routing::network_graph::NodeId;
533 use routing::router::RouteHop;
534 use util::ser::{Readable, Writeable};
536 use bitcoin::secp256k1::PublicKey;
537 use core::cell::Cell;
539 use core::time::Duration;
542 /// Time that can be advanced manually in tests.
543 #[derive(Debug, PartialEq, Eq)]
544 struct SinceEpoch(Duration);
548 static ELAPSED: Cell<Duration> = core::cell::Cell::new(Duration::from_secs(0));
551 fn advance(duration: Duration) {
552 Self::ELAPSED.with(|elapsed| elapsed.set(elapsed.get() + duration))
556 impl Time for SinceEpoch {
558 Self(Self::duration_since_epoch())
561 fn duration_since_epoch() -> Duration {
562 Self::ELAPSED.with(|elapsed| elapsed.get())
565 fn elapsed(&self) -> Duration {
566 Self::duration_since_epoch() - self.0
570 impl Sub<Duration> for SinceEpoch {
573 fn sub(self, other: Duration) -> Self {
579 fn time_passes_when_advanced() {
580 let now = SinceEpoch::now();
581 assert_eq!(now.elapsed(), Duration::from_secs(0));
583 SinceEpoch::advance(Duration::from_secs(1));
584 SinceEpoch::advance(Duration::from_secs(1));
586 let elapsed = now.elapsed();
587 let later = SinceEpoch::now();
589 assert_eq!(elapsed, Duration::from_secs(2));
590 assert_eq!(later - elapsed, now);
594 fn time_never_passes_in_an_eternity() {
595 let now = Eternity::now();
596 let elapsed = now.elapsed();
597 let later = Eternity::now();
599 assert_eq!(now.elapsed(), Duration::from_secs(0));
600 assert_eq!(later - elapsed, now);
603 /// A scorer for testing with time that can be manually advanced.
604 type Scorer = ScorerUsingTime::<SinceEpoch>;
606 fn source_node_id() -> NodeId {
607 NodeId::from_pubkey(&PublicKey::from_slice(&hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap())
610 fn target_node_id() -> NodeId {
611 NodeId::from_pubkey(&PublicKey::from_slice(&hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap())
615 fn penalizes_without_channel_failures() {
616 let scorer = Scorer::new(ScoringParameters {
617 base_penalty_msat: 1_000,
618 failure_penalty_msat: 512,
619 failure_penalty_half_life: Duration::from_secs(1),
620 overuse_penalty_start_1024th: 1024,
621 overuse_penalty_msat_per_1024th: 0,
623 let source = source_node_id();
624 let target = target_node_id();
625 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_000);
627 SinceEpoch::advance(Duration::from_secs(1));
628 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_000);
632 fn accumulates_channel_failure_penalties() {
633 let mut scorer = Scorer::new(ScoringParameters {
634 base_penalty_msat: 1_000,
635 failure_penalty_msat: 64,
636 failure_penalty_half_life: Duration::from_secs(10),
637 overuse_penalty_start_1024th: 1024,
638 overuse_penalty_msat_per_1024th: 0,
640 let source = source_node_id();
641 let target = target_node_id();
642 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_000);
644 scorer.payment_path_failed(&[], 42);
645 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_064);
647 scorer.payment_path_failed(&[], 42);
648 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_128);
650 scorer.payment_path_failed(&[], 42);
651 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_192);
655 fn decays_channel_failure_penalties_over_time() {
656 let mut scorer = Scorer::new(ScoringParameters {
657 base_penalty_msat: 1_000,
658 failure_penalty_msat: 512,
659 failure_penalty_half_life: Duration::from_secs(10),
660 overuse_penalty_start_1024th: 1024,
661 overuse_penalty_msat_per_1024th: 0,
663 let source = source_node_id();
664 let target = target_node_id();
665 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_000);
667 scorer.payment_path_failed(&[], 42);
668 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_512);
670 SinceEpoch::advance(Duration::from_secs(9));
671 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_512);
673 SinceEpoch::advance(Duration::from_secs(1));
674 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_256);
676 SinceEpoch::advance(Duration::from_secs(10 * 8));
677 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_001);
679 SinceEpoch::advance(Duration::from_secs(10));
680 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_000);
682 SinceEpoch::advance(Duration::from_secs(10));
683 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_000);
687 fn decays_channel_failure_penalties_without_shift_overflow() {
688 let mut scorer = Scorer::new(ScoringParameters {
689 base_penalty_msat: 1_000,
690 failure_penalty_msat: 512,
691 failure_penalty_half_life: Duration::from_secs(10),
692 overuse_penalty_start_1024th: 1024,
693 overuse_penalty_msat_per_1024th: 0,
695 let source = source_node_id();
696 let target = target_node_id();
697 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_000);
699 scorer.payment_path_failed(&[], 42);
700 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_512);
702 // An unchecked right shift 64 bits or more in ChannelFailure::decayed_penalty_msat would
703 // cause an overflow.
704 SinceEpoch::advance(Duration::from_secs(10 * 64));
705 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_000);
707 SinceEpoch::advance(Duration::from_secs(10));
708 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_000);
712 fn accumulates_channel_failure_penalties_after_decay() {
713 let mut scorer = Scorer::new(ScoringParameters {
714 base_penalty_msat: 1_000,
715 failure_penalty_msat: 512,
716 failure_penalty_half_life: Duration::from_secs(10),
717 overuse_penalty_start_1024th: 1024,
718 overuse_penalty_msat_per_1024th: 0,
720 let source = source_node_id();
721 let target = target_node_id();
722 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_000);
724 scorer.payment_path_failed(&[], 42);
725 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_512);
727 SinceEpoch::advance(Duration::from_secs(10));
728 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_256);
730 scorer.payment_path_failed(&[], 42);
731 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_768);
733 SinceEpoch::advance(Duration::from_secs(10));
734 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_384);
738 fn reduces_channel_failure_penalties_after_success() {
739 let mut scorer = Scorer::new(ScoringParameters {
740 base_penalty_msat: 1_000,
741 failure_penalty_msat: 512,
742 failure_penalty_half_life: Duration::from_secs(10),
743 overuse_penalty_start_1024th: 1024,
744 overuse_penalty_msat_per_1024th: 0,
746 let source = source_node_id();
747 let target = target_node_id();
748 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_000);
750 scorer.payment_path_failed(&[], 42);
751 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_512);
753 SinceEpoch::advance(Duration::from_secs(10));
754 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_256);
757 pubkey: PublicKey::from_slice(target.as_slice()).unwrap(),
758 node_features: NodeFeatures::known(),
759 short_channel_id: 42,
760 channel_features: ChannelFeatures::known(),
762 cltv_expiry_delta: 18,
764 scorer.payment_path_successful(&[&hop]);
765 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_128);
767 SinceEpoch::advance(Duration::from_secs(10));
768 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_064);
772 fn restores_persisted_channel_failure_penalties() {
773 let mut scorer = Scorer::new(ScoringParameters {
774 base_penalty_msat: 1_000,
775 failure_penalty_msat: 512,
776 failure_penalty_half_life: Duration::from_secs(10),
777 overuse_penalty_start_1024th: 1024,
778 overuse_penalty_msat_per_1024th: 0,
780 let source = source_node_id();
781 let target = target_node_id();
783 scorer.payment_path_failed(&[], 42);
784 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_512);
786 SinceEpoch::advance(Duration::from_secs(10));
787 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_256);
789 scorer.payment_path_failed(&[], 43);
790 assert_eq!(scorer.channel_penalty_msat(43, 1, Some(1), &source, &target), 1_512);
792 let mut serialized_scorer = Vec::new();
793 scorer.write(&mut serialized_scorer).unwrap();
795 let deserialized_scorer = <Scorer>::read(&mut io::Cursor::new(&serialized_scorer)).unwrap();
796 assert_eq!(deserialized_scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_256);
797 assert_eq!(deserialized_scorer.channel_penalty_msat(43, 1, Some(1), &source, &target), 1_512);
801 fn decays_persisted_channel_failure_penalties() {
802 let mut scorer = Scorer::new(ScoringParameters {
803 base_penalty_msat: 1_000,
804 failure_penalty_msat: 512,
805 failure_penalty_half_life: Duration::from_secs(10),
806 overuse_penalty_start_1024th: 1024,
807 overuse_penalty_msat_per_1024th: 0,
809 let source = source_node_id();
810 let target = target_node_id();
812 scorer.payment_path_failed(&[], 42);
813 assert_eq!(scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_512);
815 let mut serialized_scorer = Vec::new();
816 scorer.write(&mut serialized_scorer).unwrap();
818 SinceEpoch::advance(Duration::from_secs(10));
820 let deserialized_scorer = <Scorer>::read(&mut io::Cursor::new(&serialized_scorer)).unwrap();
821 assert_eq!(deserialized_scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_256);
823 SinceEpoch::advance(Duration::from_secs(10));
824 assert_eq!(deserialized_scorer.channel_penalty_msat(42, 1, Some(1), &source, &target), 1_128);
828 fn charges_per_1024th_penalty() {
829 let scorer = Scorer::new(ScoringParameters {
830 base_penalty_msat: 0,
831 failure_penalty_msat: 0,
832 failure_penalty_half_life: Duration::from_secs(0),
833 overuse_penalty_start_1024th: 256,
834 overuse_penalty_msat_per_1024th: 100,
836 let source = source_node_id();
837 let target = target_node_id();
839 assert_eq!(scorer.channel_penalty_msat(42, 1_000, None, &source, &target), 0);
840 assert_eq!(scorer.channel_penalty_msat(42, 1_000, Some(1_024_000), &source, &target), 0);
841 assert_eq!(scorer.channel_penalty_msat(42, 256_999, Some(1_024_000), &source, &target), 0);
842 assert_eq!(scorer.channel_penalty_msat(42, 257_000, Some(1_024_000), &source, &target), 100);
843 assert_eq!(scorer.channel_penalty_msat(42, 258_000, Some(1_024_000), &source, &target), 200);
844 assert_eq!(scorer.channel_penalty_msat(42, 512_000, Some(1_024_000), &source, &target), 256 * 100);