-
-
Notifications
You must be signed in to change notification settings - Fork 60
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
fa11f11
commit 7110c94
Showing
82 changed files
with
1,210 additions
and
876 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| --- | ||
| title: "→ Overview" | ||
| description: "DipDup can index any EVM-compatible network as long as there's enough historical data. This page contains a list of supported networks and instructions on how to configure your indexer for them." | ||
| network: "ethereum" | ||
| --- | ||
|
|
||
| <!-- markdownlint-disable no-bare-urls no-inline-html no-emphasis-as-heading --> | ||
|
|
||
| _Latest update: 2024-05-04._ | ||
|
|
||
| # Supported networks | ||
|
|
||
| DipDup can index any EVM-compatible network as long as there's enough historical data. This page contains a list of supported networks and instructions on how to configure your indexer for them. | ||
|
|
||
| We aim to support all networks available in [Subsquid Network](https://docs.subsquid.io/subsquid-network/reference/evm-networks/#raw-urls), and several others in node-only mode. | ||
|
|
||
| If you want to share your test results or have found an error, please open an issue on [GitHub](https://github.com/dipdup-io/dipdup). | ||
|
|
||
| ## Configuring datasources | ||
|
|
||
| If you've created a new project using `dipdup new` command and used one of the EVM templates, `datasources` section in your config file should look like this: | ||
|
|
||
| ```yaml [dipdup.yaml] | ||
| datasources: | ||
| subsquid: | ||
| kind: evm.subsquid | ||
| url: ${SUBSQUID_URL:-https://v2.archive.subsquid.io/network/ethereum-mainnet} | ||
| etherscan: | ||
| kind: abi.etherscan | ||
| url: ${ETHERSCAN_URL:-https://api.etherscan.io/api} | ||
| api_key: ${ETHERSCAN_API_KEY:-''} | ||
| evm_node: | ||
| kind: evm.node | ||
| url: ${NODE_URL:-https://eth-mainnet.g.alchemy.com/v2}/${NODE_API_KEY:-''} | ||
| ws_url: ${NODE_WS_URL:-wss://eth-mainnet.g.alchemy.com/v2}/${NODE_API_KEY:-''} | ||
| ``` | ||
| To configure datasources for other networks, you need to change URLs and API keys. You can do it in the config file directly, but it's better to use environment variables. Check the `deploy/.env.default` file in your project directory; it contains all the variables used in config. | ||
|
|
||
| [evm.subsquid](../3.datasources/4.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/1.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.node](../3.datasources/3.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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| --- | ||
| title: "Arbitrum" | ||
| description: "Arbitrum network support" | ||
| --- | ||
|
|
||
| <!-- markdownlint-disable single-h1 heading-increment no-inline-html --> | ||
|
|
||
| # Arbitrum | ||
|
|
||
| {{ #include 10.supported-networks/_intro.md }} | ||
|
|
||
| See also: [RPC endpoints and providers | Arbitrum Docs](https://docs.arbitrum.io/node-running/node-providers) | ||
|
|
||
| ### Arbitrum One | ||
|
|
||
| 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.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.node** | ⚰️ deprecated | | | ||
|
|
||
| ### Arbitrum Nova | ||
|
|
||
| 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.node** | 🤔 WS not tested | `https://nova.arbitrum.io/rpc` | | ||
|
|
||
| ### Arbitrum Sepolia | ||
|
|
||
| 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.node** | 🟢 works | `https://arb-sepolia.g.alchemy.com/v2` <br> `wss://arb-sepolia.g.alchemy.com/v2` | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| --- | ||
| title: "Dogechain" | ||
| description: "Dogechain network support" | ||
| --- | ||
|
|
||
| <!-- markdownlint-disable single-h1 heading-increment no-inline-html --> | ||
|
|
||
| # Dogechain | ||
|
|
||
| {{ #include 10.supported-networks/_intro.md }} | ||
|
|
||
| Explorers: [Dogechain](https://dogechain.info/), [Blockscout](https://explorer.dogechain.dog/) | ||
|
|
||
| | datasource | status | URLs | | ||
| | -----------------:|:------------- | -------------------------------------------------- | | ||
| | **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/dogechain` | | ||
| | **abi.etherscan** | 🤔 not tested | `https://explorer.dogechain.dog/api` | | ||
| | **evm.node** | 🤔 not tested | | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| --- | ||
| title: "Ethereum" | ||
| description: "Ethereum network support" | ||
| --- | ||
|
|
||
| <!-- markdownlint-disable single-h1 heading-increment no-inline-html --> | ||
|
|
||
| # Ethereum | ||
|
|
||
| {{ #include 10.supported-networks/_intro.md }} | ||
|
|
||
| ### Ethereum Mainnet | ||
|
|
||
| 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.node** | 🟢 works | `https://eth-mainnet.g.alchemy.com/v2` <br> `wss://eth-mainnet.g.alchemy.com/v2` | | ||
|
|
||
| ### Ethereum Goerli | ||
|
|
||
| Explorer: [Etherscan](https://goerli.etherscan.io/) | ||
|
|
||
| | datasource | status | URLs | | ||
| | -----------------:|:------------- | -------------------------------------------------------- | | ||
| | **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/ethereum-goerli` | | ||
| | **abi.etherscan** | 🤔 not tested | `https://api-goerli.etherscan.io/api` | | ||
| | **evm.node** | 🤔 not tested | | | ||
|
|
||
| ### Ethereum Holesky | ||
|
|
||
| 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.node** | 🤔 not tested | | | ||
|
|
||
| ### Ethereum Sepolia | ||
|
|
||
| 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.node** | 🤔 not tested | | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| --- | ||
| title: "Etherlink" | ||
| description: "Etherlink network support" | ||
| --- | ||
|
|
||
| <!-- markdownlint-disable single-h1 heading-increment no-inline-html --> | ||
|
|
||
| # Etherlink | ||
|
|
||
| {{ #include 10.supported-networks/_intro.md }} | ||
|
|
||
| ### Etherlink Testnet | ||
|
|
||
| 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.node** | 🤔 not tested | | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| --- | ||
| title: "Exosama" | ||
| description: "Exosama network support" | ||
| --- | ||
|
|
||
| <!-- markdownlint-disable single-h1 heading-increment no-inline-html --> | ||
|
|
||
| # Exosama | ||
|
|
||
| {{ #include 10.supported-networks/_intro.md }} | ||
|
|
||
| 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.node** | 🤔 not tested | | |
Oops, something went wrong.