proposals

package
v1.7.0-alpha.1-nomain Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 20, 2024 License: MIT Imports: 32 Imported by: 0

Documentation

Overview

Package proposals is a generated GoMock package.

nolint

Index

Constants

This section is empty.

Variables

View Source
var (
	CalcEligibleLayer   = util.CalcEligibleLayer
	GetNumEligibleSlots = util.GetNumEligibleSlots
)

Functions

func MustGetNumEligibleSlots added in v1.2.2

func MustGetNumEligibleSlots(
	weight, minWeight, totalWeight uint64,
	committeeSize, layersPerEpoch uint32,
) uint32

func MustSerializeVRFMessage added in v1.1.4

func MustSerializeVRFMessage(
	beacon types.Beacon,
	epoch types.EpochID,
	nonce types.VRFPostIndex,
	counter uint32,
) []byte

MustSerializeVRFMessage serializes a message for generating/verifying a VRF signature.

Types

type Config

type Config struct {
	LayerSize              uint32
	LayersPerEpoch         uint32
	GoldenATXID            types.ATXID
	MaxExceptions          int
	Hdist                  uint32
	MinimalActiveSetWeight []types.EpochMinimalActiveWeight
}

Config defines configuration for the handler.

type Handler

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

Handler processes Proposal from gossip and, if deems it valid, propagates it to peers.

func NewHandler

func NewHandler(
	db *sql.Database,
	atxsdata *atxsdata.Data,
	proposals proposalsConsumer,
	edVerifier *signing.EdVerifier,
	p pubsub.Publisher,
	f system.Fetcher,
	bc system.BeaconCollector,
	m meshProvider,
	tortoise tortoiseProvider,
	verifier vrfVerifier,
	clock layerClock,
	opts ...Opt,
) *Handler

NewHandler creates new Handler.

func (*Handler) HandleActiveSet added in v1.1.5

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

func (*Handler) HandleProposal

func (h *Handler) HandleProposal(ctx context.Context, peer p2p.Peer, data []byte) error

HandleProposal is the gossip receiver for Proposal.

func (*Handler) HandleSyncedBallot

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

HandleSyncedBallot handles Ballot data from sync.

func (*Handler) HandleSyncedProposal

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

HandleSyncedProposal handles Proposal data from sync.

type MockeligibilityValidator

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

MockeligibilityValidator is a mock of eligibilityValidator interface.

func NewMockeligibilityValidator

func NewMockeligibilityValidator(ctrl *gomock.Controller) *MockeligibilityValidator

NewMockeligibilityValidator creates a new mock instance.

func (*MockeligibilityValidator) CheckEligibility

func (m *MockeligibilityValidator) CheckEligibility(arg0 context.Context, arg1 *types.Ballot, arg2 uint64) error

CheckEligibility mocks base method.

func (*MockeligibilityValidator) EXPECT

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

type MockeligibilityValidatorCheckEligibilityCall added in v1.4.0

type MockeligibilityValidatorCheckEligibilityCall struct {
	*gomock.Call
}

MockeligibilityValidatorCheckEligibilityCall wrap *gomock.Call

func (*MockeligibilityValidatorCheckEligibilityCall) Do added in v1.4.0

Do rewrite *gomock.Call.Do

func (*MockeligibilityValidatorCheckEligibilityCall) DoAndReturn added in v1.4.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockeligibilityValidatorCheckEligibilityCall) Return added in v1.4.0

Return rewrite *gomock.Call.Return

type MockeligibilityValidatorMockRecorder

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

MockeligibilityValidatorMockRecorder is the mock recorder for MockeligibilityValidator.

func (*MockeligibilityValidatorMockRecorder) CheckEligibility

CheckEligibility indicates an expected call of CheckEligibility.

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

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

CurrentLayer mocks base method.

func (*MocklayerClock) EXPECT

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 MocklayerClockCurrentLayerCall added in v1.4.0

type MocklayerClockCurrentLayerCall struct {
	*gomock.Call
}

MocklayerClockCurrentLayerCall wrap *gomock.Call

func (*MocklayerClockCurrentLayerCall) Do added in v1.4.0

Do rewrite *gomock.Call.Do

func (*MocklayerClockCurrentLayerCall) DoAndReturn added in v1.4.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MocklayerClockCurrentLayerCall) Return added in v1.4.0

Return rewrite *gomock.Call.Return

type MocklayerClockLayerToTimeCall added in v1.4.0

type MocklayerClockLayerToTimeCall struct {
	*gomock.Call
}

MocklayerClockLayerToTimeCall wrap *gomock.Call

func (*MocklayerClockLayerToTimeCall) Do added in v1.4.0

Do rewrite *gomock.Call.Do

func (*MocklayerClockLayerToTimeCall) DoAndReturn added in v1.4.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MocklayerClockLayerToTimeCall) Return added in v1.4.0

Return rewrite *gomock.Call.Return

type MocklayerClockMockRecorder

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

MocklayerClockMockRecorder is the mock recorder for MocklayerClock.

func (*MocklayerClockMockRecorder) CurrentLayer

CurrentLayer indicates an expected call of CurrentLayer.

func (*MocklayerClockMockRecorder) LayerToTime

LayerToTime indicates an expected call of LayerToTime.

type MockmeshProvider

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

MockmeshProvider is a mock of meshProvider interface.

func NewMockmeshProvider

func NewMockmeshProvider(ctrl *gomock.Controller) *MockmeshProvider

NewMockmeshProvider creates a new mock instance.

func (*MockmeshProvider) AddBallot

func (m *MockmeshProvider) AddBallot(arg0 context.Context, arg1 *types.Ballot) (*wire.MalfeasanceProof, error)

AddBallot mocks base method.

func (*MockmeshProvider) AddTXsFromProposal

func (m *MockmeshProvider) AddTXsFromProposal(arg0 context.Context, arg1 types.LayerID, arg2 types.ProposalID, arg3 []types.TransactionID) error

AddTXsFromProposal mocks base method.

func (*MockmeshProvider) EXPECT

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

func (*MockmeshProvider) ProcessedLayer added in v1.1.6

func (m *MockmeshProvider) ProcessedLayer() types.LayerID

ProcessedLayer mocks base method.

type MockmeshProviderAddBallotCall added in v1.4.0

type MockmeshProviderAddBallotCall struct {
	*gomock.Call
}

MockmeshProviderAddBallotCall wrap *gomock.Call

func (*MockmeshProviderAddBallotCall) Do added in v1.4.0

Do rewrite *gomock.Call.Do

func (*MockmeshProviderAddBallotCall) DoAndReturn added in v1.4.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockmeshProviderAddBallotCall) Return added in v1.4.0

Return rewrite *gomock.Call.Return

type MockmeshProviderAddTXsFromProposalCall added in v1.4.0

type MockmeshProviderAddTXsFromProposalCall struct {
	*gomock.Call
}

MockmeshProviderAddTXsFromProposalCall wrap *gomock.Call

func (*MockmeshProviderAddTXsFromProposalCall) Do added in v1.4.0

Do rewrite *gomock.Call.Do

func (*MockmeshProviderAddTXsFromProposalCall) DoAndReturn added in v1.4.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockmeshProviderAddTXsFromProposalCall) Return added in v1.4.0

Return rewrite *gomock.Call.Return

type MockmeshProviderMockRecorder

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

MockmeshProviderMockRecorder is the mock recorder for MockmeshProvider.

func (*MockmeshProviderMockRecorder) AddBallot

AddBallot indicates an expected call of AddBallot.

func (*MockmeshProviderMockRecorder) AddTXsFromProposal

func (mr *MockmeshProviderMockRecorder) AddTXsFromProposal(arg0, arg1, arg2, arg3 any) *MockmeshProviderAddTXsFromProposalCall

AddTXsFromProposal indicates an expected call of AddTXsFromProposal.

func (*MockmeshProviderMockRecorder) ProcessedLayer added in v1.1.6

ProcessedLayer indicates an expected call of ProcessedLayer.

type MockmeshProviderProcessedLayerCall added in v1.4.0

type MockmeshProviderProcessedLayerCall struct {
	*gomock.Call
}

MockmeshProviderProcessedLayerCall wrap *gomock.Call

func (*MockmeshProviderProcessedLayerCall) Do added in v1.4.0

Do rewrite *gomock.Call.Do

func (*MockmeshProviderProcessedLayerCall) DoAndReturn added in v1.4.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockmeshProviderProcessedLayerCall) Return added in v1.4.0

Return rewrite *gomock.Call.Return

type MockproposalsConsumer added in v1.4.0

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

MockproposalsConsumer is a mock of proposalsConsumer interface.

func NewMockproposalsConsumer added in v1.4.0

func NewMockproposalsConsumer(ctrl *gomock.Controller) *MockproposalsConsumer

NewMockproposalsConsumer creates a new mock instance.

func (*MockproposalsConsumer) EXPECT added in v1.4.0

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

func (*MockproposalsConsumer) IsKnown added in v1.4.0

func (m *MockproposalsConsumer) IsKnown(arg0 types.LayerID, arg1 types.ProposalID) bool

IsKnown mocks base method.

func (*MockproposalsConsumer) OnProposal added in v1.4.0

func (m *MockproposalsConsumer) OnProposal(p *types.Proposal) error

OnProposal mocks base method.

type MockproposalsConsumerIsKnownCall added in v1.4.0

type MockproposalsConsumerIsKnownCall struct {
	*gomock.Call
}

MockproposalsConsumerIsKnownCall wrap *gomock.Call

func (*MockproposalsConsumerIsKnownCall) Do added in v1.4.0

Do rewrite *gomock.Call.Do

func (*MockproposalsConsumerIsKnownCall) DoAndReturn added in v1.4.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockproposalsConsumerIsKnownCall) Return added in v1.4.0

Return rewrite *gomock.Call.Return

type MockproposalsConsumerMockRecorder added in v1.4.0

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

MockproposalsConsumerMockRecorder is the mock recorder for MockproposalsConsumer.

func (*MockproposalsConsumerMockRecorder) IsKnown added in v1.4.0

IsKnown indicates an expected call of IsKnown.

func (*MockproposalsConsumerMockRecorder) OnProposal added in v1.4.0

OnProposal indicates an expected call of OnProposal.

type MockproposalsConsumerOnProposalCall added in v1.4.0

type MockproposalsConsumerOnProposalCall struct {
	*gomock.Call
}

MockproposalsConsumerOnProposalCall wrap *gomock.Call

func (*MockproposalsConsumerOnProposalCall) Do added in v1.4.0

Do rewrite *gomock.Call.Do

func (*MockproposalsConsumerOnProposalCall) DoAndReturn added in v1.4.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockproposalsConsumerOnProposalCall) Return added in v1.4.0

Return rewrite *gomock.Call.Return

type MocktortoiseProvider added in v1.1.4

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

MocktortoiseProvider is a mock of tortoiseProvider interface.

func NewMocktortoiseProvider added in v1.1.4

func NewMocktortoiseProvider(ctrl *gomock.Controller) *MocktortoiseProvider

NewMocktortoiseProvider creates a new mock instance.

func (*MocktortoiseProvider) DecodeBallot added in v1.1.4

DecodeBallot mocks base method.

func (*MocktortoiseProvider) EXPECT added in v1.1.4

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

func (*MocktortoiseProvider) GetBallot added in v1.1.4

GetBallot mocks base method.

func (*MocktortoiseProvider) StoreBallot added in v1.1.4

func (m *MocktortoiseProvider) StoreBallot(arg0 *tortoise.DecodedBallot) error

StoreBallot mocks base method.

type MocktortoiseProviderDecodeBallotCall added in v1.4.0

type MocktortoiseProviderDecodeBallotCall struct {
	*gomock.Call
}

MocktortoiseProviderDecodeBallotCall wrap *gomock.Call

func (*MocktortoiseProviderDecodeBallotCall) Do added in v1.4.0

Do rewrite *gomock.Call.Do

func (*MocktortoiseProviderDecodeBallotCall) DoAndReturn added in v1.4.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MocktortoiseProviderDecodeBallotCall) Return added in v1.4.0

Return rewrite *gomock.Call.Return

type MocktortoiseProviderGetBallotCall added in v1.4.0

type MocktortoiseProviderGetBallotCall struct {
	*gomock.Call
}

MocktortoiseProviderGetBallotCall wrap *gomock.Call

func (*MocktortoiseProviderGetBallotCall) Do added in v1.4.0

Do rewrite *gomock.Call.Do

func (*MocktortoiseProviderGetBallotCall) DoAndReturn added in v1.4.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MocktortoiseProviderGetBallotCall) Return added in v1.4.0

Return rewrite *gomock.Call.Return

type MocktortoiseProviderMockRecorder added in v1.1.4

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

