Blockscout Migration (#9)

-    Switch to Blockscout as a data source
-    Change configuration format
-    Rebuild cache

Author: ritzdorf

.github/workflows/ci.yml

@@ -60,11 +60,11 @@ jobs:
 
       - name: Run tests
         env:
-          MAINNET_RPC: ${{ secrets.MAINNET_RPC }}
-          ETHERSCAN_TEST_API_URL: ${{ secrets.ETHERSCAN_TEST_API_URL }}
+          BLOCKSCOUT_API_KEY: ${{ secrets.BLOCKSCOUT_API_KEY }}
+          BLOCKSCOUT_TEST_API_URL: ${{ secrets.BLOCKSCOUT_TEST_API_URL}}
           ETHERSCAN_API_KEY: ${{ secrets.ETHERSCAN_API_KEY }}
-          BITQUERY_API_URL: ${{ secrets.BITQUERY_API_URL }}
-          BITQUERY_API_KEY: ${{ secrets.BITQUERY_API_KEY }}
+          ETHERSCAN_TEST_API_URL: ${{ secrets.ETHERSCAN_TEST_API_URL }}
+          MAINNET_RPC: ${{ secrets.MAINNET_RPC }}
           SIGNER_ADDRESS: ${{ secrets.SIGNER_ADDRESS }}
           SIGNER_SECRET_KEY: ${{ secrets.SIGNER_SECRET_KEY }}
         run: ./tests/ci_tests.sh

.gitignore

@@ -8,3 +8,4 @@ on_chain_bytecode.txt
 **/*.swp
 /*.dvf.json
 .env
+tests/hardhat/package-lock.json

Cargo.lock

@@ -66,3 +66,4 @@ time = "0.3.36"
 
 [dev-dependencies]
 assert_cmd = "2.0.12"
+env_logger = "0.11.5"

Cargo.toml

@@ -68,13 +68,13 @@ Once you have it installed you can continue to [validate](#validate-dvf).
 To successfully create DVFs for on-chain smart contracts, you need access to the following APIs:
 
 1. An RPC archive node for the desired chain ID.
-2. (Optional) A [BitQuery](https://bitquery.io/) API key.
+2. (Optional) A [Blockscout](https://blockscout.com/) API key.
 3. (Optional) An [Etherscan](https://etherscan.io/apis) API key.
 
 **Please note the following restrictions/requirements**:
 
-1. While BitQuery and Etherscan API keys are optional, at least one of them is required to determine the deployment transaction of a contract. If you provide neither, you are limited to local RPC nodes with less than 100 blocks.
-2. A BitQuery API key allows for faster execution.
+1. While Blockscout and Etherscan API keys are optional, at least one of them is required to determine the deployment transaction of a contract. If you provide neither, you are limited to local RPC nodes with less than 100 blocks.
+2. A Blockscout API key allows for faster execution.
 3. Your RPC node **must** support either `debug_traceTransaction` or `trace_transaction`.
 4. Your RPC node **should** support `debug_traceTransaction` with [opcode logger](https://geth.ethereum.org/docs/developers/evm-tracing/built-in-tracers#struct-opcode-logger) enabled. Otherwise, `dv` won't be able to decode mapping keys.
 5. For faster execution, your RPC node **may** support `debug_storageRangeAt`.
@@ -484,7 +484,7 @@ This section will be updated soon.
 - Only projects with `solc` version starting from `0.5.13` are supported due to the lack of generated storage layout in older versions (see [solc release 0.5.13](https://github.com/ethereum/solidity/releases/tag/v0.5.13)).
 - The RPC endpoints automatically parsed in `dv generate-config` are not guaranteed to be compatible.
 - As detailed [above](#dvf-creation), many public RPCs are not or only partially supported for DVF creation.
-- Finding the deployment transaction of a contract currently requires either BitQuery or Etherscan API keys to collect all relevant information.
+- Finding the deployment transaction of a contract currently requires either Blockscout or Etherscan API keys to collect all relevant information.
 - Contracts performing `delegatecall` to more than one other contract are currently not supported.
 - `dv update` currently only updates values of existing storage variables in the DVF and does not add newly added storage values.
 - Multiple contracts with the same name compiled with different compiler versions in one project are not supported.

README.md

@@ -8,8 +8,10 @@ When running the `dvf` command, the default configuration file is expected at `$
 | `rpc_urls` | Mapping from chain ID to RPC URL |
 | `dvf_storage` | Folder where DVFs are stored |
 | `trusted_signers`: | List of addresses of trusted signers |
-| `etherscan_api_key` | Etherscan API Key, free plan sufficient, optional | 
-| `bitquery_api_key` | Bitquery API Key, free plan sufficient, optional |
+| `etherscan_api_key` | Mapping from chain ID to Etherscan API Key, free plan sufficient, optional | 
+| `blockscout_api_key` | Mapping from chain ID to Blockscout API Key, free plan sufficient, optional |
+| `etherscan_test_api_url` | Only for testing, optional | 
+| `blockscout_test_api_url` | Only for testing, optional | 
 | `max_blocks_per_event_query` | Number of blocks that can be queried at once in `getLogs`, optional |
 | `web3_timeout` | Timeout is seconds for web3 RPC queries, optional |
 | `signer` | Configuration on how to sign, optional |