mirror of
https://github.com/status-im/nimbus-eth2.git
synced 2025-01-11 14:54:12 +00:00
a7a65bce42
* reorganize ssz dependencies This PR continues the work in https://github.com/status-im/nimbus-eth2/pull/2646, https://github.com/status-im/nimbus-eth2/pull/2779 as well as past issues with serialization and type, to disentangle SSZ from eth2 and at the same time simplify imports and exports with a structured approach. The principal idea here is that when a library wants to introduce SSZ support, they do so via 3 files: * `ssz_codecs` which imports and reexports `codecs` - this covers the basic byte conversions and ensures no overloads get lost * `xxx_merkleization` imports and exports `merkleization` to specialize and get access to `hash_tree_root` and friends * `xxx_ssz_serialization` imports and exports `ssz_serialization` to specialize ssz for a specific library Those that need to interact with SSZ always import the `xxx_` versions of the modules and never `ssz` itself so as to keep imports simple and safe. This is similar to how the REST / JSON-RPC serializers are structured in that someone wanting to serialize spec types to REST-JSON will import `eth2_rest_serialization` and nothing else. * split up ssz into a core library that is independendent of eth2 types * rename `bytes_reader` to `codec` to highlight that it contains coding and decoding of bytes and native ssz types * remove tricky List init overload that causes compile issues * get rid of top-level ssz import * reenable merkleization tests * move some "standard" json serializers to spec * remove `ValidatorIndex` serialization for now * remove test_ssz_merkleization * add tests for over/underlong byte sequences * fix broken seq[byte] test - seq[byte] is not an SSZ type There are a few things this PR doesn't solve: * like #2646 this PR is weak on how to handle root and other dontSerialize fields that "sometimes" should be computed - the same problem appears in REST / JSON-RPC etc * Fix a build problem on macOS * Another way to fix the macOS builds Co-authored-by: Zahary Karadjov <zahary@gmail.com>
133 lines
5.2 KiB
Nim
133 lines
5.2 KiB
Nim
# beacon_chain
|
|
# Copyright (c) 2020-Present Status Research & Development GmbH
|
|
# Licensed and distributed under either of
|
|
# * MIT license (license terms in the root directory or at https://opensource.org/licenses/MIT).
|
|
# * Apache v2 license (license terms in the root directory or at https://www.apache.org/licenses/LICENSE-2.0).
|
|
# at your option. This file may not be copied, modified, or distributed except according to those terms.
|
|
|
|
{.used.}
|
|
|
|
import
|
|
# Standard library
|
|
os,
|
|
# Utilities
|
|
stew/results,
|
|
# Beacon chain internals
|
|
../../beacon_chain/spec/datatypes/phase0,
|
|
../../beacon_chain/spec/[validator, helpers, state_transition_epoch],
|
|
# Test utilities
|
|
../testutil,
|
|
./fixtures_utils
|
|
|
|
const
|
|
RewardsDirBase = SszTestsDir/const_preset/"phase0"/"rewards"
|
|
RewardsDirBasic = RewardsDirBase/"basic"/"pyspec_tests"
|
|
RewardsDirLeak = RewardsDirBase/"leak"/"pyspec_tests"
|
|
RewardsDirRandom = RewardsDirBase/"random"/"pyspec_tests"
|
|
|
|
# https://github.com/ethereum/eth2.0-specs/tree/v1.0.1/tests/formats/rewards#rewards-tests
|
|
type Deltas = object
|
|
rewards: List[uint64, Limit VALIDATOR_REGISTRY_LIMIT]
|
|
penalties: List[uint64, Limit VALIDATOR_REGISTRY_LIMIT]
|
|
|
|
func add(v: var Deltas, idx: int, delta: RewardDelta) =
|
|
v.rewards[idx] += delta.rewards
|
|
v.penalties[idx] += delta.penalties
|
|
|
|
func init(T: type Deltas, len: int): T =
|
|
if not result.rewards.setLen(len):
|
|
raiseAssert "setLen"
|
|
if not result.penalties.setLen(len):
|
|
raiseAssert "setLen"
|
|
|
|
proc runTest(rewardsDir, identifier: string) =
|
|
# We wrap the tests in a proc to avoid running out of globals
|
|
# in the future: Nim supports up to 3500 globals
|
|
# but unittest with the macro/templates put everything as globals
|
|
# https://github.com/nim-lang/Nim/issues/12084#issue-486866402
|
|
let testDir = rewardsDir / identifier
|
|
|
|
proc `testImpl _ rewards _ identifier`() =
|
|
test "Rewards" & " - " & identifier & preset():
|
|
var
|
|
state = newClone(parseTest(testDir/"pre.ssz_snappy", SSZ, phase0.BeaconState))
|
|
cache = StateCache()
|
|
let
|
|
sourceDeltas =
|
|
parseTest(testDir/"source_deltas.ssz_snappy", SSZ, Deltas)
|
|
targetDeltas =
|
|
parseTest(testDir/"target_deltas.ssz_snappy", SSZ, Deltas)
|
|
headDeltas = parseTest(testDir/"head_deltas.ssz_snappy", SSZ, Deltas)
|
|
inclusionDelayDeltas =
|
|
parseTest(testDir/"inclusion_delay_deltas.ssz_snappy", SSZ, Deltas)
|
|
inactivityPenaltyDeltas =
|
|
parseTest(testDir/"inactivity_penalty_deltas.ssz_snappy", SSZ, Deltas)
|
|
|
|
var
|
|
rewards = RewardInfo()
|
|
finality_delay = (state[].get_previous_epoch() - state[].finalized_checkpoint.epoch)
|
|
|
|
rewards.init(state[])
|
|
rewards.process_attestations(state[], cache)
|
|
let
|
|
total_balance = rewards.total_balances.current_epoch
|
|
total_balance_sqrt = integer_squareroot(total_balance)
|
|
|
|
var
|
|
sourceDeltas2 = Deltas.init(state[].validators.len)
|
|
targetDeltas2 = Deltas.init(state[].validators.len)
|
|
headDeltas2 = Deltas.init(state[].validators.len)
|
|
inclusionDelayDeltas2 = Deltas.init(state[].validators.len)
|
|
inactivityPenaltyDeltas2 = Deltas.init(state[].validators.len)
|
|
|
|
for index, validator in rewards.statuses.mpairs():
|
|
if not is_eligible_validator(validator):
|
|
continue
|
|
|
|
let
|
|
base_reward = get_base_reward_sqrt(
|
|
state[], index.ValidatorIndex, total_balance_sqrt)
|
|
|
|
sourceDeltas2.add(index, get_source_delta(
|
|
validator, base_reward, rewards.total_balances, finality_delay))
|
|
targetDeltas2.add(index, get_target_delta(
|
|
validator, base_reward, rewards.total_balances, finality_delay))
|
|
headDeltas2.add(index, get_head_delta(
|
|
validator, base_reward, rewards.total_balances, finality_delay))
|
|
|
|
let
|
|
(inclusion_delay_delta, proposer_delta) =
|
|
get_inclusion_delay_delta(validator, base_reward)
|
|
inclusionDelayDeltas2.add(index, inclusion_delay_delta)
|
|
|
|
inactivityPenaltyDeltas2.add(index, get_inactivity_penalty_delta(
|
|
validator, base_reward, finality_delay))
|
|
|
|
if proposer_delta.isSome:
|
|
let proposer_index = proposer_delta.get()[0]
|
|
inclusionDelayDeltas2.add(proposer_index.int, proposer_delta.get()[1])
|
|
|
|
check:
|
|
sourceDeltas.rewards.asSeq == sourceDeltas2.rewards.asSeq
|
|
sourceDeltas.penalties.asSeq == sourceDeltas2.penalties.asSeq
|
|
|
|
targetDeltas.rewards.asSeq == targetDeltas2.rewards.asSeq
|
|
targetDeltas.penalties.asSeq == targetDeltas2.penalties.asSeq
|
|
|
|
headDeltas.rewards.asSeq == headDeltas2.rewards.asSeq
|
|
headDeltas.penalties.asSeq == headDeltas2.penalties.asSeq
|
|
|
|
inclusionDelayDeltas.rewards.asSeq == inclusionDelayDeltas2.rewards.asSeq
|
|
inclusionDelayDeltas.penalties.asSeq == inclusionDelayDeltas2.penalties.asSeq
|
|
|
|
inactivityPenaltyDeltas.rewards.asSeq == inactivityPenaltyDeltas2.rewards.asSeq
|
|
inactivityPenaltyDeltas.penalties.asSeq == inactivityPenaltyDeltas2.penalties.asSeq
|
|
|
|
|
|
`testImpl _ rewards _ identifier`()
|
|
|
|
suite "Official - Rewards " & preset():
|
|
for rewardsDir in [RewardsDirBasic, RewardsDirLeak, RewardsDirRandom]:
|
|
for kind, path in walkDir(rewardsDir, relative = true, checkDir = true):
|
|
runTest(rewardsDir, path)
|