time

Documentation

Index

• func CanProcessEpoch(state state.ReadOnlyBeaconState) bool
• func CanUpgradeToAltair(slot types.Slot) bool
• func CanUpgradeToBellatrix(slot types.Slot) bool
• func CurrentEpoch(state state.ReadOnlyBeaconState) types.Epoch
• func HigherEqualThanAltairVersionAndEpoch(s state.BeaconState, e types.Epoch) bool
• func NextEpoch(state state.ReadOnlyBeaconState) types.Epoch
• func PrevEpoch(state state.ReadOnlyBeaconState) types.Epoch

Functions

func CanProcessEpoch

func CanProcessEpoch(state state.ReadOnlyBeaconState) bool

CanProcessEpoch checks the eligibility to process epoch. The epoch can be processed at the end of the last slot of every epoch.

Spec pseudocode definition:

If (state.slot + 1) % SLOTS_PER_EPOCH == 0:

func CanUpgradeToAltair

func CanUpgradeToAltair(slot types.Slot) bool

CanUpgradeToAltair returns true if the input `slot` can upgrade to Altair. Spec code: If state.slot % SLOTS_PER_EPOCH == 0 and compute_epoch_at_slot(state.slot) == ALTAIR_FORK_EPOCH

func CanUpgradeToBellatrix

func CanUpgradeToBellatrix(slot types.Slot) bool

CanUpgradeToBellatrix returns true if the input `slot` can upgrade to Bellatrix fork.

Spec code: If state.slot % SLOTS_PER_EPOCH == 0 and compute_epoch_at_slot(state.slot) == BELLATRIX_FORK_EPOCH

func CurrentEpoch

func CurrentEpoch(state state.ReadOnlyBeaconState) types.Epoch

CurrentEpoch returns the current epoch number calculated from the slot number stored in beacon state.

Spec pseudocode definition:

def get_current_epoch(state: BeaconState) -> Epoch:
  """
  Return the current epoch.
  """
  return compute_epoch_at_slot(state.slot)

func HigherEqualThanAltairVersionAndEpoch

func HigherEqualThanAltairVersionAndEpoch(s state.BeaconState, e types.Epoch) bool

HigherEqualThanAltairVersionAndEpoch returns if the input state `s` has a higher version number than Altair state and input epoch `e` is higher equal than fork epoch.

func NextEpoch

func NextEpoch(state state.ReadOnlyBeaconState) types.Epoch

NextEpoch returns the next epoch number calculated from the slot number stored in beacon state.

func PrevEpoch

func PrevEpoch(state state.ReadOnlyBeaconState) types.Epoch

PrevEpoch returns the previous epoch number calculated from the slot number stored in beacon state. It also checks for underflow condition.

Spec pseudocode definition:

def get_previous_epoch(state: BeaconState) -> Epoch:
  """`
  Return the previous epoch (unless the current epoch is ``GENESIS_EPOCH``).
  """
  current_epoch = get_current_epoch(state)
  return GENESIS_EPOCH if current_epoch == GENESIS_EPOCH else Epoch(current_epoch - 1)