chain: change env name for block receipts check and add to docs

graphprotocol · Jun 17, 2024 · 301773c · 301773c
1 parent 1ec1bcd
commit 301773c
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 8 deletions.
diff --git a/chain/ethereum/src/env.rs b/chain/ethereum/src/env.rs
@@ -47,9 +47,9 @@ pub struct EnvVars {
     /// (expressed in seconds). The default value is 180s.
     pub json_rpc_timeout: Duration,
 
-    /// Set by the environment variable `GRAPH_ETHEREUM_BLOCK_RECEIPTS_TIMEOUT`
-    /// (expressed in seconds). The default value is 180s.
-    pub block_receipts_timeout: Duration,
+    /// Set by the environment variable `GRAPH_ETHEREUM_BLOCK_RECEIPTS_CHECK_TIMEOUT`
+    /// (expressed in seconds). The default value is 10s.
+    pub block_receipts_check_timeout: Duration,
     /// This is used for requests that will not fail the subgraph if the limit
     /// is reached, but will simply restart the syncing step, so it can be low.
     /// This limit guards against scenarios such as requesting a block hash that
@@ -118,7 +118,9 @@ impl From<Inner> for EnvVars {
             block_batch_size: x.block_batch_size,
             max_block_range_size: x.max_block_range_size,
             json_rpc_timeout: Duration::from_secs(x.json_rpc_timeout_in_secs),
-            block_receipts_timeout: Duration::from_secs(x.block_receipts_timeout_in_seccs),
+            block_receipts_check_timeout: Duration::from_secs(
+                x.block_receipts_check_timeout_in_seccs,
+            ),
             request_retries: x.request_retries,
             block_ingestor_max_concurrent_json_rpc_calls: x
                 .block_ingestor_max_concurrent_json_rpc_calls,
@@ -162,8 +164,8 @@ struct Inner {
     max_block_range_size: BlockNumber,
     #[envconfig(from = "GRAPH_ETHEREUM_JSON_RPC_TIMEOUT", default = "180")]
     json_rpc_timeout_in_secs: u64,
-    #[envconfig(from = "GRAPH_ETHEREUM_BLOCK_RECEIPTS_TIMEOUT", default = "10")]
-    block_receipts_timeout_in_seccs: u64,
+    #[envconfig(from = "GRAPH_ETHEREUM_BLOCK_RECEIPTS_CHECK_TIMEOUT", default = "10")]
+    block_receipts_check_timeout_in_seccs: u64,
     #[envconfig(from = "GRAPH_ETHEREUM_REQUEST_RETRIES", default = "10")]
     request_retries: usize,
     #[envconfig(

diff --git a/chain/ethereum/src/ethereum_adapter.rs b/chain/ethereum/src/ethereum_adapter.rs
@@ -243,7 +243,7 @@ impl EthereumAdapter {
 
         info!(logger, "Checking eth_getBlockReceipts support");
         let result = timeout(
-            ENV_VARS.block_receipts_timeout,
+            ENV_VARS.block_receipts_check_timeout,
             check_block_receipt_support(web3, block_hash, supports_eip_1898, call_only),
         )
         .await;
@@ -261,7 +261,7 @@ impl EthereumAdapter {
                 warn!(
                     logger,
                     "Skipping use of block receipts, reason: Timeout after {} seconds",
-                    ENV_VARS.block_receipts_timeout.as_secs()
+                    ENV_VARS.block_receipts_check_timeout.as_secs()
                 );
                 false
             }

diff --git a/docs/environment-variables.md b/docs/environment-variables.md
@@ -251,3 +251,8 @@ those.
 - `GRAPH_STORE_WRITE_BATCH_SIZE`: how many changes to accumulate during
   syncing in kilobytes before a write has to happen. The default is 10_000
   which corresponds to 10MB. Setting this to 0 disables write batching.
+- `GRAPH_MIN_HISTORY_BLOCKS`: Specifies the minimum number of blocks to 
+retain for subgraphs with historyBlocks set to auto. The default value is 2 times the reorg threshold.
+- `GRAPH_ETHEREUM_BLOCK_RECEIPTS_CHECK_TIMEOUT`: Timeout for checking
+  `eth_getBlockReceipts` support during chain startup, if this times out
+  individual transaction receipts will be fetched instead. Defaults to 10s.