blocks

Documentation

Index

• type CertConfig
• type Certifier
  • func NewCertifier(db *sql.Database, o hare.Rolacle, n types.NodeID, s *signing.EdSigner, ...) *Certifier
  • func (c *Certifier) CertifyIfEligible(ctx context.Context, logger log.Log, lid types.LayerID, bid types.BlockID) error
  • func (c *Certifier) HandleCertifyMessage(ctx context.Context, peer p2p.Peer, msg []byte) pubsub.ValidationResult
  • func (c *Certifier) HandleSyncedCertificate(ctx context.Context, lid types.LayerID, cert *types.Certificate) error
  • func (c *Certifier) NumCached() int
  • func (c *Certifier) RegisterForCert(ctx context.Context, lid types.LayerID, bid types.BlockID) error
  • func (c *Certifier) Start()
  • func (c *Certifier) Stop()
• type CertifierOpt
  • func WithCertConfig(cfg CertConfig) CertifierOpt
  • func WithCertContext(ctx context.Context) CertifierOpt
  • func WithCertifierLogger(logger log.Log) CertifierOpt
• type Config
• type Generator
  • func NewGenerator(cdb *datastore.CachedDB, cState conservativeState, m meshProvider, ...) *Generator
  • func (g *Generator) Start()
  • func (g *Generator) Stop()
• type GeneratorOpt
  • func WithConfig(cfg Config) GeneratorOpt
  • func WithContext(ctx context.Context) GeneratorOpt
  • func WithGeneratorLogger(logger log.Log) GeneratorOpt
  • func WithHareOutputChan(ch chan hare.LayerOutput) GeneratorOpt
• type Handler
  • func NewHandler(f system.Fetcher, db *sql.Database, m meshProvider, opts ...Opt) *Handler
  • func (h *Handler) HandleSyncedBlock(ctx context.Context, data []byte) error
• type Opt
  • func WithLogger(logger log.Log) Opt

Types

type CertConfig

type CertConfig struct {
	CommitteeSize    int
	CertifyThreshold int
	WaitSigLayers    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.Database, o hare.Rolacle, n types.NodeID, s *signing.EdSigner, p pubsub.Publisher, lc layerClock, b system.BeaconGetter, tortoise system.Tortoise,
	opts ...CertifierOpt,
) *Certifier

NewCertifier creates new block certifier.

func (*Certifier) CertifyIfEligible

func (c *Certifier) CertifyIfEligible(ctx context.Context, logger log.Log, 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, msg []byte) pubsub.ValidationResult

HandleCertifyMessage is the gossip receiver for certify message.

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) 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()

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 WithCertContext

func WithCertContext(ctx context.Context) CertifierOpt

WithCertContext modifies parent context for Certifier.

func WithCertifierLogger

func WithCertifierLogger(logger log.Log) CertifierOpt

WithCertifierLogger defines logger for Certifier.

type Config

type Config struct {
	LayerSize      uint32
	LayersPerEpoch uint32
}

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(
	cdb *datastore.CachedDB, cState conservativeState, m meshProvider, f system.ProposalFetcher, c certifier,
	opts ...GeneratorOpt,
) *Generator

NewGenerator creates new block generator.

func (*Generator) Start

func (g *Generator) Start()

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 WithContext

func WithContext(ctx context.Context) GeneratorOpt

WithContext modifies default context.

func WithGeneratorLogger

func WithGeneratorLogger(logger log.Log) GeneratorOpt

WithGeneratorLogger defines logger for Generator.

func WithHareOutputChan

func WithHareOutputChan(ch chan hare.LayerOutput) 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.Database, m meshProvider, opts ...Opt) *Handler

NewHandler creates new Handler.

func (*Handler) HandleSyncedBlock

func (h *Handler) HandleSyncedBlock(ctx context.Context, data []byte) error

HandleSyncedBlock handles Block data from sync.

type Opt

type Opt func(*Handler)

Opt for configuring BlockHandler.

func WithLogger

func WithLogger(logger log.Log) Opt

WithLogger defines logger for Handler.