fix docs, extract request_id util, and remove logger

Author: johncantrell97

.github/workflows/build.yml

@@ -31,8 +31,10 @@ jobs:
       - name: Pin serde for MSRV
         if: matrix.msrv
         run: cargo update -p serde --precise "1.0.156" --verbose
+      - name: Cargo check
+        run: cargo check --release
       - name: Check documentation
-        run: cargo check --release && cargo doc --release
+        run: cargo doc --release
       - name: Build on Rust ${{ matrix.toolchain }}
         run: cargo build --verbose --color always
       - name: Check formatting

Cargo.toml

@@ -8,7 +8,7 @@ description = "Types and primitives to integrate a spec-compliant LSP with an LD
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-lightning = { git = "https://github.com/lightningdevkit/rust-lightning.git", rev = "498f2331459d8031031ef151a44c90d700aa8c7e", features = ["max_level_trace"] }
+lightning = { git = "https://github.com/lightningdevkit/rust-lightning.git", rev = "498f2331459d8031031ef151a44c90d700aa8c7e", features = ["max_level_trace", "std"] }
 lightning-invoice = { git = "https://github.com/lightningdevkit/rust-lightning.git", rev = "498f2331459d8031031ef151a44c90d700aa8c7e" }
 lightning-net-tokio = { git = "https://github.com/lightningdevkit/rust-lightning.git", rev = "498f2331459d8031031ef151a44c90d700aa8c7e" }
 

src/events.rs

@@ -7,11 +7,11 @@
 // You may not use this file except in accordance with one or both of these
 // licenses.
 
-//! Events are returned from various bits in the library which indicate some action must be taken
+//! Events are surfaced by the library when some action must be taken
 //! by the client.
 //!
-//! Because we don't have a built-in runtime, it's up to the client to call events at a time in the
-//! future.
+//! Because we don't have a built-in runtime, it's up to the client to
+//! regularly poll [`crate::LSPManager::get_and_clear_pending_events()`]
 use bitcoin::secp256k1::PublicKey;
 
 /// An Event which you should probably take some action in response to.

src/transport/message_handler.rs

@@ -4,11 +4,11 @@ use crate::transport::protocol::LSPS0MessageHandler;
 
 use bitcoin::secp256k1::PublicKey;
 use lightning::ln::features::{InitFeatures, NodeFeatures};
+use lightning::ln::msgs::{ErrorAction, LightningError};
 use lightning::ln::peer_handler::CustomMessageHandler;
 use lightning::ln::wire::CustomMessageReader;
-use lightning::log_info;
 use lightning::sign::EntropySource;
-use lightning::util::logger::Logger;
+use lightning::util::logger::Level;
 use lightning::util::ser::Readable;
 use std::collections::HashMap;
 use std::convert::TryFrom;
@@ -27,7 +27,7 @@ pub(crate) trait ProtocolMessageHandler {
 
 	fn handle_message(
 		&self, message: Self::ProtocolMessage, counterparty_node_id: &PublicKey,
-	) -> Result<(), lightning::ln::msgs::LightningError>;
+	) -> Result<(), LightningError>;
 }
 
 /// Configuration for the LSPManager
@@ -38,40 +38,36 @@ pub struct LSPConfig {
 }
 
 /// The main interface into LSP functionality
-pub struct LSPManager<L: Deref, ES: Deref>
+pub struct LSPManager<ES: Deref>
 where
-	L::Target: Logger,
 	ES::Target: EntropySource,
 {
-	logger: L,
 	pending_messages: Arc<Mutex<Vec<(PublicKey, LSPSMessage)>>>,
 	pending_events: Arc<Mutex<Vec<Event>>>,
 	request_id_to_method_map: Mutex<HashMap<String, String>>,
 	lsps0_message_handler: LSPS0MessageHandler<ES>,
 	config: LSPConfig,
 }
 
-impl<L: Deref, ES: Deref> LSPManager<L, ES>
+impl<ES: Deref> LSPManager<ES>
 where
-	L::Target: Logger,
 	ES::Target: EntropySource,
 {
 	/// Constructor for the LSPManager
 	///
 	/// Sets up all required protocol message handlers based on configuration passed in
-	pub fn new(logger: L, entropy_source: ES, config: LSPConfig) -> Self {
+	pub fn new(entropy_source: ES, config: LSPConfig) -> Self {
 		let pending_messages = Arc::new(Mutex::new(vec![]));
 		let pending_events = Arc::new(Mutex::new(vec![]));
 
 		let lsps0_message_handler = LSPS0MessageHandler::new(
 			entropy_source,
 			vec![],
-			pending_messages.clone(),
-			pending_events.clone(),
+			Arc::clone(&pending_messages),
+			Arc::clone(&pending_events),
 		);
 
 		Self {
-			logger,
 			pending_messages,
 			pending_events,
 			request_id_to_method_map: Mutex::new(HashMap::new()),
@@ -87,7 +83,7 @@ where
 		self.lsps0_message_handler.list_protocols(counterparty_node_id)
 	}
 
-	/// Needs to be polled regularly to surface events generated by the various protocols
+	/// Needs to be polled regularly to surface events generated by the various message handlers
 	pub fn get_and_clear_pending_events(&self) -> Vec<Event> {
 		self.pending_events.lock().unwrap().drain(..).collect()
 	}
@@ -97,7 +93,7 @@ where
 	) -> Result<(), lightning::ln::msgs::LightningError> {
 		match msg {
 			LSPSMessage::Invalid => {
-				log_info!(self.logger, "Received invalid message from {:?}", sender_node_id);
+				return Err(LightningError { err: format!("{} did not understand a message we previously sent, maybe they don't support a protocol we are trying to use?", sender_node_id), action: ErrorAction::IgnoreAndLog(Level::Error)});
 			}
 			LSPSMessage::LSPS0(msg) => {
 				self.lsps0_message_handler.handle_message(msg, sender_node_id)?;
@@ -112,9 +108,8 @@ where
 	}
 }
 
-impl<L: Deref, ES: Deref> CustomMessageReader for LSPManager<L, ES>
+impl<ES: Deref> CustomMessageReader for LSPManager<ES>
 where
-	L::Target: Logger,
 	ES::Target: EntropySource,
 {
 	type CustomMessage = RawLSPSMessage;
@@ -129,9 +124,8 @@ where
 	}
 }
 
-impl<L: Deref, ES: Deref> CustomMessageHandler for LSPManager<L, ES>
+impl<ES: Deref> CustomMessageHandler for LSPManager<ES>
 where
-	L::Target: Logger,
 	ES::Target: EntropySource,
 {
 	fn handle_custom_message(

src/transport/protocol.rs

@@ -35,14 +35,9 @@ where
 		Self { entropy_source, protocols, pending_messages, pending_events }
 	}
 
-	fn generate_request_id(&self) -> RequestId {
-		let bytes = self.entropy_source.get_secure_random_bytes();
-		RequestId(utils::hex_str(&bytes[0..16]))
-	}
-
 	pub fn list_protocols(&self, counterparty_node_id: PublicKey) {
 		let msg = LSPS0Message::Request(
-			self.generate_request_id(),
+			utils::generate_request_id(&self.entropy_source),
 			LSPS0Request::ListProtocols(ListProtocolsRequest {}),
 		);
 

src/utils.rs

@@ -1,5 +1,16 @@
 use bitcoin::secp256k1::PublicKey;
-use std::fmt::Write;
+use lightning::sign::EntropySource;
+use std::{fmt::Write, ops::Deref};
+
+use crate::transport::msgs::RequestId;
+
+pub(crate) fn generate_request_id<ES: Deref>(entropy_source: &ES) -> RequestId
+where
+	ES::Target: EntropySource,
+{
+	let bytes = entropy_source.get_secure_random_bytes();
+	RequestId(hex_str(&bytes[0..16]))
+}
 
 #[inline]
 pub fn hex_str(value: &[u8]) -> String {