# 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.

# This file contains constants that are part of the spec and thus subject to
# serialization and spec updates.

import
  math

type
  Slot* = distinct uint64
  Epoch* = distinct uint64

{.experimental: "codeReordering".} # SLOTS_PER_EPOCH is use before being defined in spec

const
  # Misc
  # ---------------------------------------------------------------
  # https://github.com/ethereum/eth2.0-specs/blob/v0.9.2/configs/minimal.yaml#L4

  # Changed
  MAX_COMMITTEES_PER_SLOT* = 4
  TARGET_COMMITTEE_SIZE* = 4

  # Unchanged
  MAX_VALIDATORS_PER_COMMITTEE* = 2048
  MIN_PER_EPOCH_CHURN_LIMIT* = 4
  CHURN_LIMIT_QUOTIENT* = 2^16

  # Changed
  SHUFFLE_ROUND_COUNT* = 10
  MIN_GENESIS_ACTIVE_VALIDATOR_COUNT* {.intdefine.} = 64
  MIN_GENESIS_TIME* {.intdefine.} = 1578009600 # 3 Jan, 2020

  # Constants
  # ---------------------------------------------------------------
  # https://github.com/ethereum/eth2.0-specs/blob/v0.9.4/specs/core/0_beacon-chain.md#constants
  # TODO "The following values are (non-configurable) constants" ...
  # Unchanged
  BASE_REWARDS_PER_EPOCH* = 4

  DEPOSIT_CONTRACT_TREE_DEPTH* = 32

  # Gwei values
  # ---------------------------------------------------------------
  # https://github.com/ethereum/eth2.0-specs/blob/v0.9.2/configs/minimal.yaml#L50

  # Unchanged
  MIN_DEPOSIT_AMOUNT* = 2'u64^0 * 10'u64^9
  MAX_EFFECTIVE_BALANCE* = 2'u64^5 * 10'u64^9
  EJECTION_BALANCE* = 2'u64^4 * 10'u64^9
  EFFECTIVE_BALANCE_INCREMENT* = 2'u64^0 * 10'u64^9

  # Initial values
  # ---------------------------------------------------------------
  # https://github.com/ethereum/eth2.0-specs/blob/v0.9.2/configs/minimal.yaml#L62

  # Unchanged
  GENESIS_SLOT* = 0.Slot
  GENESIS_FORK_VERSION* = 0x01000000
  BLS_WITHDRAWAL_PREFIX* = 0'u8

  # Time parameters
  # ---------------------------------------------------------------
  # https://github.com/ethereum/eth2.0-specs/blob/v0.9.2/configs/minimal.yaml#L69
  # Changed: Faster to spin up testnets, but does not give validator
  # reasonable warning time for genesis
  MIN_GENESIS_DELAY* = 300

  # Unchanged
  SECONDS_PER_SLOT*{.intdefine.} = 6'u64

  # Unchanged
  MIN_ATTESTATION_INCLUSION_DELAY* = 1

  # Changed
  SLOTS_PER_EPOCH* {.intdefine.} = 8

  # Unchanged
  MIN_SEED_LOOKAHEAD* = 1
  MAX_SEED_LOOKAHEAD* = 4

  # Changed
  SLOTS_PER_ETH1_VOTING_PERIOD* = 16
  SLOTS_PER_HISTORICAL_ROOT* = 64

  # Unchanged
  MIN_VALIDATOR_WITHDRAWABILITY_DELAY* = 2'u64^8
  PERSISTENT_COMMITTEE_PERIOD* = 2'u64^11
  MAX_EPOCHS_PER_CROSSLINK* = 4

  # Changed
  MIN_EPOCHS_TO_INACTIVITY_PENALTY* = 2'u64^2

  EARLY_DERIVED_SECRET_PENALTY_MAX_FUTURE_EPOCHS* = 4096 # epochs
  EPOCHS_PER_CUSTODY_PERIOD* = 4
  CUSTODY_PERIOD_TO_RANDAO_PADDING* = 4

  # State vector lengths
  # ---------------------------------------------------------------
  # https://github.com/ethereum/eth2.0-specs/blob/v0.9.2/configs/minimal.yaml#L101

  # Changed
  EPOCHS_PER_HISTORICAL_VECTOR* = 64
  EPOCHS_PER_SLASHINGS_VECTOR* = 64
  HISTORICAL_ROOTS_LIMIT* = 16777216
  VALIDATOR_REGISTRY_LIMIT* = 1099511627776

  # Reward and penalty quotients
  # ---------------------------------------------------------------
  # https://github.com/ethereum/eth2.0-specs/blob/v0.9.2/configs/minimal.yaml#L113

  BASE_REWARD_FACTOR* = 2'u64^6
  WHISTLEBLOWER_REWARD_QUOTIENT* = 2'u64^9
  PROPOSER_REWARD_QUOTIENT* = 2'u64^3
  INACTIVITY_PENALTY_QUOTIENT* = 2'u64^25
  MIN_SLASHING_PENALTY_QUOTIENT* = 32 # 2^5

  # Max operations per block
  # ---------------------------------------------------------------
  # https://github.com/ethereum/eth2.0-specs/blob/v0.9.2/configs/minimal.yaml#L127

  MAX_PROPOSER_SLASHINGS* = 2^4
  MAX_ATTESTER_SLASHINGS* = 2^0
  MAX_ATTESTATIONS* = 2^7
  MAX_DEPOSITS* = 2^4
  MAX_VOLUNTARY_EXITS* = 2^4

  # Fork choice
  # ---------------------------------------------------------------
  # https://github.com/ethereum/eth2.0-specs/blob/v0.9.4/configs/minimal.yaml#L26

  # Changed
  SAFE_SLOTS_TO_UPDATE_JUSTIFIED* = 2

  # Validators
  # ---------------------------------------------------------------
  # https://github.com/ethereum/eth2.0-specs/blob/v0.9.2/specs/validator/0_beacon-chain-validator.md#misc

  # Changed
  ETH1_FOLLOW_DISTANCE* = 16 # blocks

  # Unchanged
  TARGET_AGGREGATORS_PER_COMMITTEE* = 16 # validators
  RANDOM_SUBNETS_PER_VALIDATOR* = 1 # subnet
  EPOCHS_PER_RANDOM_SUBNET_SUBSCRIPTION* = 256 # epochs ~ 27 hours
  SECONDS_PER_ETH1_BLOCK* = 14 # estimate from Eth1 mainnet)

  # Phase 1 - Sharding
  # ---------------------------------------------------------------
  # https://github.com/ethereum/eth2.0-specs/blob/v0.9.4/configs/minimal.yaml#L153
  # TODO those are included in minimal.yaml but not mainnet.yaml
  #      Why?
  SHARD_SLOTS_PER_BEACON_SLOT* = 2 # spec: SHARD_SLOTS_PER_EPOCH
  EPOCHS_PER_SHARD_PERIOD* = 4
  PHASE_1_FORK_EPOCH* = 8
  PHASE_1_FORK_SLOT* = 64