toc updates

status-im · Mar 26, 2021 · 6d2d8cb · 6d2d8cb
1 parent 882aa81
commit 6d2d8cb
Show file tree

Hide file tree

Showing 9 changed files with 71 additions and 4 deletions.
diff --git a/Makefile b/Makefile
@@ -20,7 +20,11 @@ GENERATOR_VENVS = $(patsubst $(GENERATOR_DIR)/%, $(GENERATOR_DIR)/%venv, $(GENER
 # To check generator matching:
 #$(info $$GENERATOR_TARGETS is [${GENERATOR_TARGETS}])
 
-MARKDOWN_FILES = $(wildcard $(SPEC_DIR)/phase0/*.md) $(wildcard $(SPEC_DIR)/phase1/*.md) $(wildcard $(SPEC_DIR)/altair/*.md) $(wildcard $(SSZ_DIR)/*.md) $(wildcard $(SPEC_DIR)/networking/*.md) $(wildcard $(SPEC_DIR)/validator/*.md)
+MARKDOWN_FILES = $(wildcard $(SPEC_DIR)/phase0/*.md) $(wildcard $(SPEC_DIR)/altair/*.md) $(wildcard $(SSZ_DIR)/*.md) \
+                 $(wildcard $(SPEC_DIR)/merge/*.md) \
+                 $(wildcard $(SPEC_DIR)/custody/*.md) \
+                 $(wildcard $(SPEC_DIR)/das/*.md) \
+                 $(wildcard $(SPEC_DIR)/sharding/*.md)
 
 COV_HTML_OUT=.htmlcov
 COV_INDEX_FILE=$(PY_SPEC_DIR)/$(COV_HTML_OUT)/index.html

diff --git a/specs/custody/custody-game.md b/specs/custody/custody-game.md
@@ -8,7 +8,46 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-TODO
+- [Introduction](#introduction)
+- [Constants](#constants)
+  - [Misc](#misc)
+- [Configuration](#configuration)
+  - [Time parameters](#time-parameters)
+  - [Max operations per block](#max-operations-per-block)
+  - [Size parameters](#size-parameters)
+  - [Reward and penalty quotients](#reward-and-penalty-quotients)
+- [Data structures](#data-structures)
+  - [Extended types](#extended-types)
+    - [`Validator`](#validator)
+    - [`BeaconBlockBody`](#beaconblockbody)
+    - [`BeaconState`](#beaconstate)
+  - [New Beacon Chain operations](#new-beacon-chain-operations)
+    - [`CustodyChunkChallenge`](#custodychunkchallenge)
+    - [`CustodyChunkChallengeRecord`](#custodychunkchallengerecord)
+    - [`CustodyChunkResponse`](#custodychunkresponse)
+    - [`CustodySlashing`](#custodyslashing)
+    - [`SignedCustodySlashing`](#signedcustodyslashing)
+    - [`CustodyKeyReveal`](#custodykeyreveal)
+    - [`EarlyDerivedSecretReveal`](#earlyderivedsecretreveal)
+- [Helpers](#helpers)
+  - [`replace_empty_or_append`](#replace_empty_or_append)
+  - [`legendre_bit`](#legendre_bit)
+  - [`get_custody_atoms`](#get_custody_atoms)
+  - [`get_custody_secrets`](#get_custody_secrets)
+  - [`universal_hash_function`](#universal_hash_function)
+  - [`compute_custody_bit`](#compute_custody_bit)
+  - [`get_randao_epoch_for_custody_period`](#get_randao_epoch_for_custody_period)
+  - [`get_custody_period_for_validator`](#get_custody_period_for_validator)
+- [Per-block processing](#per-block-processing)
+  - [Custody Game Operations](#custody-game-operations)
+    - [Chunk challenges](#chunk-challenges)
+    - [Custody chunk response](#custody-chunk-response)
+    - [Custody key reveals](#custody-key-reveals)
+    - [Early derived secret reveals](#early-derived-secret-reveals)
+    - [Custody Slashings](#custody-slashings)
+- [Per-epoch processing](#per-epoch-processing)
+  - [Handling of reveal deadlines](#handling-of-reveal-deadlines)
+  - [Final updates](#final-updates)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 <!-- /TOC -->

diff --git a/specs/custody/validator.md b/specs/custody/validator.md
@@ -10,7 +10,16 @@ participating in the Ethereum 2.0 Phase 1 protocol.
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-TODO
+- [Introduction](#introduction)
+- [Prerequisites](#prerequisites)
+- [Becoming a validator](#becoming-a-validator)
+- [Beacon chain validator assignments](#beacon-chain-validator-assignments)
+      - [Custody slashings](#custody-slashings)
+      - [Custody key reveals](#custody-key-reveals)
+      - [Early derived secret reveals](#early-derived-secret-reveals)
+    - [Construct attestation](#construct-attestation)
+- [How to avoid slashing](#how-to-avoid-slashing)
+  - [Custody slashing](#custody-slashing)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 <!-- /TOC -->

diff --git a/specs/das/das-internals.md b/specs/das/das-internals.md
@@ -4,6 +4,7 @@
 
 ## Table of contents
 
+<!-- TOC -->
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
@@ -23,6 +24,8 @@
 - [DAS functions](#das-functions)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
+<!-- /TOC -->
+
 
 ## Custom types
 

diff --git a/specs/das/das-p2p.md b/specs/das/das-p2p.md
@@ -4,6 +4,7 @@
 
 ## Table of contents
 
+<!-- TOC -->
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
@@ -25,6 +26,8 @@
     - [DASQuery](#dasquery)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
+<!-- /TOC -->
+
 
 
 ## Introduction

diff --git a/specs/das/das-participation.md b/specs/das/das-participation.md
@@ -4,7 +4,7 @@
 
 ## Table of contents
 
-
+<!-- TOC -->
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
@@ -20,6 +20,7 @@
     - [Stage 2: Pulling missing data from validators with custody.](#stage-2-pulling-missing-data-from-validators-with-custody)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
+<!-- /TOC -->
 
 
 ## Data Availability Sampling

diff --git a/specs/das/fork-choice.md b/specs/das/fork-choice.md
@@ -3,6 +3,7 @@
 **Notice**: This document is a work-in-progress for researchers and implementers.
 
 ## Table of contents
+
 <!-- TOC -->
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
@@ -13,6 +14,7 @@
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 <!-- /TOC -->
 
+
 ## Introduction
 
 This document is the beacon chain fork choice spec for part of Ethereum 2.0 Phase 1. The only change that we add from phase 0 is that we add a concept of "data dependencies";

diff --git a/specs/sharding/beacon-chain.md b/specs/sharding/beacon-chain.md
@@ -4,6 +4,7 @@
 
 ## Table of contents
 
+<!-- TOC -->
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
@@ -51,6 +52,8 @@
     - [Custody game updates](#custody-game-updates)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
+<!-- /TOC -->
+
 
 ## Introduction
 

diff --git a/specs/sharding/p2p-phase1.md b/specs/sharding/p2p-phase1.md
@@ -4,6 +4,7 @@
 
 ## Table of contents
 
+<!-- TOC -->
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
@@ -14,6 +15,8 @@
     - [Shard header: `shard_header`](#shard-header-shard_header)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
+<!-- /TOC -->
+
 
 ## Introduction