Running mev-inspect-py without kubernetes ('monolithic mode')

Running mev-inspect-py outside of kubernetes can be useful for debug purposes. In this case, the steps for installation are:

Install dependencies (pyenv, poetry, postgres)
Set up python virtual environment using matching python version (3.9.x) and install required python modules using poetry
Create postgres database
Run database migrations

The database credentials and archive node address used by mev-inspect-py need to be loaded into environment variables (both for database migrations and to run mev-inspect-py).

Ubuntu install instructions

So, starting from a clean Ubuntu 22.04 installation, the prerequisites for pyenv, psycopg2 (python3-dev libpq-dev) and postgres (postgresql postgresql-contrib) can be installed with

sudo apt install -y make build-essential git libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev libncursesw5-dev xz-utils tk-dev liblzma-dev python3-dev libpq-dev postgresql postgresql-contrib

pyenv

Install pyenv using the web installer

curl https://pyenv.run | bash

and add the following to ~/.bashrc (if running locally) or ~/.profile (if running over ssh).

export PYENV_ROOT="$HOME/.pyenv"
command -v pyenv >/dev/null || export PATH="$PYENV_ROOT/bin:$PATH"
eval "$(pyenv init -)"

Then update the current shell by running source ~/.bashrc or source ~/.profile as appropriate.

Poetry

Finally we install Poetry using the web installer

curl -sSL https://install.python-poetry.org | python3 -

add the following to ~/.bashrc (if running locally) or ~/.profile (if running over ssh)

export PATH="/home/user/.local/bin:$PATH"

If running over ssh you should also add the following to ~/.profile to prevent Poetry errors from a lack of active keyring:

export PYTHON_KEYRING_BACKEND=keyring.backends.null.Keyring

Again update current shell by running source ~/.bashrc or source ~/.profile as appropriate.

mev-inspect-py

With all dependencies now installed, clone the mev-inspec-py repo

git clone https://github.com/flashbots/mev-inspect-py.git
cd mev-inspect-py

and use pyenv to instantiate and activate a virtual environment using Python 3.9.16

pyenv install 3.9.16
pyenv virtualenv 3.9.16 mev_inspect
pyenv local mev_inspect
pyenv activate mev_inspect

We can now use Poetry to install the required python modules into the mev_inspect virtual environment.

poetry install

Create database

mev-inspect-py outputs to a postgres database, so we need to set this up. Here we'll use the postgres superuser for simplicity.

sudo -u postgres psql
\password
[set a password at the prompt]
create database mev_inspect;
exit

Environment variables

We will need to set a few environment variables to use mev-inspect-py. These will be required every time mev-inspect-py runs, so again you may wish to add these to your ~/.bashrc and/or ~/.profile as appropriate. Note that you need to substitute your password and archive node URL in the below.

export POSTGRES_USER=postgres
export POSTGRES_PASSWORD=[the password you set above]
export POSTGRES_HOST=localhost
export RPC_URL="http://127.0.0.1:8545"

Database migrations

Finally run the database migrations:

poetry run alembic upgrade head

Usage instructions

The same functionality available through kubernetes can be run in 'monolithic mode', but the relevant functions now need to be invoked by Poetry directly. So to inspect a single block, run for example:

poetry run inspect-block 16379706

Or to inspect a range of blocks:

poetry run inspect-many-blocks 16379606 16379706

Or to run the test suite:

poetry run pytest tests

3.7 KiB Raw Blame History