365 lines
12 KiB
Nim
365 lines
12 KiB
Nim
# Nimbus
|
|
# Copyright (c) 2018-2019 Status Research & Development GmbH
|
|
# Licensed under either of
|
|
# * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
|
|
# http://www.apache.org/licenses/LICENSE-2.0)
|
|
# * MIT license ([LICENSE-MIT](LICENSE-MIT) or
|
|
# http://opensource.org/licenses/MIT)
|
|
# at your option. This file may not be copied, modified, or distributed except
|
|
# according to those terms.
|
|
|
|
import
|
|
std/[algorithm, os, sequtils, strformat, strutils, times],
|
|
chronicles,
|
|
eth/keys,
|
|
stint,
|
|
unittest2,
|
|
../nimbus/core/[chain,
|
|
clique,
|
|
clique/clique_snapshot,
|
|
clique/clique_desc,
|
|
clique/clique_helpers
|
|
],
|
|
../nimbus/common/[common,context],
|
|
../nimbus/utils/[ec_recover, utils],
|
|
../nimbus/[config, constants],
|
|
./test_clique/pool,
|
|
./replay/undump_blocks
|
|
|
|
const
|
|
baseDir = [".", "tests", ".." / "tests", $DirSep] # path containg repo
|
|
repoDir = ["test_clique", "replay", "status"] # alternative repos
|
|
|
|
goerliCapture = "goerli68161.txt.gz"
|
|
groupReplayTransactions = 7
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Helpers
|
|
# ------------------------------------------------------------------------------
|
|
|
|
proc getBlockHeader(ap: TesterPool; number: BlockNumber): BlockHeader =
|
|
## Shortcut => db/core_db.getBlockHeader()
|
|
doAssert ap.db.getBlockHeader(number, result)
|
|
|
|
proc ppSecs(elapsed: Duration): string =
|
|
result = $elapsed.inSeconds
|
|
let ns = elapsed.inNanoseconds mod 1_000_000_000
|
|
if ns != 0:
|
|
# to rounded decimal seconds
|
|
let ds = (ns + 5_000_000i64) div 10_000_000i64
|
|
result &= &".{ds:02}"
|
|
result &= "s"
|
|
|
|
proc ppRow(elapsed: Duration): string =
|
|
let ms = elapsed.inMilliSeconds + 500
|
|
"x".repeat(ms div 1000)
|
|
|
|
proc findFilePath(file: string): string =
|
|
result = "?unknown?" / file
|
|
for dir in baseDir:
|
|
for repo in repoDir:
|
|
let path = dir / repo / file
|
|
if path.fileExists:
|
|
return path
|
|
|
|
proc setTraceLevel =
|
|
discard
|
|
when defined(chronicles_runtime_filtering) and loggingEnabled:
|
|
setLogLevel(LogLevel.TRACE)
|
|
|
|
proc setErrorLevel =
|
|
discard
|
|
when defined(chronicles_runtime_filtering) and loggingEnabled:
|
|
setLogLevel(LogLevel.ERROR)
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Test Runners
|
|
# ------------------------------------------------------------------------------
|
|
|
|
# clique/snapshot_test.go(99): func TestClique(t *testing.T) {
|
|
proc runCliqueSnapshot(noisy = true; postProcessOk = false;
|
|
testIds = {0 .. 999}; skipIds = {0}-{0}) =
|
|
## Clique PoA Snapshot
|
|
## ::
|
|
## Tests that Clique signer voting is evaluated correctly for various
|
|
## simple and complex scenarios, as well as that a few special corner
|
|
## cases fail correctly.
|
|
##
|
|
let postProcessInfo = if postProcessOk: ", Transaction Finaliser Applied"
|
|
else: ", Without Finaliser"
|
|
suite &"Clique PoA Snapshot{postProcessInfo}":
|
|
var pool = newVoterPool()
|
|
|
|
setErrorLevel()
|
|
if noisy:
|
|
pool.noisy = true
|
|
setTraceLevel()
|
|
|
|
# clique/snapshot_test.go(379): for i, tt := range tests {
|
|
for voterSample in voterSamples.filterIt(it.id in testIds):
|
|
let tt = voterSample
|
|
test &"Snapshots {tt.id:2}: {tt.info.substr(0,50)}...":
|
|
pool.say "\n"
|
|
|
|
# Noisily skip this test
|
|
if tt.id in skipIds:
|
|
skip()
|
|
|
|
else:
|
|
# Assemble a chain of headers from the cast votes
|
|
# see clique/snapshot_test.go(407): config := *params.TestChainConfig
|
|
pool
|
|
.resetVoterChain(tt.signers, tt.epoch, tt.runBack)
|
|
# see clique/snapshot_test.go(425): for j, block := range blocks {
|
|
.appendVoter(tt.votes)
|
|
.commitVoterChain(postProcessOk)
|
|
|
|
# see clique/snapshot_test.go(477): if err != nil {
|
|
if tt.failure != cliqueNoError[0]:
|
|
# Note that clique/snapshot_test.go does not verify _here_ against
|
|
# the scheduled test error -- rather this voting error is supposed
|
|
# to happen earlier (processed at clique/snapshot_test.go(467)) when
|
|
# assembling the block chain (sounds counter intuitive to the author
|
|
# of this source file as the scheduled errors are _clique_ related).
|
|
check pool.failed[1][0] == tt.failure
|
|
else:
|
|
let
|
|
expected = tt.results.mapIt("@" & it).sorted
|
|
snapResult = pool.pp(pool.cliqueSigners).sorted
|
|
pool.say "*** snap state=", pool.pp(pool.snapshot,16)
|
|
pool.say " result=[", snapResult.join(",") & "]"
|
|
pool.say " expected=[", expected.join(",") & "]"
|
|
|
|
# Verify the final list of signers against the expected ones
|
|
check snapResult == expected
|
|
|
|
proc runCliqueSnapshot(noisy = true; postProcessOk = false; testId: int) =
|
|
noisy.runCliqueSnapshot(postProcessOk, testIds = {testId})
|
|
|
|
|
|
proc runGoerliReplay(noisy = true; showElapsed = false,
|
|
captureFile = goerliCapture,
|
|
startAtBlock = 0u64; stopAfterBlock = 0u64) =
|
|
var
|
|
pool = newVoterPool()
|
|
cache: array[groupReplayTransactions,(seq[BlockHeader],seq[BlockBody])]
|
|
cInx = 0
|
|
stoppedOk = false
|
|
|
|
let
|
|
fileInfo = captureFile.splitFile.name.split(".")[0]
|
|
filePath = captureFile.findFilePath
|
|
|
|
pool.verifyFrom = startAtBlock
|
|
|
|
setErrorLevel()
|
|
if noisy:
|
|
pool.noisy = true
|
|
setTraceLevel()
|
|
|
|
let stopThreshold = if stopAfterBlock == 0u64: uint64.high.u256
|
|
else: stopAfterBlock.u256
|
|
|
|
suite &"Replay Goerli chain from {fileInfo} capture":
|
|
|
|
for w in filePath.undumpBlocks:
|
|
|
|
if w[0][0].blockNumber == 0.u256:
|
|
# Verify Genesis
|
|
doAssert w[0][0] == pool.getBlockHeader(0.u256)
|
|
|
|
else:
|
|
# Condense in cache
|
|
cache[cInx] = w
|
|
cInx.inc
|
|
|
|
# Handy for partial tests
|
|
if stopThreshold < cache[cInx-1][0][0].blockNumber:
|
|
stoppedOk = true
|
|
break
|
|
|
|
# Run from cache if complete set
|
|
if cache.len <= cInx:
|
|
cInx = 0
|
|
let
|
|
first = cache[0][0][0].blockNumber
|
|
last = cache[^1][0][^1].blockNumber
|
|
blkRange = &"#{first}..#{last}"
|
|
info = if first <= startAtBlock.u256 and startAtBlock.u256 <= last:
|
|
&", verification #{startAtBlock}.."
|
|
else:
|
|
""
|
|
test &"Goerli Blocks {blkRange} ({cache.len} transactions{info})":
|
|
let start = getTime()
|
|
for (headers,bodies) in cache:
|
|
let addedPersistBlocks = pool.chain.persistBlocks(headers,bodies)
|
|
check addedPersistBlocks == ValidationResult.Ok
|
|
if addedPersistBlocks != ValidationResult.Ok: return
|
|
if showElapsed and startAtBlock.u256 <= last:
|
|
let
|
|
elpd = getTime() - start
|
|
info = &"{elpd.ppSecs:>7} {pool.cliqueSignersLen} {elpd.ppRow}"
|
|
echo &"\n elapsed {blkRange:<17} {info}"
|
|
|
|
# Rest from cache
|
|
if 0 < cInx:
|
|
let
|
|
first = cache[0][0][0].blockNumber
|
|
last = cache[cInx-1][0][^1].blockNumber
|
|
blkRange = &"#{first}..#{last}"
|
|
info = if first <= startAtBlock.u256 and startAtBlock.u256 <= last:
|
|
&", Verification #{startAtBlock}.."
|
|
else:
|
|
""
|
|
test &"Goerli Blocks {blkRange} ({cache.len} transactions{info})":
|
|
let start = getTime()
|
|
for (headers,bodies) in cache:
|
|
let addedPersistBlocks = pool.chain.persistBlocks(headers,bodies)
|
|
check addedPersistBlocks == ValidationResult.Ok
|
|
if addedPersistBlocks != ValidationResult.Ok: return
|
|
if showElapsed and startAtBlock.u256 <= last:
|
|
let
|
|
elpsd = getTime() - start
|
|
info = &"{elpsd.ppSecs:>7} {pool.cliqueSignersLen} {elpsd.ppRow}"
|
|
echo &"\n elapsed {blkRange:<17} {info}"
|
|
|
|
if stoppedOk:
|
|
test &"Runner stopped after reaching #{stopThreshold}":
|
|
discard
|
|
|
|
|
|
proc runGoerliBaybySteps(noisy = true;
|
|
captureFile = goerliCapture,
|
|
stopAfterBlock = 0u64) =
|
|
var
|
|
pool = newVoterPool()
|
|
stoppedOk = false
|
|
|
|
setErrorLevel()
|
|
if noisy:
|
|
pool.noisy = true
|
|
setTraceLevel()
|
|
|
|
let
|
|
fileInfo = captureFile.splitFile.name.split(".")[0]
|
|
filePath = captureFile.findFilePath
|
|
stopThreshold = if stopAfterBlock == 0u64: 20.u256
|
|
else: stopAfterBlock.u256
|
|
|
|
suite &"Replay Goerli chain from {fileInfo} capture, single blockwise":
|
|
|
|
for w in filePath.undumpBlocks:
|
|
if stoppedOk:
|
|
break
|
|
if w[0][0].blockNumber == 0.u256:
|
|
# Verify Genesis
|
|
doAssert w[0][0] == pool.getBlockHeader(0.u256)
|
|
else:
|
|
for n in 0 ..< w[0].len:
|
|
let
|
|
header = w[0][n]
|
|
body = w[1][n]
|
|
var
|
|
parents = w[0][0 ..< n]
|
|
test &"Goerli Block #{header.blockNumber} + {parents.len} parents":
|
|
check pool.chain.clique.cliqueSnapshot(header,parents).isOk
|
|
let addedPersistBlocks = pool.chain.persistBlocks(@[header],@[body])
|
|
check addedPersistBlocks == ValidationResult.Ok
|
|
if addedPersistBlocks != ValidationResult.Ok: return
|
|
# Handy for partial tests
|
|
if stopThreshold <= header.blockNumber:
|
|
stoppedOk = true
|
|
break
|
|
|
|
if stoppedOk:
|
|
test &"Runner stopped after reaching #{stopThreshold}":
|
|
discard
|
|
|
|
proc cliqueMiscTests() =
|
|
let
|
|
prvKeyFile = "private.key".findFilePath
|
|
|
|
suite "clique misc":
|
|
test "signer func":
|
|
let
|
|
engineSigner = "658bdf435d810c91414ec09147daa6db62406379"
|
|
privateKey = prvKeyFile
|
|
conf = makeConfig(@["--engine-signer:" & engineSigner, "--import-key:" & privateKey])
|
|
ctx = newEthContext()
|
|
|
|
check ctx.am.importPrivateKey(string conf.importKey).isOk()
|
|
check ctx.am.getAccount(conf.engineSigner).isOk()
|
|
|
|
proc signFunc(signer: EthAddress, message: openArray[byte]): Result[RawSignature, cstring] {.gcsafe.} =
|
|
let
|
|
hashData = keccakHash(message)
|
|
acc = ctx.am.getAccount(conf.engineSigner).tryGet()
|
|
rawSign = sign(acc.privateKey, SkMessage(hashData.data)).toRaw
|
|
|
|
ok(rawSign)
|
|
|
|
let signerFn: CliqueSignerFn = signFunc
|
|
var header: BlockHeader
|
|
header.extraData.setLen(EXTRA_VANITY)
|
|
header.extraData.add 0.byte.repeat(EXTRA_SEAL)
|
|
|
|
let signature = signerFn(conf.engineSigner, header.encodeSealHeader).get()
|
|
let extraLen = header.extraData.len
|
|
if EXTRA_SEAL < extraLen:
|
|
header.extraData.setLen(extraLen - EXTRA_SEAL)
|
|
header.extraData.add signature
|
|
|
|
let resAddr = ecRecover(header)
|
|
check resAddr.isOk
|
|
check resAddr.value == conf.engineSigner
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Main function(s)
|
|
# ------------------------------------------------------------------------------
|
|
|
|
proc cliqueMain*(noisy = defined(debug)) =
|
|
noisy.runCliqueSnapshot(true)
|
|
noisy.runCliqueSnapshot(false)
|
|
noisy.runGoerliBaybySteps
|
|
noisy.runGoerliReplay(startAtBlock = 31100u64)
|
|
cliqueMiscTests()
|
|
|
|
when isMainModule:
|
|
let
|
|
skipIDs = {999}
|
|
# A new capture file can be generated using
|
|
# `test_clique/indiump.dumpGroupNl()`
|
|
# placed at the end of
|
|
# `p2p/chain/persist_blocks.persistBlocks()`.
|
|
captureFile = goerliCapture
|
|
#captureFile = "dump-stream.out.gz"
|
|
|
|
proc goerliReplay(noisy = true;
|
|
showElapsed = true;
|
|
captureFile = captureFile;
|
|
startAtBlock = 0u64;
|
|
stopAfterBlock = 0u64) =
|
|
runGoerliReplay(
|
|
noisy = noisy,
|
|
showElapsed = showElapsed,
|
|
captureFile = captureFile,
|
|
startAtBlock = startAtBlock,
|
|
stopAfterBlock = stopAfterBlock)
|
|
|
|
# local path is: nimbus-eth1/tests
|
|
let noisy = defined(debug)
|
|
|
|
noisy.runCliqueSnapshot(true)
|
|
noisy.runCliqueSnapshot(false)
|
|
noisy.runGoerliBaybySteps
|
|
false.runGoerliReplay(startAtBlock = 31100u64)
|
|
|
|
#noisy.goerliReplay(startAtBlock = 31100u64)
|
|
#noisy.goerliReplay(startAtBlock = 194881u64, stopAfterBlock = 198912u64)
|
|
|
|
cliqueMiscTests()
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# End
|
|
# ------------------------------------------------------------------------------
|