refactor: move tap from common to service (#495)

gusinacio · web-flow · commit 411fdb88d07d · 2024-11-19T14:07:42.000-03:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/common/Cargo.toml b/crates/common/Cargo.toml
@@ -27,9 +27,7 @@ graphql_client.workspace = true
 serde = { workspace = true, features = ["derive"] }
 serde_json = { workspace = true }
 tokio = { workspace = true, features = ["fs", "tokio-macros"] }
-cost-model = { git = "https://github.com/graphprotocol/agora", rev = "3ed34ca" }
 regex = "1.7.1"
-tokio-util = "0.7.10"
 bip39 = "2.0.0"
 
 [dev-dependencies]
diff --git a/crates/common/src/escrow_accounts.rs b/crates/common/src/escrow_accounts.rs
@@ -165,6 +165,10 @@ async fn get_escrow_accounts(
 #[cfg(test)]
 mod tests {
     use test_log::test;
+    use test_tap_utils::{
+        ESCROW_ACCOUNTS_BALANCES, ESCROW_ACCOUNTS_SENDERS_TO_SIGNERS,
+        ESCROW_ACCOUNTS_SIGNERS_TO_SENDERS,
+    };
     use wiremock::matchers::{method, path};
     use wiremock::{Mock, MockServer, ResponseTemplate};
 
@@ -176,13 +180,13 @@ mod tests {
     #[test]
     fn test_new_escrow_accounts() {
         let escrow_accounts = EscrowAccounts::new(
-            test_vectors::ESCROW_ACCOUNTS_BALANCES.to_owned(),
-            test_vectors::ESCROW_ACCOUNTS_SENDERS_TO_SIGNERS.to_owned(),
+            ESCROW_ACCOUNTS_BALANCES.to_owned(),
+            ESCROW_ACCOUNTS_SENDERS_TO_SIGNERS.to_owned(),
         );
 
         assert_eq!(
             escrow_accounts.signers_to_senders,
-            test_vectors::ESCROW_ACCOUNTS_SIGNERS_TO_SENDERS.to_owned()
+            ESCROW_ACCOUNTS_SIGNERS_TO_SENDERS.to_owned()
         )
     }
 
@@ -227,8 +231,8 @@ mod tests {
         assert_eq!(
             accounts.borrow().clone(),
             EscrowAccounts::new(
-                test_vectors::ESCROW_ACCOUNTS_BALANCES.to_owned(),
-                test_vectors::ESCROW_ACCOUNTS_SENDERS_TO_SIGNERS.to_owned(),
+                ESCROW_ACCOUNTS_BALANCES.to_owned(),
+                ESCROW_ACCOUNTS_SENDERS_TO_SIGNERS.to_owned(),
             )
         );
     }
diff --git a/crates/common/src/lib.rs b/crates/common/src/lib.rs
@@ -4,11 +4,9 @@
 pub mod address;
 pub mod allocations;
 pub mod attestations;
-pub mod cost_model;
 pub mod escrow_accounts;
 pub mod graphql;
 pub mod subgraph_client;
-pub mod tap;
 pub mod watcher;
 
 #[cfg(test)]
@@ -23,5 +21,4 @@ pub mod prelude {
     };
     pub use super::escrow_accounts::escrow_accounts;
     pub use super::subgraph_client::{DeploymentDetails, Query, QueryVariables, SubgraphClient};
-    pub use super::tap::IndexerTapContext;
 }
diff --git a/crates/common/src/test_vectors.rs b/crates/common/src/test_vectors.rs
@@ -179,45 +179,4 @@ lazy_static! {
             },
         ),
     ]);
