131 lines
5.5 KiB
Nim
131 lines
5.5 KiB
Nim
# beacon_chain
|
|
# Copyright (c) 2018-2020 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
|
|
os, unittest, strutils, streams, strformat,
|
|
macros, sets,
|
|
# Third-party
|
|
yaml,
|
|
# Beacon chain internals
|
|
../../beacon_chain/spec/[crypto, datatypes, digest],
|
|
../../beacon_chain/ssz,
|
|
# Test utilities
|
|
../testreportutils, ./fixtures_utils
|
|
|
|
# SSZ tests of consensus objects (minimal/mainnet preset specific)
|
|
|
|
# Parsing definitions
|
|
# ----------------------------------------------------------------
|
|
|
|
const
|
|
SSZDir = SszTestsDir/const_preset/"phase0"/"ssz_static"
|
|
|
|
type
|
|
SSZHashTreeRoot = object
|
|
# The test files have the values at the "root"
|
|
# so we **must** use "root" as a field name
|
|
root: string
|
|
# Some have a signing_root field
|
|
signing_root: string
|
|
|
|
# Make signing root optional
|
|
setDefaultValue(SSZHashTreeRoot, signing_root, "")
|
|
|
|
# Note this only tracks HashTreeRoot
|
|
# Checking the values against the yaml file is TODO (require more flexible Yaml parser)
|
|
|
|
proc checkSSZ(T: type SignedBeaconBlock, dir: string, expectedHash: SSZHashTreeRoot) =
|
|
# Deserialize into a ref object to not fill Nim stack
|
|
let encoded = readFileBytes(dir/"serialized.ssz")
|
|
var deserialized = newClone(sszDecodeEntireInput(encoded, T))
|
|
|
|
# SignedBeaconBlocks usually not hashed because they're identified by
|
|
# htr(BeaconBlock), so do it manually
|
|
check: expectedHash.root == "0x" & toLowerASCII($hash_tree_root(
|
|
[hash_tree_root(deserialized.message),
|
|
hash_tree_root(deserialized.signature)]))
|
|
|
|
check deserialized.root == hash_tree_root(deserialized.message)
|
|
check SSZ.encode(deserialized[]) == encoded
|
|
check sszSize(deserialized[]) == encoded.len
|
|
|
|
# TODO check the value (requires YAML loader)
|
|
|
|
proc checkSSZ(T: type, dir: string, expectedHash: SSZHashTreeRoot) =
|
|
# Deserialize into a ref object to not fill Nim stack
|
|
let encoded = readFileBytes(dir/"serialized.ssz")
|
|
var deserialized = newClone(sszDecodeEntireInput(encoded, T))
|
|
|
|
check: expectedHash.root == "0x" & toLowerASCII($hash_tree_root(deserialized[]))
|
|
|
|
check SSZ.encode(deserialized[]) == encoded
|
|
check sszSize(deserialized[]) == encoded.len
|
|
|
|
# TODO check the value (requires YAML loader)
|
|
|
|
proc loadExpectedHashTreeRoot(dir: string): SSZHashTreeRoot =
|
|
var s = openFileStream(dir/"roots.yaml")
|
|
yaml.load(s, result)
|
|
s.close()
|
|
|
|
# Test runner
|
|
# ----------------------------------------------------------------
|
|
|
|
proc runSSZtests() =
|
|
doAssert existsDir(SSZDir), "You need to run the \"download_test_vectors.sh\" script to retrieve the official test vectors."
|
|
for pathKind, sszType in walkDir(SSZDir, relative = true):
|
|
doAssert pathKind == pcDir
|
|
|
|
timedTest &" Testing {sszType}":
|
|
let path = SSZDir/sszType
|
|
for pathKind, sszTestKind in walkDir(path, relative = true):
|
|
doAssert pathKind == pcDir
|
|
let path = SSZDir/sszType/sszTestKind
|
|
for pathKind, sszTestCase in walkDir(path, relative = true):
|
|
let path = SSZDir/sszType/sszTestKind/sszTestCase
|
|
let hash = loadExpectedHashTreeRoot(path)
|
|
|
|
case sszType:
|
|
of "AggregateAndProof": checkSSZ(AggregateAndProof, path, hash)
|
|
of "Attestation": checkSSZ(Attestation[Unchecked], path, hash)
|
|
of "AttestationData": checkSSZ(AttestationData, path, hash)
|
|
of "AttesterSlashing": checkSSZ(AttesterSlashing[Unchecked], path, hash)
|
|
of "BeaconBlock": checkSSZ(BeaconBlock[Unchecked], path, hash)
|
|
of "BeaconBlockBody": checkSSZ(BeaconBlockBody[Unchecked], path, hash)
|
|
of "BeaconBlockHeader": checkSSZ(BeaconBlockHeader, path, hash)
|
|
of "BeaconState": checkSSZ(BeaconState, path, hash)
|
|
of "Checkpoint": checkSSZ(Checkpoint, path, hash)
|
|
of "Deposit": checkSSZ(Deposit, path, hash)
|
|
of "DepositData": checkSSZ(DepositData, path, hash)
|
|
of "DepositMessage": checkSSZ(DepositMessage, path, hash)
|
|
of "Eth1Block": checkSSZ(Eth1Block, path, hash)
|
|
of "Eth1Data": checkSSZ(Eth1Data, path, hash)
|
|
of "Fork": checkSSZ(Fork, path, hash)
|
|
of "ForkData": checkSSZ(ForkData, path, hash)
|
|
of "HistoricalBatch": checkSSZ(HistoricalBatch, path, hash)
|
|
of "IndexedAttestation": checkSSZ(IndexedAttestation[Unchecked], path, hash)
|
|
of "PendingAttestation": checkSSZ(PendingAttestation, path, hash)
|
|
of "ProposerSlashing": checkSSZ(ProposerSlashing, path, hash)
|
|
of "SignedAggregateAndProof":
|
|
checkSSZ(SignedAggregateAndProof, path, hash)
|
|
of "SignedBeaconBlock": checkSSZ(SignedBeaconBlock[Unchecked], path, hash)
|
|
of "SignedBeaconBlockHeader":
|
|
checkSSZ(SignedBeaconBlockHeader, path, hash)
|
|
of "SignedVoluntaryExit": checkSSZ(SignedVoluntaryExit, path, hash)
|
|
of "SigningData":
|
|
checkSSZ(SigningData, path, hash)
|
|
of "Validator": checkSSZ(Validator, path, hash)
|
|
of "VoluntaryExit": checkSSZ(VoluntaryExit, path, hash)
|
|
else:
|
|
raise newException(ValueError, "Unsupported test: " & sszType)
|
|
|
|
suiteReport "Official - SSZ consensus objects " & preset():
|
|
runSSZtests()
|
|
|
|
summarizeLongTests("FixtureSSZConsensus")
|