Merge pull request #1163 from ethereum/dev

Release v0.7.0 into master
ethereum · Jun 11, 2019 · 54c6b03 · 54c6b03
2 parents cb9301a + 577f76a
commit 54c6b03
Show file tree

Hide file tree

Showing 112 changed files with 6,053 additions and 3,447 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,7 +1,7 @@
 version: 2.1
 commands:
   restore_cached_venv:
-    description: "Restores a cached venv"
+    description: "Restore a cached venv"
     parameters:
       reqs_checksum:
         type: string
@@ -16,7 +16,7 @@ commands:
             # fallback to using the latest cache if no exact match is found
             - << parameters.venv_name >>-venv-
   save_cached_venv:
-    description: "Saves a venv into a cache"
+    description: "Save a venv into a cache"
     parameters:
       reqs_checksum:
         type: string
@@ -31,6 +31,32 @@ commands:
       - save_cache:
           key: << parameters.venv_name >>-venv-<< parameters.reqs_checksum >>
           paths: << parameters.venv_path >>
+  restore_pyspec_cached_venv:
+    description: "Restore the cache with pyspec keys"
+    steps:
+      - restore_cached_venv:
+          venv_name: v2-pyspec
+          reqs_checksum: cache-{{ checksum "test_libs/pyspec/requirements.txt" }}-{{ checksum "test_libs/pyspec/requirements-testing.txt" }}
+  save_pyspec_cached_venv:
+    description: Save a venv into a cache with pyspec keys"
+    steps:
+      - save_cached_venv:
+          venv_name: v2-pyspec
+          reqs_checksum: cache-{{ checksum "test_libs/pyspec/requirements.txt" }}-{{ checksum "test_libs/pyspec/requirements-testing.txt" }}
+          venv_path: ./test_libs/pyspec/venv
+  restore_deposit_contract_cached_venv:
+    description: "Restore the cache with deposit_contract keys"
+    steps:
+      - restore_cached_venv:
+          venv_name: v4-deposit-contract
+          reqs_checksum: cache-{{ checksum "test_libs/pyspec/requirements.txt" }}-{{ checksum "deposit_contract/requirements-testing.txt" }}
+  save_deposit_contract_cached_venv:
+    description: Save a venv into a cache with deposit_contract keys"
+    steps:
+      - save_cached_venv:
+          venv_name: v4-deposit-contract
+          reqs_checksum: cache-{{ checksum "test_libs/pyspec/requirements.txt" }}-{{ checksum "deposit_contract/requirements-testing.txt" }}
+          venv_path: ./deposit_contract/venv
 jobs:
   checkout_specs:
     docker:
@@ -52,46 +78,82 @@ jobs:
           key: v1-specs-repo-{{ .Branch }}-{{ .Revision }}
           paths:
             - ~/specs-repo
-  install_test:
+  install_pyspec_test:
     docker:
       - image: circleci/python:3.6
     working_directory: ~/specs-repo
     steps:
       - restore_cache:
           key: v1-specs-repo-{{ .Branch }}-{{ .Revision }}
-      - restore_cached_venv:
-          venv_name: v1-pyspec
-          reqs_checksum: '{{ checksum "test_libs/pyspec/requirements.txt" }}-{{ checksum "test_libs/pyspec/requirements-testing.txt" }}'
+      - restore_pyspec_cached_venv
       - run:
           name: Install pyspec requirements
           command: make install_test
-      - save_cached_venv:
-          venv_name: v1-pyspec
-          reqs_checksum: '{{ checksum "test_libs/pyspec/requirements.txt" }}-{{ checksum "test_libs/pyspec/requirements-testing.txt" }}'
-          venv_path: ./test_libs/pyspec/venv
+      - save_pyspec_cached_venv
   test:
     docker:
       - image: circleci/python:3.6
     working_directory: ~/specs-repo
     steps:
       - restore_cache:
           key: v1-specs-repo-{{ .Branch }}-{{ .Revision }}
-      - restore_cached_venv:
-          venv_name: v1-pyspec
-          reqs_checksum: '{{ checksum "test_libs/pyspec/requirements.txt" }}-{{ checksum "test_libs/pyspec/requirements-testing.txt" }}'
+      - restore_pyspec_cached_venv
       - run:
           name: Run py-tests
           command: make citest
       - store_test_results:
           path: test_libs/pyspec/test-reports
+  lint:
+    docker:
+      - image: circleci/python:3.6
+    working_directory: ~/specs-repo
+    steps:
+      - restore_cache:
+          key: v1-specs-repo-{{ .Branch }}-{{ .Revision }}
+      - restore_pyspec_cached_venv
+      - run:
+          name: Run linter
+          command: make lint
+  install_deposit_contract_test:
+    docker:
+      - image: circleci/python:3.6
+    working_directory: ~/specs-repo
+    steps:
+      - restore_cache:
+          key: v1-specs-repo-{{ .Branch }}-{{ .Revision }}
+      - restore_deposit_contract_cached_venv
+      - run:
+          name: Install deposit contract requirements
+          command: make install_deposit_contract_test
+      - save_deposit_contract_cached_venv
+  deposit_contract:
+    docker:
+      - image: circleci/python:3.6
+    working_directory: ~/specs-repo
+    steps:
+      - restore_cache:
+          key: v1-specs-repo-{{ .Branch }}-{{ .Revision }}
+      - restore_deposit_contract_cached_venv
+      - run:
+          name: Run deposit contract test
+          command: make test_deposit_contract
 workflows:
   version: 2.1
   test_spec:
     jobs:
       - checkout_specs
-      - install_test:
+      - install_pyspec_test:
           requires:
             - checkout_specs
       - test:
           requires:
-            - install_test
+            - install_pyspec_test
+      - lint:
+          requires:
+            - test
+      - install_deposit_contract_test:
+          requires:
+            - checkout_specs
+      - deposit_contract:
+          requires:
+            - install_deposit_contract_test
diff --git a/.gitignore b/.gitignore
@@ -13,3 +13,4 @@ eth2.0-spec-tests/
 
 # Dynamically built from Markdown spec
 test_libs/pyspec/eth2spec/phase0/spec.py
+test_libs/pyspec/eth2spec/phase1/spec.py
diff --git a/Makefile b/Makefile
@@ -4,6 +4,7 @@ TEST_LIBS_DIR = ./test_libs
 PY_SPEC_DIR = $(TEST_LIBS_DIR)/pyspec
 YAML_TEST_DIR = ./eth2.0-spec-tests/tests
 GENERATOR_DIR = ./test_generators
+DEPOSIT_CONTRACT_DIR = ./deposit_contract
 CONFIGS_DIR = ./configs
 
 # Collect a list of generator names
@@ -13,10 +14,15 @@ YAML_TEST_TARGETS = $(patsubst $(GENERATOR_DIR)/%, $(YAML_TEST_DIR)/%, $(GENERAT
 GENERATOR_VENVS = $(patsubst $(GENERATOR_DIR)/%, $(GENERATOR_DIR)/%venv, $(GENERATORS))
 
 PY_SPEC_PHASE_0_TARGETS = $(PY_SPEC_DIR)/eth2spec/phase0/spec.py
-PY_SPEC_ALL_TARGETS = $(PY_SPEC_PHASE_0_TARGETS)
+PY_SPEC_PHASE_0_DEPS = $(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
 
-.PHONY: clean all test citest gen_yaml_tests pyspec phase0 install_test
+PY_SPEC_ALL_TARGETS = $(PY_SPEC_PHASE_0_TARGETS) $(PY_SPEC_PHASE_1_TARGETS)
+
+
+.PHONY: clean all test citest lint gen_yaml_tests pyspec phase0 phase1 install_test install_deposit_contract_test test_deposit_contract compile_deposit_contract 
 
 all: $(PY_SPEC_ALL_TARGETS) $(YAML_TEST_DIR) $(YAML_TEST_TARGETS)
 
@@ -25,6 +31,7 @@ clean:
 	rm -rf $(GENERATOR_VENVS)
 	rm -rf $(PY_SPEC_DIR)/venv $(PY_SPEC_DIR)/.pytest_cache
 	rm -rf $(PY_SPEC_ALL_TARGETS)
+	rm -rf $(DEPOSIT_CONTRACT_DIR)/venv $(DEPOSIT_CONTRACT_DIR)/.pytest_cache
 
 # "make gen_yaml_tests" to run generators
 gen_yaml_tests: $(PY_SPEC_ALL_TARGETS) $(YAML_TEST_TARGETS)
@@ -37,18 +44,32 @@ test: $(PY_SPEC_ALL_TARGETS)
 	cd $(PY_SPEC_DIR); . venv/bin/activate; python -m pytest eth2spec
 
 citest: $(PY_SPEC_ALL_TARGETS)
-	cd $(PY_SPEC_DIR); mkdir -p test-reports/eth2spec; . venv/bin/activate; python -m pytest --junitxml=test-reports/eth2spec/test_results.xml .
+	cd $(PY_SPEC_DIR); mkdir -p test-reports/eth2spec; . venv/bin/activate;	\
+	python -m pytest --junitxml=test-reports/eth2spec/test_results_phase0.xml eth2spec
 
-# "make pyspec" to create the pyspec for all phases.
-pyspec: $(PY_SPEC_ALL_TARGETS)
+lint: $(PY_SPEC_ALL_TARGETS)
+	cd $(PY_SPEC_DIR); . venv/bin/activate; \
+	flake8  --ignore=E252,W504,W503 --max-line-length=120 ./eth2spec;
 
-# "make phase0" to create pyspec for phase0
-phase0: $(PY_SPEC_PHASE_0_TARGETS)
+install_deposit_contract_test: $(PY_SPEC_ALL_TARGETS)
+	cd $(DEPOSIT_CONTRACT_DIR); python3 -m venv venv; . venv/bin/activate; pip3 install -r requirements-testing.txt
 
+compile_deposit_contract:
+	cd $(DEPOSIT_CONTRACT_DIR); . venv/bin/activate; \
+	python tool/compile_deposit_contract.py contracts/validator_registration.v.py;
+
+test_deposit_contract:
+	cd $(DEPOSIT_CONTRACT_DIR); . venv/bin/activate; \
+	python -m pytest .
+
+# "make pyspec" to create the pyspec for all phases.
+pyspec: $(PY_SPEC_ALL_TARGETS)
 
-$(PY_SPEC_DIR)/eth2spec/phase0/spec.py:
-	python3 $(SCRIPT_DIR)/phase0/build_spec.py  $(SPEC_DIR)/core/0_beacon-chain.md $@
+$(PY_SPEC_PHASE_0_TARGETS): $(PY_SPEC_PHASE_0_DEPS)
+	python3 $(SCRIPT_DIR)/build_spec.py -p0 $(SPEC_DIR)/core/0_beacon-chain.md $@
 
+$(PY_SPEC_DIR)/eth2spec/phase1/spec.py: $(PY_SPEC_PHASE_1_DEPS)
+	python3 $(SCRIPT_DIR)/build_spec.py -p1 $(SPEC_DIR)/core/0_beacon-chain.md $(SPEC_DIR)/core/1_custody-game.md $(SPEC_DIR)/core/1_shard-data-chains.md $@
 
 CURRENT_DIR = ${CURDIR}
 

diff --git a/README.md b/README.md
@@ -2,20 +2,20 @@
 
 [![Join the chat at https://gitter.im/ethereum/sharding](https://badges.gitter.im/ethereum/sharding.svg)](https://gitter.im/ethereum/sharding?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-To learn more about sharding and eth2.0/Serenity, see the [sharding FAQ](https://github.com/ethereum/wiki/wiki/Sharding-FAQ) and the [research compendium](https://notes.ethereum.org/s/H1PGqDhpm).
+To learn more about sharding and Ethereum 2.0 (Serenity), see the [sharding FAQ](https://github.com/ethereum/wiki/wiki/Sharding-FAQ) and the [research compendium](https://notes.ethereum.org/s/H1PGqDhpm).
 
-This repo hosts the current eth2.0 specifications. Discussions about design rationale and proposed changes can be brought up and discussed as issues. Solidified, agreed upon changes to spec can be made through pull requests.
+This repository hosts the current Eth 2.0 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 eth2.0 client validation can be found in [specs/core](specs/core). These are divided into phases. Each subsequent phase depends upon the prior. The current phases specified are:
+Core specifications for Eth 2.0 client validation can be found in [specs/core](specs/core). These are divided into phases. Each subsequent phase depends upon the prior. The current phases specified are:
 
 ### Phase 0
 * [The Beacon Chain](specs/core/0_beacon-chain.md)
 * [Fork Choice](specs/core/0_fork-choice.md)
 * [Deposit Contract](specs/core/0_deposit-contract.md)
-* [Honest validator implementation doc](specs/validator/0_beacon-chain-validator.md)
+* [Honest Validator](specs/validator/0_beacon-chain-validator.md)
 
 ### Phase 1
 * [Custody Game](specs/core/1_custody-game.md)
@@ -28,9 +28,10 @@ Core specifications for eth2.0 client validation can be found in [specs/core](sp
 * [General test format](specs/test_formats/README.md)
 * [Merkle proof formats](specs/light_client/merkle_proofs.md)
 * [Light client syncing protocol](specs/light_client/sync_protocol.md)
+* [Beacon node API for validator](specs/validator/0_beacon-node-validator-api.md)
 
 
-### Design goals
+## Design goals
 
 The following are the broad design goals for Ethereum 2.0:
 * to minimize complexity, even at the cost of some losses in efficiency

diff --git a/configs/constant_presets/README.md b/configs/constant_presets/README.md
@@ -10,11 +10,11 @@ Later-fork constants can be ignored, e.g. ignore phase1 constants as a client th
 Each preset is a key-value mapping.
 
 **Key**: an `UPPER_SNAKE_CASE` (a.k.a. "macro case") formatted string, name of the constant.
-**Value**: can be any of:
+
+**Value** can be either:
  - an unsigned integer number, can be up to 64 bits (incl.)
  - a hexadecimal string, prefixed with `0x`
 
 Presets may contain comments to describe the values.
 
-See `mainnet.yaml` for a complete example.
-
+See [`mainnet.yaml`](./mainnet.yaml) for a complete example.
diff --git a/configs/constant_presets/mainnet.yaml b/configs/constant_presets/mainnet.yaml
@@ -48,7 +48,7 @@ GENESIS_FORK_VERSION: 0x00000000
 GENESIS_SLOT: 0
 # 2**64 - 1
 FAR_FUTURE_EPOCH: 18446744073709551615
-BLS_WITHDRAWAL_PREFIX_BYTE: 0x00
+BLS_WITHDRAWAL_PREFIX: 0
 
 
 # Time parameters
@@ -72,7 +72,7 @@ MIN_VALIDATOR_WITHDRAWABILITY_DELAY: 256
 # 2**11 (= 2,048) epochs 9 days
 PERSISTENT_COMMITTEE_PERIOD: 2048
 # 2**6 (= 64) epochs ~7 hours
-MAX_CROSSLINK_EPOCHS: 64
+MAX_EPOCHS_PER_CROSSLINK: 64
 # 2**2 (= 4) epochs 25.6 minutes
 MIN_EPOCHS_TO_INACTIVITY_PENALTY: 4
 
@@ -90,7 +90,7 @@ LATEST_SLASHED_EXIT_LENGTH: 8192
 # Reward and penalty quotients
 # ---------------------------------------------------------------
 # 2**5 (= 32)
-BASE_REWARD_QUOTIENT: 32
+BASE_REWARD_FACTOR: 32
 # 2**9 (= 512)
 WHISTLEBLOWING_REWARD_QUOTIENT: 512
 # 2**3 (= 8)
@@ -124,4 +124,4 @@ DOMAIN_RANDAO: 1
 DOMAIN_ATTESTATION: 2
 DOMAIN_DEPOSIT: 3
 DOMAIN_VOLUNTARY_EXIT: 4
-DOMAIN_TRANSFER: 5
+DOMAIN_TRANSFER: 5
diff --git a/configs/constant_presets/minimal.yaml b/configs/constant_presets/minimal.yaml
@@ -47,7 +47,7 @@ GENESIS_FORK_VERSION: 0x00000000
 GENESIS_SLOT: 0
 # 2**64 - 1
 FAR_FUTURE_EPOCH: 18446744073709551615
-BLS_WITHDRAWAL_PREFIX_BYTE: 0x00
+BLS_WITHDRAWAL_PREFIX: 0
 
 
 # Time parameters
@@ -58,22 +58,24 @@ SECONDS_PER_SLOT: 6
 MIN_ATTESTATION_INCLUSION_DELAY: 2
 # [customized] fast epochs
 SLOTS_PER_EPOCH: 8
-# 2**0 (= 1) epochs 6.4 minutes
+# 2**0 (= 1) epochs
 MIN_SEED_LOOKAHEAD: 1
-# 2**2 (= 4) epochs 25.6 minutes
+# 2**2 (= 4) epochs
 ACTIVATION_EXIT_DELAY: 4
 # [customized] higher frequency new deposits from eth1 for testing
 SLOTS_PER_ETH1_VOTING_PERIOD: 16
 # [customized] smaller state
 SLOTS_PER_HISTORICAL_ROOT: 64
-# 2**8 (= 256) epochs ~27 hours
+# 2**8 (= 256) epochs
 MIN_VALIDATOR_WITHDRAWABILITY_DELAY: 256
-# 2**11 (= 2,048) epochs 9 days
+# 2**11 (= 2,048) epochs
 PERSISTENT_COMMITTEE_PERIOD: 2048
-# 2**6 (= 64) epochs ~7 hours
-MAX_CROSSLINK_EPOCHS: 64
-# 2**2 (= 4) epochs 25.6 minutes
+# 2**6 (= 64) epochs
+MAX_EPOCHS_PER_CROSSLINK: 64
+# 2**2 (= 4) epochs
 MIN_EPOCHS_TO_INACTIVITY_PENALTY: 4
+# [customized] 2**12 (= 4,096) epochs
+EARLY_DERIVED_SECRET_PENALTY_MAX_FUTURE_EPOCHS: 4096
 
 
 # State list lengths
@@ -89,7 +91,7 @@ LATEST_SLASHED_EXIT_LENGTH: 64
 # Reward and penalty quotients
 # ---------------------------------------------------------------
 # 2**5 (= 32)
-BASE_REWARD_QUOTIENT: 32
+BASE_REWARD_FACTOR: 32
 # 2**9 (= 512)
 WHISTLEBLOWING_REWARD_QUOTIENT: 512
 # 2**3 (= 8)
@@ -123,4 +125,4 @@ DOMAIN_RANDAO: 1
 DOMAIN_ATTESTATION: 2
 DOMAIN_DEPOSIT: 3
 DOMAIN_VOLUNTARY_EXIT: 4
-DOMAIN_TRANSFER: 5
+DOMAIN_TRANSFER: 5
diff --git a/configs/fork_timelines/README.md b/configs/fork_timelines/README.md
@@ -3,16 +3,17 @@
 This directory contains a set of fork timelines used for testing, testnets, and mainnet.
 
 A timeline file contains all the forks known for its target.
-Later forks can be ignored, e.g. ignore fork `phase1` as a client that only supports phase 0 currently.
+Later forks can be ignored, e.g. ignore fork `phase1` as a client that only supports Phase 0 currently.
 
 ## Format
 
 Each preset is a key-value mapping.
 
 **Key**: an `lower_snake_case` (a.k.a. "python case") formatted string, name of the fork.
-**Value**: an unsigned integer number, epoch number of activation of the fork
+
+**Value**: an unsigned integer number, epoch number of activation of the fork.
 
 Timelines may contain comments to describe the values.
 
-See `mainnet.yaml` for a complete example.
+See [`mainnet.yaml`](./mainnet.yaml) for a complete example.
 
diff --git a/configs/fork_timelines/mainnet.yaml b/configs/fork_timelines/mainnet.yaml
@@ -7,6 +7,6 @@ phase0: 67108864
 # phase0_funny_fork_name: 67116000
 
 # Example 2:
-# Should be equal to PHASE_1_GENESIS_EPOCH
+# Should be equal to PHASE_1_FORK_EPOCH
 # (placeholder in example value here)
 # phase1: 67163000
Original file line number	Diff line number	Diff line change
Expand Up		@@ -13,3 +13,4 @@ eth2.0-spec-tests/

		# Dynamically built from Markdown spec
		test_libs/pyspec/eth2spec/phase0/spec.py
		test_libs/pyspec/eth2spec/phase1/spec.py