MocktortoiseProviderMockRecorder is the mock recorder for MocktortoiseProvider.

func (*MocktortoiseProviderMockRecorder) DecodeBallot added in v1.1.4

DecodeBallot indicates an expected call of DecodeBallot.

func (*MocktortoiseProviderMockRecorder) GetBallot added in v1.1.4

GetBallot indicates an expected call of GetBallot.

func (*MocktortoiseProviderMockRecorder) StoreBallot added in v1.1.4

StoreBallot indicates an expected call of StoreBallot.

type MocktortoiseProviderStoreBallotCall added in v1.4.0

type MocktortoiseProviderStoreBallotCall struct {
	*gomock.Call
}

MocktortoiseProviderStoreBallotCall wrap *gomock.Call

func (*MocktortoiseProviderStoreBallotCall) Do added in v1.4.0

Do rewrite *gomock.Call.Do

func (*MocktortoiseProviderStoreBallotCall) DoAndReturn added in v1.4.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MocktortoiseProviderStoreBallotCall) Return added in v1.4.0

Return rewrite *gomock.Call.Return

type MockvrfVerifier

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

MockvrfVerifier is a mock of vrfVerifier interface.

func NewMockvrfVerifier

func NewMockvrfVerifier(ctrl *gomock.Controller) *MockvrfVerifier

NewMockvrfVerifier creates a new mock instance.

func (*MockvrfVerifier) EXPECT

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

func (*MockvrfVerifier) Verify

func (m *MockvrfVerifier) Verify(arg0 types.NodeID, arg1 []byte, arg2 types.VrfSignature) bool

Verify mocks base method.

type MockvrfVerifierMockRecorder

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

MockvrfVerifierMockRecorder is the mock recorder for MockvrfVerifier.

func (*MockvrfVerifierMockRecorder) Verify

func (mr *MockvrfVerifierMockRecorder) Verify(arg0, arg1, arg2 any) *MockvrfVerifierVerifyCall

Verify indicates an expected call of Verify.

type MockvrfVerifierVerifyCall added in v1.4.0

type MockvrfVerifierVerifyCall struct {
	*gomock.Call
}

MockvrfVerifierVerifyCall wrap *gomock.Call

func (*MockvrfVerifierVerifyCall) Do added in v1.4.0

Do rewrite *gomock.Call.Do

func (*MockvrfVerifierVerifyCall) DoAndReturn added in v1.4.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockvrfVerifierVerifyCall) Return added in v1.4.0

Return rewrite *gomock.Call.Return

type Opt

type Opt func(h *Handler)

Opt for configuring Handler.

func WithConfig

func WithConfig(cfg Config) Opt

WithConfig defines protocol parameters.

func WithLogger

func WithLogger(logger *zap.Logger) Opt

WithLogger defines logger for Handler.

type Validator

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

Validator validates the eligibility of a Ballot. the validation focuses on eligibility only and assumes the Ballot to be valid otherwise.

func NewEligibilityValidator

func NewEligibilityValidator(
	avgLayerSize, layersPerEpoch uint32,
	minActiveSetWeight []types.EpochMinimalActiveWeight,
	clock layerClock,
	tortoise tortoiseProvider,
	atxsdata *atxsdata.Data,
	bc system.BeaconCollector,
	lg *zap.Logger,
	vrfVerifier vrfVerifier,
	opts ...ValidatorOpt,
) *Validator

NewEligibilityValidator returns a new EligibilityValidator.

func (*Validator) CheckEligibility

func (v *Validator) CheckEligibility(ctx context.Context, ballot *types.Ballot, weight uint64) error

CheckEligibility checks that a ballot is eligible in the layer that it specifies.

type ValidatorOpt

type ValidatorOpt func(h *Validator)

ValidatorOpt for configuring Validator.

type VrfMessage

type VrfMessage struct {
	Type    types.EligibilityType // always types.EligibilityVoting
	Beacon  types.Beacon
	Epoch   types.EpochID
	Nonce   types.VRFPostIndex
	Counter uint32
}

VrfMessage is a verification message. It is the payload for the signature in `VotingEligibility`.

func (*VrfMessage) DecodeScale

func (t *VrfMessage) DecodeScale(dec *scale.Decoder) (total int, err error)

func (*VrfMessage) EncodeScale

func (t *VrfMessage) EncodeScale(enc *scale.Encoder) (total int, err error)

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL