From 51e2cebc2501ffba7617afa2753b7c8a6a5e0a4a Mon Sep 17 00:00:00 2001 From: nicolas <48695862+merklefruit@users.noreply.github.com> Date: Wed, 4 Dec 2024 15:24:48 +0100 Subject: [PATCH 1/3] chore(docs): add vouch config paragraph --- testnets/holesky/README.md | 64 ++++++++++++++++++++++---------------- 1 file changed, 37 insertions(+), 27 deletions(-) diff --git a/testnets/holesky/README.md b/testnets/holesky/README.md index e97c1489..98f95c8f 100644 --- a/testnets/holesky/README.md +++ b/testnets/holesky/README.md @@ -12,33 +12,34 @@ This document provides instructions for running Bolt on the Holesky testnet. -* [Prerequisites](#prerequisites) -* [On-Chain Registration](#on-chain-registration) - * [Validator Registration](#validator-registration) - * [Registration Steps](#registration-steps) - * [Bolt Network Entrypoint](#bolt-network-entrypoint) - * [Operator Registration](#operator-registration) - * [Symbiotic Registration Steps](#symbiotic-registration-steps) - * [EigenLayer Registration Steps](#eigenlayer-registration-steps) -* [Off-Chain Setup](#off-chain-setup) - * [Docker Mode (recommended)](#docker-mode-recommended) - * [Commit-Boost Mode](#commit-boost-mode) - * [Native Mode (advanced)](#native-mode-advanced) - * [Building and running the MEV-Boost fork binary](#building-and-running-the-mev-boost-fork-binary) - * [Building and running the Bolt sidecar binary](#building-and-running-the-bolt-sidecar-binary) - * [Configuration file](#configuration-file) - * [Observability](#observability) - * [Firewall Configuration](#firewall-configuration) -* [Reference](#reference) - * [Supported RPC nodes](#supported-rpc-nodes) - * [Supported Relays](#supported-relays) - * [Command-line options](#command-line-options) - * [Delegations and signing options for Native and Docker Compose Mode](#delegations-and-signing-options-for-native-and-docker-compose-mode) - * [`bolt` CLI](#bolt-cli) - * [Installation and usage](#installation-and-usage) - * [Using a private key directly](#using-a-private-key-directly) - * [Using a ERC-2335 Keystore](#using-a-erc-2335-keystore) - * [Avoid restarting the beacon node](#avoid-restarting-the-beacon-node) +- [Prerequisites](#prerequisites) +- [On-Chain Registration](#on-chain-registration) + - [Validator Registration](#validator-registration) + - [Registration Steps](#registration-steps) + - [Bolt Network Entrypoint](#bolt-network-entrypoint) + - [Operator Registration](#operator-registration) + - [Symbiotic Registration Steps](#symbiotic-registration-steps) + - [EigenLayer Registration Steps](#eigenlayer-registration-steps) +- [Off-Chain Setup](#off-chain-setup) + - [Docker Mode (recommended)](#docker-mode-recommended) + - [Commit-Boost Mode](#commit-boost-mode) + - [Native Mode (advanced)](#native-mode-advanced) + - [Building and running the MEV-Boost fork binary](#building-and-running-the-mev-boost-fork-binary) + - [Building and running the Bolt sidecar binary](#building-and-running-the-bolt-sidecar-binary) + - [Configuration file](#configuration-file) + - [Observability](#observability) + - [Firewall Configuration](#firewall-configuration) +- [Reference](#reference) + - [Supported RPC nodes](#supported-rpc-nodes) + - [Supported Relays](#supported-relays) + - [Command-line options](#command-line-options) + - [Delegations and signing options for Native and Docker Compose Mode](#delegations-and-signing-options-for-native-and-docker-compose-mode) + - [`bolt` CLI](#bolt-cli) + - [Installation and usage](#installation-and-usage) + - [Using a private key directly](#using-a-private-key-directly) + - [Using a ERC-2335 Keystore](#using-a-erc-2335-keystore) + - [Avoid restarting the beacon node](#avoid-restarting-the-beacon-node) + - [Vouch configuration](#vouch-configuration) @@ -1123,3 +1124,12 @@ the restart by following this steps when starting the Bolt sidecar: using another port 3. Set the `--constraints-api-url` flag (or `BOLT_SIDECAR_CONSTRAINTS_API_URL` env) to point to the Bolt MEV-Boost instance. + +## Vouch configuration + +If you are using [Vouch](https://www.attestant.io/posts/introducing-vouch/) as validator client, +you will need to tweak its configuration to make sure that it doesn't fetch blocks from PBS relays directly, +otherwise your validators might propose a block that does not adhere to the signed constraints from the Bolt sidecar. + +In particular, you need to [disable external MEV relays](https://github.com/attestantio/vouch/blob/master/docs/blockrelay.md#without-mev-relays), +and make sure that your beacon node is pointing to the bolt sidecar. From 51438b6904527842d3b00cb4acf5204ebeaee4f2 Mon Sep 17 00:00:00 2001 From: nicolas <48695862+merklefruit@users.noreply.github.com> Date: Wed, 4 Dec 2024 15:26:20 +0100 Subject: [PATCH 2/3] chore: whitespace --- testnets/holesky/README.md | 55 +++++++++++++++++++------------------- 1 file changed, 27 insertions(+), 28 deletions(-) diff --git a/testnets/holesky/README.md b/testnets/holesky/README.md index 98f95c8f..b61349bf 100644 --- a/testnets/holesky/README.md +++ b/testnets/holesky/README.md @@ -12,34 +12,33 @@ This document provides instructions for running Bolt on the Holesky testnet. -- [Prerequisites](#prerequisites) -- [On-Chain Registration](#on-chain-registration) - - [Validator Registration](#validator-registration) - - [Registration Steps](#registration-steps) - - [Bolt Network Entrypoint](#bolt-network-entrypoint) - - [Operator Registration](#operator-registration) - - [Symbiotic Registration Steps](#symbiotic-registration-steps) - - [EigenLayer Registration Steps](#eigenlayer-registration-steps) -- [Off-Chain Setup](#off-chain-setup) - - [Docker Mode (recommended)](#docker-mode-recommended) - - [Commit-Boost Mode](#commit-boost-mode) - - [Native Mode (advanced)](#native-mode-advanced) - - [Building and running the MEV-Boost fork binary](#building-and-running-the-mev-boost-fork-binary) - - [Building and running the Bolt sidecar binary](#building-and-running-the-bolt-sidecar-binary) - - [Configuration file](#configuration-file) - - [Observability](#observability) - - [Firewall Configuration](#firewall-configuration) -- [Reference](#reference) - - [Supported RPC nodes](#supported-rpc-nodes) - - [Supported Relays](#supported-relays) - - [Command-line options](#command-line-options) - - [Delegations and signing options for Native and Docker Compose Mode](#delegations-and-signing-options-for-native-and-docker-compose-mode) - - [`bolt` CLI](#bolt-cli) - - [Installation and usage](#installation-and-usage) - - [Using a private key directly](#using-a-private-key-directly) - - [Using a ERC-2335 Keystore](#using-a-erc-2335-keystore) - - [Avoid restarting the beacon node](#avoid-restarting-the-beacon-node) - - [Vouch configuration](#vouch-configuration) +* [Prerequisites](#prerequisites) +* [On-Chain Registration](#on-chain-registration) + * [Validator Registration](#validator-registration) + * [Registration Steps](#registration-steps) + * [Bolt Network Entrypoint](#bolt-network-entrypoint) + * [Operator Registration](#operator-registration) + * [Symbiotic Registration Steps](#symbiotic-registration-steps) + * [EigenLayer Registration Steps](#eigenlayer-registration-steps) +* [Off-Chain Setup](#off-chain-setup) + * [Docker Mode (recommended)](#docker-mode-recommended) + * [Commit-Boost Mode](#commit-boost-mode) + * [Native Mode (advanced)](#native-mode-advanced) + * [Building and running the MEV-Boost fork binary](#building-and-running-the-mev-boost-fork-binary) + * [Building and running the Bolt sidecar binary](#building-and-running-the-bolt-sidecar-binary) + * [Configuration file](#configuration-file) + * [Observability](#observability) + * [Firewall Configuration](#firewall-configuration) +* [Reference](#reference) + * [Supported RPC nodes](#supported-rpc-nodes) + * [Supported Relays](#supported-relays) + * [Command-line options](#command-line-options) + * [Delegations and signing options for Native and Docker Compose Mode](#delegations-and-signing-options-for-native-and-docker-compose-mode) + * [`bolt` CLI](#bolt-cli) + * [Installation and usage](#installation-and-usage) + * [Using a private key directly](#using-a-private-key-directly) + * [Using a ERC-2335 Keystore](#using-a-erc-2335-keystore) + * [Avoid restarting the beacon node](#avoid-restarting-the-beacon-node) From 203ca3d6303fa34e728e3dca804855493ad844bb Mon Sep 17 00:00:00 2001 From: nicolas <48695862+merklefruit@users.noreply.github.com> Date: Wed, 4 Dec 2024 15:40:11 +0100 Subject: [PATCH 3/3] chore: add entry to ToC --- testnets/holesky/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/testnets/holesky/README.md b/testnets/holesky/README.md index b61349bf..833eb9b5 100644 --- a/testnets/holesky/README.md +++ b/testnets/holesky/README.md @@ -39,6 +39,7 @@ This document provides instructions for running Bolt on the Holesky testnet. * [Using a private key directly](#using-a-private-key-directly) * [Using a ERC-2335 Keystore](#using-a-erc-2335-keystore) * [Avoid restarting the beacon node](#avoid-restarting-the-beacon-node) + * [Vouch configuration](#vouch-configuration)