beacon

type APIClientOptions struct {
	// AcceptEncoding requests a specific wire encoding for raw responses. Empty
	// leaves negotiation to net/http, which may transparently decompress gzip.
	AcceptEncoding string
	// Timeout bounds the entire request, including reading the response body.
	//
	// http.Client.Timeout keeps running after the response headers arrive, so it
	// also bounds any read the caller performs on a response body it owns. Set it
	// to zero to leave the body read governed by the request context.
	Timeout human.Duration
	// ResponseHeaderTimeout bounds the wait for response headers after the request
	// has been written. It never bounds reading the response body. Zero disables
	// it.
	ResponseHeaderTimeout human.Duration
	// DialTimeout bounds establishing the TCP connection. Zero disables it.
	DialTimeout human.Duration
	// TLSHandshakeTimeout bounds the TLS handshake. Zero disables it.
	TLSHandshakeTimeout human.Duration
	// MaxIdleConnsPerHost caps idle connections kept per host. Zero uses
	// http.DefaultMaxIdleConnsPerHost.
	MaxIdleConnsPerHost int
	// MaxConnsPerHost limits total connections per host, including connections
	// that are dialing, active, or idle. Excess HTTP/1 requests wait for a
	// connection; HTTP/2 streams can multiplex on one connection. Zero removes
	// the limit.
	MaxConnsPerHost int
	// MaxConcurrentRequests limits raw requests from transport start until the
	// response body is closed. Excess requests wait for a slot, including when
	// HTTP/2 multiplexes them on one connection. With no client timeout or
	// context deadline, that wait is unbounded. Zero removes the limit.
	MaxConcurrentRequests int
}

type BeaconMetrics struct {
	Slot                prometheus.GaugeVec
	Transactions        prometheus.GaugeVec
	Slashings           prometheus.GaugeVec
	Attestations        prometheus.GaugeVec
	Deposits            prometheus.GaugeVec
	VoluntaryExits      prometheus.GaugeVec
	FinalityCheckpoints prometheus.GaugeVec
	ReOrgs              prometheus.Counter
	ReOrgDepth          prometheus.Counter
	EmptySlots          prometheus.Counter
	ProposerDelay       prometheus.Histogram
	Withdrawals         prometheus.GaugeVec
	WithdrawalsAmount   prometheus.GaugeVec
	WithdrawalsIndexMax prometheus.GaugeVec
	WithdrawalsIndexMin prometheus.GaugeVec
	BlobKZGCommitments  prometheus.GaugeVec
	// contains filtered or unexported fields
}

type BeaconSubscriptionOptions struct {
	Enabled bool
	Topics  EventTopics
}

type Config struct {
	// Name is the human-readable name of the node.
	Name string `yaml:"name"`
	// Address is the address of the node.
	Addr string `yaml:"addr"`
	// Headers are the headers to send with every request.
	Headers map[string]string `yaml:"headers"`
}

type EmptySlotEvent struct {
	Slot phase0.Slot
}

type EventMetrics struct {
	Count              prometheus.CounterVec
	TimeSinceLastEvent prometheus.Gauge

	LastEventTime time.Time
	// contains filtered or unexported fields
}

type EventTopics []string

type FinalityCheckpointUpdated struct {
	Finality *v1.Finality
}

type FirstTimeHealthyEvent struct {
}

type ForkMetrics struct {
	Epochs    prometheus.GaugeVec
	Activated prometheus.GaugeVec
	Current   prometheus.GaugeVec
	// contains filtered or unexported fields
}

type GeneralMetrics struct {
	NodeVersion prometheus.GaugeVec
	ClientName  prometheus.GaugeVec
	Peers       prometheus.GaugeVec
	// contains filtered or unexported fields
}

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

type HealthCheckFailedEvent struct {
	Duration time.Duration
}

