feat: add interactive HyperSync query builder component and documentation #670
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| --- | ||
| id: chainweb-testnet-20 | ||
| title: Chainweb Testnet 20 | ||
| sidebar_label: Chainweb Testnet 20 | ||
| slug: /chainweb-testnet-20 | ||
| --- | ||
|
|
||
| # Chainweb Testnet 20 | ||
|
|
||
| ## Indexing Chainweb Testnet 20 Data with Envio | ||
|
|
||
| | **Field** | **Value** | | ||
| |-------------------------------|----------------------------------------------------------------------------------------------------| | ||
| | **Chainweb Testnet 20 Chain ID** | 5920 | | ||
| | **HyperSync URL Endpoint** | [https://chainweb-testnet-20.hypersync.xyz](https://chainweb-testnet-20.hypersync.xyz) or [https://5920.hypersync.xyz](https://5920.hypersync.xyz) | | ||
| | **HyperRPC URL Endpoint** | [https://chainweb-testnet-20.rpc.hypersync.xyz](https://chainweb-testnet-20.rpc.hypersync.xyz) or [https://5920.rpc.hypersync.xyz](https://5920.rpc.hypersync.xyz) | | ||
|
|
||
| --- | ||
|
|
||
| ### Tier | ||
|
|
||
| STONE 🪨 | ||
|
|
||
| ### Overview | ||
|
|
||
| Envio is a modular hyper-performant data indexing solution for Chainweb Testnet 20, enabling applications and developers to efficiently index and aggregate real-time and historical blockchain data. Envio offers three primary solutions for indexing and accessing large amounts of data: [HyperIndex](/docs/HyperIndex/overview) (a customizable indexing framework), [HyperSync](/docs/HyperSync/overview) (a real-time indexed data layer), and [HyperRPC](/docs/HyperSync/overview-hyperrpc) (extremely fast read-only RPC). | ||
|
|
||
| HyperSync accelerates the synchronization of historical data on Chainweb Testnet 20, enabling what usually takes hours to sync millions of events to be completed in under a minute—up to 1000x faster than traditional RPC methods. | ||
|
|
||
| Designed to optimize the user experience, Envio offers automatic code generation, flexible language support, multi-chain data aggregation, and a reliable, cost-effective hosted service. | ||
|
|
||
| To get started, see our documentation or follow our quickstart [guide](/docs/HyperIndex/contract-import). | ||
|
|
||
| --- | ||
|
|
||
| ### Defining Network Configurations | ||
|
|
||
| ```yaml | ||
| name: IndexerName # Specify indexer name | ||
| description: Indexer Description # Include indexer description | ||
| networks: | ||
| - id: 5920 # Chainweb Testnet 20 | ||
| start_block: START_BLOCK_NUMBER # Specify the starting block | ||
| contracts: | ||
| - name: ContractName | ||
| address: | ||
| - "0xYourContractAddress1" | ||
| - "0xYourContractAddress2" | ||
| handler: ./src/EventHandlers.ts | ||
| events: | ||
| - event: Event # Specify event | ||
| - event: Event | ||
| ``` | ||
|
|
||
| With these steps completed, your application will be set to efficiently index Chainweb Testnet 20 data using Envio’s blockchain indexer. | ||
|
|
||
| For more information on how to set up your config, define a schema, and write event handlers, refer to the guides section in our [documentation](/docs/HyperIndex/configuration-file). | ||
|
|
||
| ### Support | ||
|
|
||
| Can’t find what you’re looking for or need support? Reach out to us on [Discord](https://discord.com/invite/Q9qt8gZ2fX); we’re always happy to help! | ||
|
|
||
| --- | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| --- | ||
| id: chainweb-testnet-21 | ||
| title: Chainweb Testnet 21 | ||
| sidebar_label: Chainweb Testnet 21 | ||
| slug: /chainweb-testnet-21 | ||
| --- | ||
|
|
||
| # Chainweb Testnet 21 | ||
|
|
||
| ## Indexing Chainweb Testnet 21 Data with Envio | ||
|
|
||
| | **Field** | **Value** | | ||
| |-------------------------------|----------------------------------------------------------------------------------------------------| | ||
| | **Chainweb Testnet 21 Chain ID** | 5921 | | ||
| | **HyperSync URL Endpoint** | [https://chainweb-testnet-21.hypersync.xyz](https://chainweb-testnet-21.hypersync.xyz) or [https://5921.hypersync.xyz](https://5921.hypersync.xyz) | | ||
| | **HyperRPC URL Endpoint** | [https://chainweb-testnet-21.rpc.hypersync.xyz](https://chainweb-testnet-21.rpc.hypersync.xyz) or [https://5921.rpc.hypersync.xyz](https://5921.rpc.hypersync.xyz) | | ||
|
|
||
| --- | ||
|
|
||
| ### Tier | ||
|
|
||
| STONE 🪨 | ||
|
|
||
| ### Overview | ||
|
|
||
| Envio is a modular hyper-performant data indexing solution for Chainweb Testnet 21, enabling applications and developers to efficiently index and aggregate real-time and historical blockchain data. Envio offers three primary solutions for indexing and accessing large amounts of data: [HyperIndex](/docs/HyperIndex/overview) (a customizable indexing framework), [HyperSync](/docs/HyperSync/overview) (a real-time indexed data layer), and [HyperRPC](/docs/HyperSync/overview-hyperrpc) (extremely fast read-only RPC). | ||
|
|
||
| HyperSync accelerates the synchronization of historical data on Chainweb Testnet 21, enabling what usually takes hours to sync millions of events to be completed in under a minute—up to 1000x faster than traditional RPC methods. | ||
|
|
||
| Designed to optimize the user experience, Envio offers automatic code generation, flexible language support, multi-chain data aggregation, and a reliable, cost-effective hosted service. | ||
|
|
||
| To get started, see our documentation or follow our quickstart [guide](/docs/HyperIndex/contract-import). | ||
|
|
||
| --- | ||
|
|
||
| ### Defining Network Configurations | ||
|
|
||
| ```yaml | ||
| name: IndexerName # Specify indexer name | ||
| description: Indexer Description # Include indexer description | ||
| networks: | ||
| - id: 5921 # Chainweb Testnet 21 | ||
| start_block: START_BLOCK_NUMBER # Specify the starting block | ||
| contracts: | ||
| - name: ContractName | ||
| address: | ||
| - "0xYourContractAddress1" | ||
| - "0xYourContractAddress2" | ||
| handler: ./src/EventHandlers.ts | ||
| events: | ||
| - event: Event # Specify event | ||
| - event: Event | ||
| ``` | ||
|
Comment on lines
+38
to
+53
Contributor
There was a problem hiding this comment. 🛠️ Refactor suggestion YAML indentation is off – the sample won’t parse as-is The list items under - address:
- - "0xYourContractAddress1"
- - "0xYourContractAddress2"
+ address:
+ - "0xYourContractAddress1"
+ - "0xYourContractAddress2"🤖 Prompt for AI Agents |
||
|
|
||
| With these steps completed, your application will be set to efficiently index Chainweb Testnet 21 data using Envio’s blockchain indexer. | ||
|
|
||
| For more information on how to set up your config, define a schema, and write event handlers, refer to the guides section in our [documentation](/docs/HyperIndex/configuration-file). | ||
|
|
||
| ### Support | ||
|
|
||
| Can’t find what you’re looking for or need support? Reach out to us on [Discord](https://discord.com/invite/Q9qt8gZ2fX); we’re always happy to help! | ||
|
|
||
| --- | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| --- | ||
| id: plume | ||
| title: Plume | ||
| sidebar_label: Plume | ||
| slug: /plume | ||
| --- | ||
|
|
||
| # Plume | ||
|
|
||
| ## Indexing Plume Data with Envio | ||
|
|
||
| | **Field** | **Value** | | ||
| |-------------------------------|----------------------------------------------------------------------------------------------------| | ||
| | **Plume Chain ID** | 98866 | | ||
| | **HyperSync URL Endpoint** | [https://plume.hypersync.xyz](https://plume.hypersync.xyz) or [https://98866.hypersync.xyz](https://98866.hypersync.xyz) | | ||
| | **HyperRPC URL Endpoint** | [https://plume.rpc.hypersync.xyz](https://plume.rpc.hypersync.xyz) or [https://98866.rpc.hypersync.xyz](https://98866.rpc.hypersync.xyz) | | ||
|
|
||
| --- | ||
|
|
||
| ### Tier | ||
|
|
||
| STONE 🪨 | ||
|
|
||
| ### Overview | ||
|
|
||
| Envio is a modular hyper-performant data indexing solution for Plume, enabling applications and developers to efficiently index and aggregate real-time and historical blockchain data. Envio offers three primary solutions for indexing and accessing large amounts of data: [HyperIndex](/docs/HyperIndex/overview) (a customizable indexing framework), [HyperSync](/docs/HyperSync/overview) (a real-time indexed data layer), and [HyperRPC](/docs/HyperSync/overview-hyperrpc) (extremely fast read-only RPC). | ||
|
|
||
| HyperSync accelerates the synchronization of historical data on Plume, enabling what usually takes hours to sync millions of events to be completed in under a minute—up to 1000x faster than traditional RPC methods. | ||
|
|
||
| Designed to optimize the user experience, Envio offers automatic code generation, flexible language support, multi-chain data aggregation, and a reliable, cost-effective hosted service. | ||
|
|
||
| To get started, see our documentation or follow our quickstart [guide](/docs/HyperIndex/contract-import). | ||
|
|
||
| --- | ||
|
|
||
| ### Defining Network Configurations | ||
|
|
||
| ```yaml | ||
| name: IndexerName # Specify indexer name | ||
| description: Indexer Description # Include indexer description | ||
| networks: | ||
| - id: 98866 # Plume | ||
| start_block: START_BLOCK_NUMBER # Specify the starting block | ||
| contracts: | ||
| - name: ContractName | ||
| address: | ||
| - "0xYourContractAddress1" | ||
| - "0xYourContractAddress2" | ||
| handler: ./src/EventHandlers.ts | ||
| events: | ||
| - event: Event # Specify event | ||
| - event: Event | ||
| ``` | ||
|
|
||
| With these steps completed, your application will be set to efficiently index Plume data using Envio’s blockchain indexer. | ||
|
|
||
| For more information on how to set up your config, define a schema, and write event handlers, refer to the guides section in our [documentation](/docs/HyperIndex/configuration-file). | ||
|
|
||
| ### Support | ||
|
|
||
| Can’t find what you’re looking for or need support? Reach out to us on [Discord](https://discord.com/invite/Q9qt8gZ2fX); we’re always happy to help! | ||
|
|
||
| --- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,7 +19,7 @@ slug: /tangle | |
|
|
||
| ### Tier | ||
|
|
||
| STONE 🪨 | ||
|
|
||
| ### Overview | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| --- | ||
| id: taraxa | ||
| title: Taraxa | ||
| sidebar_label: Taraxa | ||
| slug: /taraxa | ||
| --- | ||
|
|
||
| # Taraxa | ||
|
|
||
| ## Indexing Taraxa Data with Envio | ||
|
|
||
| | **Field** | **Value** | | ||
| |-------------------------------|----------------------------------------------------------------------------------------------------| | ||
| | **Taraxa Chain ID** | 841 | | ||
| | **HyperSync URL Endpoint** | [https://taraxa.hypersync.xyz](https://taraxa.hypersync.xyz) or [https://841.hypersync.xyz](https://841.hypersync.xyz) | | ||
| | **HyperRPC URL Endpoint** | [https://taraxa.rpc.hypersync.xyz](https://taraxa.rpc.hypersync.xyz) or [https://841.rpc.hypersync.xyz](https://841.rpc.hypersync.xyz) | | ||
|
|
||
| --- | ||
|
|
||
| ### Tier | ||
|
|
||
| BRONZE 🥉 | ||
|
|
||
| ### Overview | ||
|
|
||
| Envio is a modular hyper-performant data indexing solution for Taraxa, enabling applications and developers to efficiently index and aggregate real-time and historical blockchain data. Envio offers three primary solutions for indexing and accessing large amounts of data: [HyperIndex](/docs/HyperIndex/overview) (a customizable indexing framework), [HyperSync](/docs/HyperSync/overview) (a real-time indexed data layer), and [HyperRPC](/docs/HyperSync/overview-hyperrpc) (extremely fast read-only RPC). | ||
|
|
||
| HyperSync accelerates the synchronization of historical data on Taraxa, enabling what usually takes hours to sync millions of events to be completed in under a minute—up to 1000x faster than traditional RPC methods. | ||
|
|
||
| Designed to optimize the user experience, Envio offers automatic code generation, flexible language support, multi-chain data aggregation, and a reliable, cost-effective hosted service. | ||
|
|
||
| To get started, see our documentation or follow our quickstart [guide](/docs/HyperIndex/contract-import). | ||
|
|
||
| --- | ||
|
|
||
| ### Defining Network Configurations | ||
|
|
||
| ```yaml | ||
| name: IndexerName # Specify indexer name | ||
| description: Indexer Description # Include indexer description | ||
| networks: | ||
| - id: 841 # Taraxa | ||
| start_block: START_BLOCK_NUMBER # Specify the starting block | ||
| contracts: | ||
| - name: ContractName | ||
| address: | ||
| - "0xYourContractAddress1" | ||
| - "0xYourContractAddress2" | ||
| handler: ./src/EventHandlers.ts | ||
| events: | ||
| - event: Event # Specify event | ||
| - event: Event | ||
| ``` | ||
|
|
||
| With these steps completed, your application will be set to efficiently index Taraxa data using Envio’s blockchain indexer. | ||
|
|
||
| For more information on how to set up your config, define a schema, and write event handlers, refer to the guides section in our [documentation](/docs/HyperIndex/configuration-file). | ||
|
|
||
| ### Support | ||
|
|
||
| Can’t find what you’re looking for or need support? Reach out to us on [Discord](https://discord.com/invite/Q9qt8gZ2fX); we’re always happy to help! | ||
|
|
||
| --- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Same indentation bug in YAML snippet
The
addresslist items need two more spaces:📝 Committable suggestion
🤖 Prompt for AI Agents