Skip to content

Commit

Permalink
readme cleanup (flashbots#269)
Browse files Browse the repository at this point in the history
  • Loading branch information
metachris authored Aug 26, 2022
1 parent 9168d4a commit a0bc224
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
1 change: 0 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,4 @@

* [ ] `make lint`
* [ ] `make test-race`
* [ ] `make run-mergemock-integration`
* [ ] `go mod tidy`
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
![mev-boost](https://user-images.githubusercontent.com/116939/179831878-dc6a0f76-94f4-46cc-bafd-18a3a4b58ea4.png)

#
#

[![Goreport status](https://goreportcard.com/badge/github.com/flashbots/mev-boost)](https://goreportcard.com/report/github.com/flashbots/mev-boost)
[![Test status](https://github.com/flashbots/mev-boost/workflows/Tests/badge.svg)](https://github.com/flashbots/mev-boost/actions?query=workflow%3A%22Tests%22)
Expand All @@ -14,7 +14,7 @@ With MEV-Boost, validators can access blocks from a marketplace of builders. Bui
## How does MEV_Boost work?


PoS node operators must run three pieces of software: a validator client, consensus client, and an execution client. MEV-boost is a sidecar for the Consensus Client, a separate piece of open source software, which queries and outsources block-building to a network of builders. Block builders prepare full blocks, optimizing for MEV extraction and fair distribution of rewards. They then submit their blocks to relays.
PoS node operators must run three pieces of software: a validator client, consensus client, and an execution client. MEV-boost is a sidecar for the Consensus Client, a separate piece of open source software, which queries and outsources block-building to a network of builders. Block builders prepare full blocks, optimizing for MEV extraction and fair distribution of rewards. They then submit their blocks to relays.

Relays aggregate blocks from **multiple** builders in order to select the block with the highest fees. One instance of MEV-boost can be configured by a validator to connect to **multiple** relays. The Consensus Layer client of a validator proposes the most profitable block received from MEV-boost to the Ethereum network for attestation and block inclusion.

Expand All @@ -30,11 +30,13 @@ MEV-Boost is a piece of software that any PoS Ethereum node operator (including

See also:

* Documentation: [Builder API](https://ethereum.github.io/builder-specs), [Relay API](https://flashbots.notion.site/Relay-API-Spec-5fb0819366954962bc02e81cb33840f5)
* [mev-boost Docker image](https://hub.docker.com/r/flashbots/mev-boost)
* [boost.flashbots.net](https://boost.flashbots.net)
* [Wiki](https://github.com/flashbots/mev-boost/wiki)
* [Troubleshooting guide](https://github.com/flashbots/mev-boost/wiki/Troubleshooting)
* [mev-boost Docker image](https://hub.docker.com/r/flashbots/mev-boost)
* [wiki](https://github.com/flashbots/mev-boost/wiki) & [troubleshooting guide](https://github.com/flashbots/mev-boost/wiki/Troubleshooting)
* [mev-boost relay source code](https://github.com/flashbots/mev-boost-relay)
* Specs:
* [Builder API](https://ethereum.github.io/builder-specs)
* [Flashbots Relay API](https://flashbots.notion.site/Relay-API-Spec-5fb0819366954962bc02e81cb33840f5)


# Table of Contents
Expand Down

0 comments on commit a0bc224

Please sign in to comment.