|
| 1 | +!!! note "Content disclaimer" |
| 2 | + |
| 3 | + Please view the third-party content disclaimer [here](https://github.com/0xPolygon/polygon-docs/blob/main/CONTENT_DISCLAIMER.md). |
| 4 | + |
| 5 | +# Envio HyperIndex |
| 6 | + |
| 7 | +[Envio](https://envio.dev/) HyperIndex is a feature-rich indexing solution that provides developers with a seamless and efficient way to index and aggregate real-time or historical blockchain data for any EVM. The indexed data is easily accessible through custom GraphQL queries, providing developers with the flexibility and power to retrieve specific information. |
| 8 | + |
| 9 | +Envio offers native support for Polygon PoS (testnet & mainnet), Polygon zkEVM (testnet & mainnet), and Polygon CDK chains, and has been designed to support high-throughput blockchain applications that rely on real-time data for their business requirements. |
| 10 | + |
| 11 | +Designed to optimize the user experience, Envio offers automatic code generation, flexible language support, quickstart templates, and a reliable cost-effective [hosted service](https://docs.envio.dev/docs/hosted-service). |
| 12 | + |
| 13 | +Indexers on Envio can be written in JavaScript, TypeScript, or ReScript. |
| 14 | + |
| 15 | +## Envio HyperSync |
| 16 | + |
| 17 | +Envio supports [HyperSync](https://docs.envio.dev/docs/hypersync) on Polygon networks. |
| 18 | + |
| 19 | +HyperSync is an accelerated data query layer for the Polygon networks, providing APIs that bypass JSON-RPC for 100x faster syncing of historical data. HyperSync is used by default in Envio HyperIndex, with the use of RPC being optional. Using HyperSync, application developers do not need to worry about RPC URLs, rate-limiting, or managing infrastructure and can easily sync large datasets in a few minutes, something that would usually take hours or days via RPC. |
| 20 | + |
| 21 | +HyperSync is also available as a standalone API for data analytic use cases. Data analysts can interact with the HyperSync API using JavaScript, Python, or Rust clients and extract data in JSON, Arrow, or Parquet formats. For more information, visit the HyperSync documentation [here](https://docs.envio.dev/docs/overview-hypersync). |
| 22 | + |
| 23 | +## HyperIndex key features |
| 24 | + |
| 25 | +- Contract import: Autogenerate the key boilerplate for an entire Indexer project off a single or multiple smart contracts. Deploy within minutes. |
| 26 | + |
| 27 | +- Multi-chain support: Aggregate data across multiple networks into a single database. Query all your data with a unified GraphQL API. |
| 28 | + |
| 29 | +- Asynchronous mode: Fetch data from off-chain storage such as IPFS, or contract state (e.g. smart contract view functions). |
| 30 | + |
| 31 | +- Factory contracts: Automatically process events emitted by all child contracts that are created by the specified factory. |
| 32 | + |
| 33 | +- Quickstart templates: Use pre-defined indexing logic for popular OpenZeppelin contracts (e.g. ERC-20). |
| 34 | + |
| 35 | + |
| 36 | +## Getting started |
| 37 | + |
| 38 | +Users can choose whether they want to start from a quickstart template, perform a subgraph migration, or use the contract import feature to get started with Envio HyperIndex. |
| 39 | + |
| 40 | +The following files are required to run the Envio indexer: |
| 41 | + |
| 42 | +- Configuration (defaults to `config.yaml`) |
| 43 | +- GraphQL Schema (defaults to `schema.graphql`) |
| 44 | +- Event Handlers (defaults to `src/EventHandlers.*` depending on the language chosen) |
| 45 | + |
| 46 | +These files are auto-generated according to the template and language chosen by running the `envio init` command. |
| 47 | + |
| 48 | +### Contract import tutorial |
| 49 | + |
| 50 | +This walkthrough explains how to initialize an indexer using a single or multiple contracts that are already deployed on Polygon. This process allows a user to quickly and easily start up a basic indexer and a queryable GraphQL API for their application in less than 3 minutes. |
| 51 | + |
| 52 | +### Intialize your indexer |
| 53 | + |
| 54 | +`cd` into the folder of your choice and run |
| 55 | + |
| 56 | +```bash |
| 57 | +envio init |
| 58 | +``` |
| 59 | + |
| 60 | +Name your indexer |
| 61 | + |
| 62 | +```bash |
| 63 | +? Name your indexer: |
| 64 | +``` |
| 65 | + |
| 66 | +Choose the directory where you would like to setup your project (default is the current directory) |
| 67 | + |
| 68 | +```bash |
| 69 | +? Set the directory: (.) . |
| 70 | +``` |
| 71 | + |
| 72 | +Select `Contract Import` as the initialization option. |
| 73 | + |
| 74 | +```bash |
| 75 | +? Choose an initialization option |
| 76 | + Template |
| 77 | +> ContractImport |
| 78 | +[↑↓ to move, enter to select, type to filter] |
| 79 | +``` |
| 80 | + |
| 81 | +```bash |
| 82 | +? Would you like to import from a block explorer or a local abi? |
| 83 | +> Block Explorer |
| 84 | + Local ABI |
| 85 | +[↑↓ to move, enter to select, type to filter] |
| 86 | +``` |
| 87 | + |
| 88 | +`Block Explorer` option only requires user to input the contracts address and chain of the contract. If the contract is verified and deployed on one of the supported chains, this is the quickest setup as it will retrieve all needed contract information from a block explorer. |
| 89 | + |
| 90 | +`Local ABI` option will allow you to point to a JSON file containing the smart contract ABI. The Contract Import process will then populate the required files from the ABI. |
| 91 | + |
| 92 | +#### Select the blockchain that the contract is deployed on |
| 93 | + |
| 94 | +```bash |
| 95 | +? Which blockchain would you like to import a contract from? |
| 96 | + ethereum-mainnet |
| 97 | + arbitrum-one |
| 98 | + arbitrum-nova |
| 99 | +> polygon |
| 100 | + gnosis |
| 101 | +v optimism |
| 102 | +[↑↓ to move, enter to select, type to filter] |
| 103 | +``` |
| 104 | + |
| 105 | +#### Enter the address of the contract to import |
| 106 | + |
| 107 | +```bash |
| 108 | +? What is the address of the contract? |
| 109 | +[Use the proxy address if your abi is a proxy implementation] |
| 110 | +``` |
| 111 | +
|
| 112 | +Note if you are using a proxy contract with an implementation, the address should be for the proxy contract. |
| 113 | +
|
| 114 | +#### Choose which events to include in the `config.yaml` file |
| 115 | +
|
| 116 | +```bash |
| 117 | +? Which events would you like to index? |
| 118 | +> [x] ClaimRewards(address indexed from, address indexed reward, uint256 amount) |
| 119 | + [x] Deposit(address indexed from, uint256 indexed tokenId, uint256 amount) |
| 120 | + [x] NotifyReward(address indexed from, address indexed reward, uint256 indexed epoch, uint256 amount) |
| 121 | + [x] Withdraw(address indexed from, uint256 indexed tokenId, uint256 amount) |
| 122 | +[↑↓ to move, space to select one, → to all, ← to none, type to filter] |
| 123 | +``` |
| 124 | +
|
| 125 | +#### Select the continuation option |
| 126 | +
|
| 127 | +```bash |
| 128 | +? Would you like to add another contract? |
| 129 | +> I'm finished |
| 130 | + Add a new address for same contract on same network |
| 131 | + Add a new network for same contract |
| 132 | + Add a new contract (with a different ABI) |
| 133 | +[Current contract: BribeVotingReward, on network: polygon] |
| 134 | +``` |
| 135 | +
|
| 136 | +The `Contract Import` process will prompt the user whether they would like to finish the import process or continue adding more addresses for same contract on same network, addresses for same contract on different network or a different contract. |
| 137 | +
|
| 138 | +For more information on contract import feature, visit the documentation [here](https://docs.envio.dev/docs/contract-import). |
| 139 | +
|
| 140 | +
|
| 141 | +## Envio examples |
| 142 | +
|
| 143 | +Click [here](https://docs.envio.dev/docs/example-uniswap-v3) for Envio HyperIndex examples. |
| 144 | +Click [here](https://docs.envio.dev/docs/hypersync-clients) for Envio HyperSync examples. |
| 145 | +
|
| 146 | +## Getting help |
| 147 | +
|
| 148 | +Indexing can be a rollercoaster, especially for more complex use cases. Our engineers are available to help you with your data availability needs. |
| 149 | +
|
| 150 | +Join our growing community of elite builders, and find peace of mind with Envio. |
| 151 | +
|
| 152 | +* [Discord](https://discord.gg/mZHNWgNCAc) |
| 153 | +* Email: [hello@envio.dev](mailto:hello@envio.dev) |
0 commit comments