headtracker

Documentation

Index

• Variables
• func NewHeadBroadcaster(lggr logger.Logger) *headBroadcaster
• func NewHeadListener(lggr logger.Logger, ethClient evmclient.Client, config Config, ...) *headListener
• func NewHeadSaver(lggr logger.Logger, orm ORM, config Config, htConfig HeadTrackerConfig) httypes.HeadSaver
• func NewHeadTracker(lggr logger.Logger, ethClient evmclient.Client, config Config, ...) httypes.HeadTracker
• type Config
• type DbORM
  • func NewORM(chainID big.Int, db sqlutil.DataSource) *DbORM
  • func (orm *DbORM) HeadByHash(ctx context.Context, hash common.Hash) (head *evmtypes.Head, err error)
  • func (orm *DbORM) IdempotentInsertHead(ctx context.Context, head *evmtypes.Head) error
  • func (orm *DbORM) LatestHead(ctx context.Context) (head *evmtypes.Head, err error)
  • func (orm *DbORM) LatestHeads(ctx context.Context, minBlockNumer int64) (heads []*evmtypes.Head, err error)
  • func (orm *DbORM) TrimOldHeads(ctx context.Context, minBlockNumber int64) (err error)
• type HeadTrackerConfig
• type Heads
  • func NewHeads() Heads
• type ORM

Variables

var NullSaver httypes.HeadSaver = &nullSaver{}

var NullTracker httypes.HeadTracker = &nullTracker{}

Functions

func NewHeadBroadcaster

func NewHeadBroadcaster(
	lggr logger.Logger,
) *headBroadcaster

func NewHeadListener

func NewHeadListener(
	lggr logger.Logger,
	ethClient evmclient.Client,
	config Config, chStop chan struct{},
) *headListener

func NewHeadSaver

func NewHeadSaver(lggr logger.Logger, orm ORM, config Config, htConfig HeadTrackerConfig) httypes.HeadSaver

func NewHeadTracker

func NewHeadTracker(
	lggr logger.Logger,
	ethClient evmclient.Client,
	config Config,
	htConfig HeadTrackerConfig,
	headBroadcaster httypes.HeadBroadcaster,
	headSaver httypes.HeadSaver,
	mailMon *mailbox.Monitor,
) httypes.HeadTracker

Types

type Config

type Config interface {
	BlockEmissionIdleWarningThreshold() time.Duration
	FinalityDepth() uint32
	FinalityTagEnabled() bool
}

Config represents a subset of options needed by head tracker

type DbORM

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

func NewORM

func NewORM(chainID big.Int, db sqlutil.DataSource) *DbORM

NewORM creates an ORM scoped to chainID.

func (*DbORM) HeadByHash

func (orm *DbORM) HeadByHash(ctx context.Context, hash common.Hash) (head *evmtypes.Head, err error)

func (*DbORM) IdempotentInsertHead

func (orm *DbORM) IdempotentInsertHead(ctx context.Context, head *evmtypes.Head) error

func (*DbORM) LatestHead

func (orm *DbORM) LatestHead(ctx context.Context) (head *evmtypes.Head, err error)

func (*DbORM) LatestHeads

func (orm *DbORM) LatestHeads(ctx context.Context, minBlockNumer int64) (heads []*evmtypes.Head, err error)

func (*DbORM) TrimOldHeads

func (orm *DbORM) TrimOldHeads(ctx context.Context, minBlockNumber int64) (err error)

type HeadTrackerConfig

type HeadTrackerConfig interface {
	config.HeadTracker
}

type Heads

type Heads interface {
	// LatestHead returns the block header with the highest number that has been seen, or nil.
	LatestHead() *evmtypes.Head
	// HeadByHash returns a head for the specified hash, or nil.
	HeadByHash(hash common.Hash) *evmtypes.Head
	// AddHeads adds newHeads to the collection, eliminates duplicates,
	// sorts by head number, fixes parents and cuts off old heads (historyDepth).
	AddHeads(newHeads ...*evmtypes.Head)
	// Count returns number of heads in the collection.
	Count() int
	// MarkFinalized - finds `finalized` in the LatestHead and marks it and all direct ancestors as finalized.
	// Trims old blocks whose height is smaller than minBlockToKeep
	MarkFinalized(finalized common.Hash, minBlockToKeep int64) bool
}

Heads is a collection of heads. All methods are thread-safe.

func NewHeads

func NewHeads() Heads

type ORM

type ORM interface {
	// IdempotentInsertHead inserts a head only if the hash is new. Will do nothing if hash exists already.
	// No advisory lock required because this is thread safe.
	IdempotentInsertHead(ctx context.Context, head *evmtypes.Head) error
	// TrimOldHeads deletes heads such that only blocks >= minBlockNumber remain
	TrimOldHeads(ctx context.Context, minBlockNumber int64) (err error)
	// LatestHead returns the highest seen head
	LatestHead(ctx context.Context) (head *evmtypes.Head, err error)
	// LatestHeads returns the latest heads with blockNumbers >= minBlockNumber
	LatestHeads(ctx context.Context, minBlockNumber int64) (heads []*evmtypes.Head, err error)
	// HeadByHash fetches the head with the given hash from the db, returns nil if none exists
	HeadByHash(ctx context.Context, hash common.Hash) (head *evmtypes.Head, err error)
}