beacon

type CacheConfig struct {
	// Blocks holds the block cache configuration.
	Blocks store.Config `yaml:"blocks" default:"{\"MaxItems\": 30}"`
	// States holds the state cache configuration.
	States store.Config `yaml:"states" default:"{\"MaxItems\": 5}"`
	// DepositSnapshots holds the deposit snapshot cache configuration.
	DepositSnapshots store.Config `yaml:"deposit_snapshots" default:"{\"MaxItems\": 30}"`
	// BlobSidecars holds the blob sidecar cache configuration.
	BlobSidecars store.Config `yaml:"blob_sidecars" default:"{\"MaxItems\": 30}"`
}

type Config struct {
	// Mode sets the operational mode of the provider.
	Mode OperatingMode `yaml:"mode" default:"light"`
	// CustomPreset enables the use of a custom preset for the provider.
	CustomPreset bool `yaml:"custom_preset" default:"false"`
	// Cache holds configuration for the caches.
	Caches CacheConfig `yaml:"caches"`

	// HistoricalEpochCount determines how many historical epochs the provider will cache.
	HistoricalEpochCount int `yaml:"historical_epoch_count" default:"20"`

	// Cache holds configuration for the caches.
	Frontend FrontendConfig `yaml:"frontend"`
}

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

type FinalityProvider interface {
	// Start starts the provider.
	Start(ctx context.Context) error
	// StartAsync starts the provider in a goroutine.
	StartAsync(ctx context.Context)
	// Healthy returns true if the provider is healthy.
	Healthy(ctx context.Context) (bool, error)
	// Peers returns the peers the provider is connected to).
	Peers(ctx context.Context) (types.Peers, error)
	// PeerCount returns the amount of peers the provider is connected to (the amount of healthy upstreams).
	PeerCount(ctx context.Context) (uint64, error)
	// Syncing returns the sync state of the provider.
	Syncing(ctx context.Context) (*v1.SyncState, error)
	// Head returns the head finality.
	Head(ctx context.Context) (*v1.Finality, error)
	// Finalized returns the finalized finality.
	Finalized(ctx context.Context) (*v1.Finality, error)
	// Genesis returns the chain genesis.
	Genesis(ctx context.Context) (*v1.Genesis, error)
	// Spec returns the chain spec.
	Spec() (*state.Spec, error)
	// SSZEncoder returns the SSZ encoder for the provider.
	SSZEncoder() *ssz.Encoder
	// UpstreamsStatus returns the status of all the upstreams.
	UpstreamsStatus(ctx context.Context) (map[string]*UpstreamStatus, error)
	// GetBlockBySlot returns the block at the given slot.
	GetBlockBySlot(ctx context.Context, slot phase0.Slot) (*spec.VersionedSignedBeaconBlock, error)
	// GetBlockByRoot returns the block with the given root.
	GetBlockByRoot(ctx context.Context, root phase0.Root) (*spec.VersionedSignedBeaconBlock, error)
	// GetBlockByStateRoot returns the block with the given root.
	GetBlockByStateRoot(ctx context.Context, root phase0.Root) (*spec.VersionedSignedBeaconBlock, error)
	// GetBeaconStateBySlot returns the beacon sate with the given slot.
	GetBeaconStateBySlot(ctx context.Context, slot phase0.Slot) (*spec.VersionedBeaconState, error)
	// GetBeaconStateByStateRoot returns the beacon sate with the given state root.
	GetBeaconStateByStateRoot(ctx context.Context, root phase0.Root) (*spec.VersionedBeaconState, error)
	// GetBeaconStateByRoot returns the beacon sate with the given root.
	GetBeaconStateByRoot(ctx context.Context, root phase0.Root) (*spec.VersionedBeaconState, error)
	// GetBlobSidecarsBySlot returns the blob sidecars for the given slot.
	GetBlobSidecarsBySlot(ctx context.Context, slot phase0.Slot) ([]*deneb.BlobSidecar, error)
	// ListFinalizedSlots returns a slice of finalized slots.
	ListFinalizedSlots(ctx context.Context) ([]phase0.Slot, error)
	// GetEpochBySlot returns the epoch for the given slot.
	GetEpochBySlot(ctx context.Context, slot phase0.Slot) (phase0.Epoch, error)
	// OperatingMode returns the mode of operation for the instance.
	OperatingMode() OperatingMode
	// GetSlotTime returns the wall clock for the given slot.
	GetSlotTime(ctx context.Context, slot phase0.Slot) (eth.SlotTime, error)
	// GetDepositSnapshot returns the deposit snapshot at the given epoch.
	GetDepositSnapshot(ctx context.Context, epoch phase0.Epoch) (*types.DepositSnapshot, error)
}

type FrontendConfig struct {
	// Enabled flag enables the frontend assets to be served
	Enabled bool `yaml:"enabled" default:"true"`

	// PublicURL is the public URL where checkpointz will be served from
	PublicURL string `yaml:"public_url"`

	// BrandName is the name of the brand to display in the frontend
	BrandName string `yaml:"brand_name"`

	// BrandImageURL is the URL of the brand image to be displayed on the frontend
	BrandImageURL string `yaml:"brand_image_url"`
}

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

type Node struct {
	Config node.Config
	Beacon sbeacon.Node
}

type Nodes []*Node

type OperatingMode string

type UpstreamStatus struct {
	Name        string       `json:"name"`
	Healthy     bool         `json:"healthy"`
	Finality    *v1.Finality `json:"finality"`
	NetworkName string       `json:"network_name,omitempty"`
}