blockfilter

Documentation

Index

• Variables
• func NewProvider(opts ...options.Option[Filter]) module.Provider[*engine.Engine, filter.Filter]
• func WithMaxAllowedWallClockDrift(d time.Duration) options.Option[Filter]
• func WithMinCommittableSlotAge(age slot.Index) options.Option[Filter]
• func WithSignatureValidation(validation bool) options.Option[Filter]
• type Filter
  • func New(opts ...options.Option[Filter]) *Filter
  • func (f *Filter) Events() *filter.Events
  • func (f *Filter) ProcessReceivedBlock(block *models.Block, source identity.ID)

Variables

var (
	ErrorCommitmentNotCommittable      = errors.New("a block cannot commit to a slot that cannot objectively be committable yet")
	ErrorsBlockTimeTooFarAheadInFuture = errors.New("a block cannot be too far ahead in the future")
	ErrorsInvalidSignature             = errors.New("block has invalid signature")
	ErrorsSignatureValidationFailed    = errors.New("error validating block signature")
)

Functions

func NewProvider

func NewProvider(opts ...options.Option[Filter]) module.Provider[*engine.Engine, filter.Filter]

func WithMaxAllowedWallClockDrift

func WithMaxAllowedWallClockDrift(d time.Duration) options.Option[Filter]

WithMaxAllowedWallClockDrift specifies how far in the future are blocks allowed to be ahead of our own wall clock (defaults to 0 seconds).

func WithMinCommittableSlotAge

func WithMinCommittableSlotAge(age slot.Index) options.Option[Filter]

WithMinCommittableSlotAge specifies how old a slot has to be for it to be committable.

func WithSignatureValidation

func WithSignatureValidation(validation bool) options.Option[Filter]

WithSignatureValidation specifies if the block signature should be validated (defaults to yes).

Types

type Filter

type Filter struct {
	module.Module
	// contains filtered or unexported fields
}

Filter filters blocks.

func New

func New(opts ...options.Option[Filter]) *Filter

New creates a new Filter.

func (*Filter) Events

func (f *Filter) Events() *filter.Events

func (*Filter) ProcessReceivedBlock

func (f *Filter) ProcessReceivedBlock(block *models.Block, source identity.ID)

ProcessReceivedBlock processes block from the given source.