Merge pull request #81 from tnull/2024-01-drop-message-queue-trait

tnull · web-flow · commit 60714651e293 · 2024-01-05T08:50:07.000+01:00
Drop `MessageQueue` trait and rename `DefaultMessageQueue`
diff --git a/src/lsps0/client.rs b/src/lsps0/client.rs
@@ -23,24 +23,22 @@ use bitcoin::secp256k1::PublicKey;
 use core::ops::Deref;
 
 /// A message handler capable of sending and handling LSPS0 messages.
-pub struct LSPS0ClientHandler<ES: Deref, MQ: Deref>
+pub struct LSPS0ClientHandler<ES: Deref>
 where
 	ES::Target: EntropySource,
-	MQ::Target: MessageQueue,
 {
 	entropy_source: ES,
-	pending_messages: MQ,
+	pending_messages: Arc<MessageQueue>,
 	pending_events: Arc<EventQueue>,
 }
 
-impl<ES: Deref, MQ: Deref> LSPS0ClientHandler<ES, MQ>
+impl<ES: Deref> LSPS0ClientHandler<ES>
 where
 	ES::Target: EntropySource,
-	MQ::Target: MessageQueue,
 {
 	/// Returns a new instance of [`LSPS0ClientHandler`].
 	pub(crate) fn new(
-		entropy_source: ES, pending_messages: MQ, pending_events: Arc<EventQueue>,
+		entropy_source: ES, pending_messages: Arc<MessageQueue>, pending_events: Arc<EventQueue>,
 	) -> Self {
 		Self { entropy_source, pending_messages, pending_events }
 	}
@@ -85,10 +83,9 @@ where
 	}
 }
 
-impl<ES: Deref, MQ: Deref> ProtocolMessageHandler for LSPS0ClientHandler<ES, MQ>
+impl<ES: Deref> ProtocolMessageHandler for LSPS0ClientHandler<ES>
 where
 	ES::Target: EntropySource,
