miner

Documentation

Overview

Package miner is responsible for creating valid blocks that contain valid activation transactions and transactions

Index

• func ActiveSetFromEpochFirstBlock(db sql.Executor, epoch types.EpochID) ([]types.ATXID, error)
• type ActiveSetPreparation
  • func DefaultActiveSetPreparation() ActiveSetPreparation
• type Opt
  • func WithActivesetPreparation(prep ActiveSetPreparation) Opt
  • func WithHdist(dist uint32) Opt
  • func WithLayerPerEpoch(layers uint32) Opt
  • func WithLayerSize(size uint32) Opt
  • func WithLogger(logger *zap.Logger) Opt
  • func WithMinGoodAtxPercent(percent int) Opt
  • func WithMinimalActiveSetWeight(weight []types.EpochMinimalActiveWeight) Opt
  • func WithNetworkDelay(delay time.Duration) Opt
  • func WithSigners(signers ...*signing.EdSigner) Opt
  • func WithWorkersLimit(limit int) Opt
• type ProposalBuilder
  • func New(clock layerClock, db sql.Executor, localdb sql.Executor, ...) *ProposalBuilder
  • func (pb *ProposalBuilder) Register(sig *signing.EdSigner)
  • func (pb *ProposalBuilder) Run(ctx context.Context) error
  • func (pb *ProposalBuilder) UpdateActiveSet(target types.EpochID, set []types.ATXID)

Functions

func ActiveSetFromEpochFirstBlock

func ActiveSetFromEpochFirstBlock(db sql.Executor, epoch types.EpochID) ([]types.ATXID, error)

Types

type ActiveSetPreparation

type ActiveSetPreparation struct {
	// Window describes how much in advance the active set should be prepared.
	Window time.Duration `mapstructure:"window"`
	// RetryInterval describes how often the active set is retried.
	RetryInterval time.Duration `mapstructure:"retry-interval"`
	// Tries describes how many times the active set is retried.
	Tries int `mapstructure:"tries"`
}

ActiveSetPreparation is a configuration to enable computation of activeset in advance.

func DefaultActiveSetPreparation

func DefaultActiveSetPreparation() ActiveSetPreparation

type Opt

type Opt func(h *ProposalBuilder)

Opt for configuring ProposalBuilder.

func WithActivesetPreparation

func WithActivesetPreparation(prep ActiveSetPreparation) Opt

WithActivesetPreparation overwrites configuration for activeset preparation.

func WithHdist

func WithHdist(dist uint32) Opt

func WithLayerPerEpoch

func WithLayerPerEpoch(layers uint32) Opt

WithLayerPerEpoch defines the number of layers per epoch.

func WithLayerSize

func WithLayerSize(size uint32) Opt

WithLayerSize defines the average number of proposal per layer.

func WithLogger

func WithLogger(logger *zap.Logger) Opt

WithLogger defines the logger.

func WithMinGoodAtxPercent

func WithMinGoodAtxPercent(percent int) Opt

func WithMinimalActiveSetWeight

func WithMinimalActiveSetWeight(weight []types.EpochMinimalActiveWeight) Opt

func WithNetworkDelay

func WithNetworkDelay(delay time.Duration) Opt

func WithSigners

func WithSigners(signers ...*signing.EdSigner) Opt

WithSigners guarantees that builder will start execution with provided list of signers. Should be after logging.

func WithWorkersLimit

func WithWorkersLimit(limit int) Opt

WithWorkersLimit configures paralelization factor for builder operation when working with more than one signer.

type ProposalBuilder

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

ProposalBuilder builds Proposals for a miner.

func New

func New(
	clock layerClock,
	db sql.Executor,
	localdb sql.Executor,
	atxsdata *atxsdata.Data,
	publisher pubsub.Publisher,
	trtl votesEncoder,
	syncer system.SyncStateProvider,
	conState conservativeState,
	opts ...Opt,
) *ProposalBuilder

New creates a struct of block builder type.

func (*ProposalBuilder) Register

func (pb *ProposalBuilder) Register(sig *signing.EdSigner)

func (*ProposalBuilder) Run

func (pb *ProposalBuilder) Run(ctx context.Context) error

Start the loop that listens to layers and build proposals.

func (*ProposalBuilder) UpdateActiveSet

func (pb *ProposalBuilder) UpdateActiveSet(target types.EpochID, set []types.ATXID)