Expose ListProtocolsResponse event

Author: tnull

src/events.rs

@@ -15,6 +15,7 @@
 //!
 //! [`LiquidityManager::get_and_clear_pending_events`]: crate::LiquidityManager::get_and_clear_pending_events
 
+use crate::lsps0;
 #[cfg(lsps1)]
 use crate::lsps1;
 use crate::lsps2;
@@ -78,6 +79,8 @@ impl EventQueue {
 /// An event which you should probably take some action in response to.
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub enum Event {
+	/// An LSPS0 client event.
+	LSPS0Client(lsps0::event::LSPS0ClientEvent),
 	/// An LSPS1 (Channel Request) client event.
 	#[cfg(lsps1)]
 	LSPS1Client(lsps1::event::LSPS1ClientEvent),

src/lsps0/client.rs

@@ -4,6 +4,8 @@
 //! specifcation](https://github.com/BitcoinAndLightningLayerSpecs/lsp/tree/main/LSPS0) for more
 //! information.
 
+use crate::events::{Event, EventQueue};
+use crate::lsps0::event::LSPS0ClientEvent;
 use crate::lsps0::msgs::{
 	LSPS0Message, LSPS0Request, LSPS0Response, LSPSMessage, ListProtocolsRequest,
 	ListProtocolsResponse, ProtocolMessageHandler, ResponseError,
@@ -27,6 +29,7 @@ where
 {
 	entropy_source: ES,
 	pending_messages: Arc<Mutex<Vec<(PublicKey, LSPSMessage)>>>,
+	pending_events: Arc<EventQueue>,
 }
 
 impl<ES: Deref> LSPS0ClientHandler<ES>
@@ -36,8 +39,9 @@ where
 	/// Returns a new instance of [`LSPS0ClientHandler`].
 	pub(crate) fn new(
 		entropy_source: ES, pending_messages: Arc<Mutex<Vec<(PublicKey, LSPSMessage)>>>,
+		pending_events: Arc<EventQueue>,
 	) -> Self {
-		Self { entropy_source, pending_messages }
+		Self { entropy_source, pending_messages, pending_events }
 	}
 
 	/// Calls LSPS0's `list_protocols`.
@@ -59,10 +63,18 @@ where
 	}
 
 	fn handle_response(
-		&self, response: LSPS0Response, _counterparty_node_id: &PublicKey,
+		&self, response: LSPS0Response, counterparty_node_id: &PublicKey,
 	) -> Result<(), LightningError> {
 		match response {
-			LSPS0Response::ListProtocols(ListProtocolsResponse { protocols: _ }) => Ok(()),
+			LSPS0Response::ListProtocols(ListProtocolsResponse { protocols }) => {
+				self.pending_events.enqueue(Event::LSPS0Client(
+					LSPS0ClientEvent::ListProtocolsResponse {
+						counterparty_node_id: *counterparty_node_id,
+						protocols,
+					},
+				));
+				Ok(())
+			}
 			LSPS0Response::ListProtocolsError(ResponseError { code, message, data, .. }) => {
 				Err(LightningError {
 					err: format!(
@@ -121,9 +133,14 @@ mod tests {
 	#[test]
 	fn test_list_protocols() {
 		let pending_messages = Arc::new(Mutex::new(vec![]));
-
-		let lsps0_handler =
-			Arc::new(LSPS0ClientHandler::new(Arc::new(TestEntropy {}), pending_messages.clone()));
+		let entropy_source = Arc::new(TestEntropy {});
+		let event_queue = Arc::new(EventQueue::new());
+
+		let lsps0_handler = Arc::new(LSPS0ClientHandler::new(
+			entropy_source,
+			Arc::clone(&pending_messages),
+			event_queue,
+		));
 
 		let counterparty_node_id = utils::parse_pubkey(
 			"027100442c3b79f606f80f322d98d499eefcb060599efc5d4ecb00209c2cb54190",

src/lsps0/event.rs

@@ -0,0 +1,25 @@
+// This file is Copyright its original authors, visible in version control
+// history.
+//
+// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
+// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
+// You may not use this file except in accordance with one or both of these
+// licenses.
+
+//! Contains LSPS0 event types
+
+use crate::prelude::Vec;
+use bitcoin::secp256k1::PublicKey;
+
+/// An event which an LSPS0 client may want to take some action in response to.
+#[derive(Clone, Debug, PartialEq, Eq)]
+pub enum LSPS0ClientEvent {
+	/// Information from the LSP about the protocols they support.
+	ListProtocolsResponse {
+		/// The node id of the LSP.
+		counterparty_node_id: PublicKey,
+		/// A list of supported protocols.
+		protocols: Vec<u16>,
+	},
+}

src/lsps0/mod.rs

@@ -10,5 +10,6 @@
 //! Types and primitives that implement the LSPS0: Transport Layer specification.
 
 pub mod client;
+pub mod event;
 pub mod msgs;
 pub mod service;

src/lsps2/client.rs

@@ -9,12 +9,11 @@
 
 //! Contains the main LSPS2 client object, [`LSPS2ClientHandler`].
 
-use crate::events::EventQueue;
-use crate::lsps0::msgs::{LSPSMessage, ProtocolMessageHandler, RequestId};
+use crate::events::{Event, EventQueue};
+use crate::lsps0::msgs::{LSPSMessage, ProtocolMessageHandler, RequestId, ResponseError};
 use crate::lsps2::event::LSPS2ClientEvent;
 use crate::prelude::{HashMap, String, ToString, Vec};
 use crate::sync::{Arc, Mutex, RwLock};
-use crate::{events::Event, lsps0::msgs::ResponseError};
 
 use lightning::ln::msgs::{ErrorAction, LightningError};
 use lightning::ln::peer_handler::APeerManager;

src/manager.rs

@@ -126,8 +126,11 @@ where {
 		let pending_messages = Arc::new(Mutex::new(vec![]));
 		let pending_events = Arc::new(EventQueue::new());
 
-		let lsps0_client_handler =
-			LSPS0ClientHandler::new(entropy_source.clone(), Arc::clone(&pending_messages));
+		let lsps0_client_handler = LSPS0ClientHandler::new(
+			entropy_source.clone(),
+			Arc::clone(&pending_messages),
+			Arc::clone(&pending_events),
+		);
 
 		let lsps0_service_handler = if service_config.is_some() {
 			Some(LSPS0ServiceHandler::new(vec![], Arc::clone(&pending_messages)))