f - Rename Clock trait to Time which is more accurate

Author: jkczyz

lightning/src/routing/scorer.rs

@@ -62,23 +62,23 @@ use core::time::Duration;
 /// See [module-level documentation] for usage.
 ///
 /// [module-level documentation]: crate::routing::scorer
-pub type Scorer = ScorerUsingClock::<DefaultClock>;
+pub type Scorer = ScorerUsingTime::<DefaultTime>;
 
-/// Clock used by [`Scorer`].
+/// Time used by [`Scorer`].
 #[cfg(not(feature = "no-std"))]
-pub type DefaultClock = std::time::Instant;
+pub type DefaultTime = std::time::Instant;
 
-/// Clock used by [`Scorer`].
+/// Time used by [`Scorer`].
 #[cfg(feature = "no-std")]
-pub type DefaultClock = Eternity;
+pub type DefaultTime = Eternity;
 
-/// [`routing::Score`] implementation parameterized by a [`Clock`].
+/// [`routing::Score`] implementation parameterized by [`Time`].
 ///
 /// See [`Scorer`] for details.
-pub struct ScorerUsingClock<C: Clock> {
+pub struct ScorerUsingTime<T: Time> {
 	params: ScoringParameters,
 	// TODO: Remove entries of closed channels.
-	channel_failures: HashMap<u64, ChannelFailure<C>>,
+	channel_failures: HashMap<u64, ChannelFailure<T>>,
 }
 
 /// Parameters for configuring [`Scorer`].
@@ -106,24 +106,24 @@ pub struct ScoringParameters {
 /// Accounting for penalties from channel failures.
 ///
 /// Penalties decay over time, though accumulate as more failures occur.
-struct ChannelFailure<C: Clock> {
+struct ChannelFailure<T: Time> {
 	/// Accumulated penalty in msats for the channel as of `last_failed`.
 	undecayed_penalty_msat: u64,
 
 	/// Last time the channel failed. Used to decay `undecayed_penalty_msat`.
-	last_failed: C,
+	last_failed: T,
 }
 
 /// A measurement of time.
-pub trait Clock {
-	/// Returns an instance corresponding to "now".
+pub trait Time {
+	/// Returns an instance corresponding to the current moment.
 	fn now() -> Self;
 
-	/// Returns the amount of time elapsed since the clock was created.
+	/// Returns the amount of time elapsed since created.
 	fn elapsed(&self) -> Duration;
 }
 
-impl<C: Clock> ScorerUsingClock<C> {
+impl<T: Time> ScorerUsingTime<T> {
 	/// Creates a new scorer using the given scoring parameters.
 	pub fn new(params: ScoringParameters) -> Self {
 		Self {
@@ -143,17 +143,17 @@ impl<C: Clock> ScorerUsingClock<C> {
 	}
 }
 
-impl<C: Clock> ChannelFailure<C> {
+impl<T: Time> ChannelFailure<T> {
 	fn new(failure_penalty_msat: u64) -> Self {
 		Self {
 			undecayed_penalty_msat: failure_penalty_msat,
-			last_failed: C::now(),
+			last_failed: T::now(),
 		}
 	}
 
 	fn add_penalty(&mut self, failure_penalty_msat: u64, half_life: Duration) {
 		self.undecayed_penalty_msat = self.decayed_penalty_msat(half_life) + failure_penalty_msat;
-		self.last_failed = C::now();
+		self.last_failed = T::now();
 	}
 
 	fn decayed_penalty_msat(&self, half_life: Duration) -> u64 {
@@ -165,7 +165,7 @@ impl<C: Clock> ChannelFailure<C> {
 	}
 }
 
-impl<C: Clock> Default for ScorerUsingClock<C> {
+impl<T: Time> Default for ScorerUsingTime<T> {
 	fn default() -> Self {
 		Self::new(ScoringParameters::default())
 	}
@@ -181,7 +181,7 @@ impl Default for ScoringParameters {
 	}
 }
 
-impl<C: Clock> routing::Score for ScorerUsingClock<C> {
+impl<T: Time> routing::Score for ScorerUsingTime<T> {
 	fn channel_penalty_msat(
 		&self, short_channel_id: u64, _source: &NodeId, _target: &NodeId
 	) -> u64 {
@@ -203,7 +203,7 @@ impl<C: Clock> routing::Score for ScorerUsingClock<C> {
 }
 
 #[cfg(not(feature = "no-std"))]
-impl Clock for std::time::Instant {
+impl Time for std::time::Instant {
 	fn now() -> Self {
 		std::time::Instant::now()
 	}
@@ -216,7 +216,7 @@ impl Clock for std::time::Instant {
 /// A state in which time has no meaning.
 pub struct Eternity;
 
-impl Clock for Eternity {
+impl Time for Eternity {
 	fn now() -> Self {
 		Self
 	}

lightning/src/util/test_utils.rs

@@ -21,7 +21,7 @@ use ln::features::{ChannelFeatures, InitFeatures};
 use ln::msgs;
 use ln::msgs::OptionalField;
 use ln::script::ShutdownScript;
-use routing::scorer::{Eternity, ScorerUsingClock};
+use routing::scorer::{Eternity, ScorerUsingTime};
 use util::enforcing_trait_impls::{EnforcingSigner, EnforcementState};
 use util::events;
 use util::logger::{Logger, Level, Record};
@@ -693,4 +693,4 @@ impl core::fmt::Debug for OnRegisterOutput {
 }
 
 /// A scorer useful in testing, when the passage of time isn't a concern.
-pub type TestScorer = ScorerUsingClock<Eternity>;
+pub type TestScorer = ScorerUsingTime<Eternity>;