state

Documentation

Overview

Package state contains types for state operation-specific events fired during the runtime of a beacon node such state initialization, state updates, and chain start.

Index

• Constants
• type BlockProcessedData
• type ChainStartedData
• type InitializedData
• type Notifier
• type SyncedData

Constants

const (
	// BlockProcessed is sent after a block has been processed and updated the state database.
	BlockProcessed = iota + 1
	// ChainStarted is sent when enough validators are active to start proposing blocks.
	ChainStarted

	// Reorg is an event sent when the new head is not a descendant of the previous head.
	Reorg
	// FinalizedCheckpoint event.
	FinalizedCheckpoint
	// NewHead of the chain event.
	NewHead
	// MissedSlot is sent when we need to notify users that a slot was missed.
	MissedSlot
	// LightClientFinalityUpdate event
	LightClientFinalityUpdate
	// LightClientOptimisticUpdate event
	LightClientOptimisticUpdate
	// PayloadAttributes events are fired upon a missed slot or new head.
	PayloadAttributes
)

Types

type BlockProcessedData

type BlockProcessedData struct {
	// Slot is the slot of the processed block.
	Slot primitives.Slot
	// BlockRoot of the processed block.
	BlockRoot [32]byte
	// SignedBlock is the physical processed block.
	SignedBlock interfaces.ReadOnlySignedBeaconBlock
	// Verified is true if the block's BLS contents have been verified.
	Verified bool
	// Optimistic is true if the block is optimistic.
	Optimistic bool
}

BlockProcessedData is the data sent with BlockProcessed events.

type ChainStartedData

type ChainStartedData struct {
	// StartTime is the time at which the chain started.
	StartTime time.Time
}

ChainStartedData is the data sent with ChainStarted events.

type InitializedData

type InitializedData struct {
	// StartTime is the time at which the chain started.
	StartTime time.Time
	// GenesisValidatorsRoot represents state.validators.HashTreeRoot().
	GenesisValidatorsRoot []byte
}

InitializedData is the data sent with Initialized events.

type Notifier

type Notifier interface {
	StateFeed() event.SubscriberSender
}

Notifier interface defines the methods of the service that provides state updates to consumers.

type SyncedData

type SyncedData struct {
	// StartTime is the time at which the chain started.
	StartTime time.Time
}

SyncedData is the data sent with Synced events.