From 994504e65a015bb5c6521678cab9e2409e765996 Mon Sep 17 00:00:00 2001 From: Scott Twiname Date: Tue, 3 Oct 2023 14:38:25 +1300 Subject: [PATCH] Document node runner options, specifically skipTransactions (#400) * Document node runner options, specifically skipBlock * Improve description for skipBlock * Rename skipBlock to skipTransactions, document for ethereum * Add Runner options to other chains --------- Co-authored-by: James Bayly --- docs/build/manifest/algorand.md | 17 +++++++++++++---- docs/build/manifest/arbitrum.md | 18 ++++++++++++++---- docs/build/manifest/avalanche.md | 18 ++++++++++++++---- docs/build/manifest/bsc.md | 18 ++++++++++++++---- docs/build/manifest/cosmos.md | 17 +++++++++++++---- docs/build/manifest/ethereum.md | 18 ++++++++++++++---- docs/build/manifest/flare.md | 18 ++++++++++++++---- docs/build/manifest/gnosis.md | 18 ++++++++++++++---- docs/build/manifest/near.md | 17 +++++++++++++---- docs/build/manifest/optimism.md | 18 ++++++++++++++---- docs/build/manifest/polkadot.md | 18 ++++++++++++++---- docs/build/manifest/polygon.md | 18 ++++++++++++++---- docs/build/manifest/stellar.md | 17 +++++++++++++---- docs/build/manifest/terra.md | 17 +++++++++++++---- 14 files changed, 191 insertions(+), 56 deletions(-) diff --git a/docs/build/manifest/algorand.md b/docs/build/manifest/algorand.md index 1106d803368..65c3e2f7690 100644 --- a/docs/build/manifest/algorand.md +++ b/docs/build/manifest/algorand.md @@ -111,10 +111,11 @@ Public nodes may be rate limited which can affect indexing speed, when developin ### Runner Node Spec -| Field | Type | Description | -| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **name** | String | `@subql/node-algorand` | -| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| Field | Type | Description | +| ----------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **name** | String | `@subql/node-algorand` | +| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| **options** | [Runner Node Options](#runner-node-options) | Runner specific options for how to run your project. These will have an impact on the data your project produces. CLI flags can be used to override these. | ### Runner Query Spec @@ -123,6 +124,14 @@ Public nodes may be rate limited which can affect indexing speed, when developin | **name** | String | We currently support `@subql/query` | | **version** | String | Version of the Query service, available versions can be found [here](https://github.com/subquery/subql/blob/main/packages/query/CHANGELOG.md), it also must follow the SEMVER rules or `latest`. | +### Runner Node Options + +| Field | v1.0.0 (default) | Description | +| --------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **historical** | Boolean (true) | Historical indexing allows you to query the state at a specific block height. e.g A users balance in the past. | +| **unfinalizedBlocks** | Boolean (false) | If enabled unfinalized blocks will be indexed, when a fork is detected the project will be reindexed from the fork. Requires historical. | +| **unsafe** | Boolean (false) | Removes all sandbox restrictions and allows access to all inbuilt node packages as well as being able to make network requests. WARNING: this can make your project non-deterministic. | + ### Datasource Spec Defines the data that will be filtered and extracted and the location of the mapping function handler for the data transformation to be applied. diff --git a/docs/build/manifest/arbitrum.md b/docs/build/manifest/arbitrum.md index cc843c78b0a..08c7f1f7e54 100644 --- a/docs/build/manifest/arbitrum.md +++ b/docs/build/manifest/arbitrum.md @@ -127,10 +127,11 @@ There is only a dictionary for Arbitrum One `https://gx.api.subquery.network/sq/ ### Runner Node Spec -| Field | Type | Description | -| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **name** | String | `@subql/node-ethereum` _We use the Ethereum node package for Arbitrum since it is compatible with the Ethereum framework_ | -| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| Field | Type | Description | +| ----------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **name** | String | `@subql/node-ethereum` _We use the Ethereum node package for Arbitrum since it is compatible with the Ethereum framework_ | +| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| **options** | [Runner Node Options](#runner-node-options) | Runner specific options for how to run your project. These will have an impact on the data your project produces. CLI flags can be used to override these. | ### Runner Query Spec @@ -139,6 +140,15 @@ There is only a dictionary for Arbitrum One `https://gx.api.subquery.network/sq/ | **name** | String | `@subql/query` | | **version** | String | Version of the Query service, available versions can be found [here](https://github.com/subquery/subql/blob/main/packages/query/CHANGELOG.md), it also must follow the SEMVER rules or `latest`. | +### Runner Node Options + +| Field | v1.0.0 (default) | Description | +| --------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **historical** | Boolean (true) | Historical indexing allows you to query the state at a specific block height. e.g A users balance in the past. | +| **unfinalizedBlocks** | Boolean (false) | If enabled unfinalized blocks will be indexed, when a fork is detected the project will be reindexed from the fork. Requires historical. | +| **unsafe** | Boolean (false) | Removes all sandbox restrictions and allows access to all inbuilt node packages as well as being able to make network requests. WARNING: this can make your project non-deterministic. | +| **skipTransactions** | Boolean (false) | If your project contains only event handlers and you don't access any other block data except for the block header you can speed your project up. Handlers should be updated to use `LightEthereumLog` instead of `EthereumLog` to ensure you are not accessing data that is unavailable. | + ### Datasource Spec Defines the data that will be filtered and extracted and the location of the mapping function handler for the data transformation to be applied. diff --git a/docs/build/manifest/avalanche.md b/docs/build/manifest/avalanche.md index d1b6f82870d..6db0f341c16 100644 --- a/docs/build/manifest/avalanche.md +++ b/docs/build/manifest/avalanche.md @@ -134,10 +134,11 @@ Public nodes may be rate limited which can affect indexing speed, when developin ### Runner Node Spec -| Field | Type | Description | -| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **name** | String | `@subql/node-ethereum` _We use the Ethereum node package for Avalanche since it is compatible with the Ethereum framework_ | -| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| Field | Type | Description | +| ----------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **name** | String | `@subql/node-ethereum` _We use the Ethereum node package for Avalanche since it is compatible with the Ethereum framework_ | +| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| **options** | [Runner Node Options](#runner-node-options) | Runner specific options for how to run your project. These will have an impact on the data your project produces. CLI flags can be used to override these. | ### Runner Query Spec @@ -146,6 +147,15 @@ Public nodes may be rate limited which can affect indexing speed, when developin | **name** | String | `@subql/query` | | **version** | String | Version of the Query service, available versions can be found [here](https://github.com/subquery/subql/blob/main/packages/query/CHANGELOG.md), it also must follow the SEMVER rules or `latest`. | +### Runner Node Options + +| Field | v1.0.0 (default) | Description | +| --------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **historical** | Boolean (true) | Historical indexing allows you to query the state at a specific block height. e.g A users balance in the past. | +| **unfinalizedBlocks** | Boolean (false) | If enabled unfinalized blocks will be indexed, when a fork is detected the project will be reindexed from the fork. Requires historical. | +| **unsafe** | Boolean (false) | Removes all sandbox restrictions and allows access to all inbuilt node packages as well as being able to make network requests. WARNING: this can make your project non-deterministic. | +| **skipTransactions** | Boolean (false) | If your project contains only event handlers and you don't access any other block data except for the block header you can speed your project up. Handlers should be updated to use `LightEthereumLog` instead of `EthereumLog` to ensure you are not accessing data that is unavailable. | + ### Datasource Spec Defines the data that will be filtered and extracted and the location of the mapping function handler for the data transformation to be applied. diff --git a/docs/build/manifest/bsc.md b/docs/build/manifest/bsc.md index c348be5ce97..4edb38b4b5b 100644 --- a/docs/build/manifest/bsc.md +++ b/docs/build/manifest/bsc.md @@ -125,10 +125,11 @@ Public nodes may be rate limited which can affect indexing speed, when developin ### Runner Node Spec -| Field | Type | Description | -| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **name** | String | `@subql/node-ethereum` _We use the Ethereum node package for BSC since it is compatible with the Ethereum framework_ | -| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| Field | Type | Description | +| ----------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **name** | String | `@subql/node-ethereum` _We use the Ethereum node package for BSC since it is compatible with the Ethereum framework_ | +| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| **options** | [Runner Node Options](#runner-node-options) | Runner specific options for how to run your project. These will have an impact on the data your project produces. CLI flags can be used to override these. | ### Runner Query Spec @@ -137,6 +138,15 @@ Public nodes may be rate limited which can affect indexing speed, when developin | **name** | String | `@subql/query` | | **version** | String | Version of the Query service, available versions can be found [here](https://github.com/subquery/subql/blob/main/packages/query/CHANGELOG.md), it also must follow the SEMVER rules or `latest`. | +### Runner Node Options + +| Field | v1.0.0 (default) | Description | +| --------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **historical** | Boolean (true) | Historical indexing allows you to query the state at a specific block height. e.g A users balance in the past. | +| **unfinalizedBlocks** | Boolean (false) | If enabled unfinalized blocks will be indexed, when a fork is detected the project will be reindexed from the fork. Requires historical. | +| **unsafe** | Boolean (false) | Removes all sandbox restrictions and allows access to all inbuilt node packages as well as being able to make network requests. WARNING: this can make your project non-deterministic. | +| **skipTransactions** | Boolean (false) | If your project contains only event handlers and you don't access any other block data except for the block header you can speed your project up. Handlers should be updated to use `LightEthereumLog` instead of `EthereumLog` to ensure you are not accessing data that is unavailable. | + ### Datasource Spec Defines the data that will be filtered and extracted and the location of the mapping function handler for the data transformation to be applied. diff --git a/docs/build/manifest/cosmos.md b/docs/build/manifest/cosmos.md index 3a035801494..7b8c4682b5f 100644 --- a/docs/build/manifest/cosmos.md +++ b/docs/build/manifest/cosmos.md @@ -125,10 +125,11 @@ Public nodes may be rate limited which can affect indexing speed, when developin ### Runner Node Spec -| Field | Type | Description | -| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **name** | String | `@subql/node-cosmos` | -| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| Field | Type | Description | +| ----------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **name** | String | `@subql/node-cosmos` | +| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| **options** | [Runner Node Options](#runner-node-options) | Runner specific options for how to run your project. These will have an impact on the data your project produces. CLI flags can be used to override these. | ### Runner Query Spec @@ -137,6 +138,14 @@ Public nodes may be rate limited which can affect indexing speed, when developin | **name** | String | We currently support `@subql/query` | | **version** | String | Version of the Query service, available versions can be found [here](https://github.com/subquery/subql/blob/main/packages/query/CHANGELOG.md), it also must follow the SEMVER rules or `latest`. | +### Runner Node Options + +| Field | v1.0.0 (default) | Description | +| --------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **historical** | Boolean (true) | Historical indexing allows you to query the state at a specific block height. e.g A users balance in the past. | +| **unfinalizedBlocks** | Boolean (false) | If enabled unfinalized blocks will be indexed, when a fork is detected the project will be reindexed from the fork. Requires historical. | +| **unsafe** | Boolean (false) | Removes all sandbox restrictions and allows access to all inbuilt node packages as well as being able to make network requests. WARNING: this can make your project non-deterministic. | + ### Datasource Spec Defines the data that will be filtered and extracted and the location of the mapping function handler for the data transformation to be applied. diff --git a/docs/build/manifest/ethereum.md b/docs/build/manifest/ethereum.md index ed75ae217df..0284e2a5fd8 100644 --- a/docs/build/manifest/ethereum.md +++ b/docs/build/manifest/ethereum.md @@ -121,10 +121,11 @@ Public nodes may be rate limited which can affect indexing speed, when developin ### Runner Node Spec -| Field | Type | Description | -| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **name** | String | `@subql/node-ethereum` | -| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| Field | Type | Description | +| ----------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **name** | String | `@subql/node-ethereum` | +| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| **options** | [Runner Node Options](#runner-node-options) | Runner specific options for how to run your project. These will have an impact on the data your project produces. CLI flags can be used to override these. | ### Runner Query Spec @@ -133,6 +134,15 @@ Public nodes may be rate limited which can affect indexing speed, when developin | **name** | String | `@subql/query` | | **version** | String | Version of the Query service, available versions can be found [here](https://github.com/subquery/subql/blob/main/packages/query/CHANGELOG.md), it also must follow the SEMVER rules or `latest`. | +### Runner Node Options +| Field | v1.0.0 (default) | Description | +| --------------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **historical** | Boolean (true) | Historical indexing allows you to query the state at a specific block height. e.g A users balance in the past. | +| **unfinalizedBlocks** | Boolean (false) | If enabled unfinalized blocks will be indexed, when a fork is detected the project will be reindexed from the fork. Requires historical. | +| **unsafe** | Boolean (false) | Removes all sandbox restrictions and allows access to all inbuilt node packages as well as being able to make network requests. WARNING: this can make your project non-deterministic. | +| **skipTransactions** | Boolean (false) | If your project contains only event handlers and you don't access any other block data except for the block header you can speed your project up. Handlers should be updated to use `LightEthereumLog` instead of `EthereumLog` to ensure you are not accessing data that is unavailable. | + + ### Datasource Spec Defines the data that will be filtered and extracted and the location of the mapping function handler for the data transformation to be applied. diff --git a/docs/build/manifest/flare.md b/docs/build/manifest/flare.md index 63d3e9aeae1..2416b26beb7 100644 --- a/docs/build/manifest/flare.md +++ b/docs/build/manifest/flare.md @@ -119,10 +119,11 @@ Public nodes may be rate limited which can affect indexing speed, when developin ### Runner Node Spec -| Field | Type | Description | -| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **name** | String | `@subql/node-flare` | -| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| Field | Type | Description | +| ----------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **name** | String | `@subql/node-flare` | +| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| **options** | [Runner Node Options](#runner-node-options) | Runner specific options for how to run your project. These will have an impact on the data your project produces. CLI flags can be used to override these. | ### Runner Query Spec @@ -131,6 +132,15 @@ Public nodes may be rate limited which can affect indexing speed, when developin | **name** | String | `@subql/query` | | **version** | String | Version of the Query service, available versions can be found [here](https://github.com/subquery/subql/blob/main/packages/query/CHANGELOG.md), it also must follow the SEMVER rules or `latest`. | +### Runner Node Options + +| Field | v1.0.0 (default) | Description | +| --------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **historical** | Boolean (true) | Historical indexing allows you to query the state at a specific block height. e.g A users balance in the past. | +| **unfinalizedBlocks** | Boolean (false) | If enabled unfinalized blocks will be indexed, when a fork is detected the project will be reindexed from the fork. Requires historical. | +| **unsafe** | Boolean (false) | Removes all sandbox restrictions and allows access to all inbuilt node packages as well as being able to make network requests. WARNING: this can make your project non-deterministic. | +| **skipTransactions** | Boolean (false) | If your project contains only event handlers and you don't access any other block data except for the block header you can speed your project up. Handlers should be updated to use `LightEthereumLog` instead of `EthereumLog` to ensure you are not accessing data that is unavailable. | + ### Datasource Spec Defines the data that will be filtered and extracted and the location of the mapping function handler for the data transformation to be applied. diff --git a/docs/build/manifest/gnosis.md b/docs/build/manifest/gnosis.md index 7e84af89ee1..4d65203834c 100644 --- a/docs/build/manifest/gnosis.md +++ b/docs/build/manifest/gnosis.md @@ -132,10 +132,11 @@ There is a dictionary for Gnosis which is `https://api.subquery.network/sq/subqu ### Runner Node Spec -| Field | Type | Description | -| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **name** | String | `@subql/node-ethereum` _We use the Ethereum node package for Gnosis since it is compatible with the Ethereum framework_ | -| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| Field | Type | Description | +| ----------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **name** | String | `@subql/node-ethereum` _We use the Ethereum node package for Gnosis since it is compatible with the Ethereum framework_ | +| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| **options** | [Runner Node Options](#runner-node-options) | Runner specific options for how to run your project. These will have an impact on the data your project produces. CLI flags can be used to override these. | ### Runner Query Spec @@ -144,6 +145,15 @@ There is a dictionary for Gnosis which is `https://api.subquery.network/sq/subqu | **name** | String | `@subql/query` | | **version** | String | Version of the Query service, available versions can be found [here](https://github.com/subquery/subql/blob/main/packages/query/CHANGELOG.md), it also must follow the SEMVER rules or `latest`. | +### Runner Node Options + +| Field | v1.0.0 (default) | Description | +| --------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **historical** | Boolean (true) | Historical indexing allows you to query the state at a specific block height. e.g A users balance in the past. | +| **unfinalizedBlocks** | Boolean (false) | If enabled unfinalized blocks will be indexed, when a fork is detected the project will be reindexed from the fork. Requires historical. | +| **unsafe** | Boolean (false) | Removes all sandbox restrictions and allows access to all inbuilt node packages as well as being able to make network requests. WARNING: this can make your project non-deterministic. | +| **skipTransactions** | Boolean (false) | If your project contains only event handlers and you don't access any other block data except for the block header you can speed your project up. Handlers should be updated to use `LightEthereumLog` instead of `EthereumLog` to ensure you are not accessing data that is unavailable. | + ### Datasource Spec Defines the data that will be filtered and extracted and the location of the mapping function handler for the data transformation to be applied. diff --git a/docs/build/manifest/near.md b/docs/build/manifest/near.md index 5322bec7938..6fb450917d8 100644 --- a/docs/build/manifest/near.md +++ b/docs/build/manifest/near.md @@ -112,10 +112,11 @@ Public nodes may be rate limited which can affect indexing speed, when developin ### Runner Node Spec -| Field | Type | Description | -| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **name** | String | `@subql/node-near` | -| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| Field | Type | Description | +| ----------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **name** | String | `@subql/node-near` | +| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| **options** | [Runner Node Options](#runner-node-options) | Runner specific options for how to run your project. These will have an impact on the data your project produces. CLI flags can be used to override these. | ### Runner Query Spec @@ -124,6 +125,14 @@ Public nodes may be rate limited which can affect indexing speed, when developin | **name** | String | We currently support `@subql/query` | | **version** | String | Version of the Query service, available versions can be found [here](https://github.com/subquery/subql/blob/main/packages/query/CHANGELOG.md), it also must follow the SEMVER rules or `latest`. | +### Runner Node Options + +| Field | v1.0.0 (default) | Description | +| --------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **historical** | Boolean (true) | Historical indexing allows you to query the state at a specific block height. e.g A users balance in the past. | +| **unfinalizedBlocks** | Boolean (false) | If enabled unfinalized blocks will be indexed, when a fork is detected the project will be reindexed from the fork. Requires historical. | +| **unsafe** | Boolean (false) | Removes all sandbox restrictions and allows access to all inbuilt node packages as well as being able to make network requests. WARNING: this can make your project non-deterministic. | + ### Datasource Spec Defines the data that will be filtered and extracted and the location of the mapping function handler for the data transformation to be applied. diff --git a/docs/build/manifest/optimism.md b/docs/build/manifest/optimism.md index c0caa17765a..b8714582c83 100644 --- a/docs/build/manifest/optimism.md +++ b/docs/build/manifest/optimism.md @@ -127,10 +127,11 @@ There is a dictionary for Optimism which is `https://api.subquery.network/sq/sub ### Runner Node Spec -| Field | Type | Description | -| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **name** | String | `@subql/node-ethereum` _We use the Ethereum node package for Optimism since it is compatible with the Ethereum framework_ | -| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| Field | Type | Description | +| ----------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **name** | String | `@subql/node-ethereum` _We use the Ethereum node package for Optimism since it is compatible with the Ethereum framework_ | +| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| **options** | [Runner Node Options](#runner-node-options) | Runner specific options for how to run your project. These will have an impact on the data your project produces. CLI flags can be used to override these. | ### Runner Query Spec @@ -139,6 +140,15 @@ There is a dictionary for Optimism which is `https://api.subquery.network/sq/sub | **name** | String | `@subql/query` | | **version** | String | Version of the Query service, available versions can be found [here](https://github.com/subquery/subql/blob/main/packages/query/CHANGELOG.md), it also must follow the SEMVER rules or `latest`. | +### Runner Node Options + +| Field | v1.0.0 (default) | Description | +| --------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **historical** | Boolean (true) | Historical indexing allows you to query the state at a specific block height. e.g A users balance in the past. | +| **unfinalizedBlocks** | Boolean (false) | If enabled unfinalized blocks will be indexed, when a fork is detected the project will be reindexed from the fork. Requires historical. | +| **unsafe** | Boolean (false) | Removes all sandbox restrictions and allows access to all inbuilt node packages as well as being able to make network requests. WARNING: this can make your project non-deterministic. | +| **skipTransactions** | Boolean (false) | If your project contains only event handlers and you don't access any other block data except for the block header you can speed your project up. Handlers should be updated to use `LightEthereumLog` instead of `EthereumLog` to ensure you are not accessing data that is unavailable. | + ### Datasource Spec Defines the data that will be filtered and extracted and the location of the mapping function handler for the data transformation to be applied. diff --git a/docs/build/manifest/polkadot.md b/docs/build/manifest/polkadot.md index 1e6c10e5330..fc5275973e3 100644 --- a/docs/build/manifest/polkadot.md +++ b/docs/build/manifest/polkadot.md @@ -150,10 +150,11 @@ Public nodes may be rate limited which can affect indexing speed, when developin ### Runner Node Spec -| Field | v1.0.0 | Description | -| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **name** | String | We currently support `@subql/node` | -| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| Field | v1.0.0 | Description | +| ----------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **name** | String | We currently support `@subql/node` | +| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| **options** | [Runner Node Options](#runner-node-options) | Runner specific options for how to run your project. These will have an impact on the data your project produces. CLI flags can be used to override these. | ### Runner Query Spec @@ -162,6 +163,15 @@ Public nodes may be rate limited which can affect indexing speed, when developin | **name** | String | We currently support `@subql/query` | | **version** | String | Version of the Query service, available versions can be found [here](https://github.com/subquery/subql/blob/main/packages/query/CHANGELOG.md), it also must follow the SEMVER rules or `latest`. | + +### Runner Node Options +| Field | v1.0.0 (default) | Description | +| --------------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **historical** | Boolean (true) | Historical indexing allows you to query the state at a specific block height. e.g A users balance in the past. | +| **unfinalizedBlocks** | Boolean (false) | If enabled unfinalized blocks will be indexed, when a fork is detected the project will be reindexed from the fork. Requires historical. | +| **unsafe** | Boolean (false) | Removes all sandbox restrictions and allows access to all inbuilt node packages as well as being able to make network requests. WARNING: this can make your project non-deterministic. | +| **skipTransactions** | Boolean (false) | If your project contains only event handlers and you don't access any other block data except for the block header you can speed your project up. Handlers should be updated to use `LightSubstrateEvent` instead of `SubstrateEvent` to ensure you are not accessing data that is unavailable. | + ### Datasource Spec Defines the data that will be filtered and extracted and the location of the mapping function handler for the data transformation to be applied. diff --git a/docs/build/manifest/polygon.md b/docs/build/manifest/polygon.md index 8180d8ed1fb..15ad8be83a6 100644 --- a/docs/build/manifest/polygon.md +++ b/docs/build/manifest/polygon.md @@ -125,10 +125,11 @@ Public nodes may be rate limited which can affect indexing speed, when developin ### Runner Node Spec -| Field | Type | Description | -| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **name** | String | `@subql/node-ethereum` _We use the Ethereum node package for Polygon since it is compatible with the Ethereum framework_ | -| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| Field | Type | Description | +| ----------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **name** | String | `@subql/node-ethereum` _We use the Ethereum node package for Polygon since it is compatible with the Ethereum framework_ | +| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| **options** | [Runner Node Options](#runner-node-options) | Runner specific options for how to run your project. These will have an impact on the data your project produces. CLI flags can be used to override these. | ### Runner Query Spec @@ -137,6 +138,15 @@ Public nodes may be rate limited which can affect indexing speed, when developin | **name** | String | `@subql/query` | | **version** | String | Version of the Query service, available versions can be found [here](https://github.com/subquery/subql/blob/main/packages/query/CHANGELOG.md), it also must follow the SEMVER rules or `latest`. | +### Runner Node Options + +| Field | v1.0.0 (default) | Description | +| --------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **historical** | Boolean (true) | Historical indexing allows you to query the state at a specific block height. e.g A users balance in the past. | +| **unfinalizedBlocks** | Boolean (false) | If enabled unfinalized blocks will be indexed, when a fork is detected the project will be reindexed from the fork. Requires historical. | +| **unsafe** | Boolean (false) | Removes all sandbox restrictions and allows access to all inbuilt node packages as well as being able to make network requests. WARNING: this can make your project non-deterministic. | +| **skipTransactions** | Boolean (false) | If your project contains only event handlers and you don't access any other block data except for the block header you can speed your project up. Handlers should be updated to use `LightEthereumLog` instead of `EthereumLog` to ensure you are not accessing data that is unavailable. | + ### Datasource Spec Defines the data that will be filtered and extracted and the location of the mapping function handler for the data transformation to be applied. diff --git a/docs/build/manifest/stellar.md b/docs/build/manifest/stellar.md index 70345b03cc5..ce18ff8021a 100644 --- a/docs/build/manifest/stellar.md +++ b/docs/build/manifest/stellar.md @@ -120,10 +120,11 @@ Public nodes may be rate limited which can affect indexing speed, when developin ### Runner Node Spec -| Field | Type | Description | -| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **name** | String | `@subql/node-stellar` | -| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| Field | Type | Description | +| ----------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **name** | String | `@subql/node-stellar` | +| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| **options** | [Runner Node Options](#runner-node-options) | Runner specific options for how to run your project. These will have an impact on the data your project produces. CLI flags can be used to override these. | ### Runner Query Spec @@ -132,6 +133,14 @@ Public nodes may be rate limited which can affect indexing speed, when developin | **name** | String | `@subql/query` | | **version** | String | Version of the Query service, available versions can be found [here](https://github.com/subquery/subql/blob/main/packages/query/CHANGELOG.md), it also must follow the SEMVER rules or `latest`. | +### Runner Node Options + +| Field | v1.0.0 (default) | Description | +| --------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **historical** | Boolean (true) | Historical indexing allows you to query the state at a specific block height. e.g A users balance in the past. | +| **unfinalizedBlocks** | Boolean (false) | If enabled unfinalized blocks will be indexed, when a fork is detected the project will be reindexed from the fork. Requires historical. | +| **unsafe** | Boolean (false) | Removes all sandbox restrictions and allows access to all inbuilt node packages as well as being able to make network requests. WARNING: this can make your project non-deterministic. | + ### Datasource Spec Defines the data that will be filtered and extracted and the location of the mapping function handler for the data transformation to be applied. diff --git a/docs/build/manifest/terra.md b/docs/build/manifest/terra.md index 01ba1313cca..a7f09692b15 100644 --- a/docs/build/manifest/terra.md +++ b/docs/build/manifest/terra.md @@ -113,10 +113,11 @@ Public nodes may be rate limited which can affect indexing speed, when developin ### Runner Node Spec -| Field | Type | Description | -| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **name** | String | `@subql/node-terra` | -| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| Field | Type | Description | +| ----------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **name** | String | `@subql/node-terra` | +| **version** | String | Version of the indexer Node service, it must follow the [SEMVER](https://semver.org/) rules or `latest`, you can also find available versions in subquery SDK [releases](https://github.com/subquery/subql/releases) | +| **options** | [Runner Node Options](#runner-node-options) | Runner specific options for how to run your project. These will have an impact on the data your project produces. CLI flags can be used to override these. | ### Runner Query Spec @@ -125,6 +126,14 @@ Public nodes may be rate limited which can affect indexing speed, when developin | **name** | String | We currently support `@subql/query` | | **version** | String | Version of the Query service, available versions can be found [here](https://github.com/subquery/subql/blob/main/packages/query/CHANGELOG.md), it also must follow the SEMVER rules or `latest`. | +### Runner Node Options + +| Field | v1.0.0 (default) | Description | +| --------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **historical** | Boolean (true) | Historical indexing allows you to query the state at a specific block height. e.g A users balance in the past. | +| **unfinalizedBlocks** | Boolean (false) | If enabled unfinalized blocks will be indexed, when a fork is detected the project will be reindexed from the fork. Requires historical. | +| **unsafe** | Boolean (false) | Removes all sandbox restrictions and allows access to all inbuilt node packages as well as being able to make network requests. WARNING: this can make your project non-deterministic. | + ### Datasource Spec Defines the data that will be filtered and extracted and the location of the mapping function handler for the data transformation to be applied.