status-im
/
nimbus-eth2
mirror of https://github.com/status-im/nimbus-eth2.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

cleanup `OnBlockAdded` usage (#5426) 

Reduce repetitiveness when using forked `OnBlockAdded` callbacks by
introducing a template to obtain appropriate cb from `ConsensusFork`.
This commit is contained in:
Etan Kissling 2023-09-13 19:57:54 +02:00 committed by GitHub
parent d7aaf1b809
commit 176ea09c2b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 29 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
beacon_chain/consensus_object_pools/block_pools_types.nim
View File

@ -279,7 +279,7 @@ type
# balances, as used in fork choice # balances, as used in fork choice
effective_balances_bytes*: seq[byte] effective_balances_bytes*: seq[byte]
OnBlockAdded[T] = proc( OnBlockAdded[T: ForkyTrustedSignedBeaconBlock] = proc(
blckRef: BlockRef, blck: T, epochRef: EpochRef, blckRef: BlockRef, blck: T, epochRef: EpochRef,
unrealized: FinalityCheckpoints) {.gcsafe, raises: [].} unrealized: FinalityCheckpoints) {.gcsafe, raises: [].}
OnPhase0BlockAdded* = OnBlockAdded[phase0.TrustedSignedBeaconBlock] OnPhase0BlockAdded* = OnBlockAdded[phase0.TrustedSignedBeaconBlock]
@ -321,6 +321,20 @@ type
block_root* {.serializedFieldName: "block".}: Eth2Digest block_root* {.serializedFieldName: "block".}: Eth2Digest
optimistic* {.serializedFieldName: "execution_optimistic".}: Option[bool] optimistic* {.serializedFieldName: "execution_optimistic".}: Option[bool]
template OnBlockAddedCallback*(kind: static ConsensusFork): auto =
when kind == ConsensusFork.Deneb:
typedesc[OnDenebBlockAdded]
elif kind == ConsensusFork.Capella:
typedesc[OnCapellaBlockAdded]
elif kind == ConsensusFork.Bellatrix:
typedesc[OnBellatrixBlockAdded]
elif kind == ConsensusFork.Altair:
typedesc[OnAltairBlockAdded]
elif kind == ConsensusFork.Phase0:
typedesc[OnPhase0BlockAdded]
else:
static: raiseAssert "Unreachable"
func proposer_dependent_slot*(epochRef: EpochRef): Slot = func proposer_dependent_slot*(epochRef: EpochRef): Slot =
epochRef.key.epoch.proposer_dependent_slot() epochRef.key.epoch.proposer_dependent_slot()

26
tests/test_blockchain_dag.nim
View File

@ -1212,9 +1212,7 @@ suite "Ancestry":
let let
blck = dag.headState.addTestBlock(cache, nextSlot = false, cfg = cfg) blck = dag.headState.addTestBlock(cache, nextSlot = false, cfg = cfg)
added = block: added = dag.addHeadBlock(verifier, blck.phase0Data, nilPhase0Callback)
const nilCallback = OnPhase0BlockAdded(nil)
dag.addHeadBlock(verifier, blck.phase0Data, nilCallback)
check added.isOk() check added.isOk()
dag.updateHead(added[], quarantine[], []) dag.updateHead(added[], quarantine[], [])
(blck: dag.head, state: newClone(dag.headState.phase0Data)) (blck: dag.head, state: newClone(dag.headState.phase0Data))
@ -1499,27 +1497,13 @@ template runShufflingTests(cfg: RuntimeConfig, numRandomTests: int) =
graffiti: GraffitiBytes graffiti: GraffitiBytes
proc addBlocks(blocks: uint64, attested: bool, cache: var StateCache) = proc addBlocks(blocks: uint64, attested: bool, cache: var StateCache) =
inc distinctBase(graffiti)[0] # Avoid duplicate blocks across branches inc distinctBase(graffiti)[0] # Avoid duplicate blocks across branches
for blck in makeTestBlocks( for forkedBlck in makeTestBlocks(
dag.headState, cache, blocks.int, eth1_data = eth1Data, dag.headState, cache, blocks.int, eth1_data = eth1Data,
attested = attested, allDeposits = deposits, attested = attested, allDeposits = deposits,
graffiti = graffiti, cfg = cfg): graffiti = graffiti, cfg = cfg):
let added = let added = withBlck(forkedBlck):
case blck.kind const nilCallback = (consensusFork.OnBlockAddedCallback)(nil)
of ConsensusFork.Phase0: dag.addHeadBlock(verifier, blck, nilCallback)
const nilCallback = OnPhase0BlockAdded(nil)
dag.addHeadBlock(verifier, blck.phase0Data, nilCallback)
of ConsensusFork.Altair:
const nilCallback = OnAltairBlockAdded(nil)
dag.addHeadBlock(verifier, blck.altairData, nilCallback)
of ConsensusFork.Bellatrix:
const nilCallback = OnBellatrixBlockAdded(nil)
dag.addHeadBlock(verifier, blck.bellatrixData, nilCallback)
of ConsensusFork.Capella:
const nilCallback = OnCapellaBlockAdded(nil)
dag.addHeadBlock(verifier, blck.capellaData, nilCallback)
of ConsensusFork.Deneb:
const nilCallback = OnDenebBlockAdded(nil)
dag.addHeadBlock(verifier, blck.denebData, nilCallback)
check added.isOk() check added.isOk()
dag.updateHead(added[], quarantine[], []) dag.updateHead(added[], quarantine[], [])

20
tests/test_gossip_validation.nim
View File

@ -193,23 +193,9 @@ suite "Gossip validation - Altair":
for blck in makeTestBlocks( for blck in makeTestBlocks(
dag.headState, cache, blocks = 1, dag.headState, cache, blocks = 1,
attested = false, cfg = cfg): attested = false, cfg = cfg):
let added = let added = withBlck(blck):
case blck.kind const nilCallback = (consensusFork.OnBlockAddedCallback)(nil)
of ConsensusFork.Phase0: dag.addHeadBlock(verifier, blck, nilCallback)
const nilCallback = OnPhase0BlockAdded(nil)
dag.addHeadBlock(verifier, blck.phase0Data, nilCallback)
of ConsensusFork.Altair:
const nilCallback = OnAltairBlockAdded(nil)
dag.addHeadBlock(verifier, blck.altairData, nilCallback)
of ConsensusFork.Bellatrix:
const nilCallback = OnBellatrixBlockAdded(nil)
dag.addHeadBlock(verifier, blck.bellatrixData, nilCallback)
of ConsensusFork.Capella:
const nilCallback = OnCapellaBlockAdded(nil)
dag.addHeadBlock(verifier, blck.capellaData, nilCallback)
of ConsensusFork.Deneb:
const nilCallback = OnDenebBlockAdded(nil)
dag.addHeadBlock(verifier, blck.denebData, nilCallback)
check: added.isOk() check: added.isOk()
dag.updateHead(added[], quarantine, []) dag.updateHead(added[], quarantine, [])

21
tests/test_light_client.nim
View File

@ -63,24 +63,9 @@ suite "Light client" & preset():
for blck in makeTestBlocks( for blck in makeTestBlocks(
dag.headState, cache, blocks.int, attested = attested, dag.headState, cache, blocks.int, attested = attested,
syncCommitteeRatio = syncCommitteeRatio, cfg = cfg): syncCommitteeRatio = syncCommitteeRatio, cfg = cfg):
let added = let added = withBlck(blck):
case blck.kind const nilCallback = (consensusFork.OnBlockAddedCallback)(nil)
of ConsensusFork.Phase0: dag.addHeadBlock(verifier, blck, nilCallback)
const nilCallback = OnPhase0BlockAdded(nil)
dag.addHeadBlock(verifier, blck.phase0Data, nilCallback)
of ConsensusFork.Altair:
const nilCallback = OnAltairBlockAdded(nil)
dag.addHeadBlock(verifier, blck.altairData, nilCallback)
of ConsensusFork.Bellatrix:
const nilCallback = OnBellatrixBlockAdded(nil)
dag.addHeadBlock(verifier, blck.bellatrixData, nilCallback)
of ConsensusFork.Capella:
const nilCallback = OnCapellaBlockAdded(nil)
dag.addHeadBlock(verifier, blck.capellaData, nilCallback)
of ConsensusFork.Deneb:
const nilCallback = OnDenebBlockAdded(nil)
dag.addHeadBlock(verifier, blck.denebData, nilCallback)
check: added.isOk() check: added.isOk()
dag.updateHead(added[], quarantine, []) dag.updateHead(added[], quarantine, [])

20
tests/test_light_client_processor.nim
View File

@ -51,23 +51,9 @@ suite "Light client processor" & preset():
for blck in makeTestBlocks( for blck in makeTestBlocks(
dag.headState, cache, blocks.int, attested = true, dag.headState, cache, blocks.int, attested = true,
syncCommitteeRatio = syncCommitteeRatio, cfg = cfg): syncCommitteeRatio = syncCommitteeRatio, cfg = cfg):
let added = let added = withBlck(blck):
case blck.kind const nilCallback = (consensusFork.OnBlockAddedCallback)(nil)
of ConsensusFork.Phase0: dag.addHeadBlock(verifier, blck, nilCallback)
const nilCallback = OnPhase0BlockAdded(nil)
dag.addHeadBlock(verifier, blck.phase0Data, nilCallback)
of ConsensusFork.Altair:
const nilCallback = OnAltairBlockAdded(nil)
dag.addHeadBlock(verifier, blck.altairData, nilCallback)
of ConsensusFork.Bellatrix:
const nilCallback = OnBellatrixBlockAdded(nil)
dag.addHeadBlock(verifier, blck.bellatrixData, nilCallback)
of ConsensusFork.Capella:
const nilCallback = OnCapellaBlockAdded(nil)
dag.addHeadBlock(verifier, blck.capellaData, nilCallback)
of ConsensusFork.Deneb:
const nilCallback = OnDenebBlockAdded(nil)
dag.addHeadBlock(verifier, blck.denebData, nilCallback)
doAssert added.isOk() doAssert added.isOk()
dag.updateHead(added[], quarantine[], []) dag.updateHead(added[], quarantine[], [])