Skip to content

Commit

Permalink
Rename abi.etherscan
Browse files Browse the repository at this point in the history
  • Loading branch information
droserasprout committed Dec 22, 2024
1 parent 8ba27d6 commit 4100e80
Show file tree
Hide file tree
Showing 80 changed files with 338 additions and 314 deletions.
14 changes: 9 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ Releases prior to 7.0 has been removed from this file to declutter search result

- evm.subsquid: Fixed event/transaction model deserialization.

### Changed

- evm.etherscan: Datasource has been renamed from `abi.etherscan` to `evm.etherscan` for consistency.

## [8.1.3] - 2024-12-20

### Fixed
Expand Down Expand Up @@ -51,7 +55,7 @@ Releases prior to 7.0 has been removed from this file to declutter search result

### Added

- abi.etherscan: Try to extract ABI from webpage when API call fails.
- evm.etherscan: Try to extract ABI from webpage when API call fails.
- cli: Added `schema` subcommands to manage database migrations: `migrate`, `upgrade`, `downgrade`, `heads` and `history`.
- cli: Added interactive mode for `new` command.
- database: Support database migrations using [`aerich`](https://github.com/tortoise/aerich).
Expand Down Expand Up @@ -231,7 +235,7 @@ Releases prior to 7.0 has been removed from this file to declutter search result
### Removed

- config: `node_only` index config flag has been removed; add `evm.node` datasource(s) to the `datasources` list instead.
- config: `abi` index config field has been removed; add `abi.etherscan` datasource(s) to the `datasources` list instead.
- config: `abi` index config field has been removed; add `evm.etherscan` datasource(s) to the `datasources` list instead.

### Other

Expand Down Expand Up @@ -291,7 +295,7 @@ Releases prior to 7.0 has been removed from this file to declutter search result

### Fixed

- abi.etherscan: Raise `AbiNotAvailableError` when contract is not verified.
- evm.etherscan: Raise `AbiNotAvailableError` when contract is not verified.
- cli: Fixed incorrect indexer status logging.
- evm.node: Fixed memory leak when using realtime subscriptions.
- evm.node: Fixed processing chain reorgs.
Expand Down Expand Up @@ -349,7 +353,7 @@ Releases prior to 7.0 has been removed from this file to declutter search result

### Fixed

- abi.etherscan: Fixed handling "rate limit reached" errors.
- evm.etherscan: Fixed handling "rate limit reached" errors.
- cli: Fixed setting logger levels based on config and env variables.
- http: Fixed incorrect number of retries performed on failed requests.

Expand Down Expand Up @@ -517,7 +521,7 @@ Releases prior to 7.0 has been removed from this file to declutter search result

### Added

- abi.etherscan: Added `abi.etherscan` datasource to fetch ABIs from Etherscan.
- evm.etherscan: Added `evm.etherscan` datasource to fetch ABIs from Etherscan.
- api: Added `/performance` endpoint to request indexing stats.
- cli: Added `report` command group to manage performance and crash reports created by DipDup.
- config: Added `advanced.decimal_precision` field to overwrite precision if it's not guessed correctly based on project models.
Expand Down
2 changes: 1 addition & 1 deletion docs/1.getting-started/7.datasources.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Index datasources, ones that can be attached to a specific index, are prefixed w
| -------------------------------------------------------------- | ---------------- | ----------------------------------------------- |
| [evm.subsquid](../3.datasources/1.evm_subsquid.md) | ⟠ EVM-compatible | Subsquid Network API |
| [evm.node](../3.datasources/2.evm_node.md) | ⟠ EVM-compatible | Ethereum node |
| [abi.etherscan](../3.datasources/3.abi_etherscan.md) | ⟠ EVM-compatible | Provides ABIs for EVM contracts |
| [evm.etherscan](../3.datasources/3.evm_etherscan.md) | ⟠ EVM-compatible | Provides ABIs for EVM contracts |
| [starknet.subsquid](../3.datasources/4.starknet_subsquid.md) | 🐺 Starknet | Subsquid Network API |
| [starknet.node](../3.datasources/5.starknet_node.md) | 🐺 Starknet | Starknet node |
| [substrate.node](../3.datasources/6.substrate_node.md) | 🔮 Substrate | Substrate node |
Expand Down
4 changes: 2 additions & 2 deletions docs/10.supported-networks/0.overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ datasources:
kind: evm.subsquid
url: ${SUBSQUID_URL:-https://v2.archive.subsquid.io/network/ethereum-mainnet}
etherscan:
kind: abi.etherscan
kind: evm.etherscan
url: ${ETHERSCAN_URL:-https://api.etherscan.io/api}
api_key: ${ETHERSCAN_API_KEY:-''}
evm_node:
Expand All @@ -41,6 +41,6 @@ To configure datasources for other networks, you need to change URLs and API key

[evm.subsquid](../3.datasources/1.evm_subsquid.md) - Subsquid Network is the main source of historical data for EVM-compatible networks. It's free and available for many networks.

[abi.etherscan](../3.datasources/3.abi_etherscan.md) - Etherscan is a source of contract ABIs, which are used to generate types for the indexer. Many explorers have Etherscan-like API which could be used to retrieve ABIs. Some of them require an API key, which you can get on their website. If there's no Etherscan-like API available, you need to obtain contract ABI JSON somewhere and put it to the `abi/<typename>/abi.json` path. Don't forget to run `dipdup init` after that to generate all necessary types.
[evm.etherscan](../3.datasources/3.evm_etherscan.md) - Etherscan is a source of contract ABIs, which are used to generate types for the indexer. Many explorers have Etherscan-like API which could be used to retrieve ABIs. Some of them require an API key, which you can get on their website. If there's no Etherscan-like API available, you need to obtain contract ABI JSON somewhere and put it to the `abi/<typename>/abi.json` path. Don't forget to run `dipdup init` after that to generate all necessary types.

[evm.node](../3.datasources/2.evm_node.md) - EVM node datasource can be used to fetch recent data not yet in Subsquid Network. API methods could vary a lot across different networks, but DipDup only uses a few of them, so most of the nodes will work. WebSocket URL can be specified to get real-time updates. This option can save you some requests to the node, but otherwise, it's not required. If Subsquid for your network is not available yet, you can use this datasource to fetch historical data, but it's significantly slower.
8 changes: 4 additions & 4 deletions docs/10.supported-networks/1.arbitrum.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ Explorer: [Arbiscan](https://arbiscan.io/)
| datasource | status | URLs |
| -----------------:|:-------- | -------------------------------------------------------------------------------- |
| **evm.subsquid** | 🟢 works | `https://v2.archive.subsquid.io/network/arbitrum-one` |
| **abi.etherscan** | 🟢 works | `https://api.arbiscan.io/api` |
| **evm.etherscan** | 🟢 works | `https://api.arbiscan.io/api` |
| **evm.node** | 🟢 works | `https://arb-mainnet.g.alchemy.com/v2` <br> `wss://arb-mainnet.g.alchemy.com/v2` |

### Arbitrum Goerli

| datasource | status | URLs |
| -----------------:|:------------- | -------------------------------------------------------- |
| **evm.subsquid** | ⚰️ deprecated | `https://v2.archive.subsquid.io/network/arbitrum-goerli` |
| **abi.etherscan** | ⚰️ deprecated | |
| **evm.etherscan** | ⚰️ deprecated | |
| **evm.node** | ⚰️ deprecated | |

### Arbitrum Nova
Expand All @@ -36,7 +36,7 @@ Explorer: [Arbiscan](https://nova.arbiscan.io/)
| datasource | status | URLs |
| -----------------:|:---------------- | ------------------------------------------------------ |
| **evm.subsquid** | 🟢 works | `https://v2.archive.subsquid.io/network/arbitrum-nova` |
| **abi.etherscan** | 🟢 works | `https://api-nova.arbiscan.io/api` |
| **evm.etherscan** | 🟢 works | `https://api-nova.arbiscan.io/api` |
| **evm.node** | 🤔 WS not tested | `https://nova.arbitrum.io/rpc` |

### Arbitrum Sepolia
Expand All @@ -46,5 +46,5 @@ Explorer: [Arbiscan](https://sepolia.arbiscan.io/)
| datasource | status | URLs |
| -----------------:|:-------- | -------------------------------------------------------------------------------- |
| **evm.subsquid** | 🟢 works | `https://v2.archive.subsquid.io/network/arbitrum-sepolia` |
| **abi.etherscan** | 🟢 works | `https://api-sepolia.arbiscan.io/api` |
| **evm.etherscan** | 🟢 works | `https://api-sepolia.arbiscan.io/api` |
| **evm.node** | 🟢 works | `https://arb-sepolia.g.alchemy.com/v2` <br> `wss://arb-sepolia.g.alchemy.com/v2` |
2 changes: 1 addition & 1 deletion docs/10.supported-networks/10.canto.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ description: "Canto network support"
| datasource | status | URLs |
| -----------------:|:------------- | ---------------------------------------------- |
| **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/canto` |
| **abi.etherscan** | 🤔 not tested | |
| **evm.etherscan** | 🤔 not tested | |
| **evm.node** | 🤔 not tested | |
2 changes: 1 addition & 1 deletion docs/10.supported-networks/11.core.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ description: "Core network support"
| datasource | status | URLs |
| -----------------:|:------------- | ----------------------------------------------------- |
| **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/core-mainnet` |
| **abi.etherscan** | 🤔 not tested | |
| **evm.etherscan** | 🤔 not tested | |
| **evm.node** | 🤔 not tested | |
2 changes: 1 addition & 1 deletion docs/10.supported-networks/12.cyber.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ description: "Cyber network support"
| datasource | status | URLs |
| -----------------:|:------------- | ------------------------------------------------------ |
| **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/cyber-mainnet` |
| **abi.etherscan** | 🤔 not tested | |
| **evm.etherscan** | 🤔 not tested | |
| **evm.node** | 🤔 not tested | |
2 changes: 1 addition & 1 deletion docs/10.supported-networks/13.cyberconnect.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ description: "Cyberconnect network support"
| datasource | status | URLs |
| -----------------:|:------------- | ---------------------------------------------------------------- |
| **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/cyberconnect-l2-testnet` |
| **abi.etherscan** | 🤔 not tested | |
| **evm.etherscan** | 🤔 not tested | |
| **evm.node** | 🤔 not tested | |
2 changes: 1 addition & 1 deletion docs/10.supported-networks/14.dfk-chain.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ Explorer: [Avascan](https://avascan.info/blockchain/dfk/home)
| datasource | status | URLs |
| -----------------:|:------------- | -------------------------------------------------------- |
| **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/dfk-chain` |
| **abi.etherscan** | 🤔 not tested | `https://api.avascan.info/v2` |
| **evm.etherscan** | 🤔 not tested | `https://api.avascan.info/v2` |
| **evm.node** | 🤔 not tested | `https://subnets.avax.network/defi-kingdoms/dfk-chain/` |
4 changes: 2 additions & 2 deletions docs/10.supported-networks/15.dogechain.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ Explorers: [Dogechain](https://dogechain.info/), [Blockscout](https://explorer.d
| datasource | status | URLs |
| -----------------:|:------------- | ---------------------------------------------------------- |
| **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/dogechain-mainnet` |
| **abi.etherscan** | 🤔 not tested | `https://explorer.dogechain.dog/api` |
| **evm.etherscan** | 🤔 not tested | `https://explorer.dogechain.dog/api` |
| **evm.node** | 🤔 not tested | `https://rpc.dogechain.dog` |

### Dogechain Testnet

| datasource | status | URLs |
| -----------------:|:------------- | ---------------------------------------------------------- |
| **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/dogechain-testnet` |
| **abi.etherscan** | 🤔 not tested | `http://explorer-testnet.dogechain.dog/api` |
| **evm.etherscan** | 🤔 not tested | `http://explorer-testnet.dogechain.dog/api` |
| **evm.node** | 🤔 not tested | `https://rpc-testnet.dogechain.dog` |
8 changes: 4 additions & 4 deletions docs/10.supported-networks/16.ethereum.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Explorer: [Etherscan](https://etherscan.io/)
| datasource | status | URLs |
| -----------------:|:-------- | -------------------------------------------------------------------------------- |
| **evm.subsquid** | 🟢 works | `https://v2.archive.subsquid.io/network/ethereum-mainnet` |
| **abi.etherscan** | 🟢 works | `https://api.etherscan.io/api` |
| **evm.etherscan** | 🟢 works | `https://api.etherscan.io/api` |
| **evm.node** | 🟢 works | `https://eth-mainnet.g.alchemy.com/v2` <br> `wss://eth-mainnet.g.alchemy.com/v2` |

### Ethereum Goerli
Expand All @@ -26,7 +26,7 @@ Explorer: [Etherscan](https://goerli.etherscan.io/)
| datasource | status | URLs |
| -----------------:|:------------- | -------------------------------------------------------- |
| **evm.subsquid** | ⚰️ deprecated | `https://v2.archive.subsquid.io/network/ethereum-goerli` |
| **abi.etherscan** | ⚰️ deprecated | `https://api-goerli.etherscan.io/api` |
| **evm.etherscan** | ⚰️ deprecated | `https://api-goerli.etherscan.io/api` |
| **evm.node** | ⚰️ deprecated | |

### Ethereum Holesky
Expand All @@ -36,7 +36,7 @@ Explorer: [Etherscan](https://holesky.etherscan.io/)
| datasource | status | URLs |
| -----------------:|:------------- | --------------------------------------------------------- |
| **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/ethereum-holesky` |
| **abi.etherscan** | 🤔 not tested | `https://api-holesky.etherscan.io/api` |
| **evm.etherscan** | 🤔 not tested | `https://api-holesky.etherscan.io/api` |
| **evm.node** | 🤔 not tested | |

### Ethereum Sepolia
Expand All @@ -46,5 +46,5 @@ Explorer: [Etherscan](https://sepolia.etherscan.io/)
| datasource | status | URLs |
| -----------------:|:------------- | --------------------------------------------------------- |
| **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/ethereum-sepolia` |
| **abi.etherscan** | 🤔 not tested | `https://api-sepolia.etherscan.io/api` |
| **evm.etherscan** | 🤔 not tested | `https://api-sepolia.etherscan.io/api` |
| **evm.node** | 🤔 not tested | |
4 changes: 2 additions & 2 deletions docs/10.supported-networks/17.etherlink.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Explorer: [Blockscout](https://explorer.etherlink.com/)
| datasource | status | URLs |
| -----------------:|:------------- | ---------------------------------------------------------- |
| **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/etherlink-mainnet` |
| **abi.etherscan** | 🤔 not tested | `https://testnet-explorer.etherlink.com/api` |
| **evm.etherscan** | 🤔 not tested | `https://testnet-explorer.etherlink.com/api` |
| **evm.node** | 🤔 not tested | `https://node.mainnet.etherlink.com` |

### Etherlink Testnet
Expand All @@ -26,5 +26,5 @@ Explorer: [Blockscout](https://testnet.explorer.etherlink.com/)
| datasource | status | URLs |
| -----------------:|:------------- | ---------------------------------------------------------- |
| **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/etherlink-testnet` |
| **abi.etherscan** | 🤔 not tested | `https://testnet-explorer.etherlink.com/api` |
| **evm.etherscan** | 🤔 not tested | `https://testnet-explorer.etherlink.com/api` |
| **evm.node** | 🤔 not tested | |
2 changes: 1 addition & 1 deletion docs/10.supported-networks/18.exosama.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ Explorer: [Blockscout](https://explorer.exosama.com/)
| datasource | status | URLs |
| -----------------:|:------------- | ------------------------------------------------ |
| **evm.subsquid** | 🟢 works | `https://v2.archive.subsquid.io/network/exosama` |
| **abi.etherscan** | 🤔 not tested | `https://explorer.exosama.com/api` |
| **evm.etherscan** | 🤔 not tested | `https://explorer.exosama.com/api` |
| **evm.node** | 🤔 not tested | |
4 changes: 2 additions & 2 deletions docs/10.supported-networks/19.fantom.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Explorer: [Ftmscan](https://ftmscan.com/)
| datasource | status | URLs |
| -----------------:|:------------- | ------------------------------------------------------- |
| **evm.subsquid** | 🟢 works | `https://v2.archive.subsquid.io/network/fantom-mainnet` |
| **abi.etherscan** | 🟢 works | `https://api.ftmscan.com/api` |
| **evm.etherscan** | 🟢 works | `https://api.ftmscan.com/api` |
| **evm.node** | 🤔 not tested | |

### Fantom Testnet
Expand All @@ -26,5 +26,5 @@ Explorer: [Ftmscan](https://testnet.ftmscan.com/)
| datasource | status | URLs |
| -----------------:|:------------- | ------------------------------------------------------- |
| **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/fantom-testnet` |
| **abi.etherscan** | 🤔 not tested | `https://api-testnet.ftmscan.com/api` |
| **evm.etherscan** | 🤔 not tested | `https://api-testnet.ftmscan.com/api` |
| **evm.node** | 🤔 not tested | |
Loading

0 comments on commit 4100e80

Please sign in to comment.