refactor: move EscrowMonitor, GraphNode to common

Signed-off-by: Alexis Asseman <[email protected]>

common/Cargo.toml

@@ -19,6 +19,7 @@ reqwest = "0.11.20"
 secp256k1 = { version = "0.27.0", features = ["recovery"] }
 serde = { version = "1.0.188", features = ["derive"] }
 serde_json = "1.0.107"
+thiserror = "1.0.48"
 tokio = { version = "1.32.0", features = ["full", "macros", "rt"] }
 
 [dev-dependencies]

service/src/escrow_monitor.rs → common/src/escrow_monitor.rs

@@ -10,9 +10,8 @@ use std::collections::HashMap;
 use std::sync::Arc;
 use tokio::sync::RwLock;
 
-use indexer_common::prelude::GraphQLQuery;
-
 use crate::graph_node::GraphNodeInstance;
+use crate::prelude::GraphQLQuery;
 
 #[derive(Debug)]
 struct EscrowMonitorInner {
@@ -23,14 +22,14 @@ struct EscrowMonitorInner {
     sender_accounts: Arc<RwLock<HashMap<Address, U256>>>,
 }
 
-#[cfg_attr(test, faux::create)]
+#[cfg_attr(any(test, feature = "mock"), faux::create)]
 #[derive(Debug, Clone)]
 pub struct EscrowMonitor {
     _monitor_handle: Arc<tokio::task::JoinHandle<()>>,
     inner: Arc<EscrowMonitorInner>,
 }
 
-#[cfg_attr(test, faux::methods)]
+#[cfg_attr(any(test, feature = "mock"), faux::methods)]
 impl EscrowMonitor {
     pub async fn new(
         graph_node: GraphNodeInstance,

service/src/graph_node.rs → common/src/graph_node.rs

@@ -4,9 +4,9 @@
 use std::sync::Arc;
 
 use anyhow::anyhow;
+use ethers::types::Signature;
 use reqwest::{header, Client, Url};
-
-use crate::query_processor::{QueryError, UnattestedQueryResult};
+use serde::{Deserialize, Serialize};
 
 /// Graph node query wrapper.
 ///
@@ -17,6 +17,32 @@ pub struct GraphNodeInstance {
     subgraphs_base_url: Arc<Url>,
 }
 
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct QueryResult {
+    #[serde(rename = "graphQLResponse")]
+    pub graphql_response: String,
+    pub attestation: Option<Signature>,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct UnattestedQueryResult {
+    #[serde(rename = "graphQLResponse")]
+    pub graphql_response: String,
+    pub attestable: bool,
+}
+
+#[derive(Debug, thiserror::Error)]
+pub enum QueryError {
+    #[error(transparent)]
+    Transport(#[from] reqwest::Error),
+    #[error("The subgraph is in a failed state")]
+    IndexingError,
+    #[error("Bad or invalid entity data found in the subgraph: {}", .0.to_string())]
+    BadData(anyhow::Error),
+    #[error("Unknown error: {0}")]
+    Other(anyhow::Error),
+}
+
 impl GraphNodeInstance {
     pub fn new(endpoint: &str) -> GraphNodeInstance {
         let subgraphs_base_url = Url::parse(endpoint)

common/src/lib.rs

@@ -3,6 +3,8 @@
 
 pub mod allocations;
 pub mod attestations;
+pub mod escrow_monitor;
+pub mod graph_node;
 pub mod network_subgraph;
 pub mod signature_verification;
 pub mod types;
@@ -18,6 +20,8 @@ pub mod prelude {
         signer::{create_attestation_signer, AttestationSigner},
         signers::AttestationSigners,
     };
+    pub use super::escrow_monitor::EscrowMonitor;
+    pub use super::graph_node::*;
     pub use super::network_subgraph::NetworkSubgraph;
     pub use super::types::*;
 }

common/src/test_vectors.rs

@@ -223,3 +223,39 @@ pub fn expected_eligible_allocations() -> HashMap<Address, Allocation> {
         ),
     ])
 }
+
+pub const ESCROW_QUERY_RESPONSE: &str = r#"
+    {
+        "data": {
+            "escrowAccounts": [
+                {
+                    "balance": "34",
+                    "totalAmountThawing": "10",
+                    "sender": {
+                        "id": "0x90f8bf6a479f320ead074411a4b0e7944ea8c9c1"
+                    }
+                },
+                {
+                    "balance": "42",
+                    "totalAmountThawing": "0",
+                    "sender": {
+                        "id": "0x22d491bde2303f2f43325b2108d26f1eaba1e32b"
+                    }
+                }
+            ]
+        }
+    }
+"#;
+
+pub fn expected_escrow_accounts() -> HashMap<Address, U256> {
+    HashMap::from([
+        (
+            Address::from_str("0x90f8bf6a479f320ead074411a4b0e7944ea8c9c1").unwrap(),
+            U256::from(24),
+        ),
+        (
+            Address::from_str("0x22d491bde2303f2f43325b2108d26f1eaba1e32b").unwrap(),
+            U256::from(42),
+        ),
+    ])
+}

service/src/config.rs

@@ -6,7 +6,9 @@ use clap::{command, Args, Parser, ValueEnum};
 use alloy_primitives::Address;
 use serde::{Deserialize, Serialize};
 
-use crate::{query_processor::QueryError, util::init_tracing};
+use indexer_common::prelude::QueryError;
+
+use crate::util::init_tracing;
 
 #[derive(Clone, Debug, Parser, Serialize, Deserialize, Default)]
 #[clap(

service/src/main.rs

@@ -9,7 +9,9 @@ use ethereum_types::U256;
 use std::{net::SocketAddr, str::FromStr};
 use tracing::info;
 
-use indexer_common::prelude::{AllocationMonitor, AttestationSigners, NetworkSubgraph};
+use indexer_common::prelude::{
+    AllocationMonitor, AttestationSigners, EscrowMonitor, GraphNodeInstance, NetworkSubgraph,
+};
 
 use util::{package_version, shutdown_signal};
 
@@ -22,8 +24,6 @@ use server::ServerOptions;
 
 mod common;
 mod config;
-mod escrow_monitor;
-mod graph_node;
 mod metrics;
 mod query_processor;
 mod server;
@@ -54,9 +54,8 @@ async fn main() -> Result<(), std::io::Error> {
     let release = package_version().expect("Failed to resolve for release version");
 
     // Initialize graph-node client
-    let graph_node = graph_node::GraphNodeInstance::new(
-        &config.indexer_infrastructure.graph_node_query_endpoint,
-    );
+    let graph_node =
+        GraphNodeInstance::new(&config.indexer_infrastructure.graph_node_query_endpoint);
 
     // Make an instance of network subgraph at either
     // graph_node_query_endpoint/subgraphs/id/network_subgraph_deployment
@@ -97,7 +96,7 @@ async fn main() -> Result<(), std::io::Error> {
     // assume the models are up to date in the service.
     let indexer_management_db = database::connect(&config.postgres).await;
 
-    let escrow_monitor = escrow_monitor::EscrowMonitor::new(
+    let escrow_monitor = EscrowMonitor::new(
         graph_node.clone(),
         config.escrow_subgraph.escrow_subgraph_deployment,
         config.ethereum.indexer_address,

service/src/query_processor.rs

@@ -8,22 +8,8 @@ use tap_core::tap_manager::SignedReceipt;
 
 use indexer_common::prelude::{AttestationSigner, AttestationSigners, SubgraphDeploymentID};
 
-use crate::graph_node::GraphNodeInstance;
 use crate::tap_manager::TapManager;
-
-#[derive(Debug, Clone, Serialize, Deserialize)]
-pub struct QueryResult {
-    #[serde(rename = "graphQLResponse")]
-    pub graphql_response: String,
-    pub attestation: Option<Signature>,
-}
-
-#[derive(Debug, Clone, Serialize, Deserialize)]
-pub struct UnattestedQueryResult {
-    #[serde(rename = "graphQLResponse")]
-    pub graphql_response: String,
-    pub attestable: bool,
-}
+use indexer_common::prelude::{GraphNodeInstance, QueryError, QueryResult, UnattestedQueryResult};
 
 #[derive(Debug, Serialize, Deserialize, PartialEq)]
 pub struct Response<T> {
@@ -47,18 +33,6 @@ pub struct PaidQuery {
     pub receipt: String,
 }
 
-#[derive(Debug, thiserror::Error)]
-pub enum QueryError {
-    #[error(transparent)]
-    Transport(#[from] reqwest::Error),
-    #[error("The subgraph is in a failed state")]
-    IndexingError,
-    #[error("Bad or invalid entity data found in the subgraph: {}", .0.to_string())]
-    BadData(anyhow::Error),
-    #[error("Unknown error: {0}")]
-    Other(anyhow::Error),
-}
-
 #[derive(Debug, Clone)]
 pub struct QueryProcessor {
     graph_node: GraphNodeInstance,

service/src/tap_manager.rs

@@ -7,14 +7,12 @@ use sqlx::{types::BigDecimal, PgPool};
 use std::sync::Arc;
 use tap_core::tap_manager::SignedReceipt;
 
-use indexer_common::prelude::AllocationMonitor;
-
-use crate::{escrow_monitor, query_processor::QueryError};
+use indexer_common::prelude::{AllocationMonitor, EscrowMonitor, QueryError};
 
 #[derive(Clone, Debug)]
 pub struct TapManager {
     allocation_monitor: AllocationMonitor,
-    escrow_monitor: escrow_monitor::EscrowMonitor,
+    escrow_monitor: EscrowMonitor,
     pgpool: PgPool,
     domain_separator: Arc<Eip712Domain>,
 }
@@ -23,7 +21,7 @@ impl TapManager {
     pub fn new(
         pgpool: PgPool,
         allocation_monitor: AllocationMonitor,
-        escrow_monitor: escrow_monitor::EscrowMonitor,
+        escrow_monitor: EscrowMonitor,
         domain_separator: Eip712Domain,
     ) -> Self {
         Self {
@@ -175,7 +173,7 @@ mod test {
         faux::when!(mock_allocation_monitor.is_allocation_eligible).then_return(true);
 
         // Mock escrow monitor
-        let mut mock_escrow_monitor = escrow_monitor::EscrowMonitor::faux();
+        let mut mock_escrow_monitor = EscrowMonitor::faux();
         faux::when!(mock_escrow_monitor.is_sender_eligible).then_return(true);
 
         let tap_manager = TapManager::new(