A set of microservices that crawler data from a namada node, store them in a postgres database and serve them via a REST api.
🔧 This is currently being worked on. Don't expect things to work! 🔧
When using this project as a backend for Namadillo, always checkout the latest tag, as the main branch could have an incompatible set of APIs.
The indexer is composed of a set microservices and a webserver, each one of these lives in his own crate. Each microservice is responsible of indexing some data from the chain and store them in the postgres database. Right now, there are 4 microservices:
chain: goes block by block and fetches information from transactions (e.g balances)pos: fetches the validator set each new epochrewards: fetches PoS rewards each new epochgovernance: fetches new proposal and the corresponding votesparameters: fetches the chain parameters
The webserver is responsible to serve the data via a REST API, which are described in the swagger.yml file in the project root.
- Create the
.envfile in the root of the project. You can use the.env_samplefile as a reference:
cp .env_sample .env- Set the
TENDERMINT_URLwith the Namada RPC url:- Either create a local chain
- Or use a Public RPC
- Install just
- Run
just docker-up
- Install rust/cargo
- Update the
.envvalues to match your setup, for example:DATABASE_URL=postgres://postgres:[email protected]:5433/namada-indexer TENDERMINT_URL=http://127.0.0.1:27657 CACHE_URL=redis://[email protected]:6379 PORT=5001
- Use the
run.shscript inside each package. Keep in mind that PoS package have to be run always while other service might not
Instead of fetching data from a running network, for testing porpuses it's also possible to populate the databse with some random data.
cargo buildcd seeder && cargo run -- --database-url postgres://postgres:[email protected]:5433/namada-indexer
It's possible to only run the webserver and have access to the data via API.