The indexer keeps an up-to-date record of all escrowed payments relevant to platforms integrating Unicrow. It does it by listening to events from Unicrow smart contracts and optionally filtering them by marketplace addresses.
Check out Unicrow SDK Tutorial to learn how to query the indexed data.
Create a copy of the example file .env.example named .env and fill it out according to your setup and preferences.
Unicrow's contracts are intentionally immutable. This also means that migrating to a new set of contracts (i.e. a new version) requires a completely fresh restart of the indexer and its database.
It is then critical for you to:
- Recreate or empty the database
- Configure the new contracts addresses in the
.envfile (we'll keep.env.exampleup to date with the latest addresses of every supported chain) - Configure the new indexing starting block (see below)
Important: failing to clean or reconfigure the environment properly could result in inconsistent, unpredictable data.
Open hasura/migrations/unicrow/1726203142180_squashed/up.sql
Replace 0 with the block number where indexing should start e.g. the launch of your marketplace, or few blocks before the deployment of Unicrow on that specific network.
INSERT INTO last_block_number (block_number) VALUES (0);
Open hasura/migrations/unicrow/1726203142180_squashed/up.sql
Replace * with your marketplace's address. To add multiple addresses, duplicate the line.
INSERT INTO marketplace (address) VALUES ('*');
docker compose up -d
- API running: http://localhost:5555
- Hasura running: http://localhost:8080
Docker
- List all containers running
docker ps
- Stop all containers
docker compose down
- Logs
docker compose logs
- Clean up all
docker compose down && docker rmi $(docker images -q) && docker volume rm $(docker volume ls -q)
or:
docker system prune -a --volumes