-
-    pub static ref ESCROW_ACCOUNTS_BALANCES: HashMap<Address, U256> = HashMap::from([
-        (Address::from_str("0x9858EfFD232B4033E47d90003D41EC34EcaEda94").unwrap(), U256::from(24)), // TAP_SENDER
-        (Address::from_str("0x22d491bde2303f2f43325b2108d26f1eaba1e32b").unwrap(), U256::from(42)),
-        (Address::from_str("0x192c3B6e0184Fa0Cc5B9D2bDDEb6B79Fb216a002").unwrap(), U256::from(2975)),
-    ]);
-
-    /// Maps signers back to their senders
-    pub static ref ESCROW_ACCOUNTS_SIGNERS_TO_SENDERS: HashMap<Address, Address> = HashMap::from([
-        (
-            Address::from_str("0x533661F0fb14d2E8B26223C86a610Dd7D2260892").unwrap(), // TAP_SIGNER
-            Address::from_str("0x9858EfFD232B4033E47d90003D41EC34EcaEda94").unwrap(), // TAP_SENDER
-        ),
-        (
-            Address::from_str("0x2740f6fA9188cF53ffB6729DDD21575721dE92ce").unwrap(),
-            Address::from_str("0x9858EfFD232B4033E47d90003D41EC34EcaEda94").unwrap(), // TAP_SENDER
-        ),
-        (
-            Address::from_str("0x245059163ff6ee14279aa7b35ea8f0fdb967df6e").unwrap(),
-            Address::from_str("0x22d491bde2303f2f43325b2108d26f1eaba1e32b").unwrap(),
-        ),
-    ]);
-
-    pub static ref ESCROW_ACCOUNTS_SENDERS_TO_SIGNERS: HashMap<Address, Vec<Address>> = HashMap::from([
-        (
-            Address::from_str("0x9858EfFD232B4033E47d90003D41EC34EcaEda94").unwrap(), // TAP_SENDER
-            vec![
-                Address::from_str("0x533661F0fb14d2E8B26223C86a610Dd7D2260892").unwrap(), // TAP_SIGNER
-                Address::from_str("0x2740f6fA9188cF53ffB6729DDD21575721dE92ce").unwrap(),
-            ],
-        ),
-        (
-            Address::from_str("0x22d491bde2303f2f43325b2108d26f1eaba1e32b").unwrap(),
-            vec![Address::from_str("0x245059163ff6ee14279aa7b35ea8f0fdb967df6e").unwrap()],
-        ),
-        (
-            Address::from_str("0x192c3B6e0184Fa0Cc5B9D2bDDEb6B79Fb216a002").unwrap(),
-            vec![],
-        ),
-    ]);
-
 }
diff --git a/crates/service/Cargo.toml b/crates/service/Cargo.toml
@@ -20,6 +20,7 @@ thiserror.workspace = true
 serde = { workspace = true }
 serde_json.workspace = true
 axum.workspace = true
+bigdecimal.workspace = true
 sqlx.workspace = true
 thegraph-core.workspace = true
 thegraph-graphql-http.workspace = true
@@ -28,6 +29,7 @@ tracing-subscriber = { workspace = true, features = ["fmt"] }
 clap = { workspace = true, features = ["derive"] }
 build-info.workspace = true
 lazy_static.workspace = true
+async-trait.workspace = true
 async-graphql = { version = "7.0.11", default-features = false }
 async-graphql-axum = "7.0.11"
 base64.workspace = true
@@ -45,6 +47,8 @@ autometrics = { version = "1.0.1", features = ["prometheus-exporter"] }
 axum-extra = { version = "0.9.3", features = [
   "typed-header",
 ], default-features = false }
+tokio-util = "0.7.10"
+cost-model = { git = "https://github.com/graphprotocol/agora", rev = "3ed34ca" }
 
 [dev-dependencies]
 hex-literal = "0.4.1"
diff --git a/crates/service/src/database/cost_model.rs b/crates/service/src/database/cost_model.rs
diff --git a/crates/service/src/database/mod.rs b/crates/service/src/database/mod.rs
@@ -1,6 +1,7 @@
 // Copyright 2023-, Edge & Node, GraphOps, and Semiotic Labs.
 // SPDX-License-Identifier: Apache-2.0
 
+pub mod cost_model;
 pub mod dips;
 
 use std::time::Duration;
diff --git a/crates/service/src/lib.rs b/crates/service/src/lib.rs
@@ -6,3 +6,4 @@ mod database;
 mod error;
 mod routes;
 pub mod service;
+mod tap;
diff --git a/crates/service/src/routes/cost.rs b/crates/service/src/routes/cost.rs
@@ -4,10 +4,10 @@
 use std::str::FromStr;
 use std::sync::Arc;
 
+use crate::database::cost_model::{self, CostModel};
 use async_graphql::{Context, EmptyMutation, EmptySubscription, Object, Schema, SimpleObject};
 use async_graphql_axum::{GraphQLRequest, GraphQLResponse};
 use axum::extract::State;
