miner

Documentation

Overview

Package miner is a generated GoMock package.

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

Index

• type MockconservativeState
  • func NewMockconservativeState(ctrl *gomock.Controller) *MockconservativeState
  • func (m *MockconservativeState) EXPECT() *MockconservativeStateMockRecorder
  • func (m *MockconservativeState) SelectProposalTXs(arg0 types.LayerID, arg1 int) []types.TransactionID
• type MockconservativeStateMockRecorder
  • func (mr *MockconservativeStateMockRecorder) SelectProposalTXs(arg0, arg1 interface{}) *gomock.Call
• type MocklayerClock
  • func NewMocklayerClock(ctrl *gomock.Controller) *MocklayerClock
  • func (m *MocklayerClock) AwaitLayer(layerID types.LayerID) chan struct{}
  • func (m *MocklayerClock) CurrentLayer() types.LayerID
  • func (m *MocklayerClock) EXPECT() *MocklayerClockMockRecorder
  • func (m *MocklayerClock) LayerToTime(arg0 types.LayerID) time.Time
• type MocklayerClockMockRecorder
  • func (mr *MocklayerClockMockRecorder) AwaitLayer(layerID interface{}) *gomock.Call
  • func (mr *MocklayerClockMockRecorder) CurrentLayer() *gomock.Call
  • func (mr *MocklayerClockMockRecorder) LayerToTime(arg0 interface{}) *gomock.Call
• type MocknonceFetcher
  • func NewMocknonceFetcher(ctrl *gomock.Controller) *MocknonceFetcher
  • func (m *MocknonceFetcher) EXPECT() *MocknonceFetcherMockRecorder
  • func (m *MocknonceFetcher) VRFNonce(arg0 types.NodeID, arg1 types.EpochID) (types.VRFPostIndex, error)
• type MocknonceFetcherMockRecorder
  • func (mr *MocknonceFetcherMockRecorder) VRFNonce(arg0, arg1 interface{}) *gomock.Call
• type MockproposalOracle
  • func NewMockproposalOracle(ctrl *gomock.Controller) *MockproposalOracle
  • func (m *MockproposalOracle) EXPECT() *MockproposalOracleMockRecorder
  • func (m *MockproposalOracle) GetProposalEligibility(arg0 types.LayerID, arg1 types.Beacon, arg2 types.VRFPostIndex) (types.ATXID, []types.ATXID, []types.VotingEligibility, error)
• type MockproposalOracleMockRecorder
  • func (mr *MockproposalOracleMockRecorder) GetProposalEligibility(arg0, arg1, arg2 interface{}) *gomock.Call
• type MockvotesEncoder
  • func NewMockvotesEncoder(ctrl *gomock.Controller) *MockvotesEncoder
  • func (m *MockvotesEncoder) EXPECT() *MockvotesEncoderMockRecorder
  • func (m *MockvotesEncoder) EncodeVotes(arg0 context.Context, arg1 ...tortoise.EncodeVotesOpts) (*types.Opinion, error)
  • func (m *MockvotesEncoder) LatestComplete() types.LayerID
  • func (m *MockvotesEncoder) TallyVotes(arg0 context.Context, arg1 types.LayerID)
• type MockvotesEncoderMockRecorder
  • func (mr *MockvotesEncoderMockRecorder) EncodeVotes(arg0 interface{}, arg1 ...interface{}) *gomock.Call
  • func (mr *MockvotesEncoderMockRecorder) LatestComplete() *gomock.Call
  • func (mr *MockvotesEncoderMockRecorder) TallyVotes(arg0, arg1 interface{}) *gomock.Call
• type Opt
  • func WithHdist(dist uint32) Opt
  • func WithLayerPerEpoch(layers uint32) Opt
  • func WithLayerSize(size uint32) Opt
  • func WithLogger(logger log.Log) Opt
  • func WithMinerID(id types.NodeID) Opt
