Cyberindex is a cosmos-sdk based blockchain data aggregator and exporter that provides the ability for developers and clients to query for indexed chain data.
The cyberindex contains 4 services wrapped in docker-compose file:
- Juno - Cosmos Hub data aggregator and exporter. In other words, it can be seen as an ETL layer atop of the Cosmos Hub.
- PostgreSQL - as database
- Hasura - as graphQL engine ontop of them
- Additional crawlers - special tool for the Game of Links monitors backend.
- Open and fill
.env
file with all necessary data - To install in docker run
make docker
.
Cyberindex, Hasura and Postgres would be deployed in docker containers.
Note Not necessary to create config.toml
for docker installation, it would be generated automatically from .env
file.
Example of filled .env
file:
POSTGRES_DB_FOLDER=./postgres
POSTGRES_DB_HOST=localhost
POSTGRES_DB_PORT=5432
POSTGRES_DB_NAME=cyberindex
POSTGRES_USER_NAME=cyber
POSTGRES_DB_PASSWORD=postgres111
HASURA_PORT=8090
HASURA_ADMIN_SECRET=hasura111
JUNO_SSL_MODE=disable
JUNO_WORKERS=6
RPC_URL=http://localhost:26657
LCD_URL=http://localhost:1317
FQDN_RPC_URL=<cyberd_fqdn_http/https_rpc>
Juno as part of cyberindex internally runs a single worker that consumes from a single queue. The queue contains block heights to aggregate and export to a PostgreSQL database. Juno will start a new block even listener where for each new block, it will enqueue the height. A worker listens for new heights and queries for various data related to the block height to persist. For each block height, juno will persist the block, the validators that committed/signed the block, all the pre-commits for the block and the transactions in the block.
In addition, it will also sync missing blocks from --start-height
to the latest
known height.
$ juno /path/to/config.toml [flags]
The schema definitions are contained in the schema/
directory. Note, these
schemas are not necessarily optimal and are subject to change! However, feel
free to fork this tool and expand upon the schemas as you see fit. Any tweaks
will most likely require adjustments to the database
wrapper.