-use indexer_common::cost_model::{self, CostModel};
 use lazy_static::lazy_static;
 use prometheus::{
     register_counter, register_counter_vec, register_histogram, register_histogram_vec, Counter,
diff --git a/crates/service/src/service/indexer_service.rs b/crates/service/src/service/indexer_service.rs
@@ -21,7 +21,6 @@ use indexer_common::{
         attestation_signers, dispute_manager, escrow_accounts, indexer_allocations,
         AttestationSigner, DeploymentDetails, SubgraphClient,
     },
-    tap::IndexerTapContext,
 };
 use prometheus::TextEncoder;
 use reqwest::StatusCode;
@@ -43,6 +42,7 @@ use tracing::{error, info, info_span};
 
 use super::request_handler::request_handler;
 use super::{health::health, static_subgraph::static_subgraph_request_handler};
+use crate::tap::IndexerTapContext;
 use indexer_config::Config;
 
 pub trait IndexerServiceResponse {
diff --git a/crates/service/src/service/request_handler.rs b/crates/service/src/service/request_handler.rs
@@ -3,13 +3,13 @@
 
 use std::sync::Arc;
 
+use crate::tap::AgoraQuery;
 use axum::{
     extract::{Path, State},
     http::HeaderMap,
     response::IntoResponse,
 };
 use axum_extra::TypedHeader;
-use indexer_common::tap::AgoraQuery;
 use lazy_static::lazy_static;
 use prometheus::{register_counter_vec, register_histogram_vec, CounterVec, HistogramVec};
 use reqwest::StatusCode;
diff --git a/crates/service/src/tap.rs b/crates/service/src/tap.rs
@@ -7,9 +7,9 @@ use crate::tap::checks::receipt_max_val_check::ReceiptMaxValueCheck;
 use crate::tap::checks::sender_balance_check::SenderBalanceCheck;
 use crate::tap::checks::timestamp_check::TimestampCheck;
 use crate::tap::checks::value_check::MinimumValue;
-use crate::{escrow_accounts::EscrowAccounts, prelude::Allocation};
 use alloy::dyn_abi::Eip712Domain;
 use alloy::primitives::Address;
+use indexer_common::{escrow_accounts::EscrowAccounts, prelude::Allocation};
 use receipt_store::{DatabaseReceipt, InnerContext};
 use sqlx::PgPool;
 use std::fmt::Debug;
diff --git a/crates/service/src/tap/checks.rs b/crates/service/src/tap/checks.rs
diff --git a/crates/service/src/tap/checks/allocation_eligible.rs b/crates/service/src/tap/checks/allocation_eligible.rs
@@ -6,14 +6,14 @@ use std::collections::HashMap;
 use alloy::primitives::Address;
 use anyhow::anyhow;
 
+use indexer_common::allocations::Allocation;
 use tap_core::receipt::{
     checks::{Check, CheckError, CheckResult},
     state::Checking,
     ReceiptWithState,
 };
 use tokio::sync::watch::Receiver;
 
-use crate::prelude::Allocation;
 pub struct AllocationEligible {
     indexer_allocations: Receiver<HashMap<Address, Allocation>>,
 }
diff --git a/crates/service/src/tap/checks/deny_list_check.rs b/crates/service/src/tap/checks/deny_list_check.rs
@@ -1,9 +1,9 @@
 // Copyright 2023-, Edge & Node, GraphOps, and Semiotic Labs.
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::escrow_accounts::EscrowAccounts;
 use alloy::dyn_abi::Eip712Domain;
 use alloy::primitives::Address;
+use indexer_common::escrow_accounts::EscrowAccounts;
 use sqlx::postgres::PgListener;
 use sqlx::PgPool;
 use std::collections::HashSet;
@@ -202,8 +202,10 @@ mod tests {
     use tap_core::receipt::{Context, ReceiptWithState};
     use tokio::sync::watch;
 
-    use crate::test_vectors;
-    use test_tap_utils::{self, create_signed_receipt, TAP_EIP712_DOMAIN, TAP_SENDER};
+    use test_tap_utils::{
+        self, create_signed_receipt, ESCROW_ACCOUNTS_BALANCES, ESCROW_ACCOUNTS_SENDERS_TO_SIGNERS,
+        TAP_EIP712_DOMAIN, TAP_SENDER,
+    };
 
     use super::*;
 
@@ -212,8 +214,8 @@ mod tests {
     async fn new_deny_list_check(pgpool: PgPool) -> DenyListCheck {
         // Mock escrow accounts
         let escrow_accounts_rx = watch::channel(EscrowAccounts::new(
-            test_vectors::ESCROW_ACCOUNTS_BALANCES.to_owned(),
-            test_vectors::ESCROW_ACCOUNTS_SENDERS_TO_SIGNERS.to_owned(),
+            ESCROW_ACCOUNTS_BALANCES.to_owned(),
+            ESCROW_ACCOUNTS_SENDERS_TO_SIGNERS.to_owned(),
         ))
         .1;
 
diff --git a/crates/service/src/tap/checks/receipt_max_val_check.rs b/crates/service/src/tap/checks/receipt_max_val_check.rs
diff --git a/crates/service/src/tap/checks/sender_balance_check.rs b/crates/service/src/tap/checks/sender_balance_check.rs
@@ -1,10 +1,10 @@
 // Copyright 2023-, Edge & Node, GraphOps, and Semiotic Labs.
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::escrow_accounts::EscrowAccounts;
 use alloy::dyn_abi::Eip712Domain;
 use alloy::primitives::U256;
 use anyhow::anyhow;
+use indexer_common::escrow_accounts::EscrowAccounts;
 use tap_core::receipt::{
     checks::{Check, CheckError, CheckResult},
     state::Checking,
diff --git a/crates/service/src/tap/checks/timestamp_check.rs b/crates/service/src/tap/checks/timestamp_check.rs
diff --git a/crates/service/src/tap/checks/value_check.rs b/crates/service/src/tap/checks/value_check.rs
@@ -24,7 +24,7 @@ use tap_core::receipt::{
     Context, ReceiptWithState,
 };
 
-use crate::cost_model;
+use crate::database::cost_model;
 
 // we only accept receipts with minimal 1 wei grt
 const MINIMAL_VALUE: u128 = 1;
@@ -354,9 +354,9 @@ mod tests {
     use tap_core::receipt::{checks::Check, Context, ReceiptWithState};
     use tokio::time::sleep;
 
-    use crate::{
-        cost_model::test::{add_cost_models, global_cost_model, to_db_models},
-        tap::AgoraQuery,
+    use super::AgoraQuery;
+    use crate::database::cost_model::test::{
+        self, add_cost_models, global_cost_model, to_db_models,
     };
 
     use super::MinimumValue;
@@ -370,7 +370,7 @@ mod tests {
     #[sqlx::test(migrations = "../../migrations")]
     async fn should_initialize_check_with_models(pgpool: PgPool) {
         // insert 2 cost models for different deployment_id
-        let test_models = crate::cost_model::test::test_data();
+        let test_models = test::test_data();
 
         add_cost_models(&pgpool, to_db_models(test_models.clone())).await;
 
@@ -387,7 +387,7 @@ mod tests {
         assert_eq!(check.cost_model_map.read().unwrap().len(), 0);
 
         // insert 2 cost models for different deployment_id
-        let test_models = crate::cost_model::test::test_data();
+        let test_models = test::test_data();
         add_cost_models(&pgpool, to_db_models(test_models.clone())).await;
         sleep(Duration::from_millis(200)).await;
 
@@ -400,7 +400,7 @@ mod tests {
     #[sqlx::test(migrations = "../../migrations")]
     async fn should_watch_model_remove(pgpool: PgPool) {
         // insert 2 cost models for different deployment_id
-        let test_models = crate::cost_model::test::test_data();
+        let test_models = test::test_data();
         add_cost_models(&pgpool, to_db_models(test_models.clone())).await;
 
         let check = MinimumValue::new(pgpool.clone(), Duration::from_secs(0)).await;
@@ -460,7 +460,7 @@ mod tests {
     #[sqlx::test(migrations = "../../migrations")]
     async fn should_check_minimal_value(pgpool: PgPool) {
         // insert cost models for different deployment_id
-        let test_models = crate::cost_model::test::test_data();
+        let test_models = test::test_data();
 
         add_cost_models(&pgpool, to_db_models(test_models.clone())).await;
 
@@ -534,7 +534,7 @@ mod tests {
     #[sqlx::test(migrations = "../../migrations")]
     async fn should_check_using_global(pgpool: PgPool) {
         // insert cost models for different deployment_id
-        let test_models = crate::cost_model::test::test_data();
+        let test_models = test::test_data();
         let global_model = global_cost_model();
 
         add_cost_models(&pgpool, vec![global_model.clone()]).await;
diff --git a/crates/service/src/tap/receipt_store.rs b/crates/service/src/tap/receipt_store.rs
diff --git a/crates/tests/tap-utils/src/lib.rs b/crates/tests/tap-utils/src/lib.rs
