Skip to content

Latest commit

 

History

History
131 lines (82 loc) · 3.51 KB

running_vero.md

File metadata and controls

131 lines (82 loc) · 3.51 KB
Raw

Running Vero

Prerequisites

  • In order to use Vero, you will need to use a remote signer to manage your validator keys. The remote signer must be connected to a slashing protection database - Vero does not maintain its own slashing protection database!

Local build

Get started by using the correct version of Python - 3.12 .

Next, install the dependencies using the package manager of your choice:

pip install -r requirements.txt

You should now be able to run Vero:

python src/main.py <arguments>

Docker

You can build the image yourself using the included Dockerfile or you can use the official image.

 docker run ghcr.io/serenita-org/vero:<version> <arguments>

Check out the example docker compose file.

CLI Reference

--network

[required] The network to use, one of mainnet,gnosis,holesky,fetch.

fetch is a special case where Vero uses the network specs as returned by the beacon nodes.

--remote-signer-url

[required] URL of the remote signer, e.g. http://remote-signer:9000

--beacon-node-urls

[required] A comma-separated list of beacon node URLs, e.g. http://beacon-node-1:5052,http://beacon-node-2:5052,http://beacon-node-3:5052

--beacon-node-urls-proposal

A comma-separated list of beacon node URLs, e.g. http://beacon-node-1:5052,http://beacon-node-2:5052,http://beacon-node-3:5052 to exclusively use for block proposals. When performing a block proposal duty, only these beacon nodes will be used to produce and publish a block.

--attestation-consensus-threshold

Specify the required number of beacon nodes that need to agree on the attestation data before the validators proceed to attest.

There are a few situations where you may want to change the default:

  • when running against 2 beacon nodes, where you only want to use the second node as a fallback
  • when running against a large client-diverse set of beacon nodes where a lower threshold (like 2 or 3 out of 6 beacon nodes agreeing) may be sufficient to avoid single-client bugs.

See #38 for more information.

Defaults to a majority of beacon nodes (>50%) agreeing.

--fee-recipient

[required] The fee recipient address to use during block proposals.

--graffiti

The graffiti string to use during block proposals. Defaults to an empty string.

--gas-limit

The gas limit to be used when building blocks. Defaults to 30,000,000.

--use-external-builder

Provide this flag to submit validator registrations to external builders.

--builder-boost-factor

A percentage multiplier applied to externally built blocks when comparing their value to locally built blocks. The externally built block is only chosen if its value, post-multiplication, is higher than the locally built block's value. Defaults to 90.

--data-dir

The directory to use for storing persistent data. Defaults to /vero/data.

--metrics-address

The metrics server listen address. Defaults to localhost.

--metrics-port

The metrics server listen port. Defaults to 8000.

--metrics-multiprocess-mode

Provide this flag to collect metrics from all processes. This comes with some limitations, notably no cpu and memory metrics. See https://prometheus.github.io/client_python/multiprocess/ .

--log-level

The logging level to use, one of CRITICAL,ERROR,WARNING,INFO,DEBUG. Defaults to INFO.