README ¶
Celestia Indexer | Celenium
This is an indexing layer for Celestia DA written in Golang that operates on top of the Celestia Full node and stores data in a Postgres database.
Run
Prerequisites:
Local run
Clone the repository:
git clone https://github.com/celenium-io/celestia-indexer.git
cd celestia-indexer
Create .env
file and set up required environment variables:
cp .env.example .env
vim .env
Required environment variables:
CELESTIA_DAL_API_URL
- uri for Celestia Full Storage NodeCELESTIA_NODE_AUTH_TOKEN
- token with read access level for full storage node. You can get it from your running node instance by commandcelestia full auth read
CELESTIA_NODE_URL
- uri to Celestia Consensus NodePOSTGRES_USER
- username for PostgresPOSTGRES_PASSWORD
- password for Postgres
Build the Docker images for the indexer and API:
docker compose build
Start the services using Docker Compose:
docker compose up -d
This will start the indexer and API services as well as a Postgres database instance.
The services will be configured according to the .env
file and the docker-compose.yml
file in the repository.
≠
Features
- RPC node client
- Rollbacks are handled
- Database is partitioned for better performance
- Optional diagnostic mode for consistency checks
Indexed entities
- Blocks
- Transactions
- Balance updates (block rewards, gov-triggered issuance/burn, other events)
- Header
- Stats
- Transactions
- Details
- Balance updates
- Blobs
- Metadata
- Accounts
- Balances
- Stats
- Namespaces
- Stats
- Summary
- Stats
License
Click to show internal directories.
Click to hide internal directories.