Giter Club home page Giter Club logo

builder-specs's Introduction

Ethereum Builder API Specification

CI

The Builder API is an interface for consensus layer clients to source blocks built by external entities.

In this repository is the API specification along with specifications for actors in this ecosystem broken out by fork.

Why?

Block building is a specialized activity that requires high fixed costs to be an efficient validator. This creates an advantage for staking pools as they can effectively distribute the cost across many validators.

Proposer-builder separation (PBS) fixes this by splitting the roles of a validator into block proposing and block building. However, PBS requires modifications to the Beacon chain and will therefore not be possible at the time of the merge.

The Builder API is a temporary solution that requires higher trust assumptions than PBS, but can be fully implemented without modification to the base protocol. This is done by providing the proposer with a "blind" execution layer header to incorporate into a block and a "value" amount which will be transferred to the proposer once they create a block with the aforementioned header. Once the proposer signs a block with the header, they are bound to the choice (or risk being slashed due to equivocation). That allows the builder to reveal the blinded transactions without the possibility of the proposer tampering with them.

This design is based on the original proposal for trusted external builders: "MEV-Boost: Merge ready Flashbots Architecture".

Builder software

Users will typically connect their CL clients to builders with builder multiplexers. Please see their respective repositories for more information:

Contributing

The API specification is checked for lint errors before merging pull requests.

To run the linter locally, install it with:

npm install -g @redocly/cli

and then run it:

redocly lint builder-oapi.yaml

Render API Specification

To render spec in browser, you will simply need an HTTP server to load the index.html file in root of the repo.

For example:

python -m http.server 8080

The spec will render at http://localhost:8080.

Usage

Local changes will be observable if "dev" is selected in the "Select a definition" drop-down in the web UI.

It may be necessary to tick the "Disable Cache" box in their browser's developer tools to see changes after modifying the source.

Releasing

  1. Create and push tag
    • Make sure info.version in builder-oapi.yaml file is updated before tagging.
    • CI will create a github release and upload bundled spec file
  2. Add release entrypoint in index.html

In SwaggerUIBundle configuration (inside index.html file), add another entry in urls field. Entry should be in following format (replace <tag> with real tag name from step 1.):

{ url: "./releases/<tag>/builder-oapi.json", name: "<tag>" },

builder-specs's People

Contributors

lightclient avatar ralexstokes avatar metachris avatar jimmygchen avatar jtraglia avatar jonasbn avatar stefanbratanov avatar dgcoffman avatar fredriksvantes avatar jacobkaufmann avatar nflaig avatar avalonche avatar terencechain avatar tersec avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.