token-imbalances

This repository is to calculate the raw token imbalances before and after a settlement. The raw token imbalances are stored in the raw_token_imbalances table. Additionally, coingecko prices for fetchable token addresses at the time of transaction are stored in the coingecko_prices table. These tables are a part of the Solver Slippage Database. These prices can be used to convert raw imbalances to ETH.

Env Setup

Docker

This repo uses Docker, but you could potentially use another another container management service like podman, see docs here For docker installation go to the docker website

Python

Install python if you don't have it already, current version is 3.12+ Installation instructions

For managing different versions of python you could look at using pyenv.

There will need to be some env variables that you need to set like CHAIN_SLEEP_TIME, you can set those in a .env file. View the sample .env.sample file to see what you might need to set.

Once python has been set up and your env file is populated you can then proceed with the next set up instructions:

Set up virtual environment:

make setup-venv
source .venv/bin/activate

Install requirements from root directory:

make install

Environment Variables: Make sure the .env file is correctly set up locally. You can use the .env.sample file as reference.

To fetch imbalances for a single transaction hash, run:

make imbalances

To run a daemon for checking imbalances, run the following from the root directory:

make daemon

Tests

Note: Make sure docker is installed and the daemon is running so you can execute this

To build and start a local database for testing use the command

make test_db

To run the unittests you can use the make target unittest make unittest, however you might have a couple issues:

• You might run into the issue of the binary package for psycopg not being installed simply run:

pip install "psycopg[binary,pool]"

To shutdown the docker test db and remove the image/container you can do:

make stop_test_db