type HealthCheckOptions struct {
	// Interval is the interval at which the health check will be run.
	Interval human.Duration
	// SuccessThreshold is the number of consecutive successful health checks required before the node is considered healthy.
	SuccessfulResponses int
	// FailureThreshold is the number of consecutive failed health checks required before the node is considered unhealthy.
	FailedResponses int
}

type HealthCheckSucceededEvent struct {
	Duration time.Duration
}

type HealthMetrics struct {
	CheckResultsTotal *prometheus.CounterVec
	Up                prometheus.Gauge
	// contains filtered or unexported fields
}

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

type MetricsJob interface {
	Start(ctx context.Context) error
	Stop() error
	Name() string
}

type Node interface {
	// Lifecycle
	// Start starts the node.
	Start(ctx context.Context) error
	// StartAsync starts the node asynchronously.
	StartAsync(ctx context.Context)
	// Stop stops the node.
	Stop(ctx context.Context) error

	// Service returns the Service client for the node.
	Service() eth2client.Service

	// Getters
	// Options returns the options for the node.
	Options() *Options

	// Wallclock returns the EthWallclock instance
	Wallclock() *ethwallclock.EthereumBeaconChain

	// Eth getters. These are all cached.
	// Spec returns the spec for the node.
	Spec() (*state.Spec, error)
	// SyncState returns the sync state for the node.
	SyncState() (*v1.SyncState, error)
	// Genesis returns the genesis for the node.
	Genesis() (*v1.Genesis, error)
	// NodeVersion returns the node version.
	NodeVersion() (string, error)
	// Status returns the status of the ndoe.
	Status() *Status
	// Finality returns the finality checkpoint for the node.
	Finality() (*v1.Finality, error)
	// Healthy returns true if the node is healthy.
	Healthy() bool

	// Fetchers - these are not cached and will always fetch from the node.
	// FetchBlock fetches the block for the given state id.
	FetchBlock(ctx context.Context, stateID string) (*spec.VersionedSignedBeaconBlock, error)
	// FetchRawBlock fetches the raw, unparsed block for the given block id.
	FetchRawBlock(ctx context.Context, blockID string, contentType string) ([]byte, error)
	// FetchRawExecutionPayloadEnvelope fetches the raw, unparsed signed execution
	// payload envelope for the given block id (gloas onwards).
	FetchRawExecutionPayloadEnvelope(ctx context.Context, blockID string, contentType string) ([]byte, error)
	// FetchExecutionPayloadEnvelope fetches the signed execution payload envelope for
	// the given block id (gloas onwards). Returns nil without an error when the node
	// has no envelope for the block, e.g. a withheld payload.
	FetchExecutionPayloadEnvelope(ctx context.Context, blockID string) (*spec.VersionedSignedExecutionPayloadEnvelope, error)
	// FetchBlockRoot fetches the block root for the given state id.
	FetchBlockRoot(ctx context.Context, stateID string) (*phase0.Root, error)
	// FetchBeaconState fetches the beacon state for the given state id.
	FetchBeaconState(ctx context.Context, stateID string) (*spec.VersionedBeaconState, error)
	// FetchBeaconStateRoot fetches the state root for the given state id.
	FetchBeaconStateRoot(ctx context.Context, stateID string) (phase0.Root, error)
	// FetchRawBeaconState fetches the raw, unparsed beacon state for the given state id.
	FetchRawBeaconState(ctx context.Context, stateID string, contentType string) ([]byte, error)
	// OpenRawBeaconState opens a streaming beacon state response. A successful
	// return only establishes the response status and body; reads can still fail
	// and are governed by ctx and the configured raw API client timeout. The caller
	// must always close the response. Slow or partial reads retain transport
	// resources, so callers should bound concurrency.
	OpenRawBeaconState(ctx context.Context, stateID string, contentType string) (*api.RawResponse, error)
	// OpenRawBlock opens a streaming block response. A successful return only
	// establishes the response status and body; reads can still fail and remain
	// governed by ctx and the configured raw API client timeout. The caller must
	// always close the response. Slow or partial reads retain transport
	// resources, so callers should bound concurrency.
	OpenRawBlock(ctx context.Context, blockID string, contentType string) (*api.RawResponse, error)
	// OpenRawExecutionPayloadEnvelope opens a streaming signed execution payload
	// envelope response. A successful return only establishes the response status
	// and body; reads can still fail and are governed by ctx and the configured raw
	// API client timeout. The caller must always close the response. Slow or
	// partial reads retain transport resources, so callers should bound concurrency.
	OpenRawExecutionPayloadEnvelope(ctx context.Context, blockID string, contentType string) (*api.RawResponse, error)
	// FetchValidators fetches the validators for the given state id and validator ids.
	FetchValidators(ctx context.Context, state string, indices []phase0.ValidatorIndex, pubKeys []phase0.BLSPubKey) (map[phase0.ValidatorIndex]*v1.Validator, error)
	// FetchFinality fetches the finality checkpoint for the state id.
	FetchFinality(ctx context.Context, stateID string) (*v1.Finality, error)
	// FetchGenesis fetches the genesis configuration.
	FetchGenesis(ctx context.Context) (*v1.Genesis, error)
	// FetchPeers fetches the peers from the beacon node.
	FetchPeers(ctx context.Context) (*types.Peers, error)
	// FetchSyncStatus fetches the sync status from the beacon node.
	FetchSyncStatus(ctx context.Context) (*v1.SyncState, error)
	// FetchNodeVersion fetches the node version from the beacon node.
	FetchNodeVersion(ctx context.Context) (string, error)
	// FetchRawSpec fetches the raw, unparsed spec from the beacon node.
	FetchRawSpec(ctx context.Context) (map[string]any, error)
	// FetchSpec fetches the spec from the beacon node.
	FetchSpec(ctx context.Context) (*state.Spec, error)
	// FetchProposerDuties fetches the proposer duties from the beacon node.
	FetchProposerDuties(ctx context.Context, epoch phase0.Epoch) ([]*v1.ProposerDuty, error)
	// FetchForkChoice fetches the fork choice context.
	FetchForkChoice(ctx context.Context) (*v1.ForkChoice, error)
	// FetchDepositSnapshot fetches the deposit snapshot.
	FetchDepositSnapshot(ctx context.Context) (*types.DepositSnapshot, error)
	// FetchBeaconCommittees fetches the committees for the given epoch at the given state.
	FetchBeaconCommittees(ctx context.Context, state string, epoch *phase0.Epoch) ([]*v1.BeaconCommittee, error)
	// FetchAttestationData fetches the attestation data for the given slot and committee index.
	FetchAttestationData(ctx context.Context, slot phase0.Slot, committeeIndex phase0.CommitteeIndex) (*phase0.AttestationData, error)
	// FetchBeaconBlockBlobs fetches blob sidecars for the given block id.
	FetchBeaconBlockBlobs(ctx context.Context, blockID string) ([]*deneb.BlobSidecar, error)
	// FetchBeaconBlockHeader fetches beacon block headers.
	FetchBeaconBlockHeader(ctx context.Context, opts *eapi.BeaconBlockHeaderOpts) (*v1.BeaconBlockHeader, error)
	// FetchNodeIdentity fetches the node identity.
	FetchNodeIdentity(ctx context.Context) (*types.Identity, error)

	// Subscriptions
	// - Proxied Beacon events
	// OnEvent is called when a beacon event is received.
	OnEvent(ctx context.Context, handler func(ctx context.Context, ev *v1.Event) error)
	// OnBlock is called when a block is received.
	OnBlock(ctx context.Context, handler func(ctx context.Context, ev *v1.BlockEvent) error)
	// OnBlockGossip is called when a block gossip is received.
	OnBlockGossip(ctx context.Context, handler func(ctx context.Context, ev *v1.BlockGossipEvent) error)
	// OnAttestation is called when an attestation is received.
	OnAttestation(ctx context.Context, handler func(ctx context.Context, ev *spec.VersionedAttestation) error)
	// OnSingleAttestation is called when a single attestation is received.
	OnSingleAttestation(ctx context.Context, handler func(ctx context.Context, ev *electra.SingleAttestation) error)
	// OnFinalizedCheckpoint is called when a finalized checkpoint is received.
	OnFinalizedCheckpoint(ctx context.Context, handler func(ctx context.Context, ev *v1.FinalizedCheckpointEvent) error)
	// OnHead is called when the head is received.
	OnHead(ctx context.Context, handler func(ctx context.Context, ev *v1.HeadEvent) error)
	// OnHeadV2 is called when a head_v2 event (gloas) is received.
	OnHeadV2(ctx context.Context, handler func(ctx context.Context, ev *v1.HeadEventV2) error)
	// OnChainReOrg is called when a chain reorg is received.
	OnChainReOrg(ctx context.Context, handler func(ctx context.Context, ev *v1.ChainReorgEvent) error)
	// OnVoluntaryExit is called when a voluntary exit is received.
	OnVoluntaryExit(ctx context.Context, handler func(ctx context.Context, ev *phase0.SignedVoluntaryExit) error)
	// OnContributionAndProof is called when a contribution and proof is received.
	OnContributionAndProof(ctx context.Context, handler func(ctx context.Context, ev *altair.SignedContributionAndProof) error)
	// OnBlobSidecar is called when a blob sidecar is received.
	OnBlobSidecar(ctx context.Context, handler func(ctx context.Context, ev *v1.BlobSidecarEvent) error)
	// OnDataColumnSidecar is called when a data column sidecar is received.
	OnDataColumnSidecar(ctx context.Context, handler func(ctx context.Context, ev *v1.DataColumnSidecarEvent) error)
	// OnFastConfirmation is called when a fast confirmation is received.
	OnFastConfirmation(ctx context.Context, handler func(ctx context.Context, ev *v1.FastConfirmationEvent) error)

	// EIP-7732 ePBS subscriptions.
	// OnExecutionPayload is called when an execution payload has been imported into fork-choice.
	OnExecutionPayload(ctx context.Context, handler func(ctx context.Context, ev *v1.ExecutionPayloadEvent) error)
	// OnExecutionPayloadGossip is called when an execution payload has passed gossip validation.
	OnExecutionPayloadGossip(ctx context.Context, handler func(ctx context.Context, ev *v1.ExecutionPayloadEvent) error)
	// OnExecutionPayloadAvailable is called when the node has verified the execution payload and blobs are locally available.
	OnExecutionPayloadAvailable(ctx context.Context, handler func(ctx context.Context, ev *v1.ExecutionPayloadAvailableEvent) error)
	// OnExecutionPayloadBid is called when a SignedExecutionPayloadBid passes gossip validation.
	OnExecutionPayloadBid(ctx context.Context, handler func(ctx context.Context, ev *gloas.SignedExecutionPayloadBid) error)
	// OnPayloadAttestationMessage is called when a PayloadAttestationMessage is received.
	OnPayloadAttestationMessage(ctx context.Context, handler func(ctx context.Context, ev *gloas.PayloadAttestationMessage) error)
	// OnProposerPreferences is called when a SignedProposerPreferences is received.
	OnProposerPreferences(ctx context.Context, handler func(ctx context.Context, ev *gloas.SignedProposerPreferences) error)

	// - Custom events
	// OnReady is called when the node is ready.
	OnReady(ctx context.Context, handler func(ctx context.Context, event *ReadyEvent) error)
	// OnSyncStatus is called when the sync status changes.
	OnSyncStatus(ctx context.Context, handler func(ctx context.Context, event *SyncStatusEvent) error)
	// OnNodeVersionUpdated is called when the node version is updated.
	OnNodeVersionUpdated(ctx context.Context, handler func(ctx context.Context, event *NodeVersionUpdatedEvent) error)
	// OnPeersUpdated is called when the peers are updated.
	OnPeersUpdated(ctx context.Context, handler func(ctx context.Context, event *PeersUpdatedEvent) error)
	// OnSpecUpdated is called when the spec is updated.
	OnSpecUpdated(ctx context.Context, handler func(ctx context.Context, event *SpecUpdatedEvent) error)
	// OnEmptySlot is called when an empty slot is detected.
	OnEmptySlot(ctx context.Context, handler func(ctx context.Context, event *EmptySlotEvent) error)
	// OnHealthCheckFailed is called when a health check fails.
	OnHealthCheckFailed(ctx context.Context, handler func(ctx context.Context, event *HealthCheckFailedEvent) error)
	// OnHealthCheckSucceeded is called when a health check succeeds.
	OnHealthCheckSucceeded(ctx context.Context, handler func(ctx context.Context, event *HealthCheckSucceededEvent) error)
	// OnFinalityCheckpointUpdated is called when a the head finality checkpoint is updated.
	OnFinalityCheckpointUpdated(ctx context.Context, handler func(ctx context.Context, event *FinalityCheckpointUpdated) error)
	// OnFirstTimeHealthy is called when the node is healthy for the first time.
	OnFirstTimeHealthy(ctx context.Context, handler func(ctx context.Context, event *FirstTimeHealthyEvent) error)

	// GetZeroLogLevel returns the zerolog level for the node.
	GetZeroLogLevel() zerolog.Level
}

