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>
90 lines
2.9 KiB
Nim
90 lines
2.9 KiB
Nim
# beacon_chain
|
|
# Copyright (c) 2018-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.
|
|
|
|
import
|
|
# Standard library
|
|
std/[os, strutils, typetraits],
|
|
# Internals
|
|
../../beacon_chain/spec/datatypes/[phase0, altair],
|
|
../../beacon_chain/spec/[
|
|
eth2_merkleization, eth2_ssz_serialization, state_transition_epoch],
|
|
# Status libs,
|
|
snappy,
|
|
stew/byteutils
|
|
|
|
export
|
|
eth2_merkleization, eth2_ssz_serialization
|
|
|
|
# Process current EF test format
|
|
# ---------------------------------------------
|
|
|
|
# #######################
|
|
# JSON deserialization
|
|
|
|
func readValue*(r: var JsonReader, a: var seq[byte]) =
|
|
## Custom deserializer for seq[byte]
|
|
a = hexToSeqByte(r.readValue(string))
|
|
|
|
# #######################
|
|
# Test helpers
|
|
|
|
type
|
|
UnconsumedInput* = object of CatchableError
|
|
TestSizeError* = object of ValueError
|
|
|
|
const
|
|
FixturesDir* =
|
|
currentSourcePath.rsplit(DirSep, 1)[0] / ".." / ".." / "vendor" / "nim-eth2-scenarios"
|
|
SszTestsDir* = FixturesDir / "tests-v1.1.0-beta.2"
|
|
MaxObjectSize* = 3_000_000
|
|
|
|
proc parseTest*(path: string, Format: typedesc[Json], T: typedesc): T =
|
|
try:
|
|
# debugEcho " [Debug] Loading file: \"", path, '\"'
|
|
result = Format.loadFile(path, T)
|
|
except SerializationError as err:
|
|
writeStackTrace()
|
|
stderr.write $Format & " load issue for file \"", path, "\"\n"
|
|
stderr.write err.formatMsg(path), "\n"
|
|
quit 1
|
|
|
|
template readFileBytes*(path: string): seq[byte] =
|
|
cast[seq[byte]](readFile(path))
|
|
|
|
proc sszDecodeEntireInput*(input: openArray[byte], Decoded: type): Decoded =
|
|
var stream = unsafeMemoryInput(input)
|
|
var reader = init(SszReader, stream)
|
|
reader.readValue(result)
|
|
|
|
if stream.readable:
|
|
raise newException(UnconsumedInput, "Remaining bytes in the input")
|
|
|
|
proc parseTest*(path: string, Format: typedesc[SSZ], T: typedesc): T =
|
|
try:
|
|
# debugEcho " [Debug] Loading file: \"", path, '\"'
|
|
sszDecodeEntireInput(snappy.decode(readFileBytes(path), MaxObjectSize), T)
|
|
except SerializationError as err:
|
|
writeStackTrace()
|
|
stderr.write $Format & " load issue for file \"", path, "\"\n"
|
|
stderr.write err.formatMsg(path), "\n"
|
|
quit 1
|
|
|
|
proc process_justification_and_finalization*(state: var phase0.BeaconState) =
|
|
var cache = StateCache()
|
|
|
|
var rewards: RewardInfo
|
|
rewards.init(state)
|
|
rewards.process_attestations(state, cache)
|
|
process_justification_and_finalization(state, rewards.total_balances)
|
|
|
|
func process_slashings*(state: var phase0.BeaconState) =
|
|
var cache = StateCache()
|
|
var rewards: RewardInfo
|
|
rewards.init(state)
|
|
rewards.process_attestations(state, cache)
|
|
process_slashings(state, rewards.total_balances.current_epoch)
|