ethereum

Documentation

Index

• Variables
• func ConvertKzgCommitmentToVersionedHash(commitment []byte) common.Hash
• type BeaconNode
  • func NewBeaconNode(ctx context.Context, name string, config *Config, log logrus.FieldLogger) (*BeaconNode, error)
  • func (b *BeaconNode) Duties() *services.DutiesService
  • func (b *BeaconNode) GetBeaconBlock(ctx context.Context, identifier string, ignoreMetrics ...bool) (*spec.VersionedSignedBeaconBlock, error)
  • func (b *BeaconNode) LazyLoadBeaconBlock(identifier string)
  • func (b *BeaconNode) Metadata() *services.MetadataService
  • func (b *BeaconNode) Node() beacon.Node
  • func (b *BeaconNode) OnReady(_ context.Context, callback func(ctx context.Context) error)
  • func (b *BeaconNode) Start(ctx context.Context) error
  • func (b *BeaconNode) Synced(ctx context.Context) error
• type Config
  • func (c *Config) Validate() error
• type Metrics
  • func NewMetrics(namespace, beaconNodeName string) *Metrics
  • func (m *Metrics) IncBlockCacheHit(network string)
  • func (m *Metrics) IncBlockCacheMiss(network string)
  • func (m *Metrics) IncBlocksFetchErrors(network string)
  • func (m *Metrics) IncBlocksFetched(network string)
  • func (m *Metrics) SetPreloadBlockQueueSize(network string, size int)

Variables

var (
	ForkNamePhase0    = "PHASE0"
	ForkNameAltair    = "ALTAIR"
	ForkNameBellatrix = "BELLATRIX"
	ForkNameCapella   = "CAPELLA"
	ForkNameDeneb     = "DENEB"
	ForkNameElectra   = "ELECTRA"
)

Functions

func ConvertKzgCommitmentToVersionedHash

func ConvertKzgCommitmentToVersionedHash(commitment []byte) common.Hash

Reference: https://github.com/prysmaticlabs/prysm/blob/bfae7f3c9fa30cf0d513b59ad95cc99a5316eacd/beacon-chain/blockchain/execution_engine.go#L413

Types

type BeaconNode

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

func NewBeaconNode

func NewBeaconNode(ctx context.Context, name string, config *Config, log logrus.FieldLogger) (*BeaconNode, error)

func (*BeaconNode) Duties

func (b *BeaconNode) Duties() *services.DutiesService

func (*BeaconNode) GetBeaconBlock

func (b *BeaconNode) GetBeaconBlock(ctx context.Context, identifier string, ignoreMetrics ...bool) (*spec.VersionedSignedBeaconBlock, error)

GetBeaconBlock returns a beacon block by its identifier. Blocks can be cached internally.

func (*BeaconNode) LazyLoadBeaconBlock

func (b *BeaconNode) LazyLoadBeaconBlock(identifier string)

func (*BeaconNode) Metadata

func (b *BeaconNode) Metadata() *services.MetadataService

func (*BeaconNode) Node

func (b *BeaconNode) Node() beacon.Node

func (*BeaconNode) OnReady

func (b *BeaconNode) OnReady(_ context.Context, callback func(ctx context.Context) error)

func (*BeaconNode) Start

func (b *BeaconNode) Start(ctx context.Context) error

func (*BeaconNode) Synced

func (b *BeaconNode) Synced(ctx context.Context) error

type Config

type Config struct {
	// The address of the Beacon node to connect to
	BeaconNodeAddress string `yaml:"beaconNodeAddress"`
	// OverrideNetworkName is the name of the network to use for the sentry.
	// If not set, the network name will be retrieved from the beacon node.
	OverrideNetworkName string `yaml:"overrideNetworkName"  default:""`
	// BlockCacheSize is the number of blocks to cache.
	BlockCacheSize uint64 `yaml:"blockCacheSize" default:"1000"`
	// BlockCacheTTL is the time to live for blocks in the cache.
	BlockCacheTTL human.Duration `yaml:"blockCacheTtl" default:"1h"`
	// BeaconNodeHeaders is a map of headers to send to the beacon node.
	BeaconNodeHeaders map[string]string `yaml:"beaconNodeHeaders"`
	// BlockPreloadWorkers is the number of workers to use for preloading blocks.
	BlockPreloadWorkers uint64 `yaml:"blockPreloadWorkers" default:"5"`
	// BlockPreloadQueueSize is the size of the queue for preloading blocks.
	BlockPreloadQueueSize uint64 `yaml:"blockPreloadQueueSize" default:"5000"`
}

func (*Config) Validate

func (c *Config) Validate() error

type Metrics

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

func NewMetrics

func NewMetrics(namespace, beaconNodeName string) *Metrics

func (*Metrics) IncBlockCacheHit

func (m *Metrics) IncBlockCacheHit(network string)

func (*Metrics) IncBlockCacheMiss

func (m *Metrics) IncBlockCacheMiss(network string)

func (*Metrics) IncBlocksFetchErrors

func (m *Metrics) IncBlocksFetchErrors(network string)

func (*Metrics) IncBlocksFetched

func (m *Metrics) IncBlocksFetched(network string)

func (*Metrics) SetPreloadBlockQueueSize

func (m *Metrics) SetPreloadBlockQueueSize(network string, size int)