minor fixes, doctoc

fradamt · May 21, 2024 · dc2a2bd · dc2a2bd
1 parent 7c4b32a
commit dc2a2bd
Show file tree

Hide file tree

Showing 68 changed files with 756 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,21 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**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)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # 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
@@ -1,3 +1,13 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**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)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Security Policy
 
 ## Supported Versions

diff --git a/configs/README.md b/configs/README.md
@@ -1,3 +1,13 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Configurations](#configurations)
+  - [Forking](#forking)
+  - [Format](#format)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Configurations
 
 This directory contains a set of configurations used for testing, testnets, and mainnet.

diff --git a/docker/README.md b/docker/README.md
@@ -1,3 +1,11 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Docker related information](#docker-related-information)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 ## 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
@@ -7,6 +7,24 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
+- [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)
+
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 <!-- /TOC -->
 

diff --git a/docs/light-client/index.md b/docs/light-client/index.md
@@ -1 +1,9 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Light client specifications](#light-client-specifications)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Light client specifications
diff --git a/presets/README.md b/presets/README.md
@@ -1,3 +1,13 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Presets](#presets)
+  - [Forking](#forking)
+  - [Format](#format)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # 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
@@ -1,3 +1,15 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**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)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Deposit Contract
 
 ## History

diff --git 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)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -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
@@ -1,3 +1,20 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**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)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Getting Started with Consensus Spec Tests
 
 ## Getting Started

diff --git a/tests/core/pyspec/README.md b/tests/core/pyspec/README.md
@@ -1,3 +1,20 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**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)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # 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
@@ -1,3 +1,12 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Consensus specs config util](#consensus-specs-config-util)
+  - [Config usage:](#config-usage)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # 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
@@ -1,3 +1,14 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**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)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Consensus test generator helpers
 
 ## `gen_base`