Add comments to faucet state

0xPolygonMiden · May 31, 2024 · 0a2aff6 · 0a2aff6
1 parent 15c3a81
commit 0a2aff6
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/bin/faucet/src/state.rs b/bin/faucet/src/state.rs
@@ -6,6 +6,13 @@ use tracing::info;
 
 use crate::{client::FaucetClient, config::FaucetConfig, errors::FaucetError};
 
+// FAUCET STATE
+// ================================================================================================
+
+/// Stores the client and aditional information needed to handle requests.
+///
+/// The state is passed to every mint transaction request so the client is
+/// shared between handler threads.
 #[derive(Clone)]
 pub struct FaucetState {
     pub id: AccountId,