-	MQ::Target: MessageQueue,
 {
 	type ProtocolMessage = LSPS0Message;
 	const PROTOCOL_NUMBER: Option<u16> = None;
@@ -118,13 +115,13 @@ mod tests {
 	use alloc::sync::Arc;
 
 	use crate::lsps0::msgs::{LSPSMessage, RequestId};
-	use crate::tests::utils::{TestEntropy, TestMessageQueue};
+	use crate::tests::utils::TestEntropy;
 
 	use super::*;
 
 	#[test]
 	fn test_list_protocols() {
-		let pending_messages = Arc::new(TestMessageQueue::new());
+		let pending_messages = Arc::new(MessageQueue::new());
 		let entropy_source = Arc::new(TestEntropy {});
 		let event_queue = Arc::new(EventQueue::new());
 
diff --git a/src/lsps0/service.rs b/src/lsps0/service.rs
@@ -19,29 +19,22 @@ use crate::lsps0::msgs::{
 };
 use crate::message_queue::MessageQueue;
 use crate::prelude::Vec;
+use crate::sync::Arc;
 
 use lightning::ln::msgs::{ErrorAction, LightningError};
 use lightning::util::logger::Level;
 
 use bitcoin::secp256k1::PublicKey;
 
-use core::ops::Deref;
-
 /// The main server-side object allowing to send and receive LSPS0 messages.
-pub struct LSPS0ServiceHandler<MQ: Deref>
-where
-	MQ::Target: MessageQueue,
-{
-	pending_messages: MQ,
+pub struct LSPS0ServiceHandler {
+	pending_messages: Arc<MessageQueue>,
 	protocols: Vec<u16>,
 }
 
-impl<MQ: Deref> LSPS0ServiceHandler<MQ>
-where
-	MQ::Target: MessageQueue,
-{
+impl LSPS0ServiceHandler {
 	/// Returns a new instance of [`LSPS0ServiceHandler`].
-	pub(crate) fn new(protocols: Vec<u16>, pending_messages: MQ) -> Self {
+	pub(crate) fn new(protocols: Vec<u16>, pending_messages: Arc<MessageQueue>) -> Self {
 		Self { protocols, pending_messages }
 	}
 
@@ -63,10 +56,7 @@ where
 	}
 }
 
-impl<MQ: Deref> ProtocolMessageHandler for LSPS0ServiceHandler<MQ>
-where
-	MQ::Target: MessageQueue,
-{
+impl ProtocolMessageHandler for LSPS0ServiceHandler {
 	type ProtocolMessage = LSPS0Message;
 	const PROTOCOL_NUMBER: Option<u16> = None;
 
@@ -92,7 +82,6 @@ where
 mod tests {
 
 	use crate::lsps0::msgs::{LSPSMessage, ListProtocolsRequest};
-	use crate::tests::utils::TestMessageQueue;
 	use crate::utils;
 	use alloc::string::ToString;
 	use alloc::sync::Arc;
@@ -102,7 +91,7 @@ mod tests {
 	#[test]
 	fn test_handle_list_protocols_request() {
 		let protocols: Vec<u16> = vec![];
-		let pending_messages = Arc::new(TestMessageQueue::new());
+		let pending_messages = Arc::new(MessageQueue::new());
 
 		let lsps0_handler = Arc::new(LSPS0ServiceHandler::new(protocols, pending_messages.clone()));
 
diff --git a/src/lsps1/client.rs b/src/lsps1/client.rs
@@ -216,32 +216,30 @@ impl PeerState {
 }
 
 /// The main object allowing to send and receive LSPS1 messages.
-pub struct LSPS1ClientHandler<ES: Deref, CM: Deref + Clone, MQ: Deref, C: Deref>
+pub struct LSPS1ClientHandler<ES: Deref, CM: Deref + Clone, C: Deref>
 where
 	ES::Target: EntropySource,
 	CM::Target: AChannelManager,
-	MQ::Target: MessageQueue,
 	C::Target: Filter,
 {
 	entropy_source: ES,
 	channel_manager: CM,
 	chain_source: Option<C>,
-	pending_messages: MQ,
+	pending_messages: Arc<MessageQueue>,
 	pending_events: Arc<EventQueue>,
 	per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
 	config: LSPS1ClientConfig,
 }
 
-impl<ES: Deref, CM: Deref + Clone, MQ: Deref, C: Deref> LSPS1ClientHandler<ES, CM, MQ, C>
+impl<ES: Deref, CM: Deref + Clone, C: Deref> LSPS1ClientHandler<ES, CM, C>
 where
 	ES::Target: EntropySource,
 	CM::Target: AChannelManager,
-	MQ::Target: MessageQueue,
 	C::Target: Filter,
 	ES::Target: EntropySource,
 {
 	pub(crate) fn new(
-		entropy_source: ES, pending_messages: MQ, pending_events: Arc<EventQueue>,
+		entropy_source: ES, pending_messages: Arc<MessageQueue>, pending_events: Arc<EventQueue>,
 		channel_manager: CM, chain_source: Option<C>, config: LSPS1ClientConfig,
 	) -> Self {
 		Self {
@@ -609,12 +607,11 @@ where
 	}
 }
 
-impl<ES: Deref, CM: Deref + Clone, MQ: Deref, C: Deref> ProtocolMessageHandler
-	for LSPS1ClientHandler<ES, CM, MQ, C>
+impl<ES: Deref, CM: Deref + Clone, C: Deref> ProtocolMessageHandler
+	for LSPS1ClientHandler<ES, CM, C>
 where
 	ES::Target: EntropySource,
 	CM::Target: AChannelManager,
-	MQ::Target: MessageQueue,
 	C::Target: Filter,
 {
 	type ProtocolMessage = LSPS1Message;
diff --git a/src/lsps1/service.rs b/src/lsps1/service.rs
@@ -136,32 +136,30 @@ impl PeerState {
 }
 
 /// The main object allowing to send and receive LSPS1 messages.
-pub struct LSPS1ServiceHandler<ES: Deref, CM: Deref + Clone, MQ: Deref, C: Deref>
+pub struct LSPS1ServiceHandler<ES: Deref, CM: Deref + Clone, C: Deref>
 where
 	ES::Target: EntropySource,
 	CM::Target: AChannelManager,
-	MQ::Target: MessageQueue,
 	C::Target: Filter,
 {
 	entropy_source: ES,
 	channel_manager: CM,
 	chain_source: Option<C>,
-	pending_messages: MQ,
+	pending_messages: Arc<MessageQueue>,
 	pending_events: Arc<EventQueue>,
 	per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
 	config: LSPS1ServiceConfig,
 }
 
-impl<ES: Deref, CM: Deref + Clone, MQ: Deref, C: Deref> LSPS1ServiceHandler<ES, CM, MQ, C>
+impl<ES: Deref, CM: Deref + Clone, C: Deref> LSPS1ServiceHandler<ES, CM, C>
 where
 	ES::Target: EntropySource,
 	CM::Target: AChannelManager,
-	MQ::Target: MessageQueue,
 	C::Target: Filter,
 	ES::Target: EntropySource,
 {
 	pub(crate) fn new(
-		entropy_source: ES, pending_messages: MQ, pending_events: Arc<EventQueue>,
+		entropy_source: ES, pending_messages: Arc<MessageQueue>, pending_events: Arc<EventQueue>,
 		channel_manager: CM, chain_source: Option<C>, config: LSPS1ServiceConfig,
 	) -> Self {
 		Self {
@@ -422,12 +420,11 @@ where
 	}
 }
 
-impl<ES: Deref, CM: Deref + Clone, MQ: Deref, C: Deref> ProtocolMessageHandler
-	for LSPS1ServiceHandler<ES, CM, MQ, C>
+impl<ES: Deref, CM: Deref + Clone, C: Deref> ProtocolMessageHandler
+	for LSPS1ServiceHandler<ES, CM, C>
 where
 	ES::Target: EntropySource,
 	CM::Target: AChannelManager,
-	MQ::Target: MessageQueue,
 	C::Target: Filter,
 {
 	type ProtocolMessage = LSPS1Message;
diff --git a/src/lsps2/client.rs b/src/lsps2/client.rs
@@ -200,26 +200,24 @@ impl PeerState {
 }
 
 /// The main object allowing to send and receive LSPS2 messages.
-pub struct LSPS2ClientHandler<ES: Deref, MQ: Deref>
+pub struct LSPS2ClientHandler<ES: Deref>
 where
 	ES::Target: EntropySource,
-	MQ::Target: MessageQueue,
 {
 	entropy_source: ES,
-	pending_messages: MQ,
+	pending_messages: Arc<MessageQueue>,
 	pending_events: Arc<EventQueue>,
 	per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
 	_config: LSPS2ClientConfig,
 }
 
-impl<ES: Deref, MQ: Deref> LSPS2ClientHandler<ES, MQ>
+impl<ES: Deref> LSPS2ClientHandler<ES>
 where
 	ES::Target: EntropySource,
-	MQ::Target: MessageQueue,
 {
 	/// Constructs an `LSPS2ClientHandler`.
 	pub(crate) fn new(
-		entropy_source: ES, pending_messages: MQ, pending_events: Arc<EventQueue>,
+		entropy_source: ES, pending_messages: Arc<MessageQueue>, pending_events: Arc<EventQueue>,
 		config: LSPS2ClientConfig,
 	) -> Self {
 		Self {
@@ -592,10 +590,9 @@ where
 	}
 }
 
-impl<ES: Deref, MQ: Deref> ProtocolMessageHandler for LSPS2ClientHandler<ES, MQ>
+impl<ES: Deref> ProtocolMessageHandler for LSPS2ClientHandler<ES>
 where
 	ES::Target: EntropySource,
-	MQ::Target: MessageQueue,
 {
 	type ProtocolMessage = LSPS2Message;
 	const PROTOCOL_NUMBER: Option<u16> = Some(2);
diff --git a/src/lsps2/service.rs b/src/lsps2/service.rs
@@ -268,27 +268,25 @@ impl PeerState {
 }
 
 /// The main object allowing to send and receive LSPS2 messages.
-pub struct LSPS2ServiceHandler<CM: Deref + Clone, MQ: Deref>
+pub struct LSPS2ServiceHandler<CM: Deref + Clone>
 where
 	CM::Target: AChannelManager,
-	MQ::Target: MessageQueue,
 {
 	channel_manager: CM,
-	pending_messages: MQ,
+	pending_messages: Arc<MessageQueue>,
 	pending_events: Arc<EventQueue>,
 	per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
 	peer_by_intercept_scid: RwLock<HashMap<u64, PublicKey>>,
 	config: LSPS2ServiceConfig,
 }
 
-impl<CM: Deref + Clone, MQ: Deref> LSPS2ServiceHandler<CM, MQ>
+impl<CM: Deref + Clone> LSPS2ServiceHandler<CM>
 where
 	CM::Target: AChannelManager,
-	MQ::Target: MessageQueue,
 {
 	/// Constructs a `LSPS2ServiceHandler`.
 	pub(crate) fn new(
-		pending_messages: MQ, pending_events: Arc<EventQueue>, channel_manager: CM,
+		pending_messages: Arc<MessageQueue>, pending_events: Arc<EventQueue>, channel_manager: CM,
 		config: LSPS2ServiceConfig,
 	) -> Self {
 		Self {
@@ -771,10 +769,9 @@ where
 	}
 }
 
-impl<CM: Deref + Clone, MQ: Deref> ProtocolMessageHandler for LSPS2ServiceHandler<CM, MQ>
+impl<CM: Deref + Clone> ProtocolMessageHandler for LSPS2ServiceHandler<CM>
 where
 	CM::Target: AChannelManager,
-	MQ::Target: MessageQueue,
 {
 	type ProtocolMessage = LSPS2Message;
 	const PROTOCOL_NUMBER: Option<u16> = Some(2);
diff --git a/src/manager.rs b/src/manager.rs
diff --git a/src/message_queue.rs b/src/message_queue.rs
diff --git a/src/tests/utils.rs b/src/tests/utils.rs

Original file line number	Diff line number	Diff line change
`@@ -200,26 +200,24 @@ impl PeerState {`
`200`	`200`	`}`
`201`	`201`
`202`	`202`	`/// The main object allowing to send and receive LSPS2 messages.`
`203`		`-pub struct LSPS2ClientHandler<ES: Deref, MQ: Deref>`
	`203`	`+pub struct LSPS2ClientHandler<ES: Deref>`
`204`	`204`	`where`
`205`	`205`	`ES::Target: EntropySource,`
`206`		`- MQ::Target: MessageQueue,`
`207`	`206`	`{`
`208`	`207`	`entropy_source: ES,`
`209`		`- pending_messages: MQ,`
	`208`	`+ pending_messages: Arc<MessageQueue>,`
`210`	`209`	`pending_events: Arc<EventQueue>,`
`211`	`210`	`per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,`
`212`	`211`	`_config: LSPS2ClientConfig,`
`213`	`212`	`}`
`214`	`213`
`215`		`-impl<ES: Deref, MQ: Deref> LSPS2ClientHandler<ES, MQ>`
	`214`	`+impl<ES: Deref> LSPS2ClientHandler<ES>`
`216`	`215`	`where`
`217`	`216`	`ES::Target: EntropySource,`
`218`		`- MQ::Target: MessageQueue,`
`219`	`217`	`{`
`220`	`218`	/// Constructs an `LSPS2ClientHandler`.
`221`	`219`	`pub(crate) fn new(`
`222`		`- entropy_source: ES, pending_messages: MQ, pending_events: Arc<EventQueue>,`
	`220`	`+ entropy_source: ES, pending_messages: Arc<MessageQueue>, pending_events: Arc<EventQueue>,`
`223`	`221`	`config: LSPS2ClientConfig,`
`224`	`222`	`) -> Self {`
`225`	`223`	`Self {`
`@@ -592,10 +590,9 @@ where`
`592`	`590`	`}`
`593`	`591`	`}`
`594`	`592`
`595`		`-impl<ES: Deref, MQ: Deref> ProtocolMessageHandler for LSPS2ClientHandler<ES, MQ>`
	`593`	`+impl<ES: Deref> ProtocolMessageHandler for LSPS2ClientHandler<ES>`
`596`	`594`	`where`
`597`	`595`	`ES::Target: EntropySource,`
`598`		`- MQ::Target: MessageQueue,`
`599`	`596`	`{`
`600`	`597`	`type ProtocolMessage = LSPS2Message;`
`601`	`598`	`const PROTOCOL_NUMBER: Option<u16> = Some(2);`