Ethereum 2.0 Specifications
Go to file
Justin Traglia eff5e8f697
Remove ONESHELL stuff
2024-09-20 10:08:18 -05:00
.circleci Update cache version and add back line 2024-08-22 09:17:05 -05:00
.github/workflows Fix test vector generators to work with Python 3.12 2024-09-17 14:56:59 -05:00
configs Merge pull request #3890 from StefanBratanov/eip_7732_modify 2024-08-29 23:21:07 +08:00
docker Merge branch 'ethereum:dev' into update-readme-deps 2024-08-23 15:00:59 +02:00
docs Revert "minor fixes, doctoc" 2024-05-21 22:54:25 +02:00
fork_choice Rename `get_safe_execution_payload_hash` -> `*_block_hash` 2024-02-08 09:50:39 +01:00
presets Merge pull request #3828 from potuz/epbs_cl_repo 2024-08-07 01:19:53 +09:00
pysetup Updated ElectraSpecBuilder (NoopExecutionEngine#notify_new_payload) 2024-09-06 10:08:36 +12:00
scripts EIP-7594: PeerDAS explicit csc integer size (#3897) 2024-08-29 02:43:34 +08:00
solidity_deposit_contract Revert "minor fixes, doctoc" 2024-05-21 22:54:25 +02:00
specs EIP-7732: Refactor Beacon chain state transition function (#3898) 2024-09-18 09:03:26 -05:00
ssz fix spec error in get_generalized_index function 2024-07-09 21:26:12 +02:00
sync Move `verify_and_notify_new_payload` to Bellatrix 2023-05-24 11:12:03 +08:00
tests Fix yield statement in test_get_custody_columns (#3931) 2024-09-19 11:12:56 -05:00
.codespell-whitelist Set codespell<3.0.0,>=2.0.0 version and add `ether` to whitelist 2020-12-07 11:08:54 +08:00
.dockerignore WIP: Update dockerisation (#3477) 2024-01-04 17:09:06 +01:00
.gitattributes Update the docs and remove unused code 2020-08-18 00:58:08 +08:00
.gitignore Add `eip7732` to .gitignore 2024-07-08 14:36:49 -03:00
.gitmodules WIP: add solidity deposit contract CI workflow 2020-08-17 23:37:33 +08:00
LICENSE CC0 1.0 Universal for repo 2019-03-12 11:59:08 +00:00
Makefile Remove ONESHELL stuff 2024-09-20 10:08:18 -05:00
README.md updating readme and dependencies 2024-08-13 12:56:03 +02:00
SECURITY.md Revert "minor fixes, doctoc" 2024-05-21 22:54:25 +02:00
linter.ini Enable EIP4844 lint and fix Pylint 2022-11-28 20:01:50 +08:00
mkdocs.yml Add docs about how to add a new feature proposal in consensus-specs and online viewer support (#3239) 2023-04-18 18:31:34 +08:00
requirements_preinstallation.txt Fix test vector generators to work with Python 3.12 2024-09-17 14:56:59 -05:00
setup.py Update url 2024-09-17 15:20:59 -05:00

README.md

Ethereum Proof-of-Stake Consensus Specifications

Join the chat at https://discord.gg/qGpsxSA

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

GitHub release PyPI version

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
1 Altair 74240
2 Bellatrix
("The Merge")
144896
3 Capella 194048
4 Deneb 269568

In-development Specifications

Code Name or Topic Specs Notes
Electra
Sharding (outdated)
Custody Game (outdated) Dependent on sharding
Data Availability Sampling (outdated)

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