• type Oracle
  • func (o *Oracle) GetProposalEligibility(lid types.LayerID, beacon types.Beacon, nonce types.VRFPostIndex) (types.ATXID, []types.ATXID, []types.VotingEligibility, error)
• type ProposalBuilder
  • func NewProposalBuilder(ctx context.Context, clock layerClock, signer *signing.EdSigner, ...) *ProposalBuilder
  • func (pb *ProposalBuilder) Close()
  • func (pb *ProposalBuilder) Start(ctx context.Context) error

Types

type MockconservativeState

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

MockconservativeState is a mock of conservativeState interface.

func NewMockconservativeState

func NewMockconservativeState(ctrl *gomock.Controller) *MockconservativeState

NewMockconservativeState creates a new mock instance.

func (*MockconservativeState) EXPECT

func (m *MockconservativeState) EXPECT() *MockconservativeStateMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockconservativeState) SelectProposalTXs

func (m *MockconservativeState) SelectProposalTXs(arg0 types.LayerID, arg1 int) []types.TransactionID

SelectProposalTXs mocks base method.

type MockconservativeStateMockRecorder

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

MockconservativeStateMockRecorder is the mock recorder for MockconservativeState.

func (*MockconservativeStateMockRecorder) SelectProposalTXs

func (mr *MockconservativeStateMockRecorder) SelectProposalTXs(arg0, arg1 interface{}) *gomock.Call

SelectProposalTXs indicates an expected call of SelectProposalTXs.

type MocklayerClock

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

MocklayerClock is a mock of layerClock interface.

func NewMocklayerClock

func NewMocklayerClock(ctrl *gomock.Controller) *MocklayerClock

NewMocklayerClock creates a new mock instance.

func (*MocklayerClock) AwaitLayer

func (m *MocklayerClock) AwaitLayer(layerID types.LayerID) chan struct{}

AwaitLayer mocks base method.

func (*MocklayerClock) CurrentLayer

func (m *MocklayerClock) CurrentLayer() types.LayerID

CurrentLayer mocks base method.

func (*MocklayerClock) EXPECT

func (m *MocklayerClock) EXPECT() *MocklayerClockMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MocklayerClock) LayerToTime

func (m *MocklayerClock) LayerToTime(arg0 types.LayerID) time.Time

LayerToTime mocks base method.

type MocklayerClockMockRecorder

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

MocklayerClockMockRecorder is the mock recorder for MocklayerClock.

func (*MocklayerClockMockRecorder) AwaitLayer

func (mr *MocklayerClockMockRecorder) AwaitLayer(layerID interface{}) *gomock.Call

AwaitLayer indicates an expected call of AwaitLayer.

func (*MocklayerClockMockRecorder) CurrentLayer

func (mr *MocklayerClockMockRecorder) CurrentLayer() *gomock.Call

CurrentLayer indicates an expected call of CurrentLayer.

func (*MocklayerClockMockRecorder) LayerToTime

func (mr *MocklayerClockMockRecorder) LayerToTime(arg0 interface{}) *gomock.Call

LayerToTime indicates an expected call of LayerToTime.

type MocknonceFetcher

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

MocknonceFetcher is a mock of nonceFetcher interface.

func NewMocknonceFetcher

func NewMocknonceFetcher(ctrl *gomock.Controller) *MocknonceFetcher

NewMocknonceFetcher creates a new mock instance.

func (*MocknonceFetcher) EXPECT

func (m *MocknonceFetcher) EXPECT() *MocknonceFetcherMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MocknonceFetcher) VRFNonce

func (m *MocknonceFetcher) VRFNonce(arg0 types.NodeID, arg1 types.EpochID) (types.VRFPostIndex, error)

VRFNonce mocks base method.

type MocknonceFetcherMockRecorder

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

MocknonceFetcherMockRecorder is the mock recorder for MocknonceFetcher.

func (*MocknonceFetcherMockRecorder) VRFNonce

func (mr *MocknonceFetcherMockRecorder) VRFNonce(arg0, arg1 interface{}) *gomock.Call

VRFNonce indicates an expected call of VRFNonce.

type MockproposalOracle

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

MockproposalOracle is a mock of proposalOracle interface.

func NewMockproposalOracle

func NewMockproposalOracle(ctrl *gomock.Controller) *MockproposalOracle

NewMockproposalOracle creates a new mock instance.

func (*MockproposalOracle) EXPECT

func (m *MockproposalOracle) EXPECT() *MockproposalOracleMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockproposalOracle) GetProposalEligibility

func (m *MockproposalOracle) GetProposalEligibility(arg0 types.LayerID, arg1 types.Beacon, arg2 types.VRFPostIndex) (types.ATXID, []types.ATXID, []types.VotingEligibility, error)

GetProposalEligibility mocks base method.

type MockproposalOracleMockRecorder

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

MockproposalOracleMockRecorder is the mock recorder for MockproposalOracle.

func (*MockproposalOracleMockRecorder) GetProposalEligibility

func (mr *MockproposalOracleMockRecorder) GetProposalEligibility(arg0, arg1, arg2 interface{}) *gomock.Call

GetProposalEligibility indicates an expected call of GetProposalEligibility.

type MockvotesEncoder

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

MockvotesEncoder is a mock of votesEncoder interface.

func NewMockvotesEncoder

func NewMockvotesEncoder(ctrl *gomock.Controller) *MockvotesEncoder

NewMockvotesEncoder creates a new mock instance.

func (*MockvotesEncoder) EXPECT

func (m *MockvotesEncoder) EXPECT() *MockvotesEncoderMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockvotesEncoder) EncodeVotes

func (m *MockvotesEncoder) EncodeVotes(arg0 context.Context, arg1 ...tortoise.EncodeVotesOpts) (*types.Opinion, error)

EncodeVotes mocks base method.

func (*MockvotesEncoder) LatestComplete

func (m *MockvotesEncoder) LatestComplete() types.LayerID

LatestComplete mocks base method.

func (*MockvotesEncoder) TallyVotes

func (m *MockvotesEncoder) TallyVotes(arg0 context.Context, arg1 types.LayerID)

TallyVotes mocks base method.

type MockvotesEncoderMockRecorder

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

MockvotesEncoderMockRecorder is the mock recorder for MockvotesEncoder.

func (*MockvotesEncoderMockRecorder) EncodeVotes

func (mr *MockvotesEncoderMockRecorder) EncodeVotes(arg0 interface{}, arg1 ...interface{}) *gomock.Call

EncodeVotes indicates an expected call of EncodeVotes.

func (*MockvotesEncoderMockRecorder) LatestComplete

func (mr *MockvotesEncoderMockRecorder) LatestComplete() *gomock.Call

LatestComplete indicates an expected call of LatestComplete.

func (*MockvotesEncoderMockRecorder) TallyVotes

func (mr *MockvotesEncoderMockRecorder) TallyVotes(arg0, arg1 interface{}) *gomock.Call

TallyVotes indicates an expected call of TallyVotes.

type Opt

type Opt func(h *ProposalBuilder)

Opt for configuring ProposalBuilder.

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

WithLogger defines the logger.

func WithMinerID

func WithMinerID(id types.NodeID) Opt

WithMinerID defines the miner's NodeID.

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, nonce types.VRFPostIndex) (types.ATXID, []types.ATXID, []types.VotingEligibility, 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,
	clock layerClock,
	signer *signing.EdSigner,
	vrfSigner *signing.VRFSigner,
	cdb *datastore.CachedDB,
	publisher pubsub.Publisher,
	trtl votesEncoder,
	beaconProvider system.BeaconGetter,
	syncer system.SyncStateProvider,
	conState conservativeState,
	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.