backport v093 to dev

.circleci/config.yml

@@ -103,6 +103,15 @@ jobs:
           command: make citest
       - store_test_results:
           path: test_libs/pyspec/test-reports
+  table_of_contents:
+    docker:
+      - image: circleci/node:10.16.3
+    working_directory: ~/specs-repo
+    steps:
+      - checkout
+      - run:
+          name: Check table of contents
+          command: sudo npm install -g doctoc && make check_toc
   lint:
     docker:
       - image: circleci/python:3.6
@@ -148,6 +157,7 @@ workflows:
       - test:
           requires:
             - install_pyspec_test
+      - table_of_contents
       - lint:
           requires:
             - test

Makefile

@@ -17,18 +17,22 @@ GENERATOR_VENVS = $(patsubst $(GENERATOR_DIR)/%, $(GENERATOR_DIR)/%venv, $(GENER
 #$(info $$GENERATOR_TARGETS is [${GENERATOR_TARGETS}])
 
 PY_SPEC_PHASE_0_TARGETS = $(PY_SPEC_DIR)/eth2spec/phase0/spec.py
-PY_SPEC_PHASE_0_DEPS = $(SPEC_DIR)/core/0_*.md
+PY_SPEC_PHASE_0_DEPS = $(wildcard $(SPEC_DIR)/core/0_*.md)
 
 PY_SPEC_PHASE_1_TARGETS = $(PY_SPEC_DIR)/eth2spec/phase1/spec.py
-PY_SPEC_PHASE_1_DEPS = $(SPEC_DIR)/core/1_*.md
+PY_SPEC_PHASE_1_DEPS = $(wildcard $(SPEC_DIR)/core/1_*.md)
+
+PY_SPEC_ALL_DEPS = $(PY_SPEC_PHASE_0_DEPS) $(PY_SPEC_PHASE_1_DEPS)
 
 PY_SPEC_ALL_TARGETS = $(PY_SPEC_PHASE_0_TARGETS) $(PY_SPEC_PHASE_1_TARGETS)
 
+MARKDOWN_FILES = $(PY_SPEC_ALL_DEPS) $(wildcard $(SPEC_DIR)/*.md) $(wildcard $(SPEC_DIR)/light_client/*.md) $(wildcard $(SPEC_DIR)/networking/*.md) $(wildcard $(SPEC_DIR)/validator/*.md)
+
 COV_HTML_OUT=.htmlcov
 COV_INDEX_FILE=$(PY_SPEC_DIR)/$(COV_HTML_OUT)/index.html
 
 .PHONY: clean partial_clean all test citest lint generate_tests pyspec phase0 phase1 install_test open_cov \
-        install_deposit_contract_test test_deposit_contract compile_deposit_contract
+        install_deposit_contract_test test_deposit_contract compile_deposit_contract check_toc
 
 all: $(PY_SPEC_ALL_TARGETS)
 
@@ -65,6 +69,14 @@ citest: $(PY_SPEC_ALL_TARGETS)
 open_cov:
 	((open "$(COV_INDEX_FILE)" || xdg-open "$(COV_INDEX_FILE)") &> /dev/null) &
 
+check_toc: $(MARKDOWN_FILES:=.toc)
+
+%.toc:
+	cp $* $*.tmp && \
+	doctoc $* && \
+	diff -q $* $*.tmp && \
+	rm $*.tmp
+
 lint: $(PY_SPEC_ALL_TARGETS)
 	cd $(PY_SPEC_DIR); . venv/bin/activate; \
 	flake8  --ignore=E252,W504,W503 --max-line-length=120 ./eth2spec \

scripts/build_spec.py

@@ -82,7 +82,7 @@ def get_eth1_data(distance: uint64) -> Bytes32:
     return hash(distance)
 
 
-def hash(x: bytes) -> Bytes32:
+def hash(x: bytes) -> Bytes32:  # type: ignore
     if x not in hash_cache:
         hash_cache[x] = Bytes32(_hash(x))
     return hash_cache[x]

specs/bls_signature.md

@@ -6,23 +6,25 @@
 
 ## Table of contents
 <!-- TOC -->
-
-- [BLS signature verification](#bls-signature-verification)
-    - [Table of contents](#table-of-contents)
-    - [Curve parameters](#curve-parameters)
-    - [Point representations](#point-representations)
-        - [G1 points](#g1-points)
-        - [G2 points](#g2-points)
-    - [Helpers](#helpers)
-        - [`hash_to_G2`](#hash_to_g2)
-        - [`modular_squareroot`](#modular_squareroot)
-    - [Aggregation operations](#aggregation-operations)
-        - [`bls_aggregate_pubkeys`](#bls_aggregate_pubkeys)
-        - [`bls_aggregate_signatures`](#bls_aggregate_signatures)
-    - [Signature verification](#signature-verification)
-        - [`bls_verify`](#bls_verify)
-        - [`bls_verify_multiple`](#bls_verify_multiple)
-
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+
+- [Curve parameters](#curve-parameters)
+- [Point representations](#point-representations)
+  - [G1 points](#g1-points)
+  - [G2 points](#g2-points)
+- [Helpers](#helpers)
+  - [`hash_to_G2`](#hash_to_g2)
+  - [`modular_squareroot`](#modular_squareroot)
+- [Aggregation operations](#aggregation-operations)
+  - [`bls_aggregate_pubkeys`](#bls_aggregate_pubkeys)
+  - [`bls_aggregate_signatures`](#bls_aggregate_signatures)
+- [Signature verification](#signature-verification)
+  - [`bls_verify`](#bls_verify)
+  - [`bls_verify_multiple`](#bls_verify_multiple)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
 <!-- /TOC -->
 
 ## Curve parameters