From 8f00cead0c98cbba92f2ef6dff7aceffb8051103 Mon Sep 17 00:00:00 2001 From: nicolas <48695862+merklefruit@users.noreply.github.com> Date: Fri, 24 Jan 2025 12:38:12 +0100 Subject: [PATCH 1/2] chore: update bolt RPC URL for holesky --- bolt-sidecar/.env.example | 2 +- guides/holesky/MIGRATION_v0.4.0.md | 8 +-- guides/holesky/QUICK_START.md | 6 +- guides/holesky/README.md | 70 +++++++++---------- guides/holesky/bolt-sidecar.env.example | 2 +- .../commit-boost/bolt-sidecar.env.example | 2 +- .../sidecar-delegations-preset.env.example | 2 +- 7 files changed, 46 insertions(+), 46 deletions(-) diff --git a/bolt-sidecar/.env.example b/bolt-sidecar/.env.example index 608f5a8bb..3d446c79a 100644 --- a/bolt-sidecar/.env.example +++ b/bolt-sidecar/.env.example @@ -8,7 +8,7 @@ BOLT_SIDECAR_PORT= # Comma-separated list of allowed RPC addresses to subscribe via websocket to receive # incoming commitments requests. # This is incompatible with the `BOLT_SIDECAR_PORT` option. -BOLT_SIDECAR_FIREWALL_RPCS="wss://rpc-holesky.bolt.chainbound.io/api/v1/firewall_stream" +BOLT_SIDECAR_FIREWALL_RPCS="wss://rpc.holesky.boltprotocol.xyz/api/v1/firewall_stream" # Secret ECDSA key to sign commitment messages with. The public key associated # to it must be then used when registering the operator in bolt diff --git a/guides/holesky/MIGRATION_v0.4.0.md b/guides/holesky/MIGRATION_v0.4.0.md index b7e1b7abc..c7998dff3 100644 --- a/guides/holesky/MIGRATION_v0.4.0.md +++ b/guides/holesky/MIGRATION_v0.4.0.md @@ -18,7 +18,7 @@ Some of the other duties of the firewall include: - Pricing inclusion requests correctly (see more below) - Communicating prices with consumers (wallets, users) -Currently, we operate a firewall RPC on Holesky at `wss://rpc-holesky.bolt.chainbound.io/api/v1/firewall_stream`. +Currently, we operate a firewall RPC on Holesky at `wss://rpc.holesky.boltprotocol.xyz/api/v1/firewall_stream`. Read more about firewall delegation [here](https://x.com/boltprotocol_/status/1879571451621077413). @@ -76,13 +76,13 @@ configs. **All of the changes outlined below are in `bolt-sidecar.env` (`mev-boo > [!IMPORTANT] > To fully enable firewall delegation, you must modify your -> on-chain operator RPC and set it to the following RPC: `https://rpc-holesky.bolt.chainbound.io/rpc`. +> on-chain operator RPC and set it to the following RPC: `https://rpc.holesky.boltprotocol.xyz/rpc`. > You can do this by running the following bolt CLI command (required version v0.1.2): > > ```bash -> bolt operators eigenlayer update-rpc https://rpc-holesky.bolt.chainbound.io/rpc +> bolt operators eigenlayer update-rpc https://rpc.holesky.boltprotocol.xyz/rpc > # OR -> bolt operators symbiotic update-rpc https://rpc-holesky.bolt.chainbound.io/rpc +> bolt operators symbiotic update-rpc https://rpc.holesky.boltprotocol.xyz/rpc > ``` ##### Pricing diff --git a/guides/holesky/QUICK_START.md b/guides/holesky/QUICK_START.md index 93e94bcf0..a19f2d54e 100644 --- a/guides/holesky/QUICK_START.md +++ b/guides/holesky/QUICK_START.md @@ -287,7 +287,7 @@ First, you need to install the 3. Register into the Bolt AVS: - NOTE: The `--operator-rpc` flag MUST be set to a PUBLICLY ACCESSIBLE URL. Since bolt v0.4.0-alpha, the default configuration - is firewall delegation, which means that your `--operator-rpc` will be set to our Bolt RPC: `https://rpc-holesky.bolt.chainbound.io/rpc`. + is firewall delegation, which means that your `--operator-rpc` will be set to our Bolt RPC: `https://rpc.holesky.boltprotocol.xyz/rpc`. Note that the value above is _exactly_ what you should register on-chain for the Bolt RPC. - NOTE: if you do not want to use firewall delegation, you should register a public endpoint (e.g. `--operator-rpc http://:` on your firewall. By default, it is set to `8017`, but it can be changed in the sidecar configuration file. @@ -297,7 +297,7 @@ First, you need to install the ```bash bolt operators eigenlayer register \ - --rpc-url https://rpc-holesky.bolt.chainbound.io/rpc \ + --rpc-url http://localhost:8545 \ --operator-private-key \ --operator-rpc \ --salt @@ -373,7 +373,7 @@ Some of the other duties of the firewall include: - Pricing inclusion requests correctly (see more below) - Communicating prices with consumers (wallets, users) -Currently, we operate a firewall RPC on Holesky at `wss://rpc-holesky.bolt.chainbound.io/api/v1/firewall_stream`. +Currently, we operate a firewall RPC on Holesky at `wss://rpc.holesky.boltprotocol.xyz/api/v1/firewall_stream`. Read more about firewall delegation [here](https://x.com/boltprotocol_/status/1879571451621077413). diff --git a/guides/holesky/README.md b/guides/holesky/README.md index 748f172cb..e91af672a 100644 --- a/guides/holesky/README.md +++ b/guides/holesky/README.md @@ -12,35 +12,35 @@ 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 Delegation](#firewall-delegation) -* [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) - * [`execution_config.json`](#execution_configjson) +- [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 Delegation](#firewall-delegation) +- [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) + - [`execution_config.json`](#execution_configjson) @@ -321,7 +321,7 @@ Fill the required options and run the script. If the script executed successfully, your validators were registered. > [!IMPORTANT] -> If you want to run in firewall delegation mode, set the `--operator-rpc` to `https://rpc-holesky.bolt.chainbound.io/rpc`. +> If you want to run in firewall delegation mode, set the `--operator-rpc` to `https://rpc.holesky.boltprotocol.xyz/rpc`. > Firewall delegation is covered [here](#firewall-delegation). To check your operator status, you can use the `bolt operator @@ -412,7 +412,7 @@ Options: ``` > [!IMPORTANT] -> If you want to run in firewall delegation mode, set the `--operator-rpc` to `https://rpc-holesky.bolt.chainbound.io/rpc`. +> If you want to run in firewall delegation mode, set the `--operator-rpc` to `https://rpc.holesky.boltprotocol.xyz/rpc`. > Firewall delegation is covered [here](#firewall-delegation). A note on the `--salt` parameter: @@ -662,7 +662,7 @@ docker compose -f telemetry.compose.yml down ## Firewall Delegation -The Bolt sidecar will run in firewall delegation mode by default (specified in `BOLT_SIDECAR_FIREWALL_RPCS=“wss://rpc-holesky.bolt.chainbound.io/api/v1/firewall_stream”`). This means that it will initiate an outbound connection to the WebSocket endpoint +The Bolt sidecar will run in firewall delegation mode by default (specified in `BOLT_SIDECAR_FIREWALL_RPCS=“wss://rpc.holesky.boltprotocol.xyz/api/v1/firewall_stream”`). This means that it will initiate an outbound connection to the WebSocket endpoint defined above. It is recommended to run this mode because it will protect you from spam and DoS. If you wish to disable this, you'll have to expose an endpoint yourself on which to receive inclusion requests. @@ -682,9 +682,9 @@ sudo ufw allow from any to any port $BOLT_SIDECAR_PORT Currently the only deployed [Bolt RPC](https://docs.boltprotocol.xyz/technical-docs/api/rpc) API is the one provided by Chainbound: -- [`https://rpc-holesky.bolt.chainbound.io`](https://rpc-holesky.bolt.chainbound.io) - - RPC entrypoint: [/rpc](https://rpc-holesky.bolt.chainbound.io/rpc) - - OpenAPI documentation: [/docs](https://rpc-holesky.bolt.chainbound.io/docs) +- [`https://rpc.holesky.boltprotocol.xyz`](https://rpc.holesky.boltprotocol.xyz) + - RPC entrypoint: [/rpc](https://rpc.holesky.boltprotocol.xyz/rpc) + - OpenAPI documentation: [/docs](https://rpc.holesky.boltprotocol.xyz/docs) ## Supported Relays diff --git a/guides/holesky/bolt-sidecar.env.example b/guides/holesky/bolt-sidecar.env.example index 67eef5506..f2d749f00 100644 --- a/guides/holesky/bolt-sidecar.env.example +++ b/guides/holesky/bolt-sidecar.env.example @@ -3,7 +3,7 @@ # Comma-separated list of allowed RPC addresses to subscribe via websocket to receive # incoming commitments requests. # This is incompatible with the `BOLT_SIDECAR_RPC_URL` option. -BOLT_SIDECAR_FIREWALL_RPCS="wss://rpc-holesky.bolt.chainbound.io/api/v1/firewall_stream" +BOLT_SIDECAR_FIREWALL_RPCS="wss://rpc.holesky.boltprotocol.xyz/api/v1/firewall_stream" # Secret ECDSA key to sign commitment messages with. The public key associated # to it must be then used when registering the operator in bolt contracts BOLT_SIDECAR_OPERATOR_PRIVATE_KEY= diff --git a/guides/holesky/commit-boost/bolt-sidecar.env.example b/guides/holesky/commit-boost/bolt-sidecar.env.example index 6d8fc4890..698d51b15 100644 --- a/guides/holesky/commit-boost/bolt-sidecar.env.example +++ b/guides/holesky/commit-boost/bolt-sidecar.env.example @@ -6,7 +6,7 @@ BOLT_SIDECAR_PORT= # Comma-separated list of allowed RPC addresses to subscribe via websocket to receive # incoming commitments requests. # This is incompatible with the `BOLT_SIDECAR_PORT` option. -BOLT_SIDECAR_FIREWALL_RPCS="wss://rpc-holesky.bolt.chainbound.io/api/v1/firewall_stream" +BOLT_SIDECAR_FIREWALL_RPCS="wss://rpc.holesky.boltprotocol.xyz/api/v1/firewall_stream" # Secret ECDSA key to sign commitment messages with. The ETH address derived from the public key # associated to it must be then used when registering the operator in the bolt contracts. diff --git a/guides/holesky/presets/sidecar-delegations-preset.env.example b/guides/holesky/presets/sidecar-delegations-preset.env.example index 54ffb4ac7..900ff1a81 100644 --- a/guides/holesky/presets/sidecar-delegations-preset.env.example +++ b/guides/holesky/presets/sidecar-delegations-preset.env.example @@ -3,7 +3,7 @@ # Comma-separated list of allowed RPC addresses to subscribe via websocket to receive # incoming commitments requests. # This is incompatible with the `BOLT_SIDECAR_PORT` option. -BOLT_SIDECAR_FIREWALL_RPCS="wss://rpc-holesky.bolt.chainbound.io/api/v1/firewall_stream" +BOLT_SIDECAR_FIREWALL_RPCS="wss://rpc.holesky.boltprotocol.xyz/api/v1/firewall_stream" # Secret ECDSA key to sign commitment messages with. The public key associated # to it must be then used when registering the operator in bolt contracts From 1df35291fe24518f06f018c9ac775bf4b7213119 Mon Sep 17 00:00:00 2001 From: nicolas <48695862+merklefruit@users.noreply.github.com> Date: Fri, 24 Jan 2025 12:41:55 +0100 Subject: [PATCH 2/2] chore: update annoying auto formatting on toc --- guides/holesky/README.md | 58 ++++++++++++++++++++-------------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/guides/holesky/README.md b/guides/holesky/README.md index e91af672a..c2d658829 100644 --- a/guides/holesky/README.md +++ b/guides/holesky/README.md @@ -12,35 +12,35 @@ 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 Delegation](#firewall-delegation) -- [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) - - [`execution_config.json`](#execution_configjson) +* [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 Delegation](#firewall-delegation) +* [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) + * [`execution_config.json`](#execution_configjson)