Gusinacio/uniform config (#199)

* refactor!(common,service): rename scalar to tap

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

* refactor!(tap-agent): inline sender endpoints

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

* refactor(common): remove id from graph, use 1

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

* refactor!: use unified config

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

* refactor: add warnings and use single value for buffer and timestamp error

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

* test(config): add maximal config test

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

* revert: use Scalar-Receipt again

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

* style(config,tap-agent): clippy

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

* refactor(config): add unit and comments

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

* docs: remove outdated example service config

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

* refactor(config): update checks for warnings

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

* refactor: remove serde-inline-default

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

* fix(config): use default values in grt

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

* style(config): keep ethereum chains together

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

---------

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

Author: gusinacio

Cargo.lock

@@ -1,5 +1,5 @@
 [workspace]
-members = ["common", "service", "tap-agent"]
+members = ["common", "config", "service", "tap-agent"]
 resolver = "2"
 
 [profile.dev.package."*"]

Cargo.toml

@@ -37,7 +37,7 @@ We follow conventional semantics for package versioning. An indexer may set a mi
 1. **Review Release Notes**: Before upgrading, check the release notes for the new version to understand what changes, fixes, or new features are included.
 2. **Review Documentation**: Check the up-to-date documentation for an accurate reflection of the changes made during the upgrade.
 3. **Backup Configuration**: Save your current configuration files and any local modifications you've made to the existing codebase.
-4. **Deploy**: Replace the old executable or docker image with the new one and restart the service to apply the upgrade. 
+4. **Deploy**: Replace the old executable or docker image with the new one and restart the service to apply the upgrade.
 5. **Monitor and Validate**: After the upgrade, monitor system behavior and performance metrics to validate that the service is running as expected.
 
 These steps should ensure a smooth transition to the latest version of `indexer-service-rs`, harnessing new capabilities while maintaining system integrity.
@@ -46,13 +46,11 @@ These steps should ensure a smooth transition to the latest version of `indexer-
 
 [Contributions guide](/contributing.md)
 
-
 ### Supported request and response format examples
 
-
 ```
 ✗ curl http://localhost:7300/
-Ready to roll! 
+Ready to roll!
 
 ✗ curl http://localhost:7300/health
 {"healthy":true}
@@ -78,27 +76,27 @@ Ready to roll!
 
 # Subgraph health check
 ✗ curl http://localhost:7300/subgraphs/health/QmVhiE4nax9i86UBnBmQCYDzvjWuwHShYh7aspGPQhU5Sj
-"Subgraph deployment is up to date"%                    
+"Subgraph deployment is up to date"%
 ## Unfound subgraph
 ✗ curl http://localhost:7300/subgraphs/health/QmacQnSgia4iDPWHpeY6aWxesRFdb8o5DKZUx96zZqEWrB
-"Invalid indexing status"%   
+"Invalid indexing status"%
 
 # Network queries
 # Checks for auth and configuration to serve-network-subgraph
-✗ curl -X POST -H 'Content-Type: application/json' -H 'Authorization: token-for-network-subgraph' --data '{"query": "{_meta{block{number}}}"}' http://localhost:7300/network 
+✗ curl -X POST -H 'Content-Type: application/json' -H 'Authorization: token-for-network-subgraph' --data '{"query": "{_meta{block{number}}}"}' http://localhost:7300/network
 "Not enabled or authorized query"
 
 # Indexing status resolver - Route supported root field queries to graph node status endpoint
-✗ curl -X POST -H 'Content-Type: application/json' --data '{"query": "{blockHashFromNumber(network:\"goerli\", blockNumber: 9069120)}"}' http://localhost:7300/status 
-{"data":{"blockHashFromNumber":"e1e5472636db73ba5496aee098dc21310683c95eb30fc46f9ba6c36d8b28d58e"}}%                
+✗ curl -X POST -H 'Content-Type: application/json' --data '{"query": "{blockHashFromNumber(network:\"goerli\", blockNumber: 9069120)}"}' http://localhost:7300/status
+{"data":{"blockHashFromNumber":"e1e5472636db73ba5496aee098dc21310683c95eb30fc46f9ba6c36d8b28d58e"}}%
 
-# Indexing status resolver - 
-✗ curl -X POST -H 'Content-Type: application/json' --data '{"query": "{indexingStatuses {subgraph health} }"}' http://localhost:7300/status 
+# Indexing status resolver -
+✗ curl -X POST -H 'Content-Type: application/json' --data '{"query": "{indexingStatuses {subgraph health} }"}' http://localhost:7300/status
 {"data":{"indexingStatuses":[{"subgraph":"QmVhiE4nax9i86UBnBmQCYDzvjWuwHShYh7aspGPQhU5Sj","health":"healthy"},{"subgraph":"QmWVtsWk8Pqn3zY3czDjyoVreshRLmoz9jko3mQ4uvxQDj","health":"healthy"},{"subgraph":"QmacQnSgia4iDPWHpeY6aWxesRFdb8o5DKZUx96zZqEWrB","health":"healthy"}]}}
 
 # Indexing status resolver - Filter out the unsupported queries
-✗ curl -X POST -H 'Content-Type: application/json' --data '{"query": "{_meta{block{number}}}"}' http://localhost:7300/status 
-{"errors":[{"locations":[{"line":1,"column":2}],"message":"Type `Query` has no field `_meta`"}]}%              
+✗ curl -X POST -H 'Content-Type: application/json' --data '{"query": "{_meta{block{number}}}"}' http://localhost:7300/status
+{"errors":[{"locations":[{"line":1,"column":2}],"message":"Type `Query` has no field `_meta`"}]}%
 
 ######## Cost server - read-only graphql query
 curl -X GET -H 'Content-Type: application/json' --data '{"query": "{ costModel(deployment: \"Qmb5Ysp5oCUXhLA8NmxmYKDAX2nCMnh7Vvb5uffb9n5vss\") { deployment model variables }} "}' http://localhost:7300/cost
@@ -109,8 +107,8 @@ curl -X GET -H 'Content-Type: application/json' --data '{"query": "{ costModel(d
 curl -X GET -H 'Content-Type: application/json' --data '{"query": "{ costModel(deployment: \"Qmb5Ysp5oCUXhLA8NmxmYKDAX2nCMnh7Vvb5uffb9n5vas\") { deployment model variables }} "}' http://localhost:7300/cost
 {"data":{"costModel":null}}%
 
-curl -X GET -H 'Content-Type: application/json' --data '{"query": "{ costModel(deployment: \"Qmb5Ysp5oCUXhLA8NmxmYKDAX2nCMnh7Vvb5uffb9n5vss\") { deployment odel variables }} "}' http://localhost:7300/cost 
-{"errors":[{"message":"Cannot query field \"odel\" on type \"CostModel\". Did you mean \"model\"?","locations":[{"line":1,"column":88}]}]}%     
+curl -X GET -H 'Content-Type: application/json' --data '{"query": "{ costModel(deployment: \"Qmb5Ysp5oCUXhLA8NmxmYKDAX2nCMnh7Vvb5uffb9n5vss\") { deployment odel variables }} "}' http://localhost:7300/cost
+{"errors":[{"message":"Cannot query field \"odel\" on type \"CostModel\". Did you mean \"model\"?","locations":[{"line":1,"column":88}]}]}%
 
 curl -X GET -H 'Content-Type: application/json' --data '{"query": "{ costModels(deployments: [\"Qmb5Ysp5oCUXhLA8NmxmYKDAX2nCMnh7Vvb5uffb9n5vss\"]) { deployment model variables }} "}' http://localhost:7300/cost
 {"data":{"costModels":[{"deployment":"0xbd499f7673ca32ef4a642207a8bebdd0fb03888cf2678b298438e3a1ae5206ea","model":"default => 0.00025;","variables":null}]}}%
@@ -125,13 +123,13 @@ curl -X GET -H 'Content-Type: application/json' --data '{"query": "{ costModels(
 - `postgres` database connection required to indexer management server database, shared with the indexer agent
 - No migration in indexer service as it might introduce conflicts to the database; indexer agent is solely responsible for database management.
 
-
 ### Indexer common components
 
 Temporarily live inside the indexer-service package under `src/common`.
 
 Simple indexer management client to track NetworkSubgraph and postgres connection.
-- NetworkSubgraph instance track both remote API endpoint and local deployment query endpoint. 
+
+- NetworkSubgraph instance track both remote API endpoint and local deployment query endpoint.
   - TODO: query indexing status of local deployment, only use remote API as fallback.
 - Keeps cost model schema and resolvers with postgres and graphQL types: `costModel(deployment)` and `costModels(deployments)`. If deployments is empty, all cost models are returned.
   - Global cost model fallback used when specific deployments are queried
@@ -141,7 +139,7 @@ Simple indexer management client to track NetworkSubgraph and postgres connectio
 
 Linked dependency could not be linked directly with git url "https://github.com/graphprotocol/indexer" and path "packages/indexer-native/native" at the same time, and could not access it on crates.io. So copid the folder to local repo with the version at https://github.com/graphprotocol/indexer/blob/972658b3ce8c512ad7b4dc575d29cd9d5377e3fe/packages/indexer-native/native.
 
-Since indexer-service will be written in Rust and no need for typescript, indexer-native's neon build and util has been removed. 
+Since indexer-service will be written in Rust and no need for typescript, indexer-native's neon build and util has been removed.
 
 Component `NativeSignatureVerifier` renamed to `SignatureVerifier`.
 
@@ -194,7 +192,7 @@ Temporarily live inside the indexer-service package under `src/types`
   - [ ] query timing logs
 - [x] Deployment health server
   - [x] query status endpoint and process result
-- [ ] Status server 
+- [ ] Status server
   - [x] indexing status resolver - to query indexingStatuses
   - [ ] Filter for unsupported queries
 - [x] Cost server
@@ -211,7 +209,7 @@ Temporarily live inside the indexer-service package under `src/types`
 - [ ] Metrics
   - [x] Metrics setup
   - [x] serve basic indexer service metrics
-  - [ ] Add cost model metrics 
+  - [ ] Add cost model metrics
 - [x] CLI args
 - [ ] App profiling
   - [ ] No gcloud profiling, can use `perf` to collect performance data.

README.md

@@ -43,7 +43,6 @@ tower_governor = "0.3.2"
 tower-http = { version = "0.5.2", features = ["trace", "cors"] }
 tokio-util = "0.7.10"
 bigdecimal = "0.4.2"
-serde-inline-default = "0.2.0"
 thegraph-core = { version = "0.4.1", features = ["subgraph-client"] }
 
 [dev-dependencies]

common/Cargo.toml

@@ -13,7 +13,6 @@ use crate::subgraph_client::{Query, SubgraphClient};
 
 pub fn dispute_manager(
     network_subgraph: &'static SubgraphClient,
-    graph_network_id: u64,
     interval: Duration,
 ) -> Eventual<Address> {
     #[derive(Deserialize)]
@@ -31,32 +30,26 @@ pub fn dispute_manager(
     timer(interval).map_with_retry(
         move |_| async move {
             let response = network_subgraph
-                .query::<DisputeManagerResponse>(Query::new_with_variables(
+                .query::<DisputeManagerResponse>(Query::new(
                     r#"
-                        query network($id: ID!) {
-                            graphNetwork(id: $id) {
+                        query network {
+                            graphNetwork(id: 1) {
                                 disputeManager
                             }
                         }
                     "#,
-                    [("id", graph_network_id.into())],
                 ))
                 .await
                 .map_err(|e| e.to_string())?;
 
             response.map_err(|e| e.to_string()).and_then(|data| {
                 data.graph_network
                     .map(|network| network.dispute_manager)
-                    .ok_or_else(|| {
-                        format!("Network {} not found in network subgraph", graph_network_id)
-                    })
+                    .ok_or_else(|| "Network 1 not found in network subgraph".to_string())
             })
         },
         move |err: String| {
-            warn!(
-                "Failed to query dispute manager for network {}: {}",
-                graph_network_id, err,
-            );
+            warn!("Failed to query dispute manager for network: {}", err,);
 
             // Sleep for a bit before we retry
             sleep(interval.div_f32(2.0))
@@ -115,7 +108,7 @@ mod test {
     async fn test_parses_dispute_manager_from_network_subgraph_correctly() {
         let (network_subgraph, _mock_server) = setup_mock_network_subgraph().await;
 
-        let dispute_manager = dispute_manager(network_subgraph, 1, Duration::from_secs(60));
+        let dispute_manager = dispute_manager(network_subgraph, Duration::from_secs(60));
 
         assert_eq!(
             dispute_manager.value().await.unwrap(),