The Starter Package is an example that you can use as a starting point for developing your SubQuery project.
This repo includes all starter projects for EVM networks - each under its own repo. The templates are registered in the templates repo.
A SubQuery package defines which data The SubQuery will index from the blockchain, and how it will store it.
Although we only list quick start guides for select EVM based networks - SubQuery has been tested to support all standard EVM implementations. You can quickly initialise a new project in any supported network using the subql init command:
View the full list of tested EVM projects in the ethereum-subql-starter repository.
We're confident that SubQuery supports all pure EVM implementations!
If your (or anyone else's EVM network) needs indexing support, we're pretty confident that SubQuery will work off the shelf with it! Reach out to us on Discord or at [email protected] and we can help out, or continue with the steps below.
Before you start, you will need:
- Access to a public RPC node to index from
- The chain ID of the network
- An example ERC20 token to test indexing against (It's helpful to have a block explorer to see details about it, Blockscout is a popular EVM explorer)
Fill out the Automated EVM Support Form
This issue template triggers an automated action to add support for your EVM network. It's takes only a few seconds to complete, and automates the setup and testing of your network.
Fill out the New Chain Support Request form.
This will create a new issue like so, and then trigger an automated GitHub pipeline to generate a custom example for your chain and save it as a PR. You can then download or clone this branch to start developing.
Our team will review your PR, and add it to the offical examples repository in a few days. We really appreciate it, and will absolutely give you a shout out for your effort on social media to our community! Reach out to us at [email protected] so we can work together on making sure the community knows about SubQuery's support for your EVM network.
- If you would like to contribute to add a Starter project, you can create a pull request into one of these.
- For our guidelines on creating a pull requests or raising issues view https://github.com/subquery/subql/blob/main/contributing.md