types

type EventSource string

type ForkChoice struct {
	// JustifiedCheckpoint is the store's justified checkpoint.
	JustifiedCheckpoint phase0.Checkpoint
	// FinalizedCheckpoint is the store's finalized checkpoint.
	FinalizedCheckpoint phase0.Checkpoint
	// ForkChoiceNodes are the fork choice nodes. Pre-Gloas, and for clients
	// without the v2 endpoint, there is one node per block. Post-Gloas a block
	// can have a pending, an empty and a full node.
	ForkChoiceNodes []*ForkChoiceNode
	// ExtraData is the client-specific extra data of the fork choice store,
	// such as the unrealized justified checkpoint.
	ExtraData map[string]any
}

type ForkChoiceNode struct {
	Slot      phase0.Slot
	BlockRoot phase0.Root
	// ParentRoot is the root of the parent block. Unlike the v2 endpoint, it is
	// the parent block's root for empty and full nodes too.
	ParentRoot         phase0.Root
	JustifiedEpoch     *phase0.Epoch
	FinalizedEpoch     *phase0.Epoch
	Weight             uint64
	Validity           v1.ForkChoiceNodeValidity
	ExecutionBlockHash phase0.Root
	// PayloadStatus is the Gloas payload status of the node; unknown (the zero
	// value) for nodes without one.
	PayloadStatus v1.ForkChoicePayloadStatus
	// ParentPayloadStatus is the payload status of the parent fork choice node:
	// for a pending node, whether its block was built on the parent block's
	// empty or full payload; for empty and full nodes, pending. Nil if unknown.
	ParentPayloadStatus             *v1.ForkChoicePayloadStatus
	PayloadAttesterCount            *uint64
	PayloadAvailabilityYesCount     *uint64
	PayloadDataAvailabilityYesCount *uint64
	ExtraData                       map[string]any
}

type Frame struct {
	// Data is the fork choice dump.
	Data *ForkChoice `json:"data"`
	// Metadata is the metadata of the frame.
	Metadata FrameMetadata `json:"metadata"`
}

type FrameMetadata struct {
	// ID is the ID of the frame.
	ID string `json:"id"`
	// Node is the node that provided the frame.
	// In the case of a beacon node, this is the beacon node's ID as specified in the config for this service.
	// In the case of Xatu, this is the Xatu Sentry ID.
	Node string `json:"node"`
	// FetchedAt is the time the frame was fetched.
	FetchedAt time.Time `json:"fetched_at"`
	// WallClockSlot is the wall clock slot at the time the frame was fetched.
	WallClockSlot phase0.Slot `json:"wall_clock_slot"`
	// WallClockSlot is the wall clock slot at the time the frame was fetched.
	WallClockEpoch phase0.Epoch `json:"wall_clock_epoch"`
	// Labels are labels to apply to the frame.
	Labels []string `json:"labels"`
	// ConsensusClient is the consensus client that provided the frame.
	ConsensusClient string `json:"consensus_client"`
	// EventSource is the event source that provided the frame.
	EventSource string `json:"event_source"`
}