Skip to content

Commit

Permalink
minor readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
metachris committed Jul 3, 2024
1 parent b21f1e4 commit 7a39cfd
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@

rbuilder is an open-source, blazingly fast, cutting edge implementation of a Ethereum MEV-Boost block builder written in Rust.
It is designed to provide a delightful developer experience, enabling community members to contribute and researchers to use rbuilder to study block building.
#### Features:

#### Features
- **Multiple algorithms**: build Ethereum blocks by sorting for either effective gas price `mev_gas_price` or total profit `max_profit`
- **Backtesting**: support for quick and easy backtesting on mempool transactions and other data
- **Bundle merging**: bundles that target transactions which have already been included in a pending block can be dropped if they are marked in `reverting_tx_hashes`.
Expand Down Expand Up @@ -48,19 +49,16 @@ Additionally, you can:

Running:
1. Prepare config file based on the `config-live-example.toml`
2. Run `builder run PATH_TO_CONFIG_FILE`
2. Run `rbuilder run PATH_TO_CONFIG_FILE`

### Benchmarking

rbuilder has a solid initial benchmarking setup (based on [Criterion.rs](https://github.com/bheisler/criterion.rs)).

- Benchmarks are located in [`crates/rbuilder/benches`](./crates/rbuilder/benches/). We'd love to add more meaningful benchmarks there!
- All PRs receive a [benchmark report like this](https://flashbots-rbuilder-ci-stats.s3.us-east-2.amazonaws.com/benchmark/17c379a-24c50ff/report/index.html).
- All PRs receive a [benchmark report like this](https://flashbots-rbuilder-ci-stats.s3.us-east-2.amazonaws.com/benchmark/3b22d52-f468712/report/index.html).
- You can run benchmarks with `make bench` and open the Criterion-generated report with `make bench-report-open`.
Benchmarks also run on every PR.
- The rbuilder benchmark report is based on the Criterion-generated one, and prettifies it with custom templates. It's produced by
[`scripts/ci/benchmark-in-ci.sh`](./scripts/ci/benchmark-in-ci.sh).
- Let us know about further improvement ideas!
- Let us know about further improvement ideas and additional relevant benchmarks.

### Other executables

Expand Down

0 comments on commit 7a39cfd

Please sign in to comment.