docs: monitor types

Signed-off-by: Gustavo Inacio <[email protected]>

Author: gusinacio

crates/monitor/src/allocations.rs

@@ -12,6 +12,7 @@ use std::{
 };
 use tokio::sync::watch::Receiver;
 
+/// Receiver of Map between allocation id and allocation struct
 pub type AllocationWatcher = Receiver<HashMap<Address, Allocation>>;
 
 /// An always up-to-date list of an indexer's active and recently closed allocations.

crates/monitor/src/attestation.rs

@@ -11,6 +11,7 @@ use thegraph_core::{Address, ChainId};
 use tokio::sync::watch::Receiver;
 use tracing::warn;
 
+/// Receiver for Map of allocation id and attestation signer
 pub type AttestationWatcher = Receiver<HashMap<Address, AttestationSigner>>;
 
 /// An always up-to-date list of attestation signers, one for each of the indexer's allocations.

crates/monitor/src/deployment_to_allocation.rs

@@ -5,15 +5,17 @@ use std::collections::HashMap;
 use thegraph_core::{Address, DeploymentId};
 use tokio::sync::watch::Receiver;
 
-use indexer_allocation::Allocation;
 use indexer_watcher::map_watcher;
 
+use crate::AllocationWatcher;
+
+/// Watcher for Map of deployment id and allocation id
 pub type DeploymentToAllocationWatcher = Receiver<HashMap<DeploymentId, Address>>;
 
 /// Watcher of indexer allocation
 /// returning a map of subgraph deployment to allocation id
 pub fn deployment_to_allocation(
-    indexer_allocations_rx: Receiver<HashMap<Address, Allocation>>,
+    indexer_allocations_rx: AllocationWatcher,
 ) -> DeploymentToAllocationWatcher {
     map_watcher(indexer_allocations_rx, move |allocation| {
         allocation

crates/monitor/src/dispute_manager.rs

@@ -9,8 +9,10 @@ use indexer_watcher::new_watcher;
 use std::time::Duration;
 use tokio::sync::watch::Receiver;
 
+/// Watcher for Dispute Manager Address
 pub type DisputeManagerWatcher = Receiver<Address>;
 
+/// Monitors the subgraph for dispute manager address
 pub async fn dispute_manager(
     network_subgraph: &'static SubgraphClient,
     interval: Duration,