From 9faf16972dfff26285b8f0c135d01c5de154731b Mon Sep 17 00:00:00 2001 From: Lev Gorodetskiy Date: Mon, 24 Feb 2025 12:21:48 -0300 Subject: [PATCH 1/3] Add Somnia Testnet --- docs/10.supported-networks/23.hokum.md | 10 +++---- docs/10.supported-networks/24.kakarot.md | 2 +- docs/10.supported-networks/25.karak.md | 2 +- docs/10.supported-networks/42.shibuya.md | 2 +- docs/10.supported-networks/44.somnia.md | 24 +++++++++++++++ .../{44.scale.md => 45.scale.md} | 0 .../{45.sonic.md => 46.sonic.md} | 4 +-- docs/10.supported-networks/46.taiko.md | 30 ------------------- docs/10.supported-networks/47.taiko.md | 30 +++++++++++++++++++ .../{47.tanssi.md => 48.tanssi.md} | 0 .../{48.x1.md => 49.x1.md} | 0 .../{49.x-layer.md => 50.x-layer.md} | 0 .../{50.zksync.md => 51.zksync.md} | 0 .../{51.zora.md => 52.zora.md} | 0 14 files changed, 64 insertions(+), 40 deletions(-) create mode 100644 docs/10.supported-networks/44.somnia.md rename docs/10.supported-networks/{44.scale.md => 45.scale.md} (100%) rename docs/10.supported-networks/{45.sonic.md => 46.sonic.md} (78%) delete mode 100644 docs/10.supported-networks/46.taiko.md create mode 100644 docs/10.supported-networks/47.taiko.md rename docs/10.supported-networks/{47.tanssi.md => 48.tanssi.md} (100%) rename docs/10.supported-networks/{48.x1.md => 49.x1.md} (100%) rename docs/10.supported-networks/{49.x-layer.md => 50.x-layer.md} (100%) rename docs/10.supported-networks/{50.zksync.md => 51.zksync.md} (100%) rename docs/10.supported-networks/{51.zora.md => 52.zora.md} (100%) diff --git a/docs/10.supported-networks/23.hokum.md b/docs/10.supported-networks/23.hokum.md index 931b88665..50d978b11 100644 --- a/docs/10.supported-networks/23.hokum.md +++ b/docs/10.supported-networks/23.hokum.md @@ -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` | diff --git a/docs/10.supported-networks/24.kakarot.md b/docs/10.supported-networks/24.kakarot.md index 2f97dd6b7..1d7a6b8c3 100644 --- a/docs/10.supported-networks/24.kakarot.md +++ b/docs/10.supported-networks/24.kakarot.md @@ -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` | diff --git a/docs/10.supported-networks/25.karak.md b/docs/10.supported-networks/25.karak.md index 54d0887ad..70562bd98 100644 --- a/docs/10.supported-networks/25.karak.md +++ b/docs/10.supported-networks/25.karak.md @@ -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` | diff --git a/docs/10.supported-networks/42.shibuya.md b/docs/10.supported-networks/42.shibuya.md index 9d1617736..8e0e42f06 100644 --- a/docs/10.supported-networks/42.shibuya.md +++ b/docs/10.supported-networks/42.shibuya.md @@ -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 | | diff --git a/docs/10.supported-networks/44.somnia.md b/docs/10.supported-networks/44.somnia.md new file mode 100644 index 000000000..d289dbb78 --- /dev/null +++ b/docs/10.supported-networks/44.somnia.md @@ -0,0 +1,24 @@ +--- +title: "Somnia" +description: "Somnia network support" +--- + + + +# 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** | 🔴 504 Gateway Time-out | `https://dream-rpc.somnia.network/` | diff --git a/docs/10.supported-networks/44.scale.md b/docs/10.supported-networks/45.scale.md similarity index 100% rename from docs/10.supported-networks/44.scale.md rename to docs/10.supported-networks/45.scale.md diff --git a/docs/10.supported-networks/45.sonic.md b/docs/10.supported-networks/46.sonic.md similarity index 78% rename from docs/10.supported-networks/45.sonic.md rename to docs/10.supported-networks/46.sonic.md index 1beca983c..7ac0204f7 100644 --- a/docs/10.supported-networks/45.sonic.md +++ b/docs/10.supported-networks/46.sonic.md @@ -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` | diff --git a/docs/10.supported-networks/46.taiko.md b/docs/10.supported-networks/46.taiko.md deleted file mode 100644 index 456b326d7..000000000 --- a/docs/10.supported-networks/46.taiko.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Taiko" -description: "Taiko network support" ---- - - - -# 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** | 🔴 no API | N/A | -| **evm.etherscan** | 🤔 not tested | `https://api-hekla.taikoscan.io/api` | -| **evm.node** | 🤔 not tested | `https://rpc.hekla.taiko.xyz` | diff --git a/docs/10.supported-networks/47.taiko.md b/docs/10.supported-networks/47.taiko.md new file mode 100644 index 000000000..ea81d1756 --- /dev/null +++ b/docs/10.supported-networks/47.taiko.md @@ -0,0 +1,30 @@ +--- +title: "Taiko" +description: "Taiko network support" +--- + + + +# 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` | diff --git a/docs/10.supported-networks/47.tanssi.md b/docs/10.supported-networks/48.tanssi.md similarity index 100% rename from docs/10.supported-networks/47.tanssi.md rename to docs/10.supported-networks/48.tanssi.md diff --git a/docs/10.supported-networks/48.x1.md b/docs/10.supported-networks/49.x1.md similarity index 100% rename from docs/10.supported-networks/48.x1.md rename to docs/10.supported-networks/49.x1.md diff --git a/docs/10.supported-networks/49.x-layer.md b/docs/10.supported-networks/50.x-layer.md similarity index 100% rename from docs/10.supported-networks/49.x-layer.md rename to docs/10.supported-networks/50.x-layer.md diff --git a/docs/10.supported-networks/50.zksync.md b/docs/10.supported-networks/51.zksync.md similarity index 100% rename from docs/10.supported-networks/50.zksync.md rename to docs/10.supported-networks/51.zksync.md diff --git a/docs/10.supported-networks/51.zora.md b/docs/10.supported-networks/52.zora.md similarity index 100% rename from docs/10.supported-networks/51.zora.md rename to docs/10.supported-networks/52.zora.md From 06ae0e044d80b42e49c27d966e7210411bfe9207 Mon Sep 17 00:00:00 2001 From: Lev Gorodetskiy Date: Mon, 24 Feb 2025 14:26:37 -0300 Subject: [PATCH 2/3] subsquid banner, refs --- docs/10.supported-networks/44.somnia.md | 10 +- docs/3.datasources/1.evm_subsquid.md | 4 +- docs/3.datasources/10.substrate_subsquid.md | 4 +- docs/3.datasources/11.tezos_tzkt.md | 2 +- docs/3.datasources/12.tzip_metadata.md | 2 +- docs/3.datasources/2.evm_node.md | 2 +- docs/3.datasources/3.evm_etherscan.md | 2 +- docs/3.datasources/4.evm_blockvision.md | 2 +- docs/3.datasources/5.evm_sourcify.md | 2 +- docs/3.datasources/6.starknet_subsquid.md | 4 +- docs/3.datasources/7.starknet_node.md | 2 +- docs/3.datasources/8.substrate_node.md | 2 +- docs/3.datasources/9.substrate_subscan.md | 4 +- docs/3.datasources/_subsquid_banner.md | 4 + docs/7.references/2.config.md | 128 ++++++++++---------- docs/7.references/3.context.md | 26 ++-- docs/7.references/4.models.md | 98 +++++++-------- 17 files changed, 154 insertions(+), 144 deletions(-) create mode 100644 docs/3.datasources/_subsquid_banner.md diff --git a/docs/10.supported-networks/44.somnia.md b/docs/10.supported-networks/44.somnia.md index d289dbb78..e2fc2fa39 100644 --- a/docs/10.supported-networks/44.somnia.md +++ b/docs/10.supported-networks/44.somnia.md @@ -17,8 +17,8 @@ From [Network Info](https://docs.somnia.network/developer/network-info) page: - 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** | 🔴 504 Gateway Time-out | `https://dream-rpc.somnia.network/` | +| datasource | status | URLs | +| -----------------:|:-------- | ------------------------------------------ | +| **evm.subsquid** | N/A | | +| **evm.etherscan** | 🟢 works | `https://shannon-explorer.somnia.network/` | +| **evm.node** | 🟢 works | `https://dream-rpc.somnia.network/` | diff --git a/docs/3.datasources/1.evm_subsquid.md b/docs/3.datasources/1.evm_subsquid.md index e2ddd6a17..a5acb24a0 100644 --- a/docs/3.datasources/1.evm_subsquid.md +++ b/docs/3.datasources/1.evm_subsquid.md @@ -1,5 +1,5 @@ --- -title: "Subsquid Network" +title: "EVM: Subsquid Network" description: "DipDup uses Subsquid Network as a source of historical data for EVM-compatible blockchains." network: "ethereum" --- @@ -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: diff --git a/docs/3.datasources/10.substrate_subsquid.md b/docs/3.datasources/10.substrate_subsquid.md index f23275e4c..86d6e2a47 100644 --- a/docs/3.datasources/10.substrate_subsquid.md +++ b/docs/3.datasources/10.substrate_subsquid.md @@ -1,11 +1,13 @@ --- -title: "Subsquid Network" +title: "Substrate: Subsquid Network" 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: diff --git a/docs/3.datasources/11.tezos_tzkt.md b/docs/3.datasources/11.tezos_tzkt.md index 3a5681d71..c0a625463 100644 --- a/docs/3.datasources/11.tezos_tzkt.md +++ b/docs/3.datasources/11.tezos_tzkt.md @@ -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" --- diff --git a/docs/3.datasources/12.tzip_metadata.md b/docs/3.datasources/12.tzip_metadata.md index 443bc6fee..d35eb51e3 100644 --- a/docs/3.datasources/12.tzip_metadata.md +++ b/docs/3.datasources/12.tzip_metadata.md @@ -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" --- diff --git a/docs/3.datasources/2.evm_node.md b/docs/3.datasources/2.evm_node.md index 68231ff29..e44ef52a7 100644 --- a/docs/3.datasources/2.evm_node.md +++ b/docs/3.datasources/2.evm_node.md @@ -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" --- diff --git a/docs/3.datasources/3.evm_etherscan.md b/docs/3.datasources/3.evm_etherscan.md index baea4466b..3d9a3a9eb 100644 --- a/docs/3.datasources/3.evm_etherscan.md +++ b/docs/3.datasources/3.evm_etherscan.md @@ -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" --- diff --git a/docs/3.datasources/4.evm_blockvision.md b/docs/3.datasources/4.evm_blockvision.md index d567f58ca..3cab717e5 100644 --- a/docs/3.datasources/4.evm_blockvision.md +++ b/docs/3.datasources/4.evm_blockvision.md @@ -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" --- diff --git a/docs/3.datasources/5.evm_sourcify.md b/docs/3.datasources/5.evm_sourcify.md index db47a86cb..38cc2ab60 100644 --- a/docs/3.datasources/5.evm_sourcify.md +++ b/docs/3.datasources/5.evm_sourcify.md @@ -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" --- diff --git a/docs/3.datasources/6.starknet_subsquid.md b/docs/3.datasources/6.starknet_subsquid.md index e332a6cd8..245579b9a 100644 --- a/docs/3.datasources/6.starknet_subsquid.md +++ b/docs/3.datasources/6.starknet_subsquid.md @@ -1,11 +1,13 @@ --- -title: "Subsquid Network" +title: "Starknet: Subsquid Network" 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: diff --git a/docs/3.datasources/7.starknet_node.md b/docs/3.datasources/7.starknet_node.md index e13d3dc88..00805be5d 100644 --- a/docs/3.datasources/7.starknet_node.md +++ b/docs/3.datasources/7.starknet_node.md @@ -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" --- diff --git a/docs/3.datasources/8.substrate_node.md b/docs/3.datasources/8.substrate_node.md index f64c60f17..4b69a000e 100644 --- a/docs/3.datasources/8.substrate_node.md +++ b/docs/3.datasources/8.substrate_node.md @@ -1,5 +1,5 @@ --- -title: "Substrate Node" +title: "Substrate: Node RPC" description: "DipDup can connect to any Substrate node via JSON-RPC. It can be used as a last mile datasource for Substrate indexes (data that is not in Subsquid Network yet) or as a standalone datasource for handlers and hooks." network: "substrate" --- diff --git a/docs/3.datasources/9.substrate_subscan.md b/docs/3.datasources/9.substrate_subscan.md index b1a9f509f..ed98c9397 100644 --- a/docs/3.datasources/9.substrate_subscan.md +++ b/docs/3.datasources/9.substrate_subscan.md @@ -1,7 +1,7 @@ --- -title: "Subscan" +title: "Substrate: Subscan" description: "Subscan is a popular Substrate blockchain explorer. It provides a public API to fetch Substrate metadata. DipDup can use its API to fetch ABIs for pallets being indexed." -network: "ethereum" +network: "substrate" --- # Subscan diff --git a/docs/3.datasources/_subsquid_banner.md b/docs/3.datasources/_subsquid_banner.md new file mode 100644 index 000000000..25d227bf5 --- /dev/null +++ b/docs/3.datasources/_subsquid_banner.md @@ -0,0 +1,4 @@ + +::banner{type="note"} +Subsquid Network [has been rebranded](https://blog.sqd.dev/subsquid-becomes-sqd-meet-our-new-self/) to SQD Network. We keep using old name in documentation and config specification for compatibility reasons. +:: diff --git a/docs/7.references/2.config.md b/docs/7.references/2.config.md index 7f446f24b..a3c70946c 100644 --- a/docs/7.references/2.config.md +++ b/docs/7.references/2.config.md @@ -10,7 +10,7 @@ description: "Config file reference" ## dipdup.config.DipDupConfig -class dipdup.config.DipDupConfig(*args, spec_version, package, datasources=<factory>, database=<factory>, runtimes=<factory>, contracts=<factory>, indexes=<factory>, templates=<factory>, jobs=<factory>, hooks=<factory>, hasura=None, sentry=None, prometheus=None, api=None, advanced=<factory>, custom=<factory>, logging='INFO') +class dipdup.config.DipDupConfig(*args, spec_version, package, datasources=<factory>, database=<factory>, runtimes=<factory>, contracts=<factory>, indexes=<factory>, templates=<factory>, jobs=<factory>, hooks=<factory>, hasura=None, sentry=None, prometheus=None, api=None, advanced=<factory>, custom=<factory>, logging='INFO')

DipDup project configuration file

Parameters:
@@ -50,7 +50,7 @@ description: "Config file reference" ## dipdup.config.ContractConfig -class dipdup.config.ContractConfig(**kwargs) +class dipdup.config.ContractConfig(**kwargs)

Contract config

Parameters:
@@ -68,7 +68,7 @@ description: "Config file reference" ## dipdup.config.AdvancedConfig -class dipdup.config.AdvancedConfig(**kwargs) +class dipdup.config.AdvancedConfig(**kwargs)

This section allows users to tune some system-wide options, either experimental or unsuitable for generic configurations.

Parameters:
@@ -92,7 +92,7 @@ description: "Config file reference" ## dipdup.config.ApiConfig -class dipdup.config.ApiConfig(**kwargs) +class dipdup.config.ApiConfig(**kwargs)

Management API config

Parameters:
@@ -110,7 +110,7 @@ description: "Config file reference" ## dipdup.config.coinbase.CoinbaseDatasourceConfig -class dipdup.config.coinbase.CoinbaseDatasourceConfig(*args) +class dipdup.config.coinbase.CoinbaseDatasourceConfig(*args)

Coinbase datasource config

Parameters:
@@ -130,7 +130,7 @@ description: "Config file reference" ## dipdup.config.evm.EvmContractConfig -class dipdup.config.evm.EvmContractConfig(*args) +class dipdup.config.evm.EvmContractConfig(*args)

EVM contract config

Parameters:
@@ -149,7 +149,7 @@ description: "Config file reference" ## dipdup.config.evm_node.EvmNodeDatasourceConfig -class dipdup.config.evm_node.EvmNodeDatasourceConfig(*args) +class dipdup.config.evm_node.EvmNodeDatasourceConfig(*args)

EVM node datasource config

Parameters:
@@ -169,7 +169,7 @@ description: "Config file reference" ## dipdup.config.evm_etherscan.EvmEtherscanDatasourceConfig -class dipdup.config.evm_etherscan.EvmEtherscanDatasourceConfig(*args) +class dipdup.config.evm_etherscan.EvmEtherscanDatasourceConfig(*args)

Etherscan datasource config

Parameters:
@@ -188,7 +188,7 @@ description: "Config file reference" ## dipdup.config.evm_events.EvmEventsHandlerConfig -class dipdup.config.evm_events.EvmEventsHandlerConfig(**kwargs) +class dipdup.config.evm_events.EvmEventsHandlerConfig(**kwargs)

Subsquid event handler

Parameters:
@@ -207,7 +207,7 @@ description: "Config file reference" ## dipdup.config.evm_events.EvmEventsIndexConfig -class dipdup.config.evm_events.EvmEventsIndexConfig(*args) +class dipdup.config.evm_events.EvmEventsIndexConfig(*args)

Subsquid datasource config

Parameters:
@@ -227,7 +227,7 @@ description: "Config file reference" ## dipdup.config.evm_subsquid.EvmSubsquidDatasourceConfig -class dipdup.config.evm_subsquid.EvmSubsquidDatasourceConfig(*args) +class dipdup.config.evm_subsquid.EvmSubsquidDatasourceConfig(*args)

Subsquid datasource config

Parameters:
@@ -245,7 +245,7 @@ description: "Config file reference" ## dipdup.config.evm_transactions.EvmTransactionsHandlerConfig -class dipdup.config.evm_transactions.EvmTransactionsHandlerConfig(**kwargs) +class dipdup.config.evm_transactions.EvmTransactionsHandlerConfig(**kwargs)

Subsquid transaction handler

Parameters:
@@ -266,7 +266,7 @@ description: "Config file reference" ## dipdup.config.evm_transactions.EvmTransactionsIndexConfig -class dipdup.config.evm_transactions.EvmTransactionsIndexConfig(*args) +class dipdup.config.evm_transactions.EvmTransactionsIndexConfig(*args)

Index that uses Subsquid Network as a datasource for transactions

Parameters:
@@ -286,7 +286,7 @@ description: "Config file reference" ## dipdup.config.HandlerConfig -class dipdup.config.HandlerConfig(**kwargs) +class dipdup.config.HandlerConfig(**kwargs)

Base class for index handlers

Parameters:
@@ -303,7 +303,7 @@ description: "Config file reference" ## dipdup.config.HasuraConfig -class dipdup.config.HasuraConfig(**kwargs) +class dipdup.config.HasuraConfig(**kwargs)

Config for the Hasura integration.

Parameters:
@@ -331,7 +331,7 @@ description: "Config file reference" ## dipdup.config.HookConfig -class dipdup.config.HookConfig(**kwargs) +class dipdup.config.HookConfig(**kwargs)

Hook config

Parameters:
@@ -349,7 +349,7 @@ description: "Config file reference" ## dipdup.config.HttpConfig -class dipdup.config.HttpConfig(retry_count=None, retry_sleep=None, retry_multiplier=None, ratelimit_rate=None, ratelimit_period=None, ratelimit_sleep=None, connection_limit=None, connection_timeout=None, request_timeout=None, batch_size=None, polling_interval=None, replay=None, replay_path=None, alias=None) +class dipdup.config.HttpConfig(retry_count=None, retry_sleep=None, retry_multiplier=None, ratelimit_rate=None, ratelimit_period=None, ratelimit_sleep=None, connection_limit=None, connection_timeout=None, request_timeout=None, batch_size=None, polling_interval=None, replay=None, replay_path=None, alias=None)

Advanced configuration of HTTP client

Parameters:
@@ -378,7 +378,7 @@ description: "Config file reference" ## dipdup.config.http.HttpDatasourceConfig -class dipdup.config.http.HttpDatasourceConfig(*args) +class dipdup.config.http.HttpDatasourceConfig(*args)

Generic HTTP datasource config

Parameters:
@@ -396,7 +396,7 @@ description: "Config file reference" ## dipdup.config.IndexConfig -class dipdup.config.IndexConfig(*args) +class dipdup.config.IndexConfig(*args)

Index config

Parameters:
@@ -413,7 +413,7 @@ description: "Config file reference" ## dipdup.config.DatasourceConfig -class dipdup.config.DatasourceConfig(*args) +class dipdup.config.DatasourceConfig(*args)

Base class for datasource configs

Parameters:
@@ -431,7 +431,7 @@ description: "Config file reference" ## dipdup.config.IndexTemplateConfig -class dipdup.config.IndexTemplateConfig(*args) +class dipdup.config.IndexTemplateConfig(*args)

Index template config

Parameters:
@@ -451,7 +451,7 @@ description: "Config file reference" ## dipdup.config.ipfs.IpfsDatasourceConfig -class dipdup.config.ipfs.IpfsDatasourceConfig(*args) +class dipdup.config.ipfs.IpfsDatasourceConfig(*args)

IPFS datasource config

Parameters:
@@ -469,7 +469,7 @@ description: "Config file reference" ## dipdup.config.JobConfig -class dipdup.config.JobConfig(*args) +class dipdup.config.JobConfig(*args)

Job schedule config

Parameters:
@@ -488,7 +488,7 @@ description: "Config file reference" ## dipdup.config.PostgresDatabaseConfig -class dipdup.config.PostgresDatabaseConfig(**kwargs) +class dipdup.config.PostgresDatabaseConfig(**kwargs)

Postgres database connection config

Parameters:
@@ -513,7 +513,7 @@ description: "Config file reference" ## dipdup.config.PrometheusConfig -class dipdup.config.PrometheusConfig(**kwargs) +class dipdup.config.PrometheusConfig(**kwargs)

Config for Prometheus integration.

Parameters:
@@ -532,7 +532,7 @@ description: "Config file reference" ## dipdup.config.ResolvedHttpConfig -class dipdup.config.ResolvedHttpConfig(**kwargs) +class dipdup.config.ResolvedHttpConfig(**kwargs)

Advanced configuration of HTTP client

Parameters:
@@ -562,7 +562,7 @@ description: "Config file reference" ## dipdup.config.RuntimeConfig -class dipdup.config.RuntimeConfig(*args) +class dipdup.config.RuntimeConfig(*args)

Runtime config

Parameters:
@@ -579,7 +579,7 @@ description: "Config file reference" ## dipdup.config.SentryConfig -class dipdup.config.SentryConfig(**kwargs) +class dipdup.config.SentryConfig(**kwargs)

Config for Sentry integration.

Parameters:
@@ -601,7 +601,7 @@ description: "Config file reference" ## dipdup.config.SqliteDatabaseConfig -class dipdup.config.SqliteDatabaseConfig(**kwargs) +class dipdup.config.SqliteDatabaseConfig(**kwargs)

SQLite connection config

Parameters:
@@ -620,7 +620,7 @@ description: "Config file reference" ## dipdup.config.SystemHookConfig -class dipdup.config.SystemHookConfig(callback, atomic=False) +class dipdup.config.SystemHookConfig(callback, atomic=False)

Hook config

Parameters:
@@ -637,7 +637,7 @@ description: "Config file reference" ## dipdup.config.tezos.TezosContractConfig -class dipdup.config.tezos.TezosContractConfig(*args) +class dipdup.config.tezos.TezosContractConfig(*args)

Tezos contract config.

Parameters:
@@ -656,7 +656,7 @@ description: "Config file reference" ## dipdup.config.tezos.TezosIndexConfig -class dipdup.config.tezos.TezosIndexConfig(kind, datasources) +class dipdup.config.tezos.TezosIndexConfig(kind, datasources)

TzKT index config

Parameters:
@@ -673,7 +673,7 @@ description: "Config file reference" ## dipdup.config.tezos_big_maps.TezosBigMapsHandlerConfig -class dipdup.config.tezos_big_maps.TezosBigMapsHandlerConfig(callback) +class dipdup.config.tezos_big_maps.TezosBigMapsHandlerConfig(callback)

Big map handler config

Parameters:
@@ -691,7 +691,7 @@ description: "Config file reference" ## dipdup.config.tezos_big_maps.TezosBigMapsIndexConfig -class dipdup.config.tezos_big_maps.TezosBigMapsIndexConfig(kind, datasources) +class dipdup.config.tezos_big_maps.TezosBigMapsIndexConfig(kind, datasources)

Big map index config

Parameters:
@@ -712,7 +712,7 @@ description: "Config file reference" ## dipdup.config.tezos_events.TezosEventsHandlerConfig -class dipdup.config.tezos_events.TezosEventsHandlerConfig(callback) +class dipdup.config.tezos_events.TezosEventsHandlerConfig(callback)

Event handler config

Parameters:
@@ -730,7 +730,7 @@ description: "Config file reference" ## dipdup.config.tezos_events.TezosEventsIndexConfig -class dipdup.config.tezos_events.TezosEventsIndexConfig(kind, datasources) +class dipdup.config.tezos_events.TezosEventsIndexConfig(kind, datasources)

Event index config

Parameters:
@@ -750,7 +750,7 @@ description: "Config file reference" ## dipdup.config.tezos_events.TezosEventsUnknownEventHandlerConfig -class dipdup.config.tezos_events.TezosEventsUnknownEventHandlerConfig(callback) +class dipdup.config.tezos_events.TezosEventsUnknownEventHandlerConfig(callback)

Unknown event handler config

Parameters:
@@ -767,7 +767,7 @@ description: "Config file reference" ## dipdup.config.tezos_head.TezosTzktHeadHandlerConfig -class dipdup.config.tezos_head.TezosTzktHeadHandlerConfig(callback) +class dipdup.config.tezos_head.TezosTzktHeadHandlerConfig(callback)

Head block handler config

Parameters:
@@ -783,7 +783,7 @@ description: "Config file reference" ## dipdup.config.tezos_head.TezosHeadIndexConfig -class dipdup.config.tezos_head.TezosHeadIndexConfig(kind, datasources) +class dipdup.config.tezos_head.TezosHeadIndexConfig(kind, datasources)

Head block index config

Parameters:
@@ -801,7 +801,7 @@ description: "Config file reference" ## dipdup.config.tezos_operations.TezosOperationsHandlerConfig -class dipdup.config.tezos_operations.TezosOperationsHandlerConfig(callback) +class dipdup.config.tezos_operations.TezosOperationsHandlerConfig(callback)

Operation handler config

Parameters:
@@ -818,7 +818,7 @@ description: "Config file reference" ## dipdup.config.tezos_operations.TezosOperationsHandlerOriginationPatternConfig -class dipdup.config.tezos_operations.TezosOperationsHandlerOriginationPatternConfig(**kwargs) +class dipdup.config.tezos_operations.TezosOperationsHandlerOriginationPatternConfig(**kwargs)

Origination handler pattern config

Parameters:
@@ -840,7 +840,7 @@ description: "Config file reference" ## dipdup.config.tezos_operations.TezosOperationsHandlerSmartRollupCementPatternConfig -class dipdup.config.tezos_operations.TezosOperationsHandlerSmartRollupCementPatternConfig(**kwargs) +class dipdup.config.tezos_operations.TezosOperationsHandlerSmartRollupCementPatternConfig(**kwargs)

Operation handler pattern config

Parameters:
@@ -861,7 +861,7 @@ description: "Config file reference" ## dipdup.config.tezos_operations.TezosOperationsHandlerSmartRollupExecutePatternConfig -class dipdup.config.tezos_operations.TezosOperationsHandlerSmartRollupExecutePatternConfig(**kwargs) +class dipdup.config.tezos_operations.TezosOperationsHandlerSmartRollupExecutePatternConfig(**kwargs)

Operation handler pattern config

Parameters:
@@ -882,7 +882,7 @@ description: "Config file reference" ## dipdup.config.tezos_operations.TezosOperationsHandlerTransactionPatternConfig -class dipdup.config.tezos_operations.TezosOperationsHandlerTransactionPatternConfig(**kwargs) +class dipdup.config.tezos_operations.TezosOperationsHandlerTransactionPatternConfig(**kwargs)

Transaction handler pattern config

Parameters:
@@ -904,7 +904,7 @@ description: "Config file reference" ## dipdup.config.tezos_operations.TezosOperationsIndexConfig -class dipdup.config.tezos_operations.TezosOperationsIndexConfig(kind, datasources) +class dipdup.config.tezos_operations.TezosOperationsIndexConfig(kind, datasources)

Operation index config

Parameters:
@@ -926,7 +926,7 @@ description: "Config file reference" ## dipdup.config.tezos_operations.TezosOperationsPatternConfig -class dipdup.config.tezos_operations.TezosOperationsPatternConfig(**kwargs) +class dipdup.config.tezos_operations.TezosOperationsPatternConfig(**kwargs)

Base class for pattern config items.

Contains methods for import and method signature generation during handler callbacks codegen.

@@ -943,7 +943,7 @@ description: "Config file reference" ## dipdup.config.tezos_operations.TezosOperationsUnfilteredHandlerConfig -class dipdup.config.tezos_operations.TezosOperationsUnfilteredHandlerConfig(callback) +class dipdup.config.tezos_operations.TezosOperationsUnfilteredHandlerConfig(callback)

Handler of unfiltered operation index

Parameters:
@@ -959,7 +959,7 @@ description: "Config file reference" ## dipdup.config.tezos_operations.TezosOperationsUnfilteredIndexConfig -class dipdup.config.tezos_operations.TezosOperationsUnfilteredIndexConfig(kind, datasources) +class dipdup.config.tezos_operations.TezosOperationsUnfilteredIndexConfig(kind, datasources)

Operation index config

Parameters:
@@ -980,7 +980,7 @@ description: "Config file reference" ## dipdup.config.tezos_tzkt.TezosTzktDatasourceConfig -class dipdup.config.tezos_tzkt.TezosTzktDatasourceConfig(*args) +class dipdup.config.tezos_tzkt.TezosTzktDatasourceConfig(*args)

TzKT datasource config

Parameters:
@@ -1001,7 +1001,7 @@ description: "Config file reference" ## dipdup.config.tezos_token_balances.TezosTokenBalancesHandlerConfig -class dipdup.config.tezos_token_balances.TezosTokenBalancesHandlerConfig(callback) +class dipdup.config.tezos_token_balances.TezosTokenBalancesHandlerConfig(callback)

Token balance handler config

Parameters:
@@ -1019,7 +1019,7 @@ description: "Config file reference" ## dipdup.config.tezos_token_balances.TezosTokenBalancesIndexConfig -class dipdup.config.tezos_token_balances.TezosTokenBalancesIndexConfig(kind, datasources) +class dipdup.config.tezos_token_balances.TezosTokenBalancesIndexConfig(kind, datasources)

Token balance index config

Parameters:
@@ -1039,7 +1039,7 @@ description: "Config file reference" ## dipdup.config.tezos_token_transfers.TezosTokenTransfersHandlerConfig -class dipdup.config.tezos_token_transfers.TezosTokenTransfersHandlerConfig(callback) +class dipdup.config.tezos_token_transfers.TezosTokenTransfersHandlerConfig(callback)

Token transfer handler config

Parameters:
@@ -1059,7 +1059,7 @@ description: "Config file reference" ## dipdup.config.tezos_token_transfers.TezosTokenTransfersIndexConfig -class dipdup.config.tezos_token_transfers.TezosTokenTransfersIndexConfig(kind, datasources) +class dipdup.config.tezos_token_transfers.TezosTokenTransfersIndexConfig(kind, datasources)

Token transfer index config

Parameters:
@@ -1079,7 +1079,7 @@ description: "Config file reference" ## dipdup.config.starknet.StarknetContractConfig -class dipdup.config.starknet.StarknetContractConfig(*args) +class dipdup.config.starknet.StarknetContractConfig(*args)

Starknet contract config

Parameters:
@@ -1098,7 +1098,7 @@ description: "Config file reference" ## dipdup.config.starknet_events.StarknetEventsHandlerConfig -class dipdup.config.starknet_events.StarknetEventsHandlerConfig(callback) +class dipdup.config.starknet_events.StarknetEventsHandlerConfig(callback)

Subsquid event handler

Parameters:
@@ -1116,7 +1116,7 @@ description: "Config file reference" ## dipdup.config.starknet_events.StarknetEventsIndexConfig -class dipdup.config.starknet_events.StarknetEventsIndexConfig(kind, datasources) +class dipdup.config.starknet_events.StarknetEventsIndexConfig(kind, datasources)

Starknet events index config

Parameters:
@@ -1136,7 +1136,7 @@ description: "Config file reference" ## dipdup.config.starknet_node.StarknetNodeDatasourceConfig -class dipdup.config.starknet_node.StarknetNodeDatasourceConfig(*args) +class dipdup.config.starknet_node.StarknetNodeDatasourceConfig(*args)

Starknet node datasource config

Parameters:
@@ -1156,7 +1156,7 @@ description: "Config file reference" ## dipdup.config.starknet_subsquid.StarknetSubsquidDatasourceConfig -class dipdup.config.starknet_subsquid.StarknetSubsquidDatasourceConfig(*args) +class dipdup.config.starknet_subsquid.StarknetSubsquidDatasourceConfig(*args)

Subsquid datasource config

Parameters:
@@ -1174,7 +1174,7 @@ description: "Config file reference" ## dipdup.config.substrate.SubstrateRuntimeConfig -class dipdup.config.substrate.SubstrateRuntimeConfig(*args) +class dipdup.config.substrate.SubstrateRuntimeConfig(*args)

Substrate runtime config

Parameters:
@@ -1191,7 +1191,7 @@ description: "Config file reference" ## dipdup.config.substrate_events.SubstrateEventsHandlerConfig -class dipdup.config.substrate_events.SubstrateEventsHandlerConfig(callback) +class dipdup.config.substrate_events.SubstrateEventsHandlerConfig(callback)

Subsquid event handler

Parameters:
@@ -1208,7 +1208,7 @@ description: "Config file reference" ## dipdup.config.substrate_events.SubstrateEventsIndexConfig -class dipdup.config.substrate_events.SubstrateEventsIndexConfig(kind, datasources) +class dipdup.config.substrate_events.SubstrateEventsIndexConfig(kind, datasources)

Subsquid datasource config

Parameters:
@@ -1230,7 +1230,7 @@ description: "Config file reference" ## dipdup.config.substrate_subsquid.SubstrateSubsquidDatasourceConfig -class dipdup.config.substrate_subsquid.SubstrateSubsquidDatasourceConfig(*args) +class dipdup.config.substrate_subsquid.SubstrateSubsquidDatasourceConfig(*args)

Subsquid datasource config

Parameters:
@@ -1248,7 +1248,7 @@ description: "Config file reference" ## dipdup.config.substrate_subscan.SubstrateSubscanDatasourceConfig -class dipdup.config.substrate_subscan.SubstrateSubscanDatasourceConfig(*args) +class dipdup.config.substrate_subscan.SubstrateSubscanDatasourceConfig(*args)

Subscan datasource config

Parameters:
@@ -1267,7 +1267,7 @@ description: "Config file reference" ## dipdup.config.tzip_metadata.TzipMetadataDatasourceConfig -class dipdup.config.tzip_metadata.TzipMetadataDatasourceConfig(*args) +class dipdup.config.tzip_metadata.TzipMetadataDatasourceConfig(*args)

DipDup Metadata datasource config

Parameters:
diff --git a/docs/7.references/3.context.md b/docs/7.references/3.context.md index 2f286b646..eba8986bb 100644 --- a/docs/7.references/3.context.md +++ b/docs/7.references/3.context.md @@ -10,7 +10,7 @@ description: "Context reference" ## dipdup.context.DipDupContext -class dipdup.context.DipDupContext(config, package, datasources, transactions) +class dipdup.context.DipDupContext(config, package, datasources, transactions)

Common execution context for handler and hook callbacks.

Parameters:
@@ -29,7 +29,7 @@ description: "Context reference" ## dipdup.context.HandlerContext -class dipdup.context.HandlerContext(config, package, datasources, transactions, logger, handler_config) +class dipdup.context.HandlerContext(config, package, datasources, transactions, logger, handler_config)

Execution context of handler callbacks.

Parameters:
@@ -49,7 +49,7 @@ description: "Context reference" ## dipdup.context.HookContext -class dipdup.context.HookContext(config, package, datasources, transactions, logger, hook_config) +class dipdup.context.HookContext(config, package, datasources, transactions, logger, hook_config)

Execution context of hook callbacks.

Parameters:
@@ -69,7 +69,7 @@ description: "Context reference" ## dipdup.context.DipDupContext.add_contract -async DipDupContext.add_contract(kind, name, address=None, typename=None, code_hash=None) +async DipDupContext.add_contract(kind, name, address=None, typename=None, code_hash=None)

Adds contract to the inventory.

Parameters:
@@ -91,7 +91,7 @@ description: "Context reference" ## dipdup.context.DipDupContext.add_index -async DipDupContext.add_index(name, template, values, first_level=0, last_level=0, state=None) +async DipDupContext.add_index(name, template, values, first_level=0, last_level=0, state=None)

Adds a new index from template.

Parameters:
@@ -114,7 +114,7 @@ description: "Context reference" ## dipdup.context.DipDupContext.execute_sql -async DipDupContext.execute_sql(name, *args, **kwargs) +async DipDupContext.execute_sql(name, *args, **kwargs)

Executes SQL script(s) with given name.

If the name path is a directory, all .sql scripts within it will be executed in alphabetical order.

@@ -135,7 +135,7 @@ description: "Context reference" ## dipdup.context.DipDupContext.execute_sql_query -async DipDupContext.execute_sql_query(name, *args) +async DipDupContext.execute_sql_query(name, *args)

Executes SQL query with given name included with the project

Parameters:
@@ -155,7 +155,7 @@ description: "Context reference" ## dipdup.context.DipDupContext.fire_hook -async DipDupContext.fire_hook(name, wait=True, **kwargs) +async DipDupContext.fire_hook(name, wait=True, **kwargs)

Fire hook with given name and arguments.

Parameters:
@@ -303,7 +303,7 @@ description: "Context reference" ## dipdup.context.DipDupContext.reindex -async DipDupContext.reindex(reason=None, **context) +async DipDupContext.reindex(reason=None, **context)

Drops the entire database and starts the indexing process from scratch.

Parameters:
@@ -322,7 +322,7 @@ description: "Context reference" ## dipdup.context.DipDupContext.restart -async DipDupContext.restart() +async DipDupContext.restart()

Restart process and continue indexing.

Return type:
@@ -335,7 +335,7 @@ description: "Context reference" ## dipdup.context.DipDupContext.rollback -async DipDupContext.rollback(index, from_level, to_level) +async DipDupContext.rollback(index, from_level, to_level)

Rollback index to a given level reverting all changes made since that level.

Parameters:
@@ -355,7 +355,7 @@ description: "Context reference" ## dipdup.context.DipDupContext.update_contract_metadata -async DipDupContext.update_contract_metadata(network, address, metadata) +async DipDupContext.update_contract_metadata(network, address, metadata)

Inserts or updates corresponding rows in the internal dipdup_contract_metadata table to provide a generic metadata interface (see docs).

@@ -376,7 +376,7 @@ to provide a generic metadata interface (see docs).

## dipdup.context.DipDupContext.update_token_metadata -async DipDupContext.update_token_metadata(network, address, token_id, metadata) +async DipDupContext.update_token_metadata(network, address, token_id, metadata)

Inserts or updates corresponding rows in the internal dipdup_token_metadata table to provide a generic metadata interface (see docs).

diff --git a/docs/7.references/4.models.md b/docs/7.references/4.models.md index ea70d49e1..8a2e1e545 100644 --- a/docs/7.references/4.models.md +++ b/docs/7.references/4.models.md @@ -14,7 +14,7 @@ description: "Models reference" ## dipdup.models.CachedModel -class dipdup.models.CachedModel(**kwargs) +class dipdup.models.CachedModel(**kwargs)
Parameters:

kwargs (Any)

@@ -26,7 +26,7 @@ description: "Models reference" ## dipdup.models.Model -class dipdup.models.Model(**kwargs) +class dipdup.models.Model(**kwargs)

Base class for DipDup project models

Parameters:
@@ -44,7 +44,7 @@ description: "Models reference" ## dipdup.models.ContractMetadata -class dipdup.models.ContractMetadata(**kwargs) +class dipdup.models.ContractMetadata(**kwargs)
Parameters:

kwargs (Any)

@@ -56,7 +56,7 @@ description: "Models reference" ## dipdup.models.Head -class dipdup.models.Head(**kwargs) +class dipdup.models.Head(**kwargs)
Parameters:

kwargs (Any)

@@ -68,7 +68,7 @@ description: "Models reference" ## dipdup.models.TokenMetadata -class dipdup.models.TokenMetadata(**kwargs) +class dipdup.models.TokenMetadata(**kwargs)
Parameters:

kwargs (Any)

@@ -80,7 +80,7 @@ description: "Models reference" ## dipdup.models.Contract -class dipdup.models.Contract(**kwargs) +class dipdup.models.Contract(**kwargs)
Parameters:

kwargs (Any)

@@ -92,7 +92,7 @@ description: "Models reference" ## dipdup.models.ContractKind -class dipdup.models.ContractKind(*values) +class dipdup.models.ContractKind(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Mapping for contract kind in

@@ -100,7 +100,7 @@ description: "Models reference" ## dipdup.models.Index -class dipdup.models.Index(**kwargs) +class dipdup.models.Index(**kwargs)
Parameters:

kwargs (Any)

@@ -112,14 +112,14 @@ description: "Models reference" ## dipdup.models.IndexStatus -class dipdup.models.IndexStatus(*values) +class dipdup.models.IndexStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
## dipdup.models.IndexType -class dipdup.models.IndexType(*values) +class dipdup.models.IndexType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Enum for dipdup.models.Index

@@ -127,7 +127,7 @@ description: "Models reference" ## dipdup.models.Schema -class dipdup.models.Schema(**kwargs) +class dipdup.models.Schema(**kwargs)
Parameters:

kwargs (Any)

@@ -139,7 +139,7 @@ description: "Models reference" ## dipdup.models.ReindexingAction -class dipdup.models.ReindexingAction(*values) +class dipdup.models.ReindexingAction(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Action that should be performed on reindexing

Parameters:
@@ -156,7 +156,7 @@ description: "Models reference" ## dipdup.models.ReindexingReason -class dipdup.models.ReindexingReason(*values) +class dipdup.models.ReindexingReason(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Reason that caused reindexing

Parameters:
@@ -175,7 +175,7 @@ description: "Models reference" ## dipdup.models.SkipHistory -class dipdup.models.SkipHistory(*values) +class dipdup.models.SkipHistory(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Whether to skip indexing big map history and use only current state

Parameters:
@@ -192,7 +192,7 @@ description: "Models reference" ## dipdup.models.Meta -class dipdup.models.Meta(**kwargs) +class dipdup.models.Meta(**kwargs)
Parameters:

kwargs (Any)

@@ -204,7 +204,7 @@ description: "Models reference" ## dipdup.models.ModelUpdate -class dipdup.models.ModelUpdate(**kwargs) +class dipdup.models.ModelUpdate(**kwargs)

Model update created within versioned transactions

Parameters:
@@ -217,7 +217,7 @@ description: "Models reference" ## dipdup.models.ModelUpdateAction -class dipdup.models.ModelUpdateAction(*values) +class dipdup.models.ModelUpdateAction(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Mapping for actions in model update

