- 🔧 - This project is a work in progress.
- 🚧 - Functionality is not guaranteed at this stage.
⚠️ - Use at your own risk.
This repository, Namada Indexer, is distinct from and incomparable to the similarly named Namada MASP Indexer.
Note that: Namada Indexer != Namada MASP Indexer && Namada MASP Indexer != Namada Indexer.
The Namada Indexer is a collection of microservices that crawls data from a Namada Node, stores it in a PostgreSQL database, and makes it accessible via a REST API.
The primary goal of the indexer is to retrieve and store the data necessary for Namadillo (the Namada Interface) to operate. Consequently, the indexer does not store historical data, except for the Transactions Service, which indexes all transactions starting from block 1 and is not used by Namadillo.
When using this project as a backend for Namadillo, always ensure you check out the latest tag. The main branch may contain an incompatible set of APIs.
We welcome contributions to this project! If you'd like to help, feel free to pick an issue labeled as bug or good-first-issue. If you want to propose a new feature, please open an issue first so we can discuss it.
- For new features, target the
mainbranch. - For bug fixes, check out the latest maintenance branch (e.g.,
1.0.0-maint) and target your changes there.
The Namada Indexer is composed of a set of microservices, with each component residing in its own crate. Each microservice is responsible for indexing specific data from the blockchain and storing it in the PostgreSQL database.
-
namada/chain-indexer: Processes blocks sequentially and extracts information from transactions (e.g., balances). -
namada/governance-indexer: Tracks new proposals and their corresponding votes. -
namada/parameters-indexer: Retrieves the chain parameters. -
namada/pos-indexer: Retrieves the validator set at the start of each new epoch. -
namada/rewards-indexer: Fetches Proof-of-Stake rewards for each new epoch. -
namada/transactions-indexer: Processes transactions starting from block height 0 (or the last successfully processed block height). -
namada/webserver-indexer: Thewebserverserves indexed data via a REST API, enabling external applications and users to access blockchain data in a structured and accessible way. It listens on port5001. -
docker.dragonflydb.io/dragonflydb/dragonfly: This container runs a DragonflyDB instance, an advanced in-memory key-value store that acts as a caching layer. It listens on port6379and stores frequently accessed or temporary data, improving system performance by reducing the need for repeated database queries. -
postgres:16-alpine: This container runs a PostgreSQL instance, serving as the primary database for storing indexed data fetched by the microservices. It listens on port5433and provides a reliable and scalable storage backend for the project.
Follow these instructions to set up the project locally. The steps below will guide you through the process of getting a local copy up and running.
It is strongly recommended to change the default username and password for your PostgreSQL database for security purposes. Update these credentials in both the .env file and the docker-compose.yml file to reflect the changes.
Before starting, ensure you have the necessary tools and dependencies installed. Below are the steps to set up the required environment.
- Packages: Install prerequisite packages from the APT repository.
apt-get install -y curl apt-transport-https ca-certificates software-properties-common git nano just build-essential-
Docker: Follow the official instructions provided by Docker to install it: Install Docker Engine.
-
Just: Refer to the official documentation to install
just: Just Installation Guide.
Ensure you have the latest repository cloned to maintain compatibility with other Namada interfaces. Use the following commands to clone the repository and navigate into its directory.
git clone https://github.com/anoma/namada-indexer.git
cd namada-indexerCreate the .env file in the root of the project. You can use the .env.sample file as a reference.
cp .env.sample .env- The
TENDERMINT_URLvariable must point to a Namada RPC URL, which can be either public or local. For a public RPC URL, refer to the Namada Ecosystem Repository. If running the Namada Node locally, use the preconfiguredhttp://host.docker.internal:26657. - When running locally, ensure that CometBFT allows RPC calls by setting the the configuration in your
config.tomlfile.
Build the required Docker containers for the project.
docker compose buildLaunch the Namada Indexer using the just command, which orchestrates the Docker containers.
# Run the Docker containers in the foreground, displaying all logs and keeping the terminal active until stopped.
just docker-up
# Run the Docker containers in detached mode, starting them in the background without showing logs in the terminal.
just docker-up-dIf you prefer not to use Docker, you can follow the instructions below to set up and run the services manually.
-
Install Rust and Cargo on your system. Refer to the official Rust installation guide.
-
Update the
.envfile with values that match your setup. -
Use the
run.shscript located inside each package to start the services.- The PoS package must always be running.
- Other services can be run as needed based on your requirements.
The API endpoints are described in the swagger.yml file located in the project root. A hosted HTML version of the API documentation is available at Namada Interface Indexer REST API.
Instead of fetching data from a running network, you can populate the database with random data for testing purposes. Build the project using the following command.
cargo build
# Run the seeder script to populate the database
cd seeder && cargo run -- --database-url postgres://postgres:[email protected]:5433/namada-indexerAfter populating the database, you can run the webserver to access the data via the API. To query your PostgreSQL database, ensure the PostgreSQL client is installed.
apt-get install -y postgresql-client
