fixup: Refactor LSPS5 handlers and LiquidityManager to use generic TimeProvider instead of dyn trait

Author: martinsaposnic

lightning-liquidity/src/lsps5/client.rs

@@ -83,18 +83,24 @@ impl Default for LSPS5ClientConfig {
 	}
 }
 
-struct PeerState {
+struct PeerState<TP: Deref>
+where
+	TP::Target: TimeProvider,
+{
 	pending_set_webhook_requests:
 		HashMap<LSPSRequestId, (LSPS5AppName, LSPS5WebhookUrl, LSPSDateTime)>,
 	pending_list_webhooks_requests: HashMap<LSPSRequestId, LSPSDateTime>,
 	pending_remove_webhook_requests: HashMap<LSPSRequestId, (LSPS5AppName, LSPSDateTime)>,
 	last_cleanup: Option<LSPSDateTime>,
 	max_age_secs: Duration,
-	time_provider: Arc<dyn TimeProvider>,
+	time_provider: TP,
 }
 
-impl PeerState {
-	fn new(max_age_secs: Duration, time_provider: Arc<dyn TimeProvider>) -> Self {
+impl<TP: Deref> PeerState<TP>
+where
+	TP::Target: TimeProvider,
+{
+	fn new(max_age_secs: Duration, time_provider: TP) -> Self {
 		Self {
 			pending_set_webhook_requests: new_hash_map(),
 			pending_list_webhooks_requests: new_hash_map(),
@@ -148,27 +154,29 @@ impl PeerState {
 /// [`lsps5.set_webhook`]: super::msgs::LSPS5Request::SetWebhook
 /// [`lsps5.list_webhooks`]: super::msgs::LSPS5Request::ListWebhooks
 /// [`lsps5.remove_webhook`]: super::msgs::LSPS5Request::RemoveWebhook
-pub struct LSPS5ClientHandler<ES: Deref>
+pub struct LSPS5ClientHandler<ES: Deref, TP: Deref + Clone>
 where
 	ES::Target: EntropySource,
+	TP::Target: TimeProvider,
 {
 	pending_messages: Arc<MessageQueue>,
 	pending_events: Arc<EventQueue>,
 	entropy_source: ES,
-	per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
+	per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState<TP>>>>,
 	config: LSPS5ClientConfig,
-	time_provider: Arc<dyn TimeProvider>,
+	time_provider: TP,
 	recent_signatures: Mutex<VecDeque<(String, LSPSDateTime)>>,
 }
 
-impl<ES: Deref> LSPS5ClientHandler<ES>
+impl<ES: Deref, TP: Deref + Clone> LSPS5ClientHandler<ES, TP>
 where
 	ES::Target: EntropySource,
+	TP::Target: TimeProvider,
 {
 	/// Constructs an `LSPS5ClientHandler`.
 	pub(crate) fn new(
 		entropy_source: ES, pending_messages: Arc<MessageQueue>, pending_events: Arc<EventQueue>,
-		config: LSPS5ClientConfig, time_provider: Arc<dyn TimeProvider>,
+		config: LSPS5ClientConfig, time_provider: TP,
 	) -> Self {
 		let max_signatures = config.signature_config.max_signatures.clone();
 		Self {
@@ -184,11 +192,11 @@ where
 
 	fn with_peer_state<F, R>(&self, counterparty_node_id: PublicKey, f: F) -> R
 	where
-		F: FnOnce(&mut PeerState) -> R,
+		F: FnOnce(&mut PeerState<TP>) -> R,
 	{
 		let mut outer_state_lock = self.per_peer_state.write().unwrap();
 		let inner_state_lock = outer_state_lock.entry(counterparty_node_id).or_insert(Mutex::new(
-			PeerState::new(self.config.response_max_age_secs, Arc::clone(&self.time_provider)),
+			PeerState::new(self.config.response_max_age_secs, self.time_provider.clone()),
 		));
 		let mut peer_state_lock = inner_state_lock.lock().unwrap();
 
@@ -349,7 +357,7 @@ where
 			action: ErrorAction::IgnoreAndLog(Level::Error),
 		});
 		let event_queue_notifier = self.pending_events.notifier();
-		let handle_response = |peer_state: &mut PeerState| {
+		let handle_response = |peer_state: &mut PeerState<TP>| {
 			if let Some((app_name, webhook_url, _)) =
 				peer_state.pending_set_webhook_requests.remove(&request_id)
 			{
@@ -548,9 +556,10 @@ where
 	}
 }
 
-impl<ES: Deref> LSPSProtocolMessageHandler for LSPS5ClientHandler<ES>
+impl<ES: Deref, TP: Deref + Clone> LSPSProtocolMessageHandler for LSPS5ClientHandler<ES, TP>
 where
 	ES::Target: EntropySource,
+	TP::Target: TimeProvider,
 {
 	type ProtocolMessage = LSPS5Message;
 	const PROTOCOL_NUMBER: Option<u16> = Some(5);

lightning-liquidity/src/lsps5/service.rs

@@ -57,7 +57,7 @@ struct StoredWebhook {
 ///
 /// This trait is used to provide the current time for LSPS5 service operations
 /// and to convert between timestamps and durations.
-pub trait TimeProvider: Send + Sync {
+pub trait TimeProvider {
 	/// Get the current time as a duration since the Unix epoch.
 	fn duration_since_epoch(&self) -> Duration;
 }
@@ -127,27 +127,29 @@ pub struct LSPS5ServiceConfig {
 /// [`LSPS5ServiceEvent::SendWebhookNotification`]: super::event::LSPS5ServiceEvent::SendWebhookNotification
 /// [`app_name`]: super::msgs::LSPS5AppName
 /// [`lsps5.webhook_registered`]: super::msgs::WebhookNotificationMethod::LSPS5WebhookRegistered
-pub struct LSPS5ServiceHandler<CM: Deref>
+pub struct LSPS5ServiceHandler<CM: Deref, TP: Deref>
 where
 	CM::Target: AChannelManager,
+	TP::Target: TimeProvider,
 {
 	config: LSPS5ServiceConfig,
 	webhooks: Mutex<HashMap<PublicKey, HashMap<LSPS5AppName, StoredWebhook>>>,
 	event_queue: Arc<EventQueue>,
 	pending_messages: Arc<MessageQueue>,
-	time_provider: Arc<dyn TimeProvider>,
+	time_provider: TP,
 	channel_manager: CM,
 	last_pruning: Mutex<Option<LSPSDateTime>>,
 }
 
-impl<CM: Deref> LSPS5ServiceHandler<CM>
+impl<CM: Deref, TP: Deref> LSPS5ServiceHandler<CM, TP>
 where
 	CM::Target: AChannelManager,
+	TP::Target: TimeProvider,
 {
 	/// Constructs a `LSPS5ServiceHandler`.
 	pub(crate) fn new(
 		event_queue: Arc<EventQueue>, pending_messages: Arc<MessageQueue>, channel_manager: CM,
-		config: LSPS5ServiceConfig, time_provider: Arc<dyn TimeProvider>,
+		config: LSPS5ServiceConfig, time_provider: TP,
 	) -> Self {
 		assert!(config.max_webhooks_per_client > 0, "`max_webhooks_per_client` must be > 0");
 		Self {
@@ -494,9 +496,10 @@ where
 	}
 }
 
-impl<CM: Deref> LSPSProtocolMessageHandler for LSPS5ServiceHandler<CM>
+impl<CM: Deref, TP: Deref> LSPSProtocolMessageHandler for LSPS5ServiceHandler<CM, TP>
 where
 	CM::Target: AChannelManager,
+	TP::Target: TimeProvider,
 {
 	type ProtocolMessage = LSPS5Message;
 	const PROTOCOL_NUMBER: Option<u16> = Some(5);

lightning-liquidity/src/manager.rs

@@ -94,24 +94,31 @@ pub trait ALiquidityManager {
 	type Filter: Filter + ?Sized;
 	/// A type that may be dereferenced to [`Self::Filter`].
 	type C: Deref<Target = Self::Filter> + Clone;
+	/// A type implementing [`TimeProvider`].
+	type TimeProvider: TimeProvider + ?Sized;
+	/// A type that may be dereferenced to [`Self::TimeProvider`].
+	type TP: Deref<Target = Self::TimeProvider> + Clone;
 	/// Returns a reference to the actual [`LiquidityManager`] object.
-	fn get_lm(&self) -> &LiquidityManager<Self::ES, Self::CM, Self::C>;
+	fn get_lm(&self) -> &LiquidityManager<Self::ES, Self::CM, Self::C, Self::TP>;
 }
 
-impl<ES: Deref + Clone, CM: Deref + Clone, C: Deref + Clone> ALiquidityManager
-	for LiquidityManager<ES, CM, C>
+impl<ES: Deref + Clone, CM: Deref + Clone, C: Deref + Clone, TP: Deref + Clone> ALiquidityManager
+	for LiquidityManager<ES, CM, C, TP>
 where
 	ES::Target: EntropySource,
 	CM::Target: AChannelManager,
 	C::Target: Filter,
+	TP::Target: TimeProvider,
 {
 	type EntropySource = ES::Target;
 	type ES = ES;
 	type AChannelManager = CM::Target;
 	type CM = CM;
 	type Filter = C::Target;
 	type C = C;
-	fn get_lm(&self) -> &LiquidityManager<ES, CM, C> {
+	type TimeProvider = TP::Target;
+	type TP = TP;
+	fn get_lm(&self) -> &LiquidityManager<ES, CM, C, TP> {
 		self
 	}
 }
@@ -135,11 +142,16 @@ where
 /// [`Event::ChannelReady`]: lightning::events::Event::ChannelReady
 /// [`Event::HTLCHandlingFailed`]: lightning::events::Event::HTLCHandlingFailed
 /// [`Event::PaymentForwarded`]: lightning::events::Event::PaymentForwarded
-pub struct LiquidityManager<ES: Deref + Clone, CM: Deref + Clone, C: Deref + Clone>
-where
+pub struct LiquidityManager<
+	ES: Deref + Clone,
+	CM: Deref + Clone,
+	C: Deref + Clone,
+	TP: Deref + Clone,
+> where
 	ES::Target: EntropySource,
 	CM::Target: AChannelManager,
 	C::Target: Filter,
+	TP::Target: TimeProvider,
 {
 	pending_messages: Arc<MessageQueue>,
 	pending_events: Arc<EventQueue>,
@@ -153,25 +165,23 @@ where
 	lsps1_client_handler: Option<LSPS1ClientHandler<ES>>,
 	lsps2_service_handler: Option<LSPS2ServiceHandler<CM>>,
 	lsps2_client_handler: Option<LSPS2ClientHandler<ES>>,
-	lsps5_service_handler: Option<LSPS5ServiceHandler<CM>>,
-	lsps5_client_handler: Option<LSPS5ClientHandler<ES>>,
+	lsps5_service_handler: Option<LSPS5ServiceHandler<CM, TP>>,
+	lsps5_client_handler: Option<LSPS5ClientHandler<ES, TP>>,
 	service_config: Option<LiquidityServiceConfig>,
 	_client_config: Option<LiquidityClientConfig>,
 	best_block: RwLock<Option<BestBlock>>,
 	_chain_source: Option<C>,
 }
 
-impl<ES: Deref + Clone, CM: Deref + Clone, C: Deref + Clone> LiquidityManager<ES, CM, C>
+#[cfg(feature = "time")]
+impl<ES: Deref + Clone, CM: Deref + Clone, C: Deref + Clone>
+	LiquidityManager<ES, CM, C, Arc<DefaultTimeProvider>>
 where
 	ES::Target: EntropySource,
 	CM::Target: AChannelManager,
 	C::Target: Filter,
 {
-	/// Constructor for the [`LiquidityManager`].
-	///
-	/// Sets up the required protocol message handlers based on the given
-	/// [`LiquidityClientConfig`] and [`LiquidityServiceConfig`].
-	#[cfg(feature = "time")]
+	/// Constructor for the [`LiquidityManager`] using the default system clock
 	pub fn new(
 		entropy_source: ES, channel_manager: CM, chain_source: Option<C>,
 		chain_params: Option<ChainParameters>, service_config: Option<LiquidityServiceConfig>,
@@ -188,7 +198,16 @@ where
 			time_provider,
 		)
 	}
+}
 
+impl<ES: Deref + Clone, CM: Deref + Clone, C: Deref + Clone, TP: Deref + Clone>
+	LiquidityManager<ES, CM, C, TP>
+where
+	ES::Target: EntropySource,
+	CM::Target: AChannelManager,
+	C::Target: Filter,
+	TP::Target: TimeProvider,
+{
 	/// Constructor for the [`LiquidityManager`] with a custom time provider.
 	///
 	/// This should be used on non-std platforms where access to the system time is not
@@ -198,9 +217,8 @@ where
 	pub fn new_with_custom_time_provider(
 		entropy_source: ES, channel_manager: CM, chain_source: Option<C>,
 		chain_params: Option<ChainParameters>, service_config: Option<LiquidityServiceConfig>,
-		client_config: Option<LiquidityClientConfig>, time_provider: Arc<dyn TimeProvider>,
-	) -> Self
-where {
+		client_config: Option<LiquidityClientConfig>, time_provider: TP,
+	) -> Self {
 		let pending_messages = Arc::new(MessageQueue::new());
 		let pending_events = Arc::new(EventQueue::new());
 		let ignored_peers = RwLock::new(new_hash_set());
@@ -248,7 +266,7 @@ where {
 		let lsps5_service_handler = service_config.as_ref().and_then(|config| {
 			config.lsps5_service_config.as_ref().map(|config| {
 				if let Some(number) =
-					<LSPS5ServiceHandler<CM> as LSPSProtocolMessageHandler>::PROTOCOL_NUMBER
+					<LSPS5ServiceHandler<CM, TP> as LSPSProtocolMessageHandler>::PROTOCOL_NUMBER
 				{
 					supported_protocols.push(number);
 				}
@@ -369,14 +387,14 @@ where {
 	/// Returns a reference to the LSPS5 client-side handler.
 	///
 	/// The returned hendler allows to initiate the LSPS5 client-side flow. That is, it allows to
-	pub fn lsps5_client_handler(&self) -> Option<&LSPS5ClientHandler<ES>> {
+	pub fn lsps5_client_handler(&self) -> Option<&LSPS5ClientHandler<ES, TP>> {
 		self.lsps5_client_handler.as_ref()
 	}
 
 	/// Returns a reference to the LSPS5 server-side handler.
 	///
 	/// The returned hendler allows to initiate the LSPS5 service-side flow.
-	pub fn lsps5_service_handler(&self) -> Option<&LSPS5ServiceHandler<CM>> {
+	pub fn lsps5_service_handler(&self) -> Option<&LSPS5ServiceHandler<CM, TP>> {
 		self.lsps5_service_handler.as_ref()
 	}
 
@@ -530,12 +548,13 @@ where {
 	}
 }
 
-impl<ES: Deref + Clone + Clone, CM: Deref + Clone, C: Deref + Clone> CustomMessageReader
-	for LiquidityManager<ES, CM, C>
+impl<ES: Deref + Clone, CM: Deref + Clone, C: Deref + Clone, TP: Deref + Clone> CustomMessageReader
+	for LiquidityManager<ES, CM, C, TP>
 where
 	ES::Target: EntropySource,
 	CM::Target: AChannelManager,
 	C::Target: Filter,
+	TP::Target: TimeProvider,
 {
 	type CustomMessage = RawLSPSMessage;
 
@@ -551,12 +570,13 @@ where
 	}
 }
 
-impl<ES: Deref + Clone, CM: Deref + Clone, C: Deref + Clone> CustomMessageHandler
-	for LiquidityManager<ES, CM, C>
+impl<ES: Deref + Clone, CM: Deref + Clone, C: Deref + Clone, TP: Deref + Clone> CustomMessageHandler
+	for LiquidityManager<ES, CM, C, TP>
 where
 	ES::Target: EntropySource,
 	CM::Target: AChannelManager,
 	C::Target: Filter,
+	TP::Target: TimeProvider,
 {
 	fn handle_custom_message(
 		&self, msg: Self::CustomMessage, sender_node_id: PublicKey,
@@ -663,11 +683,13 @@ where
 	}
 }
 
-impl<ES: Deref + Clone, CM: Deref + Clone, C: Deref + Clone> Listen for LiquidityManager<ES, CM, C>
+impl<ES: Deref + Clone, CM: Deref + Clone, C: Deref + Clone, TP: Deref + Clone> Listen
+	for LiquidityManager<ES, CM, C, TP>
 where
 	ES::Target: EntropySource,
 	CM::Target: AChannelManager,
 	C::Target: Filter,
+	TP::Target: TimeProvider,
 {
 	fn filtered_block_connected(
 		&self, header: &bitcoin::block::Header, txdata: &chain::transaction::TransactionData,
@@ -700,11 +722,13 @@ where
 	}
 }
 
-impl<ES: Deref + Clone, CM: Deref + Clone, C: Deref + Clone> Confirm for LiquidityManager<ES, CM, C>
+impl<ES: Deref + Clone, CM: Deref + Clone, C: Deref + Clone, TP: Deref + Clone> Confirm
+	for LiquidityManager<ES, CM, C, TP>
 where
 	ES::Target: EntropySource,
 	CM::Target: AChannelManager,
 	C::Target: Filter,
+	TP::Target: TimeProvider,
 {
 	fn transactions_confirmed(
 		&self, _header: &bitcoin::block::Header, _txdata: &chain::transaction::TransactionData,