Skip to content

Commit

Permalink
Version 2.12.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
yorickdowne committed Oct 5, 2024
1 parent 67efbb5 commit 4455b83
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 4 deletions.
14 changes: 14 additions & 0 deletions website/docs/About/Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,20 @@ instead.
> On 1/27/2022, Eth Docker's repository name changed. Everything should work as it did.
> If you do wish to manually update your local reference, run `git remote set-url origin https://github.com/eth-educators/eth-docker.git`
## v2.12.4.0 2024-10-07

*This is a recommended release*

Changes
- Add support for commit boost
- A fresh Reth sync keeps all receipts, for compatibility with sundry protocols such as SSV, RocketPool, NodeSet,
StakeWise
- Improved IPv4/v6 dual stack support
- IPv6 is enabled on hosts that have IPv6 connectivity

Bug Fixes
- Fixes to Lido CSM support. Thanks @cnupy!

## v2.12.3.0 2024-09-20

*This is a recommended release*
Expand Down
24 changes: 20 additions & 4 deletions website/docs/Usage/ClientSetup.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,10 @@ Choose one execution client:
> If you wish to use the built-in Caplin consensus client with Erigon, use `erigon.yml` without a consensus client file,
and it will use the built-in Caplin consensus client

Optionally, enable MEV boost:
Optionally, enable MEV boost or Commit boost:

- `mev-boost.yml` - add the mev-boost sidecar
- `commit-boost-pbs.yml` - add the cb-pbs sidecar

Optionally, choose a reporting package:

Expand Down Expand Up @@ -138,14 +139,30 @@ to Internet.
setup.
- `CLIENT-vc-only.yml` - the other side of the distributed client setup.

## MEV Boost
## Proposer Builder Separation

### MEV Boost

Your Consensus Layer client connects to the mev-boost container. If you are running a CL in Eth Docker, then in `.env`
you'd add `mev-boost.yml` to `COMPOSE_FILE`, set `MEV_BOOST=true` and set `MEV_RELAYS` to the
[relays you wish to use](https://ethstaker.cc/mev-relay-list/).

If you would like to ensure whether your MEV relay has registered your validator, follow the documentation for your chosen relays. For instance, if you have included Flashbots, you can see whether your validator has been registered by querying their API. Add your validator's public key to the end of this endpoint: https://boost-relay.flashbots.net/relay/v1/data/validator_registration?pubkey=
### Commit Boost

This is an alternative to MEV Boost. Your Consensus Layer client connects to the cb-pbs container. If you are running
a CL in Eth Docker, then in `.env` you'd add `commit-boost-pbs.yml` to `COMPOSE_FILE`, set `MEV_BOOST=true` and
set `MEV_NODE=http://cb-pbs:18550`.

Next, edit `commit-boost/cb-config.toml` and configure the relays you'd like to use.

### Verify

If you would like to verify whether your MEV relay has registered your validator, follow the documentation for your
chosen relays. For instance, if you have included Flashbots, you can see whether your validator has been registered by
querying their API. Add your validator's public key to the end of this endpoint:
https://boost-relay.flashbots.net/relay/v1/data/validator_registration?pubkey=

### Just a VC, example RocketPool

If you are running a validator client only, such as with a RocketPool "reverse hybrid" setup, then all you need to do
is to set `MEV_BOOST=true` in `.env`. `mev-boost.yml` and `MEV_RELAYS` are not needed and won't be used if they are
Expand All @@ -158,7 +175,6 @@ Eth Docker supports some specialty use cases. These are the corresponding yml fi

- `ext-network.yml` - Connect to another Docker network, for example for reverse hybrid with RocketPool or connecting
to a central traefik/prometheus.
- `v6-network.yml` - part of enabling IPv6 support
- `central-metrics.yml` - Scrape metrics from a
[central prometheus](https://github.com/CryptoManufaktur-io/central-proxy-docker)
- `nimbus-stats.yml` - Send Nimbus stats to beaconcha.in app
Expand Down

0 comments on commit 4455b83

Please sign in to comment.