https://github.com/anoma/namada-indexer

Namada indexer to be used in conjunction with the namada interface
https://github.com/anoma/namada-indexer

Last synced: 3 months ago
JSON representation

Namada indexer to be used in conjunction with the namada interface

• Host: GitHub
• URL: https://github.com/anoma/namada-indexer
• Owner: anoma
• Created: 2024-04-29T08:36:34.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-05-22T10:22:46.000Z (6 months ago)
• Last Synced: 2024-05-22T11:54:07.507Z (6 months ago)
• Language: Rust
• Homepage:
• Size: 428 KB
• Stars: 6
• Watchers: 15
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Governance: governance/Cargo.toml

Awesome Lists containing this project

• awesome-ccamel - anoma/namada-indexer - Namada indexer to be used in conjunction with the namada interface (Rust)

README

        
# Namada Interface Indexer

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! 🔧

## Architecture

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 epoch

- `rewards`: fetches PoS rewards each new epoch

- `governance`: fetches new proposal and the corresponding votes

- `parameters`: 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.

![Namada indexer architecture](docs/architecture.png "Architecture")

## How to run

### Prerequisites

- Create the `.env` file in the root of the project. You can use the `.env_sample` file as a reference:

```sh

cp .env_sample .env

```

- Set the `TENDERMINT_URL` with the Namada RPC url:

  - [Either create a local chain](https://docs.namada.net/operators/networks/local-network)

  - Or use a Public RPC

### With docker

- Install [just](https://github.com/casey/just)

- Run `just docker-up`

### Without docker

- Install rust/cargo

- Update the `.env` values to match your setup, for example:

  ```env

  DATABASE_URL=postgres://postgres:[email protected]:5435/namada-indexer

  TENDERMINT_URL=http://127.0.0.1:27657

  CACHE_URL=redis://[email protected]:6379

  PORT=5000

  ```

- Use the `run.sh` script inside each package. Keep in mind that PoS package have to be run always while other service might not

## Testing via seeder

Instead of fetching data from a running network, for testing porpuses it's also possible to populate the databse with some random data.

- `cargo build`

- `cd seeder && cargo run -- --database-url postgres://postgres:[email protected]:5435/namada-indexer`

It's possible to only run the webserver and have access to the data via API.