diff --git a/docs/indexer/build/manifest/algorand.md b/docs/indexer/build/manifest/algorand.md index 21955001266..44616b48cc0 100644 --- a/docs/indexer/build/manifest/algorand.md +++ b/docs/indexer/build/manifest/algorand.md @@ -178,13 +178,12 @@ Additionally you will need to update the `endpoint`. This defines the (HTTP or W Public nodes may be rate limited which can affect indexing speed, when developing your project we suggest getting a private API key from a professional RPC provider. -| Field | Type | Description | -| ---------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **chainId** | String | A network identifier for the blockchain | -| **endpoint** | String | Defines the wss or ws endpoint of the blockchain to be indexed - **This must be a full archive node**. | -| **port** | Number | Optional port number on the `endpoint` to connect to | -| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | -| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | +| Field | Type | Description | +| ---------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **chainId** | String | A network identifier for the blockchain | +| **endpoint** | String or String[] | Defines the endpoint of the blockchain to be indexed, this can be a string or an array of endpoints - **This must be a full archive node**. | +| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | +| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | ### Runner Spec diff --git a/docs/indexer/build/manifest/arbitrum.md b/docs/indexer/build/manifest/arbitrum.md index 089f255f597..7a6f3a56180 100644 --- a/docs/indexer/build/manifest/arbitrum.md +++ b/docs/indexer/build/manifest/arbitrum.md @@ -211,13 +211,12 @@ Public nodes may be rate limited which can affect indexing speed, when developin There is only a dictionary for Arbitrum One `https://gx.api.subquery.network/sq/subquery/arbitrum-one-dictionary`. For Arbitrum Nova, please omit the dictionary setting. -| Field | Type | Description | -| ---------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **chainId** | String | A network identifier for the blockchain | -| **endpoint** | String | Defines the endpoint of the blockchain to be indexed - **This must be a full archive node**. | -| **port** | Number | Optional port number on the `endpoint` to connect to | -| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | -| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | +| Field | Type | Description | +| ---------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **chainId** | String | A network identifier for the blockchain | +| **endpoint** | String or String[] | Defines the endpoint of the blockchain to be indexed, this can be a string or an array of endpoints - **This must be a full archive node**. | +| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | +| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | ### Runner Spec diff --git a/docs/indexer/build/manifest/avalanche.md b/docs/indexer/build/manifest/avalanche.md index 64800219d9d..b2c150f290d 100644 --- a/docs/indexer/build/manifest/avalanche.md +++ b/docs/indexer/build/manifest/avalanche.md @@ -218,14 +218,12 @@ Additionally you will need to update the `endpoint`. This defines the (HTTP or W Public nodes may be rate limited which can affect indexing speed, when developing your project we suggest getting a private API key from a professional RPC provider like [OnFinality](https://onfinality.io/networks/avalanche). -| Field | Type | Description | -| ---------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **chainId** | String | A network identifier for the blockchain | -| **endpoint** | String | Defines the endpoint of the blockchain to be indexed - **This must be a full archive node**. | -| **port** | Number | Optional port number on the `endpoint` to connect to | -| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | -| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | - +| Field | Type | Description | +| ---------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **chainId** | String | A network identifier for the blockchain | +| **endpoint** | String or String[] | Defines the endpoint of the blockchain to be indexed, this can be a string or an array of endpoints - **This must be a full archive node**. | +| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | +| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | ### Runner Spec | Field | Type | Description | diff --git a/docs/indexer/build/manifest/bsc.md b/docs/indexer/build/manifest/bsc.md index 84a705e10b3..060365956c1 100644 --- a/docs/indexer/build/manifest/bsc.md +++ b/docs/indexer/build/manifest/bsc.md @@ -209,14 +209,12 @@ Additionally you will need to update the `endpoint`. This defines the (HTTP or W Public nodes may be rate limited which can affect indexing speed, when developing your project we suggest getting a private API key from a professional RPC provider like [OnFinality](https://onfinality.io/networks/bsc). -| Field | Type | Description | -| ---------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **chainId** | String | A network identifier for the blockchain | -| **endpoint** | String | Defines the endpoint of the blockchain to be indexed - **This must be a full archive node**. | -| **port** | Number | Optional port number on the `endpoint` to connect to | -| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | -| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | - +| Field | Type | Description | +| ---------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **chainId** | String | A network identifier for the blockchain | +| **endpoint** | String or String[] | Defines the endpoint of the blockchain to be indexed, this can be a string or an array of endpoints - **This must be a full archive node**. | +| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | +| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | ### Runner Spec | Field | Type | Description | diff --git a/docs/indexer/build/manifest/concordium.md b/docs/indexer/build/manifest/concordium.md index e0381746c46..e460565fdab 100644 --- a/docs/indexer/build/manifest/concordium.md +++ b/docs/indexer/build/manifest/concordium.md @@ -138,13 +138,12 @@ You will need to update the `endpoint`. This defines the HTTP RPC endpoint of th Public nodes may be rate limited which can affect indexing speed, when developing your project we suggest getting a private API key from a professional RPC provider. -| Field | Type | Description | -| ---------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **chainId** | String | A network identifier for the blockchain | -| **endpoint** | String | Defines the endpoint of the blockchain to be indexed - **This should be a full archive node**. | -| **port** | Number | Optional port number on the `endpoint` to connect to | -| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | -| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | +| Field | Type | Description | +| ---------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **chainId** | String | A network identifier for the blockchain | +| **endpoint** | String or String[] | Defines the endpoint of the blockchain to be indexed, this can be a string or an array of endpoints - **This must be a full archive node**. | +| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | +| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | ### Runner Spec diff --git a/docs/indexer/build/manifest/cosmos.md b/docs/indexer/build/manifest/cosmos.md index 3dc07716935..a33767a9afd 100644 --- a/docs/indexer/build/manifest/cosmos.md +++ b/docs/indexer/build/manifest/cosmos.md @@ -190,13 +190,13 @@ Additionally you will need to update the `endpoint`. This defines the (HTTP or W Public nodes may be rate limited which can affect indexing speed, when developing your project we suggest getting a private API key from a professional RPC provider like [OnFinality](https://onfinality.io/networks). -| Field | Type | Description | -| ---------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **chainId** | String | A network identifier for the blockchain | -| **endpoint** | String | Defines the wss or ws endpoint of the blockchain to be indexed - **This must be a full archive node**. You can retrieve endpoints for all parachains for free from [OnFinality](https://app.onfinality.io) | -| **port** | Number | Optional port number on the `endpoint` to connect to | -| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | -| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | +| Field | Type | Description | +| ---------------- | -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **chainId** | String | A network identifier for the blockchain | +| **endpoint** | String or String[] | Defines the endpoint of the blockchain to be indexed, this can be a string or an array of endpoints - **This must be a full archive node**. | +| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | +| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | +| **chaintypes** | Map\ | References to protobuf files that are used to decode block content, this should include protobufs for any messages or events that you wish to decode, see [ChainTypes](#chain-types) | ### Runner Spec diff --git a/docs/indexer/build/manifest/ethereum.md b/docs/indexer/build/manifest/ethereum.md index 9ecf1ad2289..4f13886b9ed 100644 --- a/docs/indexer/build/manifest/ethereum.md +++ b/docs/indexer/build/manifest/ethereum.md @@ -207,13 +207,12 @@ Additionally you will need to update the `endpoint`. This defines the (HTTP or W Public nodes may be rate limited which can affect indexing speed, when developing your project we suggest getting a private API key from a professional RPC provider like [OnFinality](https://onfinality.io/networks/eth). -| Field | Type | Description | -| ---------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **chainId** | String | A network identifier for the blockchain | -| **endpoint** | String | Defines the endpoint of the blockchain to be indexed - **This must be a full archive node**. | -| **port** | Number | Optional port number on the `endpoint` to connect to | -| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | -| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | +| Field | Type | Description | +| ---------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **chainId** | String | A network identifier for the blockchain | +| **endpoint** | String or String[] | Defines the endpoint of the blockchain to be indexed, this can be a string or an array of endpoints - **This must be a full archive node**. | +| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | +| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | ### Runner Spec diff --git a/docs/indexer/build/manifest/flare.md b/docs/indexer/build/manifest/flare.md index 6d4996f5d22..d4106abc6ec 100644 --- a/docs/indexer/build/manifest/flare.md +++ b/docs/indexer/build/manifest/flare.md @@ -202,13 +202,12 @@ Additionally you will need to update the `endpoint`. This defines the (HTTP or W Public nodes may be rate limited which can affect indexing speed, when developing your project we suggest getting a private API key from a professional RPC provider like Flare's API Portal https://api-portal.flare.network/ -| Field | Type | Description | -| ---------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **chainId** | String | A network identifier for the blockchain | -| **endpoint** | String | Defines the wss or ws endpoint of the blockchain to be indexed - **This must be a full archive node**. | -| **port** | Number | Optional port number on the `endpoint` to connect to | -| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | -| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | +| Field | Type | Description | +| ---------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **chainId** | String | A network identifier for the blockchain | +| **endpoint** | String or String[] | Defines the endpoint of the blockchain to be indexed, this can be a string or an array of endpoints - **This must be a full archive node**. | +| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | +| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | ### Runner Spec diff --git a/docs/indexer/build/manifest/gnosis.md b/docs/indexer/build/manifest/gnosis.md index d47365f48f0..afb084a3542 100644 --- a/docs/indexer/build/manifest/gnosis.md +++ b/docs/indexer/build/manifest/gnosis.md @@ -220,13 +220,12 @@ Public nodes may be rate limited which can affect indexing speed, when developin There is a dictionary for Gnosis which is `https://api.subquery.network/sq/subquery/gnosis-dictionary`. -| Field | Type | Description | -| ---------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **chainId** | String | A network identifier for the blockchain | -| **endpoint** | String | Defines the endpoint of the blockchain to be indexed - **This must be a full archive node**. | -| **port** | Number | Optional port number on the `endpoint` to connect to | -| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | -| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | +| Field | Type | Description | +| ---------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **chainId** | String | A network identifier for the blockchain | +| **endpoint** | String or String[] | Defines the endpoint of the blockchain to be indexed, this can be a string or an array of endpoints - **This must be a full archive node**. | +| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | +| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | ### Runner Spec diff --git a/docs/indexer/build/manifest/near.md b/docs/indexer/build/manifest/near.md index 62216998c08..d928fa8af5e 100644 --- a/docs/indexer/build/manifest/near.md +++ b/docs/indexer/build/manifest/near.md @@ -220,13 +220,12 @@ Additionally you will need to update the `endpoint`. This defines the (HTTP or W Public nodes may be rate limited which can affect indexing speed, when developing your project we suggest getting a private API key from a professional RPC provider. -| Field | Type | Description | -| ---------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **chainId** | String | A network identifier for the blockchain | -| **endpoint** | String | Defines the RPC endpoint of the blockchain to be indexed - **This must be a full archive node**. You can retrieve endpoints for all parachains for free from [OnFinality](https://app.onfinality.io) | -| **port** | Number | Optional port number on the `endpoint` to connect to | -| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). For NEAR mainnet this is provided (we don't run a dictionary for the testnet) | -| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | +| Field | Type | Description | +| ---------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **chainId** | String | A network identifier for the blockchain | +| **endpoint** | String or String[] | Defines the endpoint of the blockchain to be indexed, this can be a string or an array of endpoints - **This must be a full archive node**. | +| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | +| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | ### Runner Spec diff --git a/docs/indexer/build/manifest/optimism.md b/docs/indexer/build/manifest/optimism.md index acd9e5cf17e..8c40b0090f2 100644 --- a/docs/indexer/build/manifest/optimism.md +++ b/docs/indexer/build/manifest/optimism.md @@ -217,13 +217,12 @@ Public nodes may be rate limited which can affect indexing speed, when developin There is a dictionary for Optimism which is `https://api.subquery.network/sq/subquery/optimism-dictionary`. -| Field | Type | Description | -| ---------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **chainId** | String | A network identifier for the blockchain | -| **endpoint** | String | Defines the endpoint of the blockchain to be indexed - **This must be a full archive node**. | -| **port** | Number | Optional port number on the `endpoint` to connect to | -| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | -| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | +| Field | Type | Description | +| ---------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **chainId** | String | A network identifier for the blockchain | +| **endpoint** | String or String[] | Defines the endpoint of the blockchain to be indexed, this can be a string or an array of endpoints - **This must be a full archive node**. | +| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | +| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | ### Runner Spec diff --git a/docs/indexer/build/manifest/polkadot.md b/docs/indexer/build/manifest/polkadot.md index da625413087..e4e581f4e49 100644 --- a/docs/indexer/build/manifest/polkadot.md +++ b/docs/indexer/build/manifest/polkadot.md @@ -177,15 +177,13 @@ Additionally you will need to update the `endpoint`. This defines the (HTTP or W Public nodes may be rate limited which can affect indexing speed, when developing your project we suggest getting a private API key from a professional RPC provider like [OnFinality](https://onfinality.io/networks/eth). -| Field | v1.0.0 | v0.2.0 | Description | -| ---------------- | ------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **chainId** | String | x | A network identifier for the blockchain (`genesisHash` in Substrate) | -| **genesisHash** | String | String | The genesis hash of the network (from v1.0.0 this is an alias for `chainId` and not necessary) | -| **endpoint** | String | String | Defines the wss or ws endpoint of the blockchain to be indexed - **This must be a full archive node**. You can retrieve endpoints for all parachains for free from [OnFinality](https://app.onfinality.io) | -| **port** | Number | Number | Optional port number on the `endpoint` to connect to | -| **dictionary** | String | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | -| **chaintypes** | {file:String} | {file:String} | Path to chain types file, accept `.json` or `.yaml` format | -| **bypassBlocks** | Array | x | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | +| Field | v1.0.0 | Description | +| ---------------- | ------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **chainId** | String | A network identifier for the blockchain (`genesisHash` in Substrate) | +| **endpoint** | String or String[] or Record\ | Defines the endpoint of the blockchain to be indexed, this can be a string, an array of endpoints, or a record of endpoints to [endpoint configs](#endpoint-config) - **This must be a full archive node**. You can retrieve endpoints for all parachains for free from [OnFinality](https://app.onfinality.io) | +| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | +| **chaintypes** | {file:String} | Path to chain types file, accept `.json` or `.yaml` format | +| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | ### Runner Spec @@ -444,6 +442,25 @@ When declaring a `range` use an string in the format of `"start - end"`. Both st } ``` +## Endpoint Config + +This option allows specifying options that are applied specific to an endpoint. As of now this just allows setting headers on a per endpoint basis. + +Here is an example of how to set an API key in the header. +```ts +{ + network: { + endpoint: { + "wss://polkadot.api.onfinality.io/public-ws": { + headers: { + "x-api-key": "your-api-key", + } + } + } + } +} +``` + ## Custom Data Sources Custom Data Sources provide network specific functionality that makes dealing with data easier. They act as a middleware that can provide extra filtering and data transformation. diff --git a/docs/indexer/build/manifest/polygon.md b/docs/indexer/build/manifest/polygon.md index dc77b059350..b3565238153 100644 --- a/docs/indexer/build/manifest/polygon.md +++ b/docs/indexer/build/manifest/polygon.md @@ -210,13 +210,12 @@ Additionally you will need to update the `endpoint`. This defines the (HTTP or W Public nodes may be rate limited which can affect indexing speed, when developing your project we suggest getting a private API key from a professional RPC provider like [OnFinality](https://onfinality.io/networks/polygon). -| Field | Type | Description | -| ---------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **chainId** | String | A network identifier for the blockchain | -| **endpoint** | String | Defines the endpoint of the blockchain to be indexed - **This must be a full archive node**. | -| **port** | Number | Optional port number on the `endpoint` to connect to | -| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | -| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | +| Field | Type | Description | +| ---------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **chainId** | String | A network identifier for the blockchain | +| **endpoint** | String or String[] | Defines the endpoint of the blockchain to be indexed, this can be a string or an array of endpoints - **This must be a full archive node**. | +| **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | +| **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) | ### Runner Spec diff --git a/docs/indexer/build/manifest/stellar.md b/docs/indexer/build/manifest/stellar.md index e3daf3d3b5d..b9f19ab97c1 100644 --- a/docs/indexer/build/manifest/stellar.md +++ b/docs/indexer/build/manifest/stellar.md @@ -211,7 +211,6 @@ Public nodes may be rate limited which can affect indexing speed, when developin | **chainId** | String | A network identifier for the blockchain, [Stellar and Soroban uses the network passphrase](https://developers.stellar.org/docs/encyclopedia/network-passphrases) | | **endpoint** | String or String[] | Defines the endpoint of the blockchain to be indexed - **you will want archive nodes with high rate limits if you want to index large amounts of historical datae**. | | **sorobanEndpoint** | String | Defines the soroban RPC endpoint - **you will want archive nodes with high rate limits if you want to index large amounts of historical data**. | -| **port** | Number | Optional port number on the `endpoint` to connect to | | **dictionary** | String | It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read [how a SubQuery Dictionary works](../../academy/tutorials_examples/dictionary.md). | | **bypassBlocks** | Array | Bypasses stated block numbers, the values can be a `range`(e.g. `"10- 50"`) or `integer`, see [Bypass Blocks](#bypass-blocks) |