nimbus-eth2/tests/mocking/mock_blocks.nim

# beacon_chain
# Copyright (c) 2018-2019 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
  options,
  # Specs
  ../../beacon_chain/spec/[datatypes, crypto, validator, state_transition_block],
  # Internals
  ../../beacon_chain/[ssz, extras, state_transition],
  # Mock helpers
  ./mock_validator_keys

# Routines for mocking blocks
# ---------------------------------------------------------------

proc signMockBlockImpl(
      state: BeaconState,
      signedBlock: var SignedBeaconBlock,
      proposer_index: ValidatorIndex
    ) =
  let block_slot = signedBlock.message.slot
  doAssert state.slot <= block_slot

  let privkey = MockPrivKeys[proposer_index]

  signedBlock.message.body.randao_reveal = get_epoch_signature(
    state.fork, state.genesis_validators_root, block_slot, privkey)
  signedBlock.signature = get_block_signature(
    state.fork, state.genesis_validators_root, block_slot,
    hash_tree_root(signedBlock.message), privkey)

proc signMockBlock*(
  state: BeaconState,
  signedBlock: var SignedBeaconBlock
  ) =

  var emptyCache = get_empty_per_epoch_cache()
  let proposer_index =
    if signedBlock.message.slot == state.slot:
      get_beacon_proposer_index(state, emptyCache)
    else:
      # Stub to get proposer index of future slot
      # Note: this relies on ``let`` deep-copying the state
      #       i.e. BeaconState should have value semantics
      #            and not contain ref objects or pointers
      var stubState = state
      process_slots(stub_state, signedBlock.message.slot)
      get_beacon_proposer_index(stub_state, emptyCache)

  # In tests, just let this throw if appropriate
  signMockBlockImpl(state, signedBlock, proposer_index.get)

proc mockBlock(
    state: BeaconState,
    slot: Slot,
    flags: UpdateFlags = {}): SignedBeaconBlock =
  ## TODO don't do this gradual construction, for exception safety
  ## Mock a BeaconBlock for the specific slot
  ## Skip signature creation if block should not be signed (skipBlsValidation present)

  var emptyCache = get_empty_per_epoch_cache()
  let proposer_index = get_beacon_proposer_index(state, emptyCache)
  result.message.slot = slot
  result.message.proposer_index = proposer_index.get.uint64
  result.message.body.eth1_data.deposit_count = state.eth1_deposit_index

  var previous_block_header = state.latest_block_header
  if previous_block_header.state_root == ZERO_HASH:
    previous_block_header.state_root = state.hash_tree_root()
  result.message.parent_root = previous_block_header.hash_tree_root()

  if skipBlsValidation notin flags:
    signMockBlock(state, result)

proc mockBlockForNextSlot*(state: BeaconState, flags: UpdateFlags = {}):
    SignedBeaconBlock =
  mockBlock(state, state.slot + 1, flags)

proc applyEmptyBlock*(state: var BeaconState) =
  ## Do a state transition with an empty signed block
  ## on the current slot
  let signedBlock = mockBlock(state, state.slot, flags = {})
  doAssert state_transition(state, signedBlock, {skipStateRootValidation})