graphql, index-node: endpoint to get a hash from a block number (graphprotocol#3942)

Filippo Costa · web-flow · commit 1435fceb5840 · 2022-09-16T14:39:10.000+02:00
* refactor(graphql): asyncify scalar value resolution

We're marking the GraphQL resolver for scalar values as async, like
some other resolvers are already. This is needed to .await some calls in
the new `index-node` endpoint.

* feat(index-node): new number -&gt; hash endpoint
diff --git a/graphql/src/execution/execution.rs b/graphql/src/execution/execution.rs
@@ -645,6 +645,7 @@ async fn resolve_field_value_for_named_type(
         s::TypeDefinition::Scalar(t) => {
             ctx.resolver
                 .resolve_scalar_value(object_type, field, t, field_value)
+                .await
         }
 
         s::TypeDefinition::Interface(i) => {
diff --git a/graphql/src/execution/resolver.rs b/graphql/src/execution/resolver.rs
@@ -51,7 +51,7 @@ pub trait Resolver: Sized + Send + Sync + 'static {
     }
 
     /// Resolves a scalar value for a given scalar type.
-    fn resolve_scalar_value(
+    async fn resolve_scalar_value(
         &self,
         _parent_object_type: &s::ObjectType,
         _field: &a::Field,
diff --git a/server/index-node/src/resolver.rs b/server/index-node/src/resolver.rs
@@ -202,6 +202,75 @@ impl<S: Store> IndexNodeResolver<S> {
         })
     }
 
+    async fn resolve_block_hash_from_number(
+        &self,
+        field: &a::Field,
+    ) -> Result<r::Value, QueryExecutionError> {
+        let network = field
+            .get_required::<String>("network")
+            .expect("Valid network required");
+        let block_number = field
+            .get_required::<BlockNumber>("blockNumber")
+            .expect("Valid blockNumber required");
+
+        macro_rules! try_resolve_for_chain {
+            ( $typ:path ) => {
+                let blockchain = self.blockchain_map.get::<$typ>(network.to_string()).ok();
+
+                if let Some(blockchain) = blockchain {
+                    debug!(
+                        self.logger,
+                        "Fetching block hash from number";
+                        "network" => &network,
+                        "block_number" => block_number,
+                    );
+
+                    let block_ptr_res = blockchain
+                        .block_pointer_from_number(&self.logger, block_number)
+                        .await;
+
+                        if let Err(e) = block_ptr_res {
+                            warn!(
+                                self.logger,
+                                "Failed to fetch block hash from number";
+                                "network" => &network,
+                                "chain" => <$typ as Blockchain>::KIND.to_string(),
+                                "block_number" => block_number,
+                                "error" => e.to_string(),
+                            );
+                            return Ok(r::Value::Null);
+                        }
+
+                    let block_ptr = block_ptr_res.unwrap();
+                    return Ok(r::Value::String(block_ptr.hash_hex()));
+                }
+            };
+        }
+
+        // Ugly, but we can't get back an object trait from the `BlockchainMap`,
+        // so this seems like the next best thing.
+        try_resolve_for_chain!(graph_chain_ethereum::Chain);
+        try_resolve_for_chain!(graph_chain_arweave::Chain);
+        try_resolve_for_chain!(graph_chain_cosmos::Chain);
+        try_resolve_for_chain!(graph_chain_near::Chain);
+
+        // If you're adding support for a new chain and this `match` clause just
+        // gave you a compiler error, then this message is for you! You need to
+        // add a new `try_resolve!` macro invocation above for your new chain
+        // type.
+        match BlockchainKind::Ethereum {
+            // Note: we don't actually care about substreams here.
+            BlockchainKind::Substreams
+            | BlockchainKind::Arweave
+            | BlockchainKind::Ethereum
+            | BlockchainKind::Cosmos
+            | BlockchainKind::Near => (),
+        }
+
+        // The given network does not exist.
+        Ok(r::Value::Null)
+    }
+
     async fn resolve_cached_ethereum_calls(
         &self,
         field: &a::Field,
@@ -734,7 +803,7 @@ impl<S: Store> Resolver for IndexNodeResolver<S> {
     }
 
     /// Resolves a scalar value for a given scalar type.
-    fn resolve_scalar_value(
+    async fn resolve_scalar_value(
         &self,
         parent_object_type: &s::ObjectType,
         field: &a::Field,
@@ -748,6 +817,9 @@ impl<S: Store> Resolver for IndexNodeResolver<S> {
         ) {
             ("Query", "proofOfIndexing", "Bytes") => self.resolve_proof_of_indexing(field),
             ("Query", "blockData", "JSONObject") => self.resolve_block_data(field),
+            ("Query", "blockHashFromNumber", "Bytes") => {
+                self.resolve_block_hash_from_number(field).await
+            }
 
             // Fallback to the same as is in the default trait implementation. There
             // is no way to call back into the default implementation for the trait.
diff --git a/server/index-node/src/schema.graphql b/server/index-node/src/schema.graphql
@@ -39,6 +39,7 @@ type Query {
   subgraphFeatures(subgraphId: String!): SubgraphFeatures!
   entityChangesInBlock(subgraphId: String!, blockNumber: Int!): EntityChanges!
   blockData(network: String!, blockHash: Bytes!): JSONObject
+  blockHashFromNumber(network: String!, blockNumber: Int!): Bytes
   cachedEthereumCalls(
     network: String!
     blockHash: Bytes!

Original file line number	Diff line number	Diff line change
`@@ -645,6 +645,7 @@ async fn resolve_field_value_for_named_type(`
`645`	`645`	`s::TypeDefinition::Scalar(t) => {`
`646`	`646`	`ctx.resolver`
`647`	`647`	`.resolve_scalar_value(object_type, field, t, field_value)`
	`648`	`+ .await`
`648`	`649`	`}`
`649`	`650`
`650`	`651`	`s::TypeDefinition::Interface(i) => {`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ pub trait Resolver: Sized + Send + Sync + 'static {`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`/// Resolves a scalar value for a given scalar type.`
`54`		`- fn resolve_scalar_value(`
	`54`	`+ async fn resolve_scalar_value(`
`55`	`55`	`&self,`
`56`	`56`	`_parent_object_type: &s::ObjectType,`
`57`	`57`	`_field: &a::Field,`