This repository uses Apibara to index web3 data.

Create a new virtual environment for this project. While this step is not required, it is highly recommended to avoid conflicts between different installed packages.

python3 -m venv venv

Then activate the virtual environment.

source venv/bin/activate

Then install poetry and use it to install the package dependencies.

python3 -m pip install poetry
poetry install

Start Apibara and MongoDB using the provided docker-compose file:

docker-compose up

Then start the indexer by running the indexer start command. The indexer command runs the cli application defined in src/indexer/main.py. This is a standard Click application.

Notice that by default the indexer will start indexing from where it left off in the previous run. If you want restart, use the --restart flag.

indexer start --restart

Notice that will also delete the database with the indexer's data.

You can change the id of the indexer by changing the value of the indexer_id variable in src/indexer/indexer.py. This id is also used as the name of the Mongo database where the indexer data is stored.

This template includes a Dockerfile that you can use to package the indexer for production usage.