diff --git a/README.md b/README.md index 58bff5b9e4..e66e79b097 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Ethereum Proof-of-Stake Consensus Specifications](#ethereum-proof-of-stake-consensus-specifications) + - [Specs](#specs) + - [Stable Specifications](#stable-specifications) + - [In-development Specifications](#in-development-specifications) + - [Accompanying documents can be found in specs and include:](#accompanying-documents-can-be-found-in-specs-and-include) + - [Additional specifications for client implementers](#additional-specifications-for-client-implementers) + - [Design goals](#design-goals) + - [Useful external resources](#useful-external-resources) + - [For spec contributors](#for-spec-contributors) + - [Online viewer of the latest release (latest `master` branch)](#online-viewer-of-the-latest-release-latest-master-branch) + - [Consensus spec tests](#consensus-spec-tests) + + + # Ethereum Proof-of-Stake Consensus Specifications [![Join the chat at https://discord.gg/qGpsxSA](https://img.shields.io/badge/chat-on%20discord-blue.svg)](https://discord.gg/qGpsxSA) diff --git a/SECURITY.md b/SECURITY.md index 2101ea1554..a770f5749e 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,3 +1,13 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Security Policy](#security-policy) + - [Supported Versions](#supported-versions) + - [Reporting a Vulnerability](#reporting-a-vulnerability) + + + # Security Policy ## Supported Versions diff --git a/configs/README.md b/configs/README.md index 6ef081e4c4..82b7783682 100644 --- a/configs/README.md +++ b/configs/README.md @@ -1,3 +1,13 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Configurations](#configurations) + - [Forking](#forking) + - [Format](#format) + + + # Configurations This directory contains a set of configurations used for testing, testnets, and mainnet. diff --git a/docker/README.md b/docker/README.md index 6d5b21e59d..29c7faa3f5 100644 --- a/docker/README.md +++ b/docker/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Docker related information](#docker-related-information) + + + ## Docker related information This dockerfile sets up the dependencies required to run consensus-spec tests. The docker image can be locally built with: diff --git a/docs/docs/templates/beacon-chain-template.md b/docs/docs/templates/beacon-chain-template.md index 4d22d3908e..04d61b071f 100644 --- a/docs/docs/templates/beacon-chain-template.md +++ b/docs/docs/templates/beacon-chain-template.md @@ -7,6 +7,24 @@ +- [Introduction](#introduction) +- [Notation](#notation) +- [Custom types](#custom-types) +- [Constants](#constants) + - [[CATEGORY OF CONSTANTS]](#category-of-constants) +- [Preset](#preset) + - [[CATEGORY OF PRESETS]](#category-of-presets) +- [Configuration](#configuration) + - [[CATEGORY OF CONFIGURATIONS]](#category-of-configurations) +- [Containers](#containers) + - [[CATEGORY OF CONTAINERS]](#category-of-containers) + - [`CONTAINER_NAME`](#container_name) +- [Helper functions](#helper-functions) + - [[CATEGORY OF HELPERS]](#category-of-helpers) + - [Epoch processing](#epoch-processing) + - [Block processing](#block-processing) +- [Testing](#testing) + diff --git a/docs/light-client/index.md b/docs/light-client/index.md index 32155b1852..0431126eeb 100644 --- a/docs/light-client/index.md +++ b/docs/light-client/index.md @@ -1 +1,9 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Light client specifications](#light-client-specifications) + + + # Light client specifications diff --git a/presets/README.md b/presets/README.md index 3a438cb2ca..00709d653b 100644 --- a/presets/README.md +++ b/presets/README.md @@ -1,3 +1,13 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Presets](#presets) + - [Forking](#forking) + - [Format](#format) + + + # Presets Presets are more extensive than runtime configurations, and generally only applicable during compile-time. diff --git a/solidity_deposit_contract/README.md b/solidity_deposit_contract/README.md index 0388d7d2f5..139adf8b11 100644 --- a/solidity_deposit_contract/README.md +++ b/solidity_deposit_contract/README.md @@ -1,3 +1,15 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Deposit Contract](#deposit-contract) + - [History](#history) + - [Compiling solidity deposit contract](#compiling-solidity-deposit-contract) + - [Running web3 tests](#running-web3-tests) + - [Running randomized `dapp` tests:](#running-randomized-dapp-tests) + + + # Deposit Contract ## History diff --git a/specs/electra/beacon-chain.md b/specs/electra/beacon-chain.md index 4bc2cfaf06..87a282b8f5 100644 --- a/specs/electra/beacon-chain.md +++ b/specs/electra/beacon-chain.md @@ -28,8 +28,7 @@ - [`PendingBalanceDeposit`](#pendingbalancedeposit) - [`PendingPartialWithdrawal`](#pendingpartialwithdrawal) - [`ExecutionLayerWithdrawalRequest`](#executionlayerwithdrawalrequest) - - [`Consolidation`](#consolidation) - - [`SignedConsolidation`](#signedconsolidation) + - [`ExecutionLayerConsolidationRequest`](#executionlayerconsolidationrequest) - [`PendingConsolidation`](#pendingconsolidation) - [Modified Containers](#modified-containers) - [`AttesterSlashing`](#attesterslashing) @@ -94,8 +93,8 @@ - [New `process_execution_layer_withdrawal_request`](#new-process_execution_layer_withdrawal_request) - [Deposit receipts](#deposit-receipts) - [New `process_deposit_receipt`](#new-process_deposit_receipt) - - [Consolidations](#consolidations) - - [New `process_consolidation`](#new-process_consolidation) + - [Execution layer consolidation requests](#execution-layer-consolidation-requests) + - [New `process_execution_layer_consolidation_request`](#new-process_execution_layer_consolidation_request) - [Testing](#testing) @@ -1286,10 +1285,10 @@ def process_deposit_receipt(state: BeaconState, deposit_receipt: DepositReceipt) ##### Execution layer consolidation requests -###### New `process_execution_layer_consolidation_requests` +###### New `process_execution_layer_consolidation_request` ```python -def process_execution_layer_consolidation_requests( +def process_execution_layer_consolidation_request( state: BeaconState, execution_layer_consolidation_request: ExecutionLayerConsolidationRequest) -> None: # If the pending consolidations queue is full, consolidation requests are ignored diff --git a/tests/README.md b/tests/README.md index dbd2b31de2..46a7bf2ddf 100644 --- a/tests/README.md +++ b/tests/README.md @@ -1,3 +1,20 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Getting Started with Consensus Spec Tests](#getting-started-with-consensus-spec-tests) + - [Getting Started](#getting-started) + - [Creating the environment](#creating-the-environment) + - [Running your first test](#running-your-first-test) + - [The "Hello, World" of Consensus Spec Tests](#the-hello-world-of-consensus-spec-tests) + - [New Tests](#new-tests) + - [Tests Designed to Fail](#tests-designed-to-fail) + - [Attestation Tests](#attestation-tests) + - [Adding an Attestation Test](#adding-an-attestation-test) + - [How are These Tests Used?](#how-are-these-tests-used) + + + # Getting Started with Consensus Spec Tests ## Getting Started diff --git a/tests/core/pyspec/README.md b/tests/core/pyspec/README.md index baa1322771..ca177cf772 100644 --- a/tests/core/pyspec/README.md +++ b/tests/core/pyspec/README.md @@ -1,3 +1,20 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Executable Python Spec (PySpec)](#executable-python-spec-pyspec) + - [Dev Install](#dev-install) + - [Py-tests](#py-tests) + - [How to run tests](#how-to-run-tests) + - [Automated](#automated) + - [Manual](#manual) + - [How to view code coverage report](#how-to-view-code-coverage-report) + - [Advanced](#advanced) + - [Contributing](#contributing) + - [License](#license) + + + # Executable Python Spec (PySpec) The executable Python spec is built from the consensus specifications, diff --git a/tests/core/pyspec/eth2spec/config/README.md b/tests/core/pyspec/eth2spec/config/README.md index c03d890c20..7d6a044de3 100644 --- a/tests/core/pyspec/eth2spec/config/README.md +++ b/tests/core/pyspec/eth2spec/config/README.md @@ -1,3 +1,12 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Consensus specs config util](#consensus-specs-config-util) + - [Config usage:](#config-usage) + + + # Consensus specs config util For run-time configuration, see [Configs documentation](../../../../../configs/README.md). diff --git a/tests/core/pyspec/eth2spec/gen_helpers/README.md b/tests/core/pyspec/eth2spec/gen_helpers/README.md index bf791ccfea..88f8fcf4b7 100644 --- a/tests/core/pyspec/eth2spec/gen_helpers/README.md +++ b/tests/core/pyspec/eth2spec/gen_helpers/README.md @@ -1,3 +1,14 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Consensus test generator helpers](#consensus-test-generator-helpers) + - [`gen_base`](#gen_base) + - [`gen_from_tests`](#gen_from_tests) + - [Test-case parts](#test-case-parts) + + + # Consensus test generator helpers ## `gen_base` diff --git a/tests/core/pyspec/eth2spec/test/electra/block_processing/test_process_execution_layer_consolidation.py b/tests/core/pyspec/eth2spec/test/electra/block_processing/test_process_execution_layer_consolidation.py index 419d13ed14..7f0b53ba99 100644 --- a/tests/core/pyspec/eth2spec/test/electra/block_processing/test_process_execution_layer_consolidation.py +++ b/tests/core/pyspec/eth2spec/test/electra/block_processing/test_process_execution_layer_consolidation.py @@ -40,7 +40,7 @@ def test_basic_consolidation_in_current_consolidation_epoch(spec, state): spec, state, source_index, address=source_address ) # Make consolidation with source address - consolidation = spec.ExecutionLayerConsolidation( + consolidation = spec.ExecutionLayerConsolidationRequest( source_address=source_address, source_pubkey=state.validators[source_index].pubkey, target_pubkey=state.validators[target_index].pubkey, @@ -89,7 +89,7 @@ def test_basic_consolidation_in_new_consolidation_epoch(spec, state): spec, state, source_index, address=source_address ) # Make consolidation with source address - consolidation = spec.ExecutionLayerConsolidation( + consolidation = spec.ExecutionLayerConsolidationRequest( source_address=source_address, source_pubkey=state.validators[source_index].pubkey, target_pubkey=state.validators[target_index].pubkey, @@ -132,7 +132,7 @@ def test_basic_consolidation_with_preexisting_churn(spec, state): spec, state, source_index, address=source_address ) # Make consolidation with source address - consolidation = spec.ExecutionLayerConsolidation( + consolidation = spec.ExecutionLayerConsolidationRequest( source_address=source_address, source_pubkey=state.validators[source_index].pubkey, target_pubkey=state.validators[target_index].pubkey, @@ -179,7 +179,7 @@ def test_basic_consolidation_with_insufficient_preexisting_churn(spec, state): spec, state, source_index, address=source_address ) # Make consolidation with source address - consolidation = spec.ExecutionLayerConsolidation( + consolidation = spec.ExecutionLayerConsolidationRequest( source_address=source_address, source_pubkey=state.validators[source_index].pubkey, target_pubkey=state.validators[target_index].pubkey, @@ -230,7 +230,7 @@ def test_basic_consolidation_with_compounding_credentials(spec, state): spec, state, source_index, address=source_address ) # Make consolidation with source address - consolidation = spec.ExecutionLayerConsolidation( + consolidation = spec.ExecutionLayerConsolidationRequest( source_address=source_address, source_pubkey=state.validators[source_index].pubkey, target_pubkey=state.validators[target_index].pubkey, @@ -276,7 +276,7 @@ def test_consolidation_churn_limit_balance(spec, state): spec, state, source_index, address=source_address ) # Make consolidation with source address - consolidation = spec.ExecutionLayerConsolidation( + consolidation = spec.ExecutionLayerConsolidationRequest( source_address=source_address, source_pubkey=state.validators[source_index].pubkey, target_pubkey=state.validators[target_index].pubkey, @@ -324,7 +324,7 @@ def test_consolidation_balance_larger_than_churn_limit(spec, state): spec, state, source_index, address=source_address ) # Make consolidation with source address - consolidation = spec.ExecutionLayerConsolidation( + consolidation = spec.ExecutionLayerConsolidationRequest( source_address=source_address, source_pubkey=state.validators[source_index].pubkey, target_pubkey=state.validators[target_index].pubkey, @@ -371,7 +371,7 @@ def test_consolidation_balance_through_two_churn_epochs(spec, state): spec, state, source_index, address=source_address ) # Make consolidation with source address - consolidation = spec.ExecutionLayerConsolidation( + consolidation = spec.ExecutionLayerConsolidationRequest( source_address=source_address, source_pubkey=state.validators[source_index].pubkey, target_pubkey=state.validators[target_index].pubkey, @@ -417,7 +417,7 @@ def test_invalid_source_equals_target(spec, state): spec, state, source_index, address=source_address ) # Make consolidation from source to source - consolidation = spec.ExecutionLayerConsolidation( + consolidation = spec.ExecutionLayerConsolidationRequest( source_address=source_address, source_pubkey=state.validators[source_index].pubkey, target_pubkey=state.validators[source_index].pubkey, @@ -449,7 +449,7 @@ def test_invalid_exceed_pending_consolidations_limit(spec, state): set_eth1_withdrawal_credential_with_balance( spec, state, source_index, address=source_address ) - consolidation = spec.ExecutionLayerConsolidation( + consolidation = spec.ExecutionLayerConsolidationRequest( source_address=source_address, source_pubkey=state.validators[source_index].pubkey, target_pubkey=state.validators[target_index].pubkey, @@ -478,7 +478,7 @@ def test_invalid_not_enough_consolidation_churn_available(spec, state): set_eth1_withdrawal_credential_with_balance( spec, state, source_index, address=source_address ) - consolidation = spec.ExecutionLayerConsolidation( + consolidation = spec.ExecutionLayerConsolidationRequest( source_address=source_address, source_pubkey=state.validators[source_index].pubkey, target_pubkey=state.validators[target_index].pubkey, @@ -506,7 +506,7 @@ def test_invalid_exited_source(spec, state): set_eth1_withdrawal_credential_with_balance( spec, state, source_index, address=source_address ) - consolidation = spec.ExecutionLayerConsolidation( + consolidation = spec.ExecutionLayerConsolidationRequest( source_address=source_address, source_pubkey=state.validators[source_index].pubkey, target_pubkey=state.validators[target_index].pubkey, @@ -538,7 +538,7 @@ def test_invalid_exited_target(spec, state): set_eth1_withdrawal_credential_with_balance( spec, state, source_index, address=source_address ) - consolidation = spec.ExecutionLayerConsolidation( + consolidation = spec.ExecutionLayerConsolidationRequest( source_address=source_address, source_pubkey=state.validators[source_index].pubkey, target_pubkey=state.validators[target_index].pubkey, @@ -568,7 +568,7 @@ def test_invalid_inactive_source(spec, state): set_eth1_withdrawal_credential_with_balance( spec, state, source_index, address=source_address ) - consolidation = spec.ExecutionLayerConsolidation( + consolidation = spec.ExecutionLayerConsolidationRequest( source_address=source_address, source_pubkey=state.validators[source_index].pubkey, target_pubkey=state.validators[target_index].pubkey, @@ -600,7 +600,7 @@ def test_invalid_inactive_target(spec, state): set_eth1_withdrawal_credential_with_balance( spec, state, source_index, address=source_address ) - consolidation = spec.ExecutionLayerConsolidation( + consolidation = spec.ExecutionLayerConsolidationRequest( source_address=source_address, source_pubkey=state.validators[source_index].pubkey, target_pubkey=state.validators[target_index].pubkey, @@ -629,7 +629,7 @@ def test_invalid_no_source_execution_withdrawal_credential(spec, state): source_index = spec.get_active_validator_indices(state, current_epoch)[0] target_index = spec.get_active_validator_indices(state, current_epoch)[1] source_address = b"\x22" * 20 - consolidation = spec.ExecutionLayerConsolidation( + consolidation = spec.ExecutionLayerConsolidationRequest( source_address=source_address, source_pubkey=state.validators[source_index].pubkey, target_pubkey=state.validators[target_index].pubkey, @@ -657,7 +657,7 @@ def test_invalid_no_target_execution_withdrawal_credential(spec, state): set_eth1_withdrawal_credential_with_balance( spec, state, source_index, address=source_address ) - consolidation = spec.ExecutionLayerConsolidation( + consolidation = spec.ExecutionLayerConsolidationRequest( source_address=source_address, source_pubkey=state.validators[source_index].pubkey, target_pubkey=state.validators[target_index].pubkey, @@ -685,7 +685,7 @@ def test_invalid_incorrect_source_address(spec, state): spec, state, source_index, address=source_address ) # Make consolidation with different source address - consolidation = spec.ExecutionLayerConsolidation( + consolidation = spec.ExecutionLayerConsolidationRequest( source_address=b"\x33" * 20, source_pubkey=state.validators[source_index].pubkey, target_pubkey=state.validators[target_index].pubkey, @@ -715,7 +715,7 @@ def test_invalid_unknown_source_pubkey(spec, state): spec, state, source_index, address=source_address ) # Make consolidation with different source pubkey - consolidation = spec.ExecutionLayerConsolidation( + consolidation = spec.ExecutionLayerConsolidationRequest( source_address=source_address, source_pubkey=b"\x00" * 48, target_pubkey=state.validators[target_index].pubkey, @@ -744,7 +744,7 @@ def test_invalid_unknown_target_pubkey(spec, state): spec, state, source_index, address=source_address ) # Make consolidation with different target pubkey - consolidation = spec.ExecutionLayerConsolidation( + consolidation = spec.ExecutionLayerConsolidationRequest( source_address=b"\x33" * 20, source_pubkey=state.validators[source_index].pubkey, target_pubkey=b"\x00" * 48, @@ -782,7 +782,7 @@ def run_consolidation_processing(spec, state, consolidation, success=True): yield 'pre', state yield 'consolidation', consolidation - spec.process_execution_layer_consolidation(state, consolidation) + spec.process_execution_layer_consolidation_request(state, consolidation) yield 'post', state diff --git a/tests/formats/README.md b/tests/formats/README.md index ec495daa5b..0fbf3cd9ea 100644 --- a/tests/formats/README.md +++ b/tests/formats/README.md @@ -1,3 +1,32 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [General test format](#general-test-format) + - [Table of contents](#table-of-contents) + - [About](#about) + - [Test-case formats](#test-case-formats) + - [Glossary](#glossary) + - [Test format philosophy](#test-format-philosophy) + - [Config design](#config-design) + - [Test completeness](#test-completeness) + - [Test structure](#test-structure) + - [`/`](#config-name) + - [`/`](#fork-or-phase-name) + - [`/`](#test-runner-name) + - [`/`](#test-handler-name) + - [`/`](#test-suite-name) + - [`/`](#test-case) + - [``](#output-part) + - [Common output formats](#common-output-formats) + - [Special output parts](#special-output-parts) + - [`meta.yaml`](#metayaml) + - [`config.yaml`](#configyaml) + - [Config sourcing](#config-sourcing) + - [Note for implementers](#note-for-implementers) + + + # General test format This document defines the YAML format and structure used for consensus spec testing. diff --git a/tests/formats/bls/README.md b/tests/formats/bls/README.md index 77a9654a8d..d4e3ea9035 100644 --- a/tests/formats/bls/README.md +++ b/tests/formats/bls/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [BLS tests](#bls-tests) + + + # BLS tests A test type for BLS. Primarily geared towards verifying the *integration* of any BLS library. diff --git a/tests/formats/bls/aggregate.md b/tests/formats/bls/aggregate.md index 7cdebcf4d9..4f86bc0d3f 100644 --- a/tests/formats/bls/aggregate.md +++ b/tests/formats/bls/aggregate.md @@ -1,3 +1,13 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Test format: BLS signature aggregation](#test-format-bls-signature-aggregation) + - [Test case format](#test-case-format) + - [Condition](#condition) + + + # Test format: BLS signature aggregation A BLS signature aggregation combines a series of signatures into a single signature. diff --git a/tests/formats/bls/aggregate_verify.md b/tests/formats/bls/aggregate_verify.md index 9b251af46e..0e8414c00b 100644 --- a/tests/formats/bls/aggregate_verify.md +++ b/tests/formats/bls/aggregate_verify.md @@ -1,3 +1,13 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Test format: BLS sign message](#test-format-bls-sign-message) + - [Test case format](#test-case-format) + - [Condition](#condition) + + + # Test format: BLS sign message Verify the signature against the given pubkeys and one messages. diff --git a/tests/formats/bls/eth_aggregate_pubkeys.md b/tests/formats/bls/eth_aggregate_pubkeys.md index 2b72c1dcaf..4a61330a30 100644 --- a/tests/formats/bls/eth_aggregate_pubkeys.md +++ b/tests/formats/bls/eth_aggregate_pubkeys.md @@ -1,3 +1,13 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Test format: Ethereum-customized BLS pubkey aggregation](#test-format-ethereum-customized-bls-pubkey-aggregation) + - [Test case format](#test-case-format) + - [Condition](#condition) + + + # Test format: Ethereum-customized BLS pubkey aggregation A BLS pubkey aggregation combines a series of pubkeys into a single pubkey. diff --git a/tests/formats/bls/eth_fast_aggregate_verify.md b/tests/formats/bls/eth_fast_aggregate_verify.md index 83b5484e05..66a3728a0d 100644 --- a/tests/formats/bls/eth_fast_aggregate_verify.md +++ b/tests/formats/bls/eth_fast_aggregate_verify.md @@ -1,3 +1,13 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Test format: Ethereum-customized BLS fast aggregate verify](#test-format-ethereum-customized-bls-fast-aggregate-verify) + - [Test case format](#test-case-format) + - [Condition](#condition) + + + # Test format: Ethereum-customized BLS fast aggregate verify Verify the signature against the given pubkeys and one message. diff --git a/tests/formats/bls/fast_aggregate_verify.md b/tests/formats/bls/fast_aggregate_verify.md index 38ea29bb5f..b7a94b1c00 100644 --- a/tests/formats/bls/fast_aggregate_verify.md +++ b/tests/formats/bls/fast_aggregate_verify.md @@ -1,3 +1,13 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Test format: BLS fast aggregate verify](#test-format-bls-fast-aggregate-verify) + - [Test case format](#test-case-format) + - [Condition](#condition) + + + # Test format: BLS fast aggregate verify Verify the signature against the given pubkeys and one message. diff --git a/tests/formats/bls/sign.md b/tests/formats/bls/sign.md index 09e9286148..96756c9e3f 100644 --- a/tests/formats/bls/sign.md +++ b/tests/formats/bls/sign.md @@ -1,3 +1,13 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Test format: BLS sign message](#test-format-bls-sign-message) + - [Test case format](#test-case-format) + - [Condition](#condition) + + + # Test format: BLS sign message Message signing with BLS should produce a signature. diff --git a/tests/formats/bls/verify.md b/tests/formats/bls/verify.md index 57ec8a33a7..0fd5f43f29 100644 --- a/tests/formats/bls/verify.md +++ b/tests/formats/bls/verify.md @@ -1,3 +1,12 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Test format: BLS sign message](#test-format-bls-sign-message) + - [Test case format](#test-case-format) + + + # Test format: BLS sign message Verify the signature against the given one pubkey and one message. diff --git a/tests/formats/epoch_processing/README.md b/tests/formats/epoch_processing/README.md index 2951767f2c..60eee01179 100644 --- a/tests/formats/epoch_processing/README.md +++ b/tests/formats/epoch_processing/README.md @@ -1,3 +1,16 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Epoch processing tests](#epoch-processing-tests) + - [Test case format](#test-case-format) + - [`meta.yaml`](#metayaml) + - [`pre.ssz_snappy`](#pressz_snappy) + - [`post.ssz_snappy`](#postssz_snappy) + - [Condition](#condition) + + + # Epoch processing tests The different epoch sub-transitions are tested individually with test handlers. diff --git a/tests/formats/finality/README.md b/tests/formats/finality/README.md index af39f5c8ca..2cdb820c79 100644 --- a/tests/formats/finality/README.md +++ b/tests/formats/finality/README.md @@ -1,3 +1,17 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Finality tests](#finality-tests) + - [Test case format](#test-case-format) + - [`meta.yaml`](#metayaml) + - [`pre.ssz_snappy`](#pressz_snappy) + - [`blocks_.yaml`](#blocks_indexyaml) + - [`post.ssz_snappy`](#postssz_snappy) + - [Condition](#condition) + + + # Finality tests The aim of the tests for the finality rules. diff --git a/tests/formats/forks/README.md b/tests/formats/forks/README.md index dfbaf2df0b..6c685e41f6 100644 --- a/tests/formats/forks/README.md +++ b/tests/formats/forks/README.md @@ -1,3 +1,18 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Forks](#forks) + - [Test case format](#test-case-format) + - [`meta.yaml`](#metayaml) + - [Fork strings](#fork-strings) + - [`pre.ssz_snappy`](#pressz_snappy) + - [`post.ssz_snappy`](#postssz_snappy) + - [Processing](#processing) + - [Condition](#condition) + + + # Forks The aim of the fork tests is to ensure that a pre-fork state can be transformed diff --git a/tests/formats/genesis/README.md b/tests/formats/genesis/README.md index 25761e2f6a..110c3c9524 100644 --- a/tests/formats/genesis/README.md +++ b/tests/formats/genesis/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Genesis tests](#genesis-tests) + + + # Genesis tests The aim of the genesis tests is to provide a baseline to test genesis-state initialization and test diff --git a/tests/formats/genesis/initialization.md b/tests/formats/genesis/initialization.md index 9848e157d9..aebba624af 100644 --- a/tests/formats/genesis/initialization.md +++ b/tests/formats/genesis/initialization.md @@ -1,3 +1,19 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Genesis creation testing](#genesis-creation-testing) + - [Test case format](#test-case-format) + - [`eth1.yaml`](#eth1yaml) + - [`meta.yaml`](#metayaml) + - [`deposits_.ssz_snappy`](#deposits_indexssz_snappy) + - [`execution_payload_header.ssz_snappy`](#execution_payload_headerssz_snappy) + - [`state.ssz_snappy`](#statessz_snappy) + - [Processing](#processing) + - [Condition](#condition) + + + # Genesis creation testing Tests the initialization of a genesis state based on Eth1 data. diff --git a/tests/formats/genesis/validity.md b/tests/formats/genesis/validity.md index 15236c3ba3..2ad42feb67 100644 --- a/tests/formats/genesis/validity.md +++ b/tests/formats/genesis/validity.md @@ -1,3 +1,17 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Genesis validity testing](#genesis-validity-testing) + - [Test case format](#test-case-format) + - [`meta.yaml`](#metayaml) + - [`genesis.ssz_snappy`](#genesisssz_snappy) + - [`is_valid.yaml`](#is_validyaml) + - [Processing](#processing) + - [Condition](#condition) + + + # Genesis validity testing Tests if a genesis state is valid, i.e. if it counts as trigger to launch. diff --git a/tests/formats/kzg_4844/README.md b/tests/formats/kzg_4844/README.md index b5bd720393..f5afa9ed12 100644 --- a/tests/formats/kzg_4844/README.md +++ b/tests/formats/kzg_4844/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [KZG tests](#kzg-tests) + + + # KZG tests A test type for KZG libraries. Tests all the public interfaces that a KZG library required to implement EIP-4844 needs to provide, as defined in `polynomial-commitments.md`. diff --git a/tests/formats/kzg_4844/blob_to_kzg_commitment.md b/tests/formats/kzg_4844/blob_to_kzg_commitment.md index dbb1556a1d..fdc710edfd 100644 --- a/tests/formats/kzg_4844/blob_to_kzg_commitment.md +++ b/tests/formats/kzg_4844/blob_to_kzg_commitment.md @@ -1,3 +1,13 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Test format: Blob to KZG commitment](#test-format-blob-to-kzg-commitment) + - [Test case format](#test-case-format) + - [Condition](#condition) + + + # Test format: Blob to KZG commitment Compute the KZG commitment for a given `blob`. diff --git a/tests/formats/kzg_4844/compute_blob_kzg_proof.md b/tests/formats/kzg_4844/compute_blob_kzg_proof.md index 62fce37231..32a9f97104 100644 --- a/tests/formats/kzg_4844/compute_blob_kzg_proof.md +++ b/tests/formats/kzg_4844/compute_blob_kzg_proof.md @@ -1,3 +1,13 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Test format: Compute blob KZG proof](#test-format-compute-blob-kzg-proof) + - [Test case format](#test-case-format) + - [Condition](#condition) + + + # Test format: Compute blob KZG proof Compute the blob KZG proof for a given `blob`, that helps with quickly verifying that the KZG commitment for the blob is correct. diff --git a/tests/formats/kzg_4844/compute_kzg_proof.md b/tests/formats/kzg_4844/compute_kzg_proof.md index b10105129b..e85616539d 100644 --- a/tests/formats/kzg_4844/compute_kzg_proof.md +++ b/tests/formats/kzg_4844/compute_kzg_proof.md @@ -1,3 +1,13 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Test format: Compute KZG proof](#test-format-compute-kzg-proof) + - [Test case format](#test-case-format) + - [Condition](#condition) + + + # Test format: Compute KZG proof Compute the KZG proof for a given `blob` and an evaluation point `z`. diff --git a/tests/formats/kzg_4844/verify_blob_kzg_proof.md b/tests/formats/kzg_4844/verify_blob_kzg_proof.md index dd0bcda5a9..9a62ba92a4 100644 --- a/tests/formats/kzg_4844/verify_blob_kzg_proof.md +++ b/tests/formats/kzg_4844/verify_blob_kzg_proof.md @@ -1,3 +1,13 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Test format: Verify blob KZG proof](#test-format-verify-blob-kzg-proof) + - [Test case format](#test-case-format) + - [Condition](#condition) + + + # Test format: Verify blob KZG proof Use the blob KZG proof to verify that the KZG commitment for a given `blob` is correct diff --git a/tests/formats/kzg_4844/verify_blob_kzg_proof_batch.md b/tests/formats/kzg_4844/verify_blob_kzg_proof_batch.md index 82e668497d..040446f69a 100644 --- a/tests/formats/kzg_4844/verify_blob_kzg_proof_batch.md +++ b/tests/formats/kzg_4844/verify_blob_kzg_proof_batch.md @@ -1,3 +1,13 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Test format: Verify blob KZG proof batch](#test-format-verify-blob-kzg-proof-batch) + - [Test case format](#test-case-format) + - [Condition](#condition) + + + # Test format: Verify blob KZG proof batch Use the blob KZG proofs to verify that the KZG commitments for given `blobs` are correct diff --git a/tests/formats/kzg_4844/verify_kzg_proof.md b/tests/formats/kzg_4844/verify_kzg_proof.md index 18e02710c5..bb4c1547f1 100644 --- a/tests/formats/kzg_4844/verify_kzg_proof.md +++ b/tests/formats/kzg_4844/verify_kzg_proof.md @@ -1,3 +1,13 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Test format: Verify KZG proof](#test-format-verify-kzg-proof) + - [Test case format](#test-case-format) + - [Condition](#condition) + + + # Test format: Verify KZG proof Verify the KZG proof for a given `blob` and an evaluation point `z` that claims to result in a value of `y`. diff --git a/tests/formats/light_client/README.md b/tests/formats/light_client/README.md index 505b416019..84f06f58c1 100644 --- a/tests/formats/light_client/README.md +++ b/tests/formats/light_client/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Light client sync protocol tests](#light-client-sync-protocol-tests) + + + # Light client sync protocol tests This series of tests provides reference test vectors for the light client sync protocol spec. diff --git a/tests/formats/light_client/single_merkle_proof.md b/tests/formats/light_client/single_merkle_proof.md index 0cb4cd0d0c..789603af57 100644 --- a/tests/formats/light_client/single_merkle_proof.md +++ b/tests/formats/light_client/single_merkle_proof.md @@ -1,3 +1,15 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Single leaf merkle proof tests](#single-leaf-merkle-proof-tests) + - [Test case format](#test-case-format) + - [`object.ssz_snappy`](#objectssz_snappy) + - [`proof.yaml`](#proofyaml) + - [Condition](#condition) + + + # Single leaf merkle proof tests This series of tests provides reference test vectors for validating correct diff --git a/tests/formats/light_client/sync.md b/tests/formats/light_client/sync.md index 1706b4c162..f2a52f167e 100644 --- a/tests/formats/light_client/sync.md +++ b/tests/formats/light_client/sync.md @@ -1,3 +1,20 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Light client sync tests](#light-client-sync-tests) + - [Test case format](#test-case-format) + - [`meta.yaml`](#metayaml) + - [`bootstrap.ssz_snappy`](#bootstrapssz_snappy) + - [`steps.yaml`](#stepsyaml) + - [Checks to run after each step](#checks-to-run-after-each-step) + - [`force_update` execution step](#force_update-execution-step) + - [`process_update` execution step](#process_update-execution-step) + - [`upgrade_store`](#upgrade_store) + - [Condition](#condition) + + + # Light client sync tests This series of tests provides reference test vectors for validating that a light client implementing the sync protocol can sync to the latest block header. diff --git a/tests/formats/light_client/update_ranking.md b/tests/formats/light_client/update_ranking.md index fe73fb9df7..4640f7860b 100644 --- a/tests/formats/light_client/update_ranking.md +++ b/tests/formats/light_client/update_ranking.md @@ -1,3 +1,15 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [`LightClientUpdate` ranking tests](#lightclientupdate-ranking-tests) + - [Test case format](#test-case-format) + - [`meta.yaml`](#metayaml) + - [`updates_.ssz_snappy`](#updates_indexssz_snappy) + - [Condition](#condition) + + + # `LightClientUpdate` ranking tests This series of tests provides reference test vectors for validating that `LightClientUpdate` instances are ranked in a canonical order. diff --git a/tests/formats/merkle_proof/README.md b/tests/formats/merkle_proof/README.md index 77822daabe..5791dd5283 100644 --- a/tests/formats/merkle_proof/README.md +++ b/tests/formats/merkle_proof/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Merkle proof tests](#merkle-proof-tests) + + + # Merkle proof tests Handlers: diff --git a/tests/formats/operations/README.md b/tests/formats/operations/README.md index b020b5fd03..e3627cf30b 100644 --- a/tests/formats/operations/README.md +++ b/tests/formats/operations/README.md @@ -1,3 +1,17 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Operations tests](#operations-tests) + - [Test case format](#test-case-format) + - [`meta.yaml`](#metayaml) + - [`pre.ssz_snappy`](#pressz_snappy) + - [`.ssz_snappy`](#input-namessz_snappy) + - [`post.ssz_snappy`](#postssz_snappy) + - [Condition](#condition) + + + # Operations tests The different kinds of operations ("transactions") are tested individually with test handlers. diff --git a/tests/formats/random/README.md b/tests/formats/random/README.md index 54b2c1a23e..b6ac4429fd 100644 --- a/tests/formats/random/README.md +++ b/tests/formats/random/README.md @@ -1,3 +1,12 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Random tests](#random-tests) + - [Test case format](#test-case-format) + + + # Random tests The random tests are generated with various randomized states and blocks. diff --git a/tests/formats/rewards/README.md b/tests/formats/rewards/README.md index a6682042f7..7aa36adb1b 100644 --- a/tests/formats/rewards/README.md +++ b/tests/formats/rewards/README.md @@ -1,3 +1,20 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Rewards tests](#rewards-tests) + - [Test case format](#test-case-format) + - [`meta.yaml`](#metayaml) + - [`pre.ssz_snappy`](#pressz_snappy) + - [`source_deltas.ssz_snappy`](#source_deltasssz_snappy) + - [`target_deltas.ssz_snappy`](#target_deltasssz_snappy) + - [`head_deltas.ssz_snappy`](#head_deltasssz_snappy) + - [`inclusion_delay_deltas.ssz_snappy`](#inclusion_delay_deltasssz_snappy) + - [`inactivity_penalty_deltas.ssz_snappy`](#inactivity_penalty_deltasssz_snappy) + - [Condition](#condition) + + + # Rewards tests All rewards deltas sub-functions are tested for each test case. diff --git a/tests/formats/sanity/README.md b/tests/formats/sanity/README.md index 20b36208a4..d2b26709ee 100644 --- a/tests/formats/sanity/README.md +++ b/tests/formats/sanity/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Sanity tests](#sanity-tests) + + + # Sanity tests The aim of the sanity tests is to set a base-line on what really needs to pass, i.e. the essentials. diff --git a/tests/formats/sanity/blocks.md b/tests/formats/sanity/blocks.md index 7ea646b9e0..1c1bc3c92c 100644 --- a/tests/formats/sanity/blocks.md +++ b/tests/formats/sanity/blocks.md @@ -1,3 +1,17 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Sanity blocks testing](#sanity-blocks-testing) + - [Test case format](#test-case-format) + - [`meta.yaml`](#metayaml) + - [`pre.ssz_snappy`](#pressz_snappy) + - [`blocks_.ssz_snappy`](#blocks_indexssz_snappy) + - [`post.ssz_snappy`](#postssz_snappy) + - [Condition](#condition) + + + # Sanity blocks testing Sanity tests to cover a series of one or more blocks being processed, aiming to cover common changes. diff --git a/tests/formats/sanity/slots.md b/tests/formats/sanity/slots.md index f1b8a13219..54083f5cf0 100644 --- a/tests/formats/sanity/slots.md +++ b/tests/formats/sanity/slots.md @@ -1,3 +1,18 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Sanity slots testing](#sanity-slots-testing) + - [Test case format](#test-case-format) + - [`meta.yaml`](#metayaml) + - [`pre.ssz_snappy`](#pressz_snappy) + - [`slots.yaml`](#slotsyaml) + - [`post.ssz_snappy`](#postssz_snappy) + - [Processing](#processing) + - [Condition](#condition) + + + # Sanity slots testing Sanity tests to cover a series of one or more empty-slot transitions being processed, aiming to cover common changes. diff --git a/tests/formats/shuffling/README.md b/tests/formats/shuffling/README.md index 15bfe6996b..1334362f49 100644 --- a/tests/formats/shuffling/README.md +++ b/tests/formats/shuffling/README.md @@ -1,3 +1,14 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Test format: shuffling](#test-format-shuffling) + - [Test case format](#test-case-format) + - [`mapping.yaml`](#mappingyaml) + - [Condition](#condition) + + + # Test format: shuffling The runner of the Shuffling test type has only one handler: `core`. diff --git a/tests/formats/ssz_generic/README.md b/tests/formats/ssz_generic/README.md index c46025847a..c95ef2aad6 100644 --- a/tests/formats/ssz_generic/README.md +++ b/tests/formats/ssz_generic/README.md @@ -1,3 +1,26 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [SSZ, generic tests](#ssz-generic-tests) + - [Format](#format) + - [`valid`](#valid) + - [`meta.yaml`](#metayaml) + - [`serialized.ssz_snappy`](#serializedssz_snappy) + - [`value.yaml`](#valueyaml) + - [Conditions](#conditions) + - [`invalid`](#invalid) + - [Condition](#condition) + - [Type declarations](#type-declarations) + - [`basic_vector`](#basic_vector) + - [`bitlist`](#bitlist) + - [`bitvector`](#bitvector) + - [`boolean`](#boolean) + - [`uints`](#uints) + - [`containers`](#containers) + + + # SSZ, generic tests This set of test-suites provides general testing for SSZ: diff --git a/tests/formats/ssz_static/README.md b/tests/formats/ssz_static/README.md index ffa7373349..3cef2de714 100644 --- a/tests/formats/ssz_static/README.md +++ b/tests/formats/ssz_static/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [SSZ, static tests](#ssz-static-tests) + + + # SSZ, static tests This set of test-suites provides static testing for SSZ: diff --git a/tests/formats/ssz_static/core.md b/tests/formats/ssz_static/core.md index 09ff04e20d..6995de9abb 100644 --- a/tests/formats/ssz_static/core.md +++ b/tests/formats/ssz_static/core.md @@ -1,3 +1,17 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Test format: SSZ static types](#test-format-ssz-static-types) + - [Test case format](#test-case-format) + - [`roots.yaml`](#rootsyaml) + - [`serialized.ssz_snappy`](#serializedssz_snappy) + - [`value.yaml`](#valueyaml) + - [Condition](#condition) + - [References](#references) + + + # Test format: SSZ static types The goal of this type is to provide clients with a solid reference for how the known SSZ objects should be encoded. diff --git a/tests/formats/sync/README.md b/tests/formats/sync/README.md index ff9f8168cb..be95ba765f 100644 --- a/tests/formats/sync/README.md +++ b/tests/formats/sync/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Sync tests](#sync-tests) + + + # Sync tests It re-uses the [fork choice test format](../fork_choice/README.md) to apply the test script. diff --git a/tests/formats/transition/README.md b/tests/formats/transition/README.md index 7f89bdd610..cd4a23f293 100644 --- a/tests/formats/transition/README.md +++ b/tests/formats/transition/README.md @@ -1,3 +1,17 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Transition testing](#transition-testing) + - [Test case format](#test-case-format) + - [`meta.yaml`](#metayaml) + - [`pre.ssz_snappy`](#pressz_snappy) + - [`blocks_.ssz_snappy`](#blocks_indexssz_snappy) + - [`post.ssz_snappy`](#postssz_snappy) + - [Condition](#condition) + + + # Transition testing Transition tests to cover processing the chain across a fork boundary. diff --git a/tests/generators/README.md b/tests/generators/README.md index 0146ca35e8..0dd1a87a65 100644 --- a/tests/generators/README.md +++ b/tests/generators/README.md @@ -14,7 +14,6 @@ An automated nightly tests release system, with a config filter applied, is bein - - [How to run generators](#how-to-run-generators) - [Cleaning](#cleaning) - [Running all test generators](#running-all-test-generators) diff --git a/tests/generators/bls/README.md b/tests/generators/bls/README.md index 24013f88e7..be19386372 100644 --- a/tests/generators/bls/README.md +++ b/tests/generators/bls/README.md @@ -1,3 +1,12 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [BLS Test Generator](#bls-test-generator) + - [Resources](#resources) + + + # BLS Test Generator The [BLS Signature APIs](../../../specs/phase0/beacon-chain.md#bls-signatures) diff --git a/tests/generators/epoch_processing/README.md b/tests/generators/epoch_processing/README.md index 662b0b516d..4e7a8119c9 100644 --- a/tests/generators/epoch_processing/README.md +++ b/tests/generators/epoch_processing/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Epoch processing](#epoch-processing) + + + # Epoch processing Epoch processing covers the sub-transitions during an epoch change. diff --git a/tests/generators/finality/README.md b/tests/generators/finality/README.md index dec5819c68..8686ffc445 100644 --- a/tests/generators/finality/README.md +++ b/tests/generators/finality/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Finality tests](#finality-tests) + + + # Finality tests Finality tests cover regular state-transitions in a common block-list format to test finality rules. diff --git a/tests/generators/fork_choice/README.md b/tests/generators/fork_choice/README.md index e67b115ba1..61f837d42d 100644 --- a/tests/generators/fork_choice/README.md +++ b/tests/generators/fork_choice/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Fork choice tests](#fork-choice-tests) + + + # Fork choice tests Fork choice tests cover the different forking cases with fork choice helper functions. diff --git a/tests/generators/genesis/README.md b/tests/generators/genesis/README.md index e270f6e35e..3f218841ae 100644 --- a/tests/generators/genesis/README.md +++ b/tests/generators/genesis/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Genesis test generator](#genesis-test-generator) + + + # Genesis test generator Genesis tests cover the initialization and validity-based launch trigger for the Beacon Chain genesis state. diff --git a/tests/generators/kzg_4844/README.md b/tests/generators/kzg_4844/README.md index ab81a85e86..61031ac1f4 100644 --- a/tests/generators/kzg_4844/README.md +++ b/tests/generators/kzg_4844/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [KZG 4844 Test Generator](#kzg-4844-test-generator) + + + # KZG 4844 Test Generator These tests are specific to the KZG API required for implementing EIP-4844 \ No newline at end of file diff --git a/tests/generators/light_client/README.md b/tests/generators/light_client/README.md index 7eabc2520c..2751c0874e 100644 --- a/tests/generators/light_client/README.md +++ b/tests/generators/light_client/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Light client tests](#light-client-tests) + + + # Light client tests The purpose of this test-generator is to provide test-vectors for validating the correct implementation of the light client sync protocol. diff --git a/tests/generators/merkle_proof/README.md b/tests/generators/merkle_proof/README.md index fb4d05fda8..b5ee6c8b6c 100644 --- a/tests/generators/merkle_proof/README.md +++ b/tests/generators/merkle_proof/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Merkle proof tests](#merkle-proof-tests) + + + # Merkle proof tests The purpose of this test-generator is to provide test-vectors for validating the correct implementation of the Merkle proof verification. diff --git a/tests/generators/operations/README.md b/tests/generators/operations/README.md index a5d48c11b4..2eac9c9f9e 100644 --- a/tests/generators/operations/README.md +++ b/tests/generators/operations/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Operations](#operations) + + + # Operations Operations (or "transactions" in previous spec iterations), diff --git a/tests/generators/random/README.md b/tests/generators/random/README.md index fd17284412..4c49226f8e 100644 --- a/tests/generators/random/README.md +++ b/tests/generators/random/README.md @@ -1,3 +1,14 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Randomized tests](#randomized-tests) +- [To generate test sources](#to-generate-test-sources) +- [To run tests](#to-run-tests) +- [To generate spec tests (from the generated files)](#to-generate-spec-tests-from-the-generated-files) + + + # Randomized tests Randomized tests in the format of `sanity` blocks tests, with randomized operations. diff --git a/tests/generators/rewards/README.md b/tests/generators/rewards/README.md index 60f106836a..4233958924 100644 --- a/tests/generators/rewards/README.md +++ b/tests/generators/rewards/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Rewards](#rewards) + + + # Rewards Rewards covers the sub-functions of `process_rewards_and_penalties` for granular testing of components of the rewards function. diff --git a/tests/generators/sanity/README.md b/tests/generators/sanity/README.md index cbc6aef06d..31c59f84d3 100644 --- a/tests/generators/sanity/README.md +++ b/tests/generators/sanity/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Sanity tests](#sanity-tests) + + + # Sanity tests Sanity tests cover regular state-transitions in a common block-list format, to ensure the basics work. diff --git a/tests/generators/shuffling/README.md b/tests/generators/shuffling/README.md index 81ddaba15f..0294c1ec6f 100644 --- a/tests/generators/shuffling/README.md +++ b/tests/generators/shuffling/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Shuffling Tests](#shuffling-tests) + + + # Shuffling Tests Tests for the swap-or-not shuffling in the beacon chain. diff --git a/tests/generators/ssz_static/README.md b/tests/generators/ssz_static/README.md index 3434fe174b..b557b726ad 100644 --- a/tests/generators/ssz_static/README.md +++ b/tests/generators/ssz_static/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [SSZ-static](#ssz-static) + + + # SSZ-static The purpose of this test-generator is to provide test-vectors for the most important applications of SSZ: