Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/1.getting-started/5.database.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ Several tables having `dipdup_` prefix are created by DipDup automatically and a
| `dipdup_contract` | Info about contracts used by all indexes, including ones added in runtime. |
| `dipdup_model_update` | Service table to store model diffs for database rollback. Configured by `advanced.rollback_depth` |
| `dipdup_meta` | Arbitrary key-value storage for DipDup internal use. Survives reindexing. You can use it too, but don't touch keys with `dipdup_` prefix. |
| `dipdup_contract_metadata` | See [Metadata interface](../5.advanced/11.metadata-interface.md). |
| `dipdup_token_metadata` | See [Metadata interface](../5.advanced/11.metadata-interface.md) |
| `dipdup_contract_metadata` | See [Metadata interface](../5.advanced/11.metadata-interface.md). |
| `dipdup_token_metadata` | See [Metadata interface](../5.advanced/11.metadata-interface.md). |

See [`dipdup.models` module](https://github.com/dipdup-io/dipdup/blob/next/src/dipdup/models/__init__.py) for exact table definitions.

Expand Down
30 changes: 15 additions & 15 deletions docs/1.getting-started/7.datasources.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,23 @@ Datasources are DipDup connectors to various APIs. They are defined in config an

Index datasources, ones that can be attached to a specific index, are prefixed with blockchain name, e.g. `tezos.tzkt` or `evm.subsquid`.

| kind | blockchain | description |
| -------------------------------------------------------------- | ---------------- | ----------------------------------------------- |
| [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 |
| [evm.etherscan](../3.datasources/3.evm_etherscan.md) | ⟠ EVM-compatible | Provides ABIs for EVM contracts |
| [evm.blockvision](../3.datasources/4.evm_blockvision.md) | ⟠ EVM-compatible | Provides ABIs for EVM contracts |
| [evm.sourcify](../3.datasources/5.evm_sourcify.md) | ⟠ EVM-compatible | Provides ABIs for EVM contracts |
| [starknet.subsquid](../3.datasources/6.starknet_subsquid.md) | 🐺 Starknet | Subsquid Network API |
| [starknet.node](../3.datasources/7.starknet_node.md) | 🐺 Starknet | Starknet node |
| [substrate.node](../3.datasources/8.substrate_node.md) | 🔮 Substrate | Substrate node |
| [substrate.subscan](../3.datasources/9.substrate_subscan.md) | 🔮 Substrate | Provides pallet metadata for Substrate networks |
| kind | blockchain | description |
| --------------------------------------------------------------- | ---------------- | ----------------------------------------------- |
| [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 |
| [evm.etherscan](../3.datasources/3.evm_etherscan.md) | ⟠ EVM-compatible | Provides ABIs for EVM contracts |
| [evm.blockvision](../3.datasources/4.evm_blockvision.md) | ⟠ EVM-compatible | Provides ABIs for EVM contracts |
| [evm.sourcify](../3.datasources/5.evm_sourcify.md) | ⟠ EVM-compatible | Provides ABIs for EVM contracts |
| [starknet.subsquid](../3.datasources/6.starknet_subsquid.md) | 🐺 Starknet | Subsquid Network API |
| [starknet.node](../3.datasources/7.starknet_node.md) | 🐺 Starknet | Starknet node |
| [substrate.node](../3.datasources/8.substrate_node.md) | 🔮 Substrate | Substrate node |
| [substrate.subscan](../3.datasources/9.substrate_subscan.md) | 🔮 Substrate | Provides pallet metadata for Substrate networks |
| [substrate.subsquid](../3.datasources/10.substrate_subsquid.md) | 🔮 Substrate | Subsquid Network API |
| [tezos.tzkt](../3.datasources/11.tezos_tzkt.md) | ꜩ Tezos | TzKT API |
| [tzip_metadata](../3.datasources/12.tzip_metadata.md) | ꜩ Tezos | TZIP-16 metadata |
| [coinbase](../3.datasources/13.coinbase.md) | any | Coinbase price feed |
| [ipfs](../3.datasources/14.ipfs.md) | any | IPFS gateway |
| [http](../3.datasources/15.http.md) | any | Generic HTTP API |
| [tzip_metadata](../3.datasources/12.tzip_metadata.md) | ꜩ Tezos | TZIP-16 metadata |
| [coinbase](../3.datasources/13.coinbase.md) | any | Coinbase price feed |
| [ipfs](../3.datasources/14.ipfs.md) | any | IPFS gateway |
| [http](../3.datasources/15.http.md) | any | Generic HTTP API |

## Connection settings

Expand Down
2 changes: 1 addition & 1 deletion docs/10.supported-networks/0.overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ network: "ethereum"
# Supported networks

::banner{type="note"}
This page is about EVM. Looking for [Starknet](../0.quickstart-starknet.md) or [Tezos](../0.quickstart-tezos.md)?
This page is about EVM networks. Looking for [Starknet](../0.quickstart-starknet.md), [Substrate](../0.quickstart-substrate.md), [Tezos](../0.quickstart-tezos.md)?
::

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.
Expand Down
10 changes: 5 additions & 5 deletions docs/10.supported-networks/23.hokum.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ description: "Hokum network support"

Explorer: [Blockscout](https://explorer.hokum.gg/) (🔴 408)

| datasource | status | URLs |
| -----------------:|:------------- | --------------------------- |
| **evm.subsquid** | 🔴 no API | N/A |
| **evm.etherscan** | 🤔 not tested | |
| **evm.node** | 🤔 not tested | `https://mainnet.hokum.gg` |
| datasource | status | URLs |
| -----------------:|:------------- | -------------------------- |
| **evm.subsquid** | N/A | |
| **evm.etherscan** | 🤔 not tested | |
| **evm.node** | 🤔 not tested | `https://mainnet.hokum.gg` |
2 changes: 1 addition & 1 deletion docs/10.supported-networks/24.kakarot.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ See step-by-step instructions on how to get started in [this guide](https://docs

| datasource | status | URLs |
| -----------------:|:------------- | --------------------------------- |
| **evm.subsquid** | 🔴 no API | N/A |
| **evm.subsquid** | N/A | |
| **evm.etherscan** | 🤔 not tested | |
| **evm.node** | 🟢 works | `https://sepolia-rpc.kakarot.org` |
2 changes: 1 addition & 1 deletion docs/10.supported-networks/25.karak.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ Explorer: [Blockscout](https://explorer.karak.network/)

| datasource | status | URLs |
| -----------------:|:------------- | --------------------------- |
| **evm.subsquid** | 🔴 no API | N/A |
| **evm.subsquid** | N/A | |
| **evm.etherscan** | 🤔 not tested | |
| **evm.node** | 🤔 not tested | `https://rpc.karak.network` |
16 changes: 8 additions & 8 deletions docs/10.supported-networks/39.prom.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@ description: "Prom network support"

Explorer: [Promscan](https://promscan.io/)

| datasource | status | URLs |
| -----------------:|:------------- | ------------------------------------------------------- |
| datasource | status | URLs |
| -----------------:|:------------- | ----------------------------------------------------- |
| **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/prom-mainnet` |
| **evm.etherscan** | 🤔 not tested | `https://promscan.io/api/v2/search?q=USDT` |
| **evm.node** | 🤔 not tested | `https://prom-rpc.eu-north-2.gateway.fm` |
| **evm.etherscan** | 🤔 not tested | `https://promscan.io/api/v2/search?q=USDT` |
| **evm.node** | 🤔 not tested | `https://prom-rpc.eu-north-2.gateway.fm` |

### Prom Testnet

| datasource | status | URLs |
| -----------------:|:------------- | ------------------------------------------------------- |
| datasource | status | URLs |
| -----------------:|:------------- | ----------------------------------------------------- |
| **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/prom-testnet` |
| **evm.etherscan** | 🤔 not tested | |
| **evm.node** | 🤔 not tested | |
| **evm.etherscan** | 🤔 not tested | |
| **evm.node** | 🤔 not tested | |
2 changes: 1 addition & 1 deletion docs/10.supported-networks/42.shibuya.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ Explorer: [Subscan](https://shibuya.subscan.io/)
| datasource | status | URLs |
| -----------------:|:------------- | -------------------------------------------------------- |
| **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/shibuya-testnet` |
| **evm.etherscan** | 🔴 no API | N/A |
| **evm.etherscan** | N/A | |
| **evm.node** | 🤔 not tested | |
24 changes: 24 additions & 0 deletions docs/10.supported-networks/44.somnia.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: "Somnia"
description: "Somnia network support"
---

<!-- markdownlint-disable single-h1 heading-increment no-inline-html -->

# Somnia

{{ #include 10.supported-networks/_intro.md }}

### Somnia Testnet

From [Network Info](https://docs.somnia.network/developer/network-info) page:

- Chain ID: `50312`
- Explorer: [Blockscout](https://shannon-explorer.somnia.network/)
- Faucet: [Somnia Testnet](https://testnet.somnia.network/) ("Request Tokens" button)

| datasource | status | URLs |
| -----------------:|:-------- | ------------------------------------------ |
| **evm.subsquid** | N/A | |
| **evm.etherscan** | 🟢 works | `https://shannon-explorer.somnia.network/` |
| **evm.node** | 🟢 works | `https://dream-rpc.somnia.network/` |
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ description: "Sonic network support"
Explorer: [Sonic Explorer](https://explorer.soniclabs.com/)

| datasource | status | URLs |
| ----------------: | :------------ | ------------------------------------------------------ |
| -----------------:|:------------- | ------------------------------------------------------ |
| **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/sonic-testnet` |
| **evm.etherscan** | 🔴 no API | N/A |
| **evm.etherscan** | N/A | |
| **evm.node** | 🤔 not tested | `https://rpc.testnet.soniclabs.com` |
30 changes: 0 additions & 30 deletions docs/10.supported-networks/46.taiko.md

This file was deleted.

30 changes: 30 additions & 0 deletions docs/10.supported-networks/47.taiko.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: "Taiko"
description: "Taiko network support"
---

<!-- markdownlint-disable single-h1 heading-increment no-inline-html -->

# Taiko

{{ #include 10.supported-networks/_intro.md }}

### Taiko Mainnet

Explorer: [Taikoscan](https://taikoscan.io/)

| datasource | status | URLs |
| -----------------:|:------------- | ------------------------------------------------------ |
| **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/taiko-mainnet` |
| **evm.etherscan** | 🤔 not tested | `https://api.taikoscan.io/api` |
| **evm.node** | 🤔 not tested | `https://rpc.taiko.xyz` |

### Taiko Hekla

Explorer: [Taikoscan](https://hekla.taikoscan.io/)

| datasource | status | URLs |
| -----------------:|:------------- | ------------------------------------ |
| **evm.subsquid** | N/A | |
| **evm.etherscan** | 🤔 not tested | `https://api-hekla.taikoscan.io/api` |
| **evm.node** | 🤔 not tested | `https://rpc.hekla.taiko.xyz` |
2 changes: 1 addition & 1 deletion docs/10.supported-networks/9.bob.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ description: "BOB network"
| -----------------:|:------------- | ---------------------------------------------------- |
| **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/bob-mainnet` |
| **evm.etherscan** | 🤔 not tested | |
| **evm.node** | 🤔 not tested | `https://bob.drpc.org` <br> `wss://rpc.gobob.xyz` |
| **evm.node** | 🤔 not tested | `https://bob.drpc.org` <br> `wss://rpc.gobob.xyz` |
4 changes: 3 additions & 1 deletion docs/3.datasources/1.evm_subsquid.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Subsquid Network"
title: "EVM: Subsquid"
description: "DipDup uses Subsquid Network as a source of historical data for EVM-compatible blockchains."
network: "ethereum"
---
Expand All @@ -8,6 +8,8 @@ network: "ethereum"

{{ #include 3.datasources/_evm_banner.md }}

{{ #include 3.datasources/_subsquid_banner.md }}

DipDup uses [Subsquid Network](https://docs.subsquid.io/subsquid-network/reference/evm-api/) as a source of historical data for EVM-compatible blockchains.

Configure the datasource in your project config:
Expand Down
4 changes: 3 additions & 1 deletion docs/3.datasources/10.substrate_subsquid.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
---
title: "Subsquid Network"
title: "Substrate: Subsquid"
description: "DipDup uses Subsquid Network as a source of historical data for Substrate blockchains."
network: "substrate"
---

# Subsquid Network

{{ #include 3.datasources/_subsquid_banner.md }}

DipDup uses [Subsquid Network](https://docs.subsquid.io/subsquid-network/reference/evm-api/) as a source of historical data for Substrate blockchains.

Configure the datasource in your project config:
Expand Down
2 changes: 1 addition & 1 deletion docs/3.datasources/11.tezos_tzkt.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "TzKT"
title: "Tezos: TzKT"
description: "TzKT provides REST endpoints to query historical data for Tezos blockchain. Flexible filters allow to request only data needed for your application and drastically speed up the indexing process."
network: "tezos"
---
Expand Down
2 changes: 1 addition & 1 deletion docs/3.datasources/12.tzip_metadata.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "TZIP metadata"
title: "Tezos: TZIP metadata"
description: "dipdup-metadata is a standalone companion indexer for DipDup written in Go. Configure datasource in the following way"
network: "tezos"
---
Expand Down
2 changes: 1 addition & 1 deletion docs/3.datasources/2.evm_node.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "EVM Node"
title: "EVM: Node RPC"
description: "DipDup can connect to any EVM-compatible node via JSON-RPC. It can be used as a last mile datasource for EVM indexes (data that is not in Subsquid Network yet) or as a standalone datasource for handlers and hooks."
network: "ethereum"
---
Expand Down
6 changes: 5 additions & 1 deletion docs/3.datasources/3.evm_etherscan.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Etherscan"
title: "EVM: Etherscan"
description: "Etherscan is a popular Ethereum blockchain explorer. It provides a public API to fetch ABIs of verified contracts. DipDup can use its API to fetch ABIs for contracts being indexed."
network: "ethereum"
---
Expand Down Expand Up @@ -46,3 +46,7 @@ If you have an Etherscan API key, you can set it in config. You may also want to
ratelimit_period: 1
ratelimit_rate: 10
```

### Blockscout compatibility

If you are using Blockscout, you can use the same configuration with it. Blockscout and Etherscan APIs are partially compatible, just enough for DipDup to fetch contract ABIs.
2 changes: 1 addition & 1 deletion docs/3.datasources/4.evm_blockvision.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Blockvision"
title: "EVM: Blockvision"
description: "Blockvision is multi-chain Node, Token, NFT, and DeFi API provider and data retrieval portal for developers. It provides a public API to fetch ABIs of verified contracts. DipDup can use its API to fetch ABIs for contracts being indexed."
network: "ethereum"
---
Expand Down
2 changes: 1 addition & 1 deletion docs/3.datasources/5.evm_sourcify.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Sourcify"
title: "EVM: Sourcify"
description: "Sourcify is a source-code verification service for Ethereum smart contracts supporting Solidity and Vyper. It provides a public API to fetch ABIs of verified contracts. DipDup can use its API to fetch ABIs for contracts being indexed."
network: "ethereum"
---
Expand Down
4 changes: 3 additions & 1 deletion docs/3.datasources/6.starknet_subsquid.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
---
title: "Subsquid Network"
title: "Starknet: Subsquid"
description: "DipDup uses Subsquid Network as a source of historical data for Starknet blockchain."
network: "starknet"
---

# Subsquid Network

{{ #include 3.datasources/_subsquid_banner.md }}

DipDup uses [Subsquid Network](https://docs.subsquid.io/subsquid-network/reference/starknet-api/) as a source of historical data for Starknet blockchain.

Configure the datasource in your project config:
Expand Down
2 changes: 1 addition & 1 deletion docs/3.datasources/7.starknet_node.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Starknet Node"
title: "Starknet: Node RPC"
description: "DipDup can connect to Starknet nodes via JSON-RPC. It can be used as a last mile datasource for Starknet indexes (data that is not in Subsquid Network yet) or as a standalone datasource for handlers and hooks."
network: "starknet"
---
Expand Down
Loading