To help you get started, we've collected the most common ways that eth2spec is being used within popular public projects.

ethereum / trinity / scripts / test_transition.py View on Github

def pyspec_transition(pre_state, pre_block):
    yaml = YAML(typ='base')
    loaded = yaml.load(Path('min.config.bak'))
    config_data = dict()
    for k, v in loaded.items():
        if v.startswith("0x"):
            config_data[k] = bytes.fromhex(v[2:])
        else:
            config_data[k] = int(v)

    spec.apply_constants_preset(config_data)

    spec_pre_state = decoder.translate_value(pre_state, spec.BeaconState)
    spec_pre_block = decoder.translate_value(pre_block, spec.BeaconBlock)

    spec_post_block = spec.state_transition(
        spec_pre_state, spec_pre_block, False
    )
    return spec_post_block

View more ways to use eth2spec

Ethereum Proof-of-Stake Consensus Specifications

To learn more about proof-of-stake and sharding, see the PoS FAQ, sharding FAQ 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.

The current features are:

Phase 0

• The Beacon Chain
• Beacon Chain Fork Choice
• Deposit Contract
• Honest Validator
• P2P Networking
• Weak Subjectivity

Altair

• Beacon chain changes
• Altair fork
• Light client sync protocol
• Honest Validator guide changes
• P2P Networking

Bellatrix (also known as The Merge)

The Bellatrix protocol upgrade is still actively in development. The exact specification has not been formally accepted as final and details are still subject to change.

• Background material:
  • An ethresear.ch post describing the basic mechanism of the CL+EL merge
  • ethereum.org high-level description of the CL+EL merge here
• Specifications:
  • Beacon Chain changes
  • Bellatrix fork
  • Fork Choice changes
  • Validator additions
  • P2P Networking

Sharding

Sharding follows Bellatrix, and is divided into three parts:

• Sharding base functionality - In early engineering phase
  • Beacon Chain changes
  • P2P Network changes
• Custody Game - Ready, dependent on sharding
  • Beacon Chain changes
  • Validator custody work
• Data Availability Sampling - In active R&D
  • Technical details here.
  • Core types and functions
  • P2P Networking
  • Fork Choice
  • Sampling process

Accompanying documents can be found in specs and include:

• SimpleSerialize (SSZ) spec
• Merkle proof formats
• General test format

Additional specifications for client implementers

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

• Beacon APIs
• Beacon Metrics

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

• Design Rationale
• Phase 0 Onboarding Document
• Combining GHOST and Casper paper

For spec contributors

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

• YAML Test Generators
• Executable Python Spec, with Py-tests

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.