@@ -234,7 +234,7 @@ description: "Models reference" ## dipdup.models.evm.EvmTransaction -class dipdup.models.evm.EvmTransaction(data: dipdup.models.evm.EvmTransactionData, input: InputT) +class dipdup.models.evm.EvmTransaction(data: dipdup.models.evm.EvmTransactionData, input: InputT)
Parameters:
    @@ -249,7 +249,7 @@ description: "Models reference" ## dipdup.models.evm.EvmTransactionData -class dipdup.models.evm.EvmTransactionData(access_list: tuple[dict[str, dipdup.fields.Any], ...] | None, block_hash: str, chain_id: int | None, contract_address: str | None, cumulative_gas_used: int | None, effective_gas_price: int | None, from_: str, gas: int, gas_price: int, gas_used: int | None, hash: str, input: str, level: int, max_fee_per_gas: int | None, max_priority_fee_per_gas: int | None, nonce: int, r: str | None, s: str | None, status: int | None, timestamp: int, to: str | None, transaction_index: int | None, type: int | None, value: int | None, v: int | None, y_parity: bool | None) +class dipdup.models.evm.EvmTransactionData(access_list: tuple[dict[str, dipdup.fields.Any], ...] | None, block_hash: str, chain_id: int | None, contract_address: str | None, cumulative_gas_used: int | None, effective_gas_price: int | None, from_: str, gas: int, gas_price: int, gas_used: int | None, hash: str, input: str, level: int, max_fee_per_gas: int | None, max_priority_fee_per_gas: int | None, nonce: int, r: str | None, s: str | None, status: int | None, timestamp: int, to: str | None, transaction_index: int | None, type: int | None, value: int | None, v: int | None, y_parity: bool | None)
    Parameters:
      @@ -288,7 +288,7 @@ description: "Models reference" ## dipdup.models.evm.EvmEvent -class dipdup.models.evm.EvmEvent(data: dipdup.models.evm.EvmEventData, payload: PayloadT) +class dipdup.models.evm.EvmEvent(data: dipdup.models.evm.EvmEventData, payload: PayloadT)
      Parameters:
        @@ -303,7 +303,7 @@ description: "Models reference" ## dipdup.models.evm.EvmEventData -class dipdup.models.evm.EvmEventData(address: str, block_hash: str, data: str, level: int, log_index: int, removed: bool, timestamp: int, topics: tuple[str, ...], transaction_hash: str, transaction_index: int) +class dipdup.models.evm.EvmEventData(address: str, block_hash: str, data: str, level: int, log_index: int, removed: bool, timestamp: int, topics: tuple[str, ...], transaction_hash: str, transaction_index: int)
        Parameters:
          @@ -331,7 +331,7 @@ description: "Models reference" ## dipdup.models.starknet.StarknetEvent -class dipdup.models.starknet.StarknetEvent(data: dipdup.models.starknet.StarknetEventData, payload: PayloadT) +class dipdup.models.starknet.StarknetEvent(data: dipdup.models.starknet.StarknetEventData, payload: PayloadT)
          Parameters:
            @@ -346,7 +346,7 @@ description: "Models reference" ## dipdup.models.starknet.StarknetEventData -class dipdup.models.starknet.StarknetEventData(level: int, block_hash: str, transaction_index: int | None, transaction_hash: str, timestamp: int | None, from_address: str, keys: tuple[str, ...], data: tuple[str, ...]) +class dipdup.models.starknet.StarknetEventData(level: int, block_hash: str, transaction_index: int | None, transaction_hash: str, timestamp: int | None, from_address: str, keys: tuple[str, ...], data: tuple[str, ...])
            Parameters:
              @@ -367,7 +367,7 @@ description: "Models reference" ## dipdup.models.starknet.StarknetTransactionData -class dipdup.models.starknet.StarknetTransactionData(level: int, block_hash: str, transaction_index: int, transaction_hash: str, timestamp: int, contract_address: str | None, entry_point_selector: str | None, calldata: tuple[str, ...] | None, max_fee: str | None, version: str, signature: tuple[str, ...] | None, nonce: str | None, type: str, sender_address: str | None, class_hash: str | None, compiled_class_hash: str | None, contract_address_salt: str | None, constructor_calldata: tuple[str, ...] | None) +class dipdup.models.starknet.StarknetTransactionData(level: int, block_hash: str, transaction_index: int, transaction_hash: str, timestamp: int, contract_address: str | None, entry_point_selector: str | None, calldata: tuple[str, ...] | None, max_fee: str | None, version: str, signature: tuple[str, ...] | None, nonce: str | None, type: str, sender_address: str | None, class_hash: str | None, compiled_class_hash: str | None, contract_address_salt: str | None, constructor_calldata: tuple[str, ...] | None)
              Parameters:
                @@ -403,7 +403,7 @@ description: "Models reference" ## dipdup.models.substrate.SubstrateEvent -class dipdup.models.substrate.SubstrateEvent(data: dipdup.models.substrate.SubstrateEventData, runtime: dipdup.runtimes.SubstrateRuntime) +class dipdup.models.substrate.SubstrateEvent(data: dipdup.models.substrate.SubstrateEventData, runtime: dipdup.runtimes.SubstrateRuntime)
                Parameters:
                  @@ -418,7 +418,7 @@ description: "Models reference" ## dipdup.models.substrate.SubstrateEventData -class dipdup.models.substrate.SubstrateEventData(*, name: str, index: int, extrinsic_index: int, call_address: list[str] | None, args: list[dipdup.fields.Any] | None = None, decoded_args: dict[str, dipdup.fields.Any] | list[dipdup.fields.Any] | None = None, header: dipdup.models.substrate._BlockHeader, header_extra: dipdup.models.substrate._BlockHeaderExtra | None) +class dipdup.models.substrate.SubstrateEventData(*, name: str, index: int, extrinsic_index: int, call_address: list[str] | None, args: list[dipdup.fields.Any] | None = None, decoded_args: dict[str, dipdup.fields.Any] | list[dipdup.fields.Any] | None = None, header: dipdup.models.substrate._BlockHeader, header_extra: dipdup.models.substrate._BlockHeaderExtra | None)
                  Parameters:
                    @@ -439,7 +439,7 @@ description: "Models reference" ## dipdup.models.substrate.SubstrateHeadBlockData -class dipdup.models.substrate.SubstrateHeadBlockData +class dipdup.models.substrate.SubstrateHeadBlockData
                  @@ -451,7 +451,7 @@ description: "Models reference" ## dipdup.models.tezos.TezosBigMapAction -class dipdup.models.tezos.TezosBigMapAction(*values) +class dipdup.models.tezos.TezosBigMapAction(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

                  Mapping for action in TzKT response

                @@ -459,7 +459,7 @@ description: "Models reference" ## dipdup.models.tezos.TezosBigMapData -class dipdup.models.tezos.TezosBigMapData(id, level, operation_id, timestamp, bigmap, contract_address, path, action, active, key=None, value=None) +class dipdup.models.tezos.TezosBigMapData(id, level, operation_id, timestamp, bigmap, contract_address, path, action, active, key=None, value=None)

                Basic structure for big map diffs from TzKT response

                Parameters:
                @@ -484,7 +484,7 @@ description: "Models reference" ## dipdup.models.tezos.TezosBigMapDiff -class dipdup.models.tezos.TezosBigMapDiff(action, data, key, value) +class dipdup.models.tezos.TezosBigMapDiff(action, data, key, value)

                Wrapper for matched big map diff with typed data passed to the handler

                Parameters:
                @@ -502,7 +502,7 @@ description: "Models reference" ## dipdup.models.tezos.TezosBlockData -class dipdup.models.tezos.TezosBlockData(level, hash, timestamp, proto, validations, deposit, reward, fees, nonce_revealed, priority=None, baker_address=None, baker_alias=None) +class dipdup.models.tezos.TezosBlockData(level, hash, timestamp, proto, validations, deposit, reward, fees, nonce_revealed, priority=None, baker_address=None, baker_alias=None)

                Basic structure for blocks received from TzKT REST API

                Parameters:
                @@ -528,7 +528,7 @@ description: "Models reference" ## dipdup.models.tezos.TezosEvent -class dipdup.models.tezos.TezosEvent(data, payload) +class dipdup.models.tezos.TezosEvent(data, payload)
                Parameters:
                  @@ -543,7 +543,7 @@ description: "Models reference" ## dipdup.models.tezos.TezosEventData -class dipdup.models.tezos.TezosEventData(id, level, timestamp, tag, payload, contract_address, contract_alias=None, contract_code_hash=None, transaction_id=None) +class dipdup.models.tezos.TezosEventData(id, level, timestamp, tag, payload, contract_address, contract_alias=None, contract_code_hash=None, transaction_id=None)

                  Basic structure for events received from TzKT REST API

                  Parameters:
                  @@ -566,7 +566,7 @@ description: "Models reference" ## dipdup.models.tezos.TezosHeadBlockData -class dipdup.models.tezos.TezosHeadBlockData(chain, chain_id, cycle, level, hash, protocol, next_protocol, timestamp, voting_epoch, voting_period, known_level, last_sync, synced, quote_level, quote_btc, quote_eur, quote_usd, quote_cny, quote_jpy, quote_krw, quote_eth, quote_gbp) +class dipdup.models.tezos.TezosHeadBlockData(chain, chain_id, cycle, level, hash, protocol, next_protocol, timestamp, voting_epoch, voting_period, known_level, last_sync, synced, quote_level, quote_btc, quote_eur, quote_usd, quote_cny, quote_jpy, quote_krw, quote_eth, quote_gbp)

                  Basic structure for head block received from TzKT SignalR API

                  Parameters:
                  @@ -602,7 +602,7 @@ description: "Models reference" ## dipdup.models.tezos.TezosOperationData -class dipdup.models.tezos.TezosOperationData(type, id, level, timestamp, hash, counter, sender_address, target_address, initiator_address, amount, status, has_internals, storage, diffs=<factory>, block=None, sender_alias=None, nonce=None, target_alias=None, initiator_alias=None, entrypoint=None, parameter_json=None, originated_contract_address=None, originated_contract_alias=None, originated_contract_type_hash=None, originated_contract_code_hash=None, originated_contract_tzips=None, delegate_address=None, delegate_alias=None, target_code_hash=None, sender_code_hash=None, commitment_json=<factory>) +class dipdup.models.tezos.TezosOperationData(type, id, level, timestamp, hash, counter, sender_address, target_address, initiator_address, amount, status, has_internals, storage, diffs=<factory>, block=None, sender_alias=None, nonce=None, target_alias=None, initiator_alias=None, entrypoint=None, parameter_json=None, originated_contract_address=None, originated_contract_alias=None, originated_contract_type_hash=None, originated_contract_code_hash=None, originated_contract_tzips=None, delegate_address=None, delegate_alias=None, target_code_hash=None, sender_code_hash=None, commitment_json=<factory>)

                  Basic structure for operations from TzKT response

                  Parameters:
                  @@ -647,7 +647,7 @@ description: "Models reference" ## dipdup.models.tezos.TezosOperationType -class dipdup.models.tezos.TezosOperationType(*values) +class dipdup.models.tezos.TezosOperationType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

                  Type of blockchain operation

                  Parameters:
                  @@ -666,7 +666,7 @@ description: "Models reference" ## dipdup.models.tezos.TezosOrigination -class dipdup.models.tezos.TezosOrigination(data, storage) +class dipdup.models.tezos.TezosOrigination(data, storage)

                  Wrapper for matched origination with typed data passed to the handler

                  Parameters:
                  @@ -682,7 +682,7 @@ description: "Models reference" ## dipdup.models.tezos.TezosQuoteData -class dipdup.models.tezos.TezosQuoteData(level, timestamp, btc, eur, usd, cny, jpy, krw, eth, gbp) +class dipdup.models.tezos.TezosQuoteData(level, timestamp, btc, eur, usd, cny, jpy, krw, eth, gbp)

                  Basic structure for quotes received from TzKT REST API

                  Parameters:
                  @@ -706,7 +706,7 @@ description: "Models reference" ## dipdup.models.tezos.TezosSmartRollupCement -class dipdup.models.tezos.TezosSmartRollupCement(data, commitment) +class dipdup.models.tezos.TezosSmartRollupCement(data, commitment)

                  Wrapper for matched smart rollup cement to the handler

                  Parameters:
                  @@ -722,7 +722,7 @@ description: "Models reference" ## dipdup.models.tezos.TezosSmartRollupCommitment -class dipdup.models.tezos.TezosSmartRollupCommitment(id, initiator_address, initiator_alias, inbox_level, state, hash, ticks, first_level, first_time) +class dipdup.models.tezos.TezosSmartRollupCommitment(id, initiator_address, initiator_alias, inbox_level, state, hash, ticks, first_level, first_time)
                  Parameters:
                    @@ -744,7 +744,7 @@ description: "Models reference" ## dipdup.models.tezos.TezosSmartRollupExecute -class dipdup.models.tezos.TezosSmartRollupExecute(data, commitment) +class dipdup.models.tezos.TezosSmartRollupExecute(data, commitment)

                    Wrapper for matched smart rollup execute to the handler

                    Parameters:
                    @@ -760,7 +760,7 @@ description: "Models reference" ## dipdup.models.tezos.TezosTokenBalanceData -class dipdup.models.tezos.TezosTokenBalanceData(id, transfers_count, first_level, first_time, last_level, last_time, account_address=None, account_alias=None, tzkt_token_id=None, contract_address=None, contract_alias=None, token_id=None, standard=None, metadata=None, balance=None, balance_value=None) +class dipdup.models.tezos.TezosTokenBalanceData(id, transfers_count, first_level, first_time, last_level, last_time, account_address=None, account_alias=None, tzkt_token_id=None, contract_address=None, contract_alias=None, token_id=None, standard=None, metadata=None, balance=None, balance_value=None)

                    Basic structure for token transver received from TzKT SignalR API

                    Parameters:
                    @@ -790,14 +790,14 @@ description: "Models reference" ## dipdup.models.tezos.TezosTokenStandard -class dipdup.models.tezos.TezosTokenStandard(*values) +class dipdup.models.tezos.TezosTokenStandard(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
                    ## dipdup.models.tezos.TezosTokenTransferData -class dipdup.models.tezos.TezosTokenTransferData(id, level, timestamp, tzkt_token_id, contract_address=None, contract_alias=None, token_id=None, standard=None, metadata=None, from_alias=None, from_address=None, to_alias=None, to_address=None, amount=None, tzkt_transaction_id=None, tzkt_origination_id=None, tzkt_migration_id=None) +class dipdup.models.tezos.TezosTokenTransferData(id, level, timestamp, tzkt_token_id, contract_address=None, contract_alias=None, token_id=None, standard=None, metadata=None, from_alias=None, from_address=None, to_alias=None, to_address=None, amount=None, tzkt_transaction_id=None, tzkt_origination_id=None, tzkt_migration_id=None)

                    Basic structure for token transver received from TzKT SignalR API

                    Parameters:
                    @@ -828,7 +828,7 @@ description: "Models reference" ## dipdup.models.tezos.TezosTransaction -class dipdup.models.tezos.TezosTransaction(data, parameter, storage) +class dipdup.models.tezos.TezosTransaction(data, parameter, storage)

                    Wrapper for matched transaction with typed data passed to the handler

                    Parameters:
                    @@ -845,7 +845,7 @@ description: "Models reference" ## dipdup.models.tezos.TezosUnknownEvent -class dipdup.models.tezos.TezosUnknownEvent(data, payload) +class dipdup.models.tezos.TezosUnknownEvent(data, payload)
                    Parameters:
                      @@ -865,7 +865,7 @@ description: "Models reference" ## dipdup.models.coinbase.CoinbaseCandleData -class dipdup.models.coinbase.CoinbaseCandleData(timestamp, low, high, open, close, volume) +class dipdup.models.coinbase.CoinbaseCandleData(timestamp, low, high, open, close, volume)
                      Parameters:
                        @@ -884,14 +884,14 @@ description: "Models reference" ## dipdup.models.coinbase.CoinbaseCandleInterval -class dipdup.models.coinbase.CoinbaseCandleInterval(*values) +class dipdup.models.coinbase.CoinbaseCandleInterval(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
                      ## dipdup.models.tzip_metadata.TzipMetadataNetwork -class dipdup.models.tzip_metadata.TzipMetadataNetwork(*values) +class dipdup.models.tzip_metadata.TzipMetadataNetwork(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

                      Tezos network enum for TZIP-16 metadata.

                      Parameters:
                      From bb51cdddb2809b2810d82e1ff45e562a833c479b Mon Sep 17 00:00:00 2001 From: Lev Gorodetskiy Date: Tue, 25 Feb 2025 14:50:24 -0300 Subject: [PATCH 3/3] Lint, ToC --- docs/1.getting-started/5.database.md | 4 +-- docs/1.getting-started/7.datasources.md | 30 ++++++++++----------- docs/10.supported-networks/0.overview.md | 2 +- docs/10.supported-networks/39.prom.md | 16 +++++------ docs/10.supported-networks/9.bob.md | 2 +- docs/3.datasources/1.evm_subsquid.md | 2 +- docs/3.datasources/10.substrate_subsquid.md | 2 +- docs/3.datasources/3.evm_etherscan.md | 4 +++ docs/3.datasources/6.starknet_subsquid.md | 2 +- docs/3.datasources/8.substrate_node.md | 2 +- 10 files changed, 35 insertions(+), 31 deletions(-) diff --git a/docs/1.getting-started/5.database.md b/docs/1.getting-started/5.database.md index ba5875e35..7f6a70dca 100644 --- a/docs/1.getting-started/5.database.md +++ b/docs/1.getting-started/5.database.md @@ -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. diff --git a/docs/1.getting-started/7.datasources.md b/docs/1.getting-started/7.datasources.md index 78425952c..6b40060cd 100644 --- a/docs/1.getting-started/7.datasources.md +++ b/docs/1.getting-started/7.datasources.md @@ -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 diff --git a/docs/10.supported-networks/0.overview.md b/docs/10.supported-networks/0.overview.md index 922bc495c..07915b5ed 100644 --- a/docs/10.supported-networks/0.overview.md +++ b/docs/10.supported-networks/0.overview.md @@ -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. diff --git a/docs/10.supported-networks/39.prom.md b/docs/10.supported-networks/39.prom.md index ffe3aa3bf..c325a4411 100644 --- a/docs/10.supported-networks/39.prom.md +++ b/docs/10.supported-networks/39.prom.md @@ -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 | | diff --git a/docs/10.supported-networks/9.bob.md b/docs/10.supported-networks/9.bob.md index d951c5375..f59090319 100644 --- a/docs/10.supported-networks/9.bob.md +++ b/docs/10.supported-networks/9.bob.md @@ -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`
                      `wss://rpc.gobob.xyz` | +| **evm.node** | 🤔 not tested | `https://bob.drpc.org`
                      `wss://rpc.gobob.xyz` | diff --git a/docs/3.datasources/1.evm_subsquid.md b/docs/3.datasources/1.evm_subsquid.md index a5acb24a0..c739eb589 100644 --- a/docs/3.datasources/1.evm_subsquid.md +++ b/docs/3.datasources/1.evm_subsquid.md @@ -1,5 +1,5 @@ --- -title: "EVM: Subsquid Network" +title: "EVM: Subsquid" description: "DipDup uses Subsquid Network as a source of historical data for EVM-compatible blockchains." network: "ethereum" --- diff --git a/docs/3.datasources/10.substrate_subsquid.md b/docs/3.datasources/10.substrate_subsquid.md index 86d6e2a47..376ff6971 100644 --- a/docs/3.datasources/10.substrate_subsquid.md +++ b/docs/3.datasources/10.substrate_subsquid.md @@ -1,5 +1,5 @@ --- -title: "Substrate: Subsquid Network" +title: "Substrate: Subsquid" description: "DipDup uses Subsquid Network as a source of historical data for Substrate blockchains." network: "substrate" --- diff --git a/docs/3.datasources/3.evm_etherscan.md b/docs/3.datasources/3.evm_etherscan.md index 3d9a3a9eb..bc89b98ec 100644 --- a/docs/3.datasources/3.evm_etherscan.md +++ b/docs/3.datasources/3.evm_etherscan.md @@ -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. diff --git a/docs/3.datasources/6.starknet_subsquid.md b/docs/3.datasources/6.starknet_subsquid.md index 245579b9a..346a4912d 100644 --- a/docs/3.datasources/6.starknet_subsquid.md +++ b/docs/3.datasources/6.starknet_subsquid.md @@ -1,5 +1,5 @@ --- -title: "Starknet: Subsquid Network" +title: "Starknet: Subsquid" description: "DipDup uses Subsquid Network as a source of historical data for Starknet blockchain." network: "starknet" --- diff --git a/docs/3.datasources/8.substrate_node.md b/docs/3.datasources/8.substrate_node.md index 4b69a000e..3749598e0 100644 --- a/docs/3.datasources/8.substrate_node.md +++ b/docs/3.datasources/8.substrate_node.md @@ -13,7 +13,7 @@ datasources: {{ #include ../src/demo_substrate_events/dipdup.yaml:11:15 }} ``` -Then, add it to EVM index definitions: +Then, add it to Substrate index definitions: ```yaml [dipdup.yaml] {{ #include ../src/demo_substrate_events/dipdup.yaml:22: }}