consensus-specs

Ethereum Proof-of-Stake Consensus Specifications

CC0-1.0 License

Downloads
16.4K
Stars
3.5K
Committers
170

Ethereum Proof-of-Stake Consensus Specifications

To learn more about proof-of-stake and sharding, see the PoS documentation, sharding documentation and the research compendium.

This repository hosts the current Ethereum proof-of-stake specifications. Discussions about design rationale and proposed changes can be brought up and discussed as issues. Solidified, agreed-upon changes to the spec can be made through pull requests.

Specs

Core specifications for Ethereum proof-of-stake clients can be found in specs. These are divided into features. Features are researched and developed in parallel, and then consolidated into sequential upgrades when ready.

Stable Specifications

Seq. Code Name Fork Epoch Specs
0 Phase0 0 CoreThe beacon chainDeposit contractBeacon chain fork choiceAdditionsHonest validator guideP2P networkingWeak subjectivity
1 Altair 74240 CoreBeacon chain changesAltair forkAdditionsLight client sync protocol (full node, light client, networking)Honest validator guide changesP2P networking
2 Bellatrix ("The Merge") 144896 CoreBeacon Chain changesBellatrix forkFork choice changesAdditionsHonest validator guide changesP2P networking
3 Capella 194048 CoreBeacon chain changesCapella forkAdditionsLight client sync protocol changes (fork, full node, networking)Validator additionsP2P networking
4 Deneb 269568 CoreBeacon Chain changesDeneb forkPolynomial commitmentsFork choice changesAdditionsLight client sync protocol changes (fork, full node, networking)Honest validator guide changesP2P networking

In-development Specifications

Code Name or Topic Specs Notes
Electra CoreBeacon Chain changesEIP-6110 forkAdditionsLight client sync protocol changes (fork, full node, networking)Honest validator guide changes
Sharding (outdated) CoreBeacon Chain changesAdditionsP2P networking
Custody Game (outdated) CoreBeacon Chain changesAdditionsHonest validator guide changes Dependent on sharding
Data Availability Sampling (outdated) CoreCore types and functionsFork choice changesAdditionsP2P NetworkingSampling process Dependent on shardingTechnical explainer

Accompanying documents can be found in specs and include:

Additional specifications for client implementers

Additional specifications and standards outside of requisite client functionality can be found in the following repos:

Design goals

The following are the broad design goals for the Ethereum proof-of-stake consensus specifications:

  • to minimize complexity, even at the cost of some losses in efficiency
  • to remain live through major network partitions and when very large portions of nodes go offline
  • to select all components such that they are either quantum secure or can be easily swapped out for quantum secure counterparts when available
  • to utilize crypto and design techniques that allow for a large participation of validators in total and per unit time
  • to allow for a typical consumer laptop with O(C) resources to process/validate O(1) shards (including any system level validation such as the beacon chain)

Useful external resources

For spec contributors

Documentation on the different components used during spec writing can be found here:

Online viewer of the latest release (latest master branch)

Ethereum Consensus Specs

Consensus spec tests

Conformance tests built from the executable python spec are available in the Ethereum Proof-of-Stake Consensus Spec Tests repo. Compressed tarballs are available in releases.

Installation and Usage

The consensus-specs repo can be used by running the tests locally or inside a docker container.

To run the tests locally:

  • Clone the repository with git clone https://github.com/ethereum/consensus-specs.git
  • Switch to the directory cd consensus-specs
  • Install the dependencies with: make install_test && make preinstallation && make pyspec
  • Run the tests with make citest

To run the tests inside a docker container:

  • Switch to the directory with cd scripts
  • Run the script ./build_run_docker_tests.sh
  • Find the results in a folder called ./testResults
  • Find more ways to customize the script with ./build_run_docker_tests.sh --h
Package Rankings
Top 13.94% on Pypi.org
Top 4.9% on Proxy.golang.org
Badges
Extracted from project README's
Join the chat at https://discord.gg/qGpsxSA GitHub release PyPI version testgen