Add some config invariant checks

This commit is contained in:
Hsiao-Wei Wang
2021-05-26 00:13:33 +08:00
parent fa3e017b65
commit 69f2a31406
7 changed files with 72 additions and 20 deletions

View File

@@ -297,14 +297,6 @@ class SpecBuilder(ABC):
"""
raise NotImplementedError()
@classmethod
@abstractmethod
def invariant_checks(cls) -> str:
"""
The invariant checks
"""
raise NotImplementedError()
@classmethod
@abstractmethod
def build_spec(cls, preset_name: str,
@@ -425,10 +417,6 @@ get_attesting_indices = cache_this(
def hardcoded_custom_type_dep_constants(cls) -> Dict[str, str]:
return {}
@classmethod
def invariant_checks(cls) -> str:
return ''
@classmethod
def build_spec(cls, preset_name: str,
source_files: Sequence[Path], preset_files: Sequence[Path], config_file: Path) -> str:
@@ -475,13 +463,6 @@ def get_generalized_index(ssz_class: Any, *path: Sequence[Union[int, SSZVariable
}
return {**super().hardcoded_ssz_dep_constants(), **constants}
@classmethod
def invariant_checks(cls) -> str:
return '''
assert (
TIMELY_HEAD_WEIGHT + TIMELY_SOURCE_WEIGHT + TIMELY_TARGET_WEIGHT + SYNC_REWARD_WEIGHT + PROPOSER_WEIGHT
) == WEIGHT_DENOMINATOR'''
#
# MergeSpecBuilder
@@ -647,7 +628,6 @@ def objects_to_spec(preset_name: str,
# Since some constants are hardcoded in setup.py, the following assertions verify that the hardcoded constants are
# as same as the spec definition.
+ ('\n\n\n' + ssz_dep_constants_verification if ssz_dep_constants_verification != '' else '')
+ ('\n' + builder.invariant_checks() if builder.invariant_checks() != '' else '')
+ '\n'
)
return spec

View File

@@ -0,0 +1,17 @@
from eth2spec.test.context import (
spec_state_test,
with_phases,
)
from eth2spec.test.helpers.constants import ALTAIR
@with_phases([ALTAIR])
@spec_state_test
def test_weight_denominator(spec, state):
assert (
spec.TIMELY_HEAD_WEIGHT
+ spec.TIMELY_SOURCE_WEIGHT
+ spec.TIMELY_TARGET_WEIGHT
+ spec.SYNC_REWARD_WEIGHT
+ spec.PROPOSER_WEIGHT
) == spec.WEIGHT_DENOMINATOR

View File

@@ -32,3 +32,9 @@ MAINNET = PresetBaseName('mainnet')
MINIMAL = PresetBaseName('minimal')
ALL_PRESETS = (MINIMAL, MAINNET)
#
# Number
#
MAX_UINT_64 = 2**64 - 1

View File

@@ -0,0 +1,49 @@
from eth2spec.test.context import (
spec_state_test,
with_all_phases,
is_post_altair,
)
from eth2spec.test.helpers.constants import MAX_UINT_64
def check_bound(value, lower_bound, upper_bound):
assert value >= lower_bound
assert value <= upper_bound
@with_all_phases
@spec_state_test
def test_validators(spec, state):
check_bound(spec.VALIDATOR_REGISTRY_LIMIT, 1, MAX_UINT_64)
check_bound(spec.MAX_COMMITTEES_PER_SLOT, 1, MAX_UINT_64)
check_bound(spec.TARGET_COMMITTEE_SIZE, 1, MAX_UINT_64)
check_bound(spec.MAX_VALIDATORS_PER_COMMITTEE, 1, spec.VALIDATOR_REGISTRY_LIMIT)
check_bound(spec.config.MIN_PER_EPOCH_CHURN_LIMIT, 1, spec.VALIDATOR_REGISTRY_LIMIT)
check_bound(spec.config.CHURN_LIMIT_QUOTIENT, 1, spec.VALIDATOR_REGISTRY_LIMIT)
check_bound(spec.config.MIN_GENESIS_ACTIVE_VALIDATOR_COUNT, spec.TARGET_COMMITTEE_SIZE, MAX_UINT_64)
@with_all_phases
@spec_state_test
def test_hysteresis_quotient(spec, state):
check_bound(spec.HYSTERESIS_QUOTIENT, 1, MAX_UINT_64)
check_bound(spec.HYSTERESIS_DOWNWARD_MULTIPLIER, 1, spec.HYSTERESIS_QUOTIENT)
check_bound(spec.HYSTERESIS_UPWARD_MULTIPLIER, spec.HYSTERESIS_QUOTIENT, MAX_UINT_64)
@with_all_phases
@spec_state_test
def test_incentives(spec, state):
# Ensure no ETH is minted in slash_validator
if is_post_altair(spec):
assert spec.MIN_SLASHING_PENALTY_QUOTIENT_ALTAIR <= spec.WHISTLEBLOWER_REWARD_QUOTIENT
else:
assert spec.MIN_SLASHING_PENALTY_QUOTIENT <= spec.WHISTLEBLOWER_REWARD_QUOTIENT
@with_all_phases
@spec_state_test
def test_time(spec, state):
assert spec.SLOTS_PER_EPOCH <= spec.SLOTS_PER_HISTORICAL_ROOT