blocks

Documentation

Index

• func ValidateRewards(rewards []types.AnyReward) error
• type CertConfig
• type Certifier
  • func NewCertifier(db sql.StateDatabase, o eligibility.Rolacle, v *signing.EdVerifier, ...) *Certifier
  • func (c *Certifier) CertCount() map[types.EpochID]int
  • func (c *Certifier) CertifyIfEligible(ctx context.Context, lid types.LayerID, bid types.BlockID) error
  • func (c *Certifier) HandleCertifyMessage(ctx context.Context, peer p2p.Peer, data []byte) error
  • func (c *Certifier) HandleSyncedCertificate(ctx context.Context, lid types.LayerID, cert *types.Certificate) error
  • func (c *Certifier) NumCached() int
  • func (c *Certifier) Register(sig *signing.EdSigner)
  • func (c *Certifier) RegisterForCert(ctx context.Context, lid types.LayerID, bid types.BlockID) error
  • func (c *Certifier) Start(ctx context.Context)
  • func (c *Certifier) Stop()
• type CertifierOpt
  • func WithCertConfig(cfg CertConfig) CertifierOpt
  • func WithCertifierLogger(logger *zap.Logger) CertifierOpt
• type Config
• type Generator
  • func NewGenerator(db sql.StateDatabase, atxs *atxsdata.Data, proposals *store.Store, ...) *Generator
  • func (g *Generator) Start(ctx context.Context)
  • func (g *Generator) Stop()
• type GeneratorOpt
  • func WithConfig(cfg Config) GeneratorOpt
  • func WithGeneratorLogger(logger *zap.Logger) GeneratorOpt
  • func WithHareOutputChan(ch <-chan hare4.ConsensusOutput) GeneratorOpt
• type Handler
  • func NewHandler(f system.Fetcher, db sql.StateDatabase, tortoise tortoiseProvider, ...) *Handler
  • func (h *Handler) HandleSyncedBlock(ctx context.Context, expHash types.Hash32, peer p2p.Peer, data []byte) error
• type Opt
  • func WithLogger(logger *zap.Logger) Opt

Functions

func ValidateRewards

func ValidateRewards(rewards []types.AnyReward) error

ValidateRewards syntactically validates rewards.

Types

type CertConfig

type CertConfig struct {
	CommitteeSize    int `mapstructure:"committee-size"`
	CertifyThreshold int
	LayerBuffer      uint32
	NumLayersToKeep  uint32
}

CertConfig is the config for Certifier.

type Certifier

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

Certifier collects enough CertifyMessage for a given hare output and generate certificate.

func NewCertifier

func NewCertifier(
	db sql.StateDatabase,
	o eligibility.Rolacle,

	v *signing.EdVerifier,
	p pubsub.Publisher,
	lc layerClock,
	b system.BeaconGetter,
	tortoise system.Tortoise,
	opts ...CertifierOpt,
) *Certifier

NewCertifier creates new block certifier.

func (*Certifier) CertCount

func (c *Certifier) CertCount() map[types.EpochID]int

func (*Certifier) CertifyIfEligible

func (c *Certifier) CertifyIfEligible(ctx context.Context, lid types.LayerID, bid types.BlockID) error

CertifyIfEligible signs the hare output, along with its role proof as a certifier, and gossip the CertifyMessage if the node is eligible to be a certifier.

func (*Certifier) HandleCertifyMessage

func (c *Certifier) HandleCertifyMessage(ctx context.Context, peer p2p.Peer, data []byte) error

func (*Certifier) HandleSyncedCertificate

func (c *Certifier) HandleSyncedCertificate(ctx context.Context, lid types.LayerID, cert *types.Certificate) error

HandleSyncedCertificate handles Certificate from sync.

func (*Certifier) NumCached

func (c *Certifier) NumCached() int

NumCached returns the number of layers being cached in memory.

func (*Certifier) Register

func (c *Certifier) Register(sig *signing.EdSigner)

func (*Certifier) RegisterForCert

func (c *Certifier) RegisterForCert(ctx context.Context, lid types.LayerID, bid types.BlockID) error

RegisterForCert register to generate a certificate for the specified layer/block.

func (*Certifier) Start

func (c *Certifier) Start(ctx context.Context)

Start starts the background goroutine for periodic pruning.

func (*Certifier) Stop

func (c *Certifier) Stop()

Stop stops the outstanding goroutines.

type CertifierOpt

type CertifierOpt func(*Certifier)

CertifierOpt for configuring Certifier.

func WithCertConfig

func WithCertConfig(cfg CertConfig) CertifierOpt

WithCertConfig defines cfg for Certifier.

func WithCertifierLogger

func WithCertifierLogger(logger *zap.Logger) CertifierOpt

WithCertifierLogger defines logger for Certifier.

type Config

type Config struct {
	GenBlockInterval   time.Duration
	BlockGasLimit      uint64
	OptFilterThreshold int
}

Config is the config for Generator.

type Generator

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

Generator generates a block from proposals.

func NewGenerator

func NewGenerator(
	db sql.StateDatabase,
	atxs *atxsdata.Data,
	proposals *store.Store,
	exec executor,
	m meshProvider,
	f system.ProposalFetcher,
	c certifier,
	p layerPatrol,
	opts ...GeneratorOpt,
) *Generator

NewGenerator creates new block generator.

func (*Generator) Start

func (g *Generator) Start(ctx context.Context)

Start starts listening to hare output.

func (*Generator) Stop

func (g *Generator) Stop()

Stop stops listening to hare output.

type GeneratorOpt

type GeneratorOpt func(*Generator)

GeneratorOpt for configuring Generator.

func WithConfig

func WithConfig(cfg Config) GeneratorOpt

WithConfig defines cfg for Generator.

func WithGeneratorLogger

func WithGeneratorLogger(logger *zap.Logger) GeneratorOpt

WithGeneratorLogger defines logger for Generator.

func WithHareOutputChan

func WithHareOutputChan(ch <-chan hare4.ConsensusOutput) GeneratorOpt

WithHareOutputChan sets the chan to listen to hare output.

type Handler

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

Handler processes Block fetched from peers during sync.

func NewHandler

func NewHandler(
	f system.Fetcher,
	db sql.StateDatabase,
	tortoise tortoiseProvider,
	m meshProvider,
	opts ...Opt,
) *Handler

NewHandler creates new Handler.

func (*Handler) HandleSyncedBlock

func (h *Handler) HandleSyncedBlock(ctx context.Context, expHash types.Hash32, peer p2p.Peer, data []byte) error

HandleSyncedBlock handles Block data from sync.

type Opt

type Opt func(*Handler)

Opt for configuring BlockHandler.

func WithLogger

func WithLogger(logger *zap.Logger) Opt

WithLogger defines logger for Handler.