type NodeVersionUpdatedEvent struct {
	Version string
}

type Options struct {
	BeaconSubscription BeaconSubscriptionOptions
	HealthCheck        HealthCheckOptions
	PrometheusMetrics  bool
	DetectEmptySlots   bool
	GoEth2ClientParams []ehttp.Parameter
	APIClient          *APIClientOptions
}

type PeersUpdatedEvent struct {
	Peers types.Peers
}

type RawResponseMetrics struct {
	OpenStreams prometheus.Gauge
	Leaks       prometheus.Counter
}

type ReadyEvent struct {
}

type SpecMetrics struct {
	SafeSlotsToUpdateJustified       prometheus.Gauge
	DepositChainID                   prometheus.Gauge
	ConfigName                       prometheus.GaugeVec
	MaxValidatorsPerCommittee        prometheus.Gauge
	SecondsPerEth1Block              prometheus.Gauge
	BaseRewardFactor                 prometheus.Gauge
	EpochsPerSyncCommitteePeriod     prometheus.Gauge
	EffectiveBalanceIncrement        prometheus.Gauge
	MaxAttestations                  prometheus.Gauge
	MinSyncCommitteeParticipants     prometheus.Gauge
	GenesisDelay                     prometheus.Gauge
	SecondsPerSlot                   prometheus.Gauge
	MaxEffectiveBalance              prometheus.Gauge
	TerminalTotalDifficulty          prometheus.Gauge
	TerminalTotalDifficultyTrillions prometheus.Gauge
	MaxDeposits                      prometheus.Gauge
	MinGenesisActiveValidatorCount   prometheus.Gauge
	TargetCommitteeSize              prometheus.Gauge
	SyncCommitteeSize                prometheus.Gauge
	Eth1FollowDistance               prometheus.Gauge
	TerminalBlockHashActivationEpoch prometheus.Gauge
	MinDepositAmount                 prometheus.Gauge
	SlotsPerEpoch                    prometheus.Gauge
	PresetBase                       prometheus.GaugeVec
	// contains filtered or unexported fields
}

type SpecUpdatedEvent struct {
	Spec *state.Spec
}

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

type SyncMetrics struct {
	Percentage           prometheus.Gauge
	EstimatedHighestSlot prometheus.Gauge
	HeadSlot             prometheus.Gauge
	Distance             prometheus.Gauge
	IsSyncing            prometheus.Gauge
	IsOptimistic         prometheus.Gauge
	// contains filtered or unexported fields
}

type SyncStatusEvent struct {
	State *v1.SyncState
}