miner

Documentation

Overview

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

Index

• Constants
• type Opt
  • func WithDBPath(path string) Opt
  • func WithLayerPerEpoch(layers uint32) Opt
  • func WithLayerSize(size uint32) Opt
  • func WithLogger(logger log.Log) Opt
  • func WithMinerID(id types.NodeID) Opt
  • func WithTxsPerProposal(numTxs int) Opt
• type Oracle
  • func (o *Oracle) GetProposalEligibility(lid types.LayerID, beacon types.Beacon) (types.ATXID, []types.ATXID, []types.VotingEligibilityProof, error)
• type ProposalBuilder
  • func NewProposalBuilder(ctx context.Context, layerTimer timesync.LayerTimer, signer *signing.EdSigner, ...) *ProposalBuilder
  • func (pb *ProposalBuilder) Close()
  • func (pb *ProposalBuilder) Start(ctx context.Context) error

Constants

const (
	// ATXsPerBallotLimit indicates the maximum number of ATXs a Ballot can reference.
	ATXsPerBallotLimit = 100
)

Types

type Opt

type Opt func(h *ProposalBuilder)

Opt for configuring ProposalBuilder.

func WithDBPath

func WithDBPath(path string) Opt

WithDBPath defines the path to create miner's database.

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 log.Log) Opt

WithLogger defines the logger.

func WithMinerID

func WithMinerID(id types.NodeID) Opt

WithMinerID defines the miner's NodeID.

func WithTxsPerProposal

func WithTxsPerProposal(numTxs int) Opt

WithTxsPerProposal defines the number of TXs in a Proposal.

type Oracle

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

Oracle provides proposal eligibility proofs for the miner.

func (*Oracle) GetProposalEligibility

func (o *Oracle) GetProposalEligibility(lid types.LayerID, beacon types.Beacon) (types.ATXID, []types.ATXID, []types.VotingEligibilityProof, error)

GetProposalEligibility returns the miner's ATXID and the active set for the layer's epoch, along with the list of eligibility proofs for that layer.

type ProposalBuilder

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

ProposalBuilder builds Proposals for a miner.

func NewProposalBuilder

func NewProposalBuilder(
	ctx context.Context,
	layerTimer timesync.LayerTimer,
	signer *signing.EdSigner,
	vrfSigner *signing.VRFSigner,
	atxDB activationDB,
	publisher pubsub.Publisher,
	pdb proposalDB,
	bbp baseBallotProvider,
	beaconProvider system.BeaconGetter,
	syncer system.SyncStateProvider,
	projector projector,
	txPool txPool,
	opts ...Opt,
) *ProposalBuilder

NewProposalBuilder creates a struct of block builder type.

func (*ProposalBuilder) Close

func (pb *ProposalBuilder) Close()

Close stops the loop that listens to layers and build proposals.

func (*ProposalBuilder) Start

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

Start starts the loop that listens to layers and build proposals.