standard

package

v0.8.3 Latest Latest Go to latest Published: Apr 8, 2024 License: Apache-2.0 Imports: 23 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/wealdtech/chaind

Links

Open Source Insights

Documentation ¶

Index ¶

type Parameter
type Service
- func New(ctx context.Context, params ...Parameter) (*Service, error)
- func (s *Service) OnFinalityUpdated(ctx context.Context, finalizedEpoch phase0.Epoch)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Parameter ¶

type Parameter interface {
	// contains filtered or unexported methods
}

Parameter is the interface for service parameters.

func WithBlockSummaries ¶

func WithBlockSummaries(enabled bool) Parameter

WithBlockSummaries states if the module should generate block summaries.

func WithChainDB ¶

func WithChainDB(chainDB chaindb.Service) Parameter

WithChainDB sets the chain database for this module.

func WithChainTime ¶

func WithChainTime(chainTime chaintime.Service) Parameter

WithChainTime sets the chain time service for this module.

func WithETH2Client ¶

func WithETH2Client(eth2Client eth2client.Service) Parameter

WithETH2Client sets the Ethereum 2 client for this module.

func WithEpochSummaries ¶

func WithEpochSummaries(enabled bool) Parameter

WithEpochSummaries states if the module should generate epoch summaries.

func WithLogLevel ¶

func WithLogLevel(logLevel zerolog.Level) Parameter

WithLogLevel sets the log level for the module.

func WithMaxDaysPerRun ¶ added in v0.7.0

func WithMaxDaysPerRun(maxDaysPerRun uint64) Parameter

WithMaxDaysPerRun provides the maximum number of days to process in a single run of the summarizer.

func WithMonitor ¶

func WithMonitor(monitor metrics.Service) Parameter

WithMonitor sets the monitor for the module.

func WithValidatorBalanceRetention ¶ added in v0.7.0

func WithValidatorBalanceRetention(retention string) Parameter

WithValidatorBalanceRetention provides the amount of validator balance data to retain.

func WithValidatorEpochRetention ¶ added in v0.7.0

func WithValidatorEpochRetention(retention string) Parameter

WithValidatorEpochRetention provides the amount of validator epoch data to retain.

func WithValidatorRetain ¶ added in v0.8.3

func WithValidatorRetain(validatorRetain []phase0.BLSPubKey) Parameter

WithValidatorRetain states if the module should retain balance and epoch summaries for a subset of validator.

func WithValidatorSummaries ¶

func WithValidatorSummaries(enabled bool) Parameter

WithValidatorSummaries states if the module should generate validator summaries.

type Service ¶

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

Service is a summarizer service.

func New ¶

func New(ctx context.Context, params ...Parameter) (*Service, error)

New creates a new service.

func (*Service) OnFinalityUpdated ¶

func (s *Service) OnFinalityUpdated(
	ctx context.Context,
	finalizedEpoch phase0.Epoch,
)

OnFinalityUpdated is called when finality has been updated in the database. This is usually triggered by the finalizer.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL