slotutil

Documentation

Overview

Package slotutil includes ticker and timer-related functions for eth2.

Index

• func DivideSlotBy(timesPerSlot int64) time.Duration
• func EpochsSinceGenesis(genesis time.Time) uint64
• func SlotStartTime(genesis uint64, slot uint64) time.Time
• func SlotsSinceGenesis(genesis time.Time) uint64
• type SlotTicker
  • func GetSlotTicker(genesisTime time.Time, secondsPerSlot uint64) *SlotTicker
  • func GetSlotTickerWithOffset(genesisTime time.Time, offset time.Duration, secondsPerSlot uint64) *SlotTicker
  • func (s *SlotTicker) C() <-chan uint64
  • func (s *SlotTicker) Done()
• type Ticker

Functions

func DivideSlotBy

func DivideSlotBy(timesPerSlot int64) time.Duration

DivideSlotBy divides the SECONDS_PER_SLOT configuration parameter by a specified number. It returns a value of time.Duration in milliseconds, useful for dividing values such as 1 second into millisecond-based durations.

func EpochsSinceGenesis

func EpochsSinceGenesis(genesis time.Time) uint64

EpochsSinceGenesis returns the number of slots since the provided genesis time.

func SlotStartTime

func SlotStartTime(genesis uint64, slot uint64) time.Time

SlotStartTime returns the start time in terms of its unix epoch value.

func SlotsSinceGenesis

func SlotsSinceGenesis(genesis time.Time) uint64

SlotsSinceGenesis returns the number of slots since the provided genesis time.

Types

type SlotTicker

type SlotTicker struct {
	// contains filtered or unexported fields
}

SlotTicker is a special ticker for the beacon chain block. The channel emits over the slot interval, and ensures that the ticks are in line with the genesis time. This means that the duration between the ticks and the genesis time are always a multiple of the slot duration. In addition, the channel returns the new slot number.

func GetSlotTicker

func GetSlotTicker(genesisTime time.Time, secondsPerSlot uint64) *SlotTicker

GetSlotTicker is the constructor for SlotTicker.

func GetSlotTickerWithOffset

func GetSlotTickerWithOffset(genesisTime time.Time, offset time.Duration, secondsPerSlot uint64) *SlotTicker

GetSlotTickerWithOffset is a constructor for SlotTicker that allows a offset of time from genesis, entering a offset greater than secondsPerSlot is not allowed.

func (*SlotTicker) C

func (s *SlotTicker) C() <-chan uint64

C returns the ticker channel. Call Cancel afterwards to ensure that the goroutine exits cleanly.

func (*SlotTicker) Done

func (s *SlotTicker) Done()

Done should be called to clean up the ticker.

type Ticker

type Ticker interface {
	C() <-chan uint64
	Done()
}

The Ticker interface defines a type which can expose a receive-only channel firing slot events.