Installation

Vault Version Requirements

This guide requires Vault version 5 (Ethereum) or version 3 (Gnosis). You can find your Vault version in the Details section of your Vault page. If your Vault is below the required version, log in as a Vault Admin and click Upgrade at the top of the Vault page.

The Operator Service can be installed in several ways: as a binary, via Docker, or built from source. Choose your preferred method and follow the instructions below.

Binary

1. Go to the releases page ↗ and find the latest version
2. Select the binary file for your node's hardware
3. Download and decompress the file

To install the latest release, run:

curl -sSfL https://raw.githubusercontent.com/stakewise/v3-operator/master/scripts/install.sh | sh -s

The binary will be placed in ~/bin. Add it to your PATH:

export PATH=$PATH:~/bin

To install a specific version to a custom location:

curl -sSfL https://raw.githubusercontent.com/stakewise/v3-operator/master/scripts/install.sh | sh -s -- -b <custom_location> vX.X.X

Run commands from inside the v3-operator folder using this format:

./operator COMMAND --flagA=123 --flagB=xyz

Docker Image

Pull Official Image

docker pull europe-west4-docker.pkg.dev/stakewiselabs/public/v3-operator:v4.1.10

Alternatively, build the Docker image locally:

git clone https://github.com/stakewise/v3-operator.git
cd v3-operator
docker build --pull -t europe-west4-docker.pkg.dev/stakewiselabs/public/v3-operator:v4.1.10 .

Run commands using this format:

docker run --rm -ti \
-u $(id -u):$(id -g) \
-v ~/.stakewise/:/data \
europe-west4-docker.pkg.dev/stakewiselabs/public/v3-operator:v4.1.10 \
src/main.py COMMAND \
--flagA=123 \
--flagB=xyz

Docker Data Directories

You must set --data-dir=/data and map it to a host directory. The --database-dir should also be mapped to a host directory or Docker volume with write permissions enabled. Permissions setup is not required when using Docker volumes.

Source Files

Requirements:

• Python 3.12+ ↗
• Poetry ↗
• Git ↗
• Cargo ↗ (for sw-milagro-bls-binding dependency)
• libpq-dev ↗ (for psycopg2 dependency)

Run the setup command:

git clone https://github.com/stakewise/v3-operator.git
cd v3-operator
poetry install --only main

Run commands from inside the v3-operator folder using this format:

PYTHONPATH=. poetry run python src/main.py COMMAND --flagA=123 --flagB=xyz