Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(devnet): specify how to run bolt-boost #277

Merged
merged 1 commit into from
Oct 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ Make sure you have the following requirements on your machine:

> [!WARNING]
> The Kurtosis CLI version tested is `0.88.16`. Some issues may arise if you are
> using a different version.
> using a different version.
>
> [Please make sure to install the correct version](https://docs.kurtosis.com/install-historical/).

Expand Down Expand Up @@ -158,6 +158,25 @@ just demo

The web demo will be available on your browser at [`http://localhost:3000`](http://localhost:3000).

**Commit-Boost support**

The devnet by default will run using a fork of MEV-Boost which
supports the [Constraints-API](https://docs.boltprotocol.xyz/api/builder).
Bolt also supports [Commit-Boost](https://commit-boost.github.io/commit-boost-client/)
by providing a compatible MEV-Boost module called _Bolt-Boost_
that implements the Constraints-API. To use it in the devnet
add the appropriate `bolt_boost_image` in the `kurtosis_config.yaml` file:

```yaml
# ... the rest of the file
mev_params:
# Bolt-specific images:
# Adding the `bolt_boost_image` will start the devnet with Bolt-Boost
# instead of MEV-Boost
bolt_boost_image: ghcr.io/chainbound/bolt-boost:0.1.0
# ... the rest of the `mev_params`
```

### Stopping the devnet and demo

The demo app will remain open until you press `Ctrl+C` in the terminal where
Expand Down
2 changes: 2 additions & 0 deletions scripts/kurtosis_config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ mev_type: full
mev_params:
mev_builder_cl_image: sigp/lighthouse:latest
# Bolt-specific images:
# Adding the `bolt_boost_image` will start the devnet with Bolt-Boost
# instead of MEV-Boost by Flashbots
bolt_boost_image: ghcr.io/chainbound/bolt-boost:0.1.0
bolt_sidecar_image: ghcr.io/chainbound/bolt-sidecar:0.1.0
helix_relay_image: ghcr.io/chainbound/helix:0.1.0
Expand Down