Endblock docs (#443)

subquery · Nov 1, 2023 · 73459e2 · 73459e2
1 parent 398810d
commit 73459e2
Show file tree

Hide file tree

Showing 14 changed files with 106 additions and 61 deletions.
diff --git a/docs/build/manifest/algorand.md b/docs/build/manifest/algorand.md
@@ -222,7 +222,8 @@ Defines the data that will be filtered and extracted and the location of the map
 | Field | Type | Description
 | --------------- |-------------|-------------|
 | **kind** | String | [algorand/Runtime](#data-sources-and-mapping) |
-| **startBlock** | Integer | This changes your indexing start block, set this higher to skip initial blocks with less data|  
+| **startBlock** | Integer | This changes your indexing start block for this datasource, set this as high as possible to skip initial blocks with no relevant data |
+| **endBlock** | Integer | This sets a end block for processing on the datasource. After this block is processed, this datasource will no longer index your data. <br><br>Useful when your contracts change at a certain block height, or when you want to insert data at genesis. For example, setting both the `startBlock` and `endBlock` to 320, will mean this datasource only operates on block 320 |
 | **mapping** | Mapping Spec | |
 
 ### Mapping Spec

diff --git a/docs/build/manifest/arbitrum.md b/docs/build/manifest/arbitrum.md
@@ -254,11 +254,12 @@ There is only a dictionary for Arbitrum One `https://gx.api.subquery.network/sq/
 
 Defines the data that will be filtered and extracted and the location of the mapping function handler for the data transformation to be applied.
 
-| Field          | Type         | Description                                                                                                                                 |
-| -------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
-| **kind**       | string       | [ethereum/Runtime](#data-sources-and-mapping) _We use the Ethereum runtime for Arbitrum since it is compatible with the Ethereum framework_ |
-| **startBlock** | Integer      | This changes your indexing start block, set this higher to skip initial blocks with less data                                               |
-| **mapping**    | Mapping Spec |                                                                                                                                             |
+| Field          | Type         | Description                                                                                                                                                                                                                                                                                                                                                                    |
+| -------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **kind**       | string       | [ethereum/Runtime](#data-sources-and-mapping) _We use the Ethereum runtime for Arbitrum since it is compatible with the Ethereum framework_                                                                                                                                                                                                                                    |
+| **startBlock** | Integer      | This changes your indexing start block for this datasource, set this as high as possible to skip initial blocks with no relevant data                                                                                                                                                                                                                                          |
+| **endBlock**   | Integer      | This sets a end block for processing on the datasource. After this block is processed, this datasource will no longer index your data. <br><br>Useful when your contracts change at a certain block height, or when you want to insert data at genesis. For example, setting both the `startBlock` and `endBlock` to 320, will mean this datasource only operates on block 320 |
+| **mapping**    | Mapping Spec |                                                                                                                                                                                                                                                                                                                                                                                |
 
 ### Mapping Spec
 

diff --git a/docs/build/manifest/avalanche.md b/docs/build/manifest/avalanche.md
@@ -261,11 +261,12 @@ Public nodes may be rate limited which can affect indexing speed, when developin
 
 Defines the data that will be filtered and extracted and the location of the mapping function handler for the data transformation to be applied.
 
-| Field          | Type         | Description                                                                                                                                  |
-| -------------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
-| **kind**       | string       | [ethereum/Runtime](#data-sources-and-mapping) _We use the Ethereum runtime for Avalanche since it is compatible with the Ethereum framework_ |
-| **startBlock** | Integer      | This changes your indexing start block, set this higher to skip initial blocks with less data                                                |
-| **mapping**    | Mapping Spec |                                                                                                                                              |
+| Field          | Type         | Description                                                                                                                                                                                                                                                                                                                                                                    |
+| -------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **kind**       | string       | [ethereum/Runtime](#data-sources-and-mapping) _We use the Ethereum runtime for Avalanche since it is compatible with the Ethereum framework_                                                                                                                                                                                                                                   |
+| **startBlock** | Integer      | This changes your indexing start block for this datasource, set this as high as possible to skip initial blocks with no relevant data                                                                                                                                                                                                                                          |
+| **endBlock**   | Integer      | This sets a end block for processing on the datasource. After this block is processed, this datasource will no longer index your data. <br><br>Useful when your contracts change at a certain block height, or when you want to insert data at genesis. For example, setting both the `startBlock` and `endBlock` to 320, will mean this datasource only operates on block 320 |
+| **mapping**    | Mapping Spec |                                                                                                                                                                                                                                                                                                                                                                                |
 
 ### Mapping Spec
 

diff --git a/docs/build/manifest/bsc.md b/docs/build/manifest/bsc.md
@@ -252,11 +252,12 @@ Public nodes may be rate limited which can affect indexing speed, when developin
 
 Defines the data that will be filtered and extracted and the location of the mapping function handler for the data transformation to be applied.
 
-| Field          | Type         | Description                                                                                                                            |
-| -------------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
-| **kind**       | string       | [ethereum/Runtime](#data-sources-and-mapping) _We use the Ethereum runtime for BSC since it is compatible with the Ethereum framework_ |
-| **startBlock** | Integer      | This changes your indexing start block, set this higher to skip initial blocks with less data                                          |
-| **mapping**    | Mapping Spec |                                                                                                                                        |
+| Field          | Type         | Description                                                                                                                                                                                                                                                                                                                                                                    |
+| -------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **kind**       | string       | [ethereum/Runtime](#data-sources-and-mapping) _We use the Ethereum runtime for BSC since it is compatible with the Ethereum framework_                                                                                                                                                                                                                                         |
+| **startBlock** | Integer      | This changes your indexing start block for this datasource, set this as high as possible to skip initial blocks with no relevant data                                                                                                                                                                                                                                          |
+| **endBlock**   | Integer      | This sets a end block for processing on the datasource. After this block is processed, this datasource will no longer index your data. <br><br>Useful when your contracts change at a certain block height, or when you want to insert data at genesis. For example, setting both the `startBlock` and `endBlock` to 320, will mean this datasource only operates on block 320 |
+| **mapping**    | Mapping Spec |                                                                                                                                                                                                                                                                                                                                                                                |
 
 ### Mapping Spec
 

diff --git a/docs/build/manifest/cosmos.md b/docs/build/manifest/cosmos.md
@@ -248,11 +248,12 @@ Public nodes may be rate limited which can affect indexing speed, when developin
 
 Defines the data that will be filtered and extracted and the location of the mapping function handler for the data transformation to be applied.
 
-| Field          | Type         | Description                                                                                   |
-| -------------- | ------------ | --------------------------------------------------------------------------------------------- |
-| **kind**       | String       | [cosmos/Runtime](#data-sources-and-mapping)                                                   |
-| **startBlock** | Integer      | This changes your indexing start block, set this higher to skip initial blocks with less data |
-| **mapping**    | Mapping Spec |                                                                                               |
+| Field          | Type         | Description                                                                                                                                                                                                                                                                                                                                                                    |
+| -------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **kind**       | String       | [cosmos/Runtime](#data-sources-and-mapping)                                                                                                                                                                                                                                                                                                                                    |
+| **startBlock** | Integer      | This changes your indexing start block for this datasource, set this as high as possible to skip initial blocks with no relevant data                                                                                                                                                                                                                                          |
+| **endBlock**   | Integer      | This sets a end block for processing on the datasource. After this block is processed, this datasource will no longer index your data. <br><br>Useful when your contracts change at a certain block height, or when you want to insert data at genesis. For example, setting both the `startBlock` and `endBlock` to 320, will mean this datasource only operates on block 320 |
+| **mapping**    | Mapping Spec |                                                                                                                                                                                                                                                                                                                                                                                |
 
 ### Mapping Spec
 

diff --git a/docs/build/manifest/ethereum.md b/docs/build/manifest/ethereum.md
@@ -248,11 +248,12 @@ Public nodes may be rate limited which can affect indexing speed, when developin
 
 Defines the data that will be filtered and extracted and the location of the mapping function handler for the data transformation to be applied.
 
-| Field          | Type         | Description                                                                                   |
-| -------------- | ------------ | --------------------------------------------------------------------------------------------- |
-| **kind**       | string       | [ethereum/Runtime](#data-sources-and-mapping)                                                 |
-| **startBlock** | Integer      | This changes your indexing start block, set this higher to skip initial blocks with less data |
-| **mapping**    | Mapping Spec |                                                                                               |
+| Field          | Type         | Description                                                                                                                                                                                                                                                                                                                                                                    |
+| -------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **kind**       | string       | [ethereum/Runtime](#data-sources-and-mapping)                                                                                                                                                                                                                                                                                                                                  |
+| **startBlock** | Integer      | This changes your indexing start block for this datasource, set this as high as possible to skip initial blocks with no relevant data                                                                                                                                                                                                                                          |
+| **endBlock**   | Integer      | This sets a end block for processing on the datasource. After this block is processed, this datasource will no longer index your data. <br><br>Useful when your contracts change at a certain block height, or when you want to insert data at genesis. For example, setting both the `startBlock` and `endBlock` to 320, will mean this datasource only operates on block 320 |
+| **mapping**    | Mapping Spec |                                                                                                                                                                                                                                                                                                                                                                                |
 
 ### Mapping Spec