From ef5b4fdf9f226778ffe09aa7616724e08a7656cd Mon Sep 17 00:00:00 2001
From: thesimplekid <tsk@thesimplekid.com>
Date: Mon, 22 Jul 2024 16:38:21 +0100
Subject: [PATCH] chore: enforce fake wallet docs

---
 crates/cdk-fake-wallet/src/error.rs |  8 ++++++--
 crates/cdk-fake-wallet/src/lib.rs   | 16 +++++++++-------
 2 files changed, 15 insertions(+), 9 deletions(-)

diff --git a/crates/cdk-fake-wallet/src/error.rs b/crates/cdk-fake-wallet/src/error.rs
index 0629968e..036d1cab 100644
--- a/crates/cdk-fake-wallet/src/error.rs
+++ b/crates/cdk-fake-wallet/src/error.rs
@@ -1,5 +1,8 @@
+//! Fake Wallet Error
+
 use thiserror::Error;
 
+/// Fake Wallet Error
 #[derive(Debug, Error)]
 pub enum Error {
     /// Invoice amount not defined
@@ -8,8 +11,9 @@ pub enum Error {
     /// Unknown invoice
     #[error("Unknown invoice")]
     UnknownInvoice,
-    #[error("`{0}`")]
-    Custom(String),
+    /// Unknown invoice
+    #[error("No channel receiver")]
+    NoReceiver,
 }
 
 impl From<Error> for cdk::cdk_lightning::Error {
diff --git a/crates/cdk-fake-wallet/src/lib.rs b/crates/cdk-fake-wallet/src/lib.rs
index 1bf0b118..0ec3a097 100644
--- a/crates/cdk-fake-wallet/src/lib.rs
+++ b/crates/cdk-fake-wallet/src/lib.rs
@@ -1,4 +1,9 @@
-//! CDK lightning backend for CLN
+//! CDK Fake LN Backend
+//!
+//! Used for testing where quotes are auto filled
+
+#![warn(missing_docs)]
+#![warn(rustdoc::bare_urls)]
 
 use std::pin::Pin;
 use std::sync::Arc;
@@ -26,6 +31,7 @@ use uuid::Uuid;
 
 pub mod error;
 
+/// Fake Wallet
 #[derive(Clone)]
 pub struct FakeWallet {
     fee_reserve: FeeReserve,
@@ -36,6 +42,7 @@ pub struct FakeWallet {
 }
 
 impl FakeWallet {
+    /// Creat new [`FakeWallet`]
     pub fn new(
         fee_reserve: FeeReserve,
         mint_settings: MintMeltSettings,
@@ -69,12 +76,7 @@ impl MintLightning for FakeWallet {
     async fn wait_any_invoice(
         &self,
     ) -> Result<Pin<Box<dyn Stream<Item = String> + Send>>, Self::Err> {
-        let receiver = self
-            .receiver
-            .lock()
-            .await
-            .take()
-            .ok_or(Error::Custom("No reeiver".to_string()))?;
+        let receiver = self.receiver.lock().await.take().ok_or(Error::NoReceiver)?;
         let receiver_stream = ReceiverStream::new(receiver);
         Ok(Box::pin(receiver_stream.map(|label| label)))
     }