compliance

Documentation

Index

• Constants
• type Config
  • func DefaultConfig() Config
  • func (c *Config) GetSkipNewProposalsThreshold() uint64
• type Opt
  • func WithSkipNewProposalsThreshold(threshold uint64) Opt

Constants

const MinSkipNewProposalsThreshold = 1000

Types

type Config

type Config struct {
	// SkipNewProposalsThreshold defines the threshold for dropping blocks that are too far in
	// the future. Formally, let `H` be the view of the latest finalized block known to this
	// node. A new block `B` is dropped without further processing, if
	//   B.View > H + SkipNewProposalsThreshold
	SkipNewProposalsThreshold uint64
}

Config is shared config for consensus and collection compliance engines, and the consensus follower engine.

func DefaultConfig

func DefaultConfig() Config

func (*Config) GetSkipNewProposalsThreshold

func (c *Config) GetSkipNewProposalsThreshold() uint64

GetSkipNewProposalsThreshold returns stored value in config possibly applying a lower bound.

type Opt

type Opt func(*Config)

func WithSkipNewProposalsThreshold

func WithSkipNewProposalsThreshold(threshold uint64) Opt

WithSkipNewProposalsThreshold returns an option to set the skip new proposals threshold. For inputs less than the minimum threshold, the minimum threshold will be set instead.