mev-inspect

Running locally

Setup Docker

Start the services with Docker Compose

docker compose up

or to run in the background

docker compose up -d

To stop the services

docker compose down

Check docker compose help for more tools available

Executing scripts

To run a command, prefix it with

docker compose exec mev-inspect <YOUR COMMAND>

For example, to run testing_file.py:

docker compose exec mev-inspect python testing_file.py \
    -block_number 11931271 \
    -rpc 'http://111.11.11.111:8545'

Or to run the tests:

docker compose exec mev-inspect python -m unittest test/*py

Rebuilding containers

After changes to the app's Dockerfile, rebuild with

docker compose build

Contributing

Contributing requires installing the pre-commit hooks

1 . Ensure you're using python 3.9

If not, pyenv is a great option for managing python versions

2. Create a virtualenv

python3 -m venv venv

3. Activate it

. venv/bin/activate

(exit with deactivate)

4. Install dev libraries

pip install -r requirements_dev.txt

5. Install pre-commit

pre-commit install

6. Install pre-commit's dependencies and ensure it's working

pre-commit run --all-files