Unify structure with rest of ethereum repos (ethereum#2)

* Migrate consensus specs from a submodule to the pypi eth2specs

* Move from install script to Makefile & add linting

Author: CarlBeek

Makefile

@@ -0,0 +1,32 @@
+VENV_NAME?=venv
+VENV_ACTIVATE=. $(VENV_NAME)/bin/activate
+
+help:
+	@echo "Makefile help. Your options are:"
+	@echo "clean - remove build and Python file artifacts"
+	@echo "install - install basic dependencies with venv"
+	@echo "venv_lint - check style with flake8 and mypy with venv"
+	@echo "venv_test - run tests with venv"
+
+clean:
+	rm -rf $(VENV_NAME)
+	rm -rf *.egg-info
+	find . -name __pycache__ -exec rm -rf {} \;
+	find . -name .mypy_cache -exec rm -rf {} \;
+
+install:
+	python3 -m venv $(VENV_NAME);
+	$(VENV_ACTIVATE)
+	${VENV_NAME}/bin/python -m pip install -r requirements.txt
+	${VENV_NAME}/bin/python -m pip install .
+	@touch $(VENV_NAME)/bin/activate
+
+venv_activate:
+	$(VENV_ACTIVATE)
+
+venv_lint: venv_activate
+	flake8 --config=flake8.ini ./src ./tests && mypy --config-file mypy.ini ./src ./tests
+
+venv_test: venv_activate
+	@echo "TODO: implement tests"
+

consensus-specs

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length= 120

flake8.ini

@@ -0,0 +1,12 @@
+[mypy]
+warn_unused_ignores = True
+ignore_missing_imports = True
+strict_optional = False
+check_untyped_defs = True
+disallow_incomplete_defs = True
+disallow_untyped_defs = True
+disallow_any_generics = True
+disallow_untyped_calls = True
+warn_redundant_casts = True
+warn_unused_configs = True
+strict_equality = True

install.sh

@@ -0,0 +1,6 @@
+# execution requirements
+eth2spec==1.1.2
+
+# dev requirements
+mypy
+flake8

mypy.ini

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 
-from setuptools import setup, find_packages
+from setuptools import find_packages, setup
 
 setup(name='dvspec',
       version='0.1',

requirements.txt

@@ -1,21 +1,25 @@
 from dvspec.eth_node_interface import (
-    AttestationDuty, ProposerDuty,
-    AttestationData, BeaconBlock,
+    AttestationData,
+    AttestationDuty,
+    BeaconBlock,
+    ProposerDuty,
     vc_is_slashable_attestation_data,
-    vc_is_slashable_block,
+    vc_is_slashable_block
 )
 
-
 """
 Consensus Specification
 """
 
+
 def consensus_is_valid_attestation_data(attestation_data: AttestationData, attestation_duty: AttestationDuty) -> bool:
     """Determines if the given attestation is valid for the attestation duty.
     """
     assert attestation_data.slot == attestation_duty.slot
     assert attestation_data.committee_index == attestation_duty.committee_index
     assert not vc_is_slashable_attestation_data(attestation_data, attestation_duty.pubkey)
+    return True
+
 
 def consensus_on_attestation(attestation_duty: AttestationDuty) -> AttestationData:
     """Consensus protocol between distributed validator nodes for attestation values.
@@ -25,12 +29,15 @@ def consensus_on_attestation(attestation_duty: AttestationDuty) -> AttestationDa
     """
     pass
 
+
 def consensus_is_valid_block(block: BeaconBlock, proposer_duty: ProposerDuty) -> bool:
     """Determines if the given block is valid for the proposer duty.
     """
     assert block.slot == proposer_duty.slot
     # TODO: Assert correct block.proposer_index
     assert not vc_is_slashable_block(block, proposer_duty.pubkey)
+    return True
+
 
 def consensus_on_block(proposer_duty: ProposerDuty) -> AttestationData:
     """Consensus protocol between distributed validator nodes for block values.

setup.py

@@ -1,22 +1,30 @@
 from typing import List
 from eth2spec.phase0.mainnet import (
-    Container, SignedBeaconBlock, uint64, Bytes32,
-    BLSPubkey, BLSSignature,
-    Slot, Epoch,
-    ValidatorIndex, CommitteeIndex,
-    AttestationData, Attestation,
-    BeaconBlock, SignedBeaconBlock,
+    Attestation,
+    AttestationData,
+    BeaconBlock,
+    BLSPubkey,
+    BLSSignature,
+    Bytes32,
+    CommitteeIndex,
+    Container,
+    Epoch,
+    SignedBeaconBlock,
+    Slot,
+    uint64,
+    ValidatorIndex,
 )
 
+
 class AttestationDuty(Container):
     pubkey: BLSPubkey
     validator_index: ValidatorIndex
     committee_index: CommitteeIndex
     committee_length: uint64
     committees_at_slot: uint64
-    validator_committee_index: ValidatorIndex # TODO: Is this the correct datatype?
+    validator_committee_index: ValidatorIndex  # TODO: Is this the correct datatype?
     slot: Slot
-    validator_index: ValidatorIndex
+
 
 class ProposerDuty(Container):
     pubkey: BLSPubkey
@@ -34,30 +42,35 @@ def bn_get_attestation_duties_for_epoch(validator_indices: List[ValidatorIndex],
     """
     pass
 
+
 def bn_get_attestation_data(slot: Slot, committee_index: CommitteeIndex) -> AttestationData:
     """Produces attestation data for the given slot & committee index.
     Uses https://ethereum.github.io/beacon-APIs/#/ValidatorRequiredApi/produceAttestationData
     """
     pass
 
+
 def bn_submit_attestation(attestation: Attestation) -> None:
     """Submit attestation to BN for Ethereum p2p gossip.
     Uses https://ethereum.github.io/beacon-APIs/#/Beacon/submitPoolAttestations
     """
     pass
 
+
 def bn_get_proposer_duties_for_epoch(epoch: Epoch) -> List[ProposerDuty]:
     """Fetch proposer duties for all proposers in the epoch.
     Uses https://ethereum.github.io/beacon-APIs/#/ValidatorRequiredApi/getProposerDuties
     """
     pass
 
+
 def bn_produce_block(slot: Slot, randao_reveal: BLSSignature, graffiti: Bytes32) -> BeaconBlock:
     """Produces valid block for given slot using provided data
     Uses https://ethereum.github.io/beacon-APIs/#/ValidatorRequiredApi/produceBlockV2
     """
     pass
 
+
 def bn_submit_block(block: SignedBeaconBlock) -> None:
     """Submit block to BN for Ethereum p2p gossip.
     Uses https://ethereum.github.io/beacon-APIs/#/ValidatorRequiredApi/publishBlock
@@ -73,20 +86,23 @@ def vc_is_slashable_attestation_data(attestation_data: AttestationData, validato
     """
     pass
 
+
 def vc_sign_attestation(attestation_data: AttestationData, attestation_duty: AttestationDuty) -> Attestation:
     """Returns a signed attestations that is constructed using the given attestation data & attestation duty.
     This endpoint does not exist in beacon-APIs.
     """
-    # See note about attestation construction here: 
+    # See note about attestation construction here:
     # https://github.com/ethereum/beacon-APIs/blame/05c1bc142e1a3fb2a63c79098743776241341d08/validator-flow.md#L35-L37
     pass
 
+
 def vc_is_slashable_block(block: BeaconBlock, validator_pubkey: BLSPubkey) -> bool:
     """Checks whether the block is slashable according to the anti-slashing database.
     This endpoint does not exist in beacon-APIs.
     """
     pass
 
+
 def vc_sign_block(block: BeaconBlock, proposer_duty: ProposerDuty) -> SignedBeaconBlock:
     """Returns a signed beacon block using the validator index given in the proposer duty.
     This endpoint does not exist in beacon-APIs.

src/dvspec/consensus.py

@@ -1,40 +1,44 @@
 from typing import List
-from eth2spec.phase0.mainnet import (
-    Attestation,
-    SignedBeaconBlock,
-)
+
+from eth2spec.phase0.mainnet import Attestation, SignedBeaconBlock
 
 """
 Networking Specification
 """
 
+
 def broadcast_threshold_signed_attestation(threshold_signed_attestation: Attestation) -> None:
     """Broadcasts a threshold signed attestation among DV peer nodes.
     """
     pass
 
+
 def listen_for_threshold_signed_attestations() -> List[Attestation]:
     """Returns a list of any threshold signed attestations that can be combined to construct
     a complete signed attestation.
     """
     pass
 
+
 def construct_signed_attestation(threshold_signed_attestations: List[Attestation]) -> Attestation:
     """Broadcasts a threshold signed attestation among DV peer nodes.
     """
     pass
 
+
 def broadcast_threshold_signed_block(threshold_signed_block: SignedBeaconBlock) -> None:
     """Broadcasts a threshold signed beacon block among DV peer nodes.
     """
     pass
 
+
 def listen_for_threshold_signed_blocks() -> List[SignedBeaconBlock]:
     """Returns a list of any threshold signed blocks that can be combined to construct
     a complete signed block.
     """
     pass
 
+
 def construct_signed_block(threshold_signed_blocks: List[SignedBeaconBlock]) -> SignedBeaconBlock:
     """Broadcasts a threshold signed beacon block among DV peer nodes.
     """