This directory contains various SubQuery indexers used within the Astral project. Each indexer is dedicated to handling specific data transformation and querying tasks, making the data more accessible and useful for applications and services.
Each folder represent a network, since it's possible that the testnet and mainnet have different data models. Each network has its own indexer, but they are all try to follow the same structure.
consensus: Handles the indexing of consensus-related data. (blocks, extrinsics, events and accounts)leaderboard: Handles the indexing of leaderboard.staking: Focuses on indexing and managing staking-related data.
Each indexer has its own set of dependencies and setup instructions. Navigate to the respective indexer directory and follow the README.md there for detailed instructions.
To contribute to an indexer or modify its behavior:
- Clone the repository if you haven't done so already.
- Open Docker Desktop
- Run
yarnfrom this directory - Run
yarn devfrom this directory - Open a new terminal and run
yarn metadata:devfrom indexers/ directory - Open a new terminal and run
yarn migrate:devfrom indexers/ directory - Open a new terminal and run
yarn console:devfrom indexers/ directory
Ensure that any changes made are accompanied by tests to verify functionality and prevent regressions.
Contributions to improve or enhance the indexers are always welcome. Follow the standard procedure by forking the repository, making your changes, and submitting a pull request.
For more detailed guidance on how to contribute, refer to the main project's Contributing section.
Each indexer is released under the same license as the main project. See the License file for more details.