-
Notifications
You must be signed in to change notification settings - Fork 76
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b43d864
commit dd8b53c
Showing
3 changed files
with
39 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
# Summary | ||
|
||
- [intro](./introduction.md) | ||
- [mev-boost-rs](./mev-boost-rs.md) | ||
- [mev-build-rs](./mev-build-rs.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# `mev-boost-rs` | ||
|
||
This repository provides a "boost" implementation that serves the [`builder-specs` APIs] | ||
connecting validators to an external block builder network. | ||
|
||
> Warning: this software is extremely experimental. You should not use in any production capacity. | ||
## Installation | ||
|
||
### Build from source | ||
|
||
The best way right now to use this right now is to build from source. | ||
|
||
## Run `mev-boost-rs` | ||
|
||
You'll need to put some configuration into a config file like `example.config.toml` found | ||
at the root of this directory. | ||
|
||
For example, this configuration | ||
|
||
```toml | ||
[boost] | ||
host = "0.0.0.0" | ||
port = 18550 | ||
relays = [ | ||
"https://0x845bd072b7cd566f02faeb0a4033ce9399e42839ced64e8b2adcfc859ed1e8e1a5a293336a49feac6d9a5edb779be53a@boost-relay-sepolia.flashbots.net", | ||
] | ||
``` | ||
|
||
instructs `mev-boost-rs` to run on localhost on port `18550` and only use the Flashbots relay running on the `sepolia` testnet. | ||
|
||
Then, to run for `sepolia`: | ||
```bash | ||
mev --network sepolia boost example.config.toml | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters