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.

Sign up for GitHub

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

Jump to bottom

Docs fix spelling issues #688

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Docs fix spelling issues #688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
49361d2
Update audit-20220620.md
nnsW3 Sep 26, 2024
ff8c1b6
Update SECURITY.md
nnsW3 Sep 26, 2024
3d02143
Update README.md
nnsW3 Sep 26, 2024
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Ensure you are downloading the most updated MEV-Boost release. Releases are avai
clone the repository and build it:

```bash
# By default, the develop branch includes ongoing merged PRs a future release.
# By default, the develop branch includes ongoing merged PRs for a future release.
git clone https://github.com/flashbots/mev-boost.git
cd mev-boost

Expand Down
4 changes: 2 additions & 2 deletions SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ the team will work on a fix.

## Bug Bounty Program

To incentive bug reports, there is a bug bounty program. You can receive a
To incentivize bug reports, there is a bug bounty program. You can receive a
bounty (up to $25k USD) depending on the bug's severity. Severity is based on
impact and likelihood. If a bug is high impact but low likelihood, it will have
impact and likelihood. If a bug has a high impact but low likelihood, it will have
a lower severity than a bug with a high impact and high likelihood.

| Severity | Maximum | Example |
Expand Down
4 changes: 2 additions & 2 deletions docs/audit-20220620.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,9 @@ Consider clearly documenting the expected behavior of the bls client library, th

*Update: Fixed in [PR210](https://github.com/flashbots/mev-boost/pull/210)*

Even though MEV-Boost has a command line flag to set the timeout settings for the `http.Client` and that the default value is a "safe" value of two seconds, it is possible that a user sets this value to 0, disabling the client timeout and opening the door to being attacked by a malicious relayer that stalls the communication.
Even though MEV-Boost has a command line flag to set the timeout settings for the `http.Client` and the default value is a "safe" value of two seconds, it is possible that a user sets this value to 0, disabling the client timeout and opening the door to being attacked by a malicious relayer that stalls the communication.

This is specially important during [`handleGetHeader` function execution](https://github.com/flashbots/mev-boost/blob/9a701c1b4d625d2e7f83fef2971af54ca856facd/server/service.go#L233) as any of the relayers can [block the execution](https://github.com/flashbots/mev-boost/blob/c47fa3e4739cc858ce0eabbf31a2131fce96fbf6/server/service.go#L298) until every single request to the different relayers return.
This is especially important during [`handleGetHeader` function execution](https://github.com/flashbots/mev-boost/blob/9a701c1b4d625d2e7f83fef2971af54ca856facd/server/service.go#L233) as any of the relayers can [block the execution](https://github.com/flashbots/mev-boost/blob/c47fa3e4739cc858ce0eabbf31a2131fce96fbf6/server/service.go#L298) until every single request to the different relayers return.

Given the [proposer boost](https://ethresear.ch/t/change-fork-choice-rule-to-mitigate-balancing-and-reorging-attacks/11127), it is recommended for validators to include the block before 4 seconds into the slot or they will be probably be reorganized out of the canonical chain.

Expand Down