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>
62 lines
2.2 KiB
Nim
62 lines
2.2 KiB
Nim
# beacon_chain
|
|
# Copyright (c) 2018-2021 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.
|
|
|
|
{.push raises: [Defect].}
|
|
|
|
import
|
|
std/[os, strformat],
|
|
chronicles,
|
|
./spec/[eth2_ssz_serialization, eth2_merkleization],
|
|
./spec/datatypes/[phase0, altair],
|
|
./consensus_object_pools/block_pools_types
|
|
|
|
# Dump errors are generally not fatal where used currently - the code calling
|
|
# these functions, like most code, is not exception safe
|
|
template logErrors(body: untyped) =
|
|
try:
|
|
body
|
|
except CatchableError as err:
|
|
notice "Failed to write SSZ", dir, msg = err.msg
|
|
|
|
proc dump*(dir: string, v: AttestationData, validator: ValidatorPubKey) =
|
|
logErrors:
|
|
SSZ.saveFile(dir / &"att-{v.slot}-{v.index}-{shortLog(validator)}.ssz", v)
|
|
|
|
proc dump*(dir: string, v: phase0.TrustedSignedBeaconBlock) =
|
|
logErrors:
|
|
SSZ.saveFile(dir / &"block-{v.message.slot}-{shortLog(v.root)}.ssz", v)
|
|
|
|
proc dump*(dir: string, v: altair.TrustedSignedBeaconBlock) =
|
|
logErrors:
|
|
SSZ.saveFile(dir / &"block-{v.message.slot}-{shortLog(v.root)}.ssz", v)
|
|
|
|
proc dump*(dir: string, v: phase0.SignedBeaconBlock) =
|
|
logErrors:
|
|
SSZ.saveFile(dir / &"block-{v.message.slot}-{shortLog(v.root)}.ssz", v)
|
|
|
|
proc dump*(dir: string, v: altair.SignedBeaconBlock) =
|
|
logErrors:
|
|
SSZ.saveFile(dir / &"block-{v.message.slot}-{shortLog(v.root)}.ssz", v)
|
|
|
|
proc dump*(dir: string, v: SomeHashedBeaconState, blck: BlockRef) =
|
|
mixin saveFile
|
|
logErrors:
|
|
SSZ.saveFile(
|
|
dir / &"state-{v.data.slot}-{shortLog(blck.root)}-{shortLog(v.root)}.ssz",
|
|
v.data)
|
|
|
|
proc dump*(dir: string, v: SomeHashedBeaconState) =
|
|
mixin saveFile
|
|
logErrors:
|
|
SSZ.saveFile(
|
|
dir / &"state-{v.data.slot}-{shortLog(v.root)}.ssz",
|
|
v.data)
|
|
|
|
proc dump*(dir: string, v: SyncCommitteeMessage, validator: ValidatorPubKey) =
|
|
logErrors:
|
|
SSZ.saveFile(dir / &"sync-committee-msg-{v.slot}-{shortLog(validator)}.ssz", v)
|