proposals

package
v1.0.17 Latest Latest
Warning

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

 Go to latest Published: Aug 13, 2023 License: MIT Imports: 24 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
	GetLegacyNumEligible = util.GetLegacyNumEligible
	// ComputeWeightPerEligibility computes the ballot weight per eligibility w.r.t the active set recorded in its reference ballot.
	ComputeWeightPerEligibility = util.ComputeWeightPerEligibility
)

Functions

func SerializeVRFMessage 

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

SerializeVRFMessage 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 uint64
}

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(
	cdb *datastore.CachedDB,
	edVerifier *signing.EdVerifier,
	p pubsub.Publisher,
	f system.Fetcher,
	bc system.BeaconCollector,
	m meshProvider,
	decoder ballotDecoder,
	verifier vrfVerifier,
	clock layerClock,
	opts ...Opt,
) *Handler

NewHandler creates new Handler.

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, peer p2p.Peer, data []byte) error

HandleSyncedBallot handles Ballot data from sync.

func (*Handler) HandleSyncedProposal 

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

HandleSyncedProposal handles Proposal data from sync.

type MockballotDecoder 

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

MockballotDecoder is a mock of ballotDecoder interface.

func NewMockballotDecoder 

func NewMockballotDecoder(ctrl *gomock.Controller) *MockballotDecoder

NewMockballotDecoder creates a new mock instance.

func (*MockballotDecoder) DecodeBallot 

func (m *MockballotDecoder) DecodeBallot(arg0 *types.BallotTortoiseData) (*tortoise.DecodedBallot, error)

DecodeBallot mocks base method.

func (*MockballotDecoder) EXPECT 

func (m *MockballotDecoder) EXPECT() *MockballotDecoderMockRecorder

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

func (*MockballotDecoder) GetMissingActiveSet 

func (m *MockballotDecoder) GetMissingActiveSet(arg0 types.EpochID, arg1 []types.ATXID) []types.ATXID

GetMissingActiveSet mocks base method.

func (*MockballotDecoder) StoreBallot 

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

StoreBallot mocks base method.

type MockballotDecoderMockRecorder 

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

MockballotDecoderMockRecorder is the mock recorder for MockballotDecoder.

func (*MockballotDecoderMockRecorder) DecodeBallot 

func (mr *MockballotDecoderMockRecorder) DecodeBallot(arg0 interface{}) *gomock.Call

DecodeBallot indicates an expected call of DecodeBallot.

func (*MockballotDecoderMockRecorder) GetMissingActiveSet 

func (mr *MockballotDecoderMockRecorder) GetMissingActiveSet(arg0, arg1 interface{}) *gomock.Call

GetMissingActiveSet indicates an expected call of GetMissingActiveSet.

func (*MockballotDecoderMockRecorder) StoreBallot 

func (mr *MockballotDecoderMockRecorder) StoreBallot(arg0 interface{}) *gomock.Call

StoreBallot indicates an expected call of StoreBallot.

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) (bool, error)

CheckEligibility mocks base method.

func (*MockeligibilityValidator) EXPECT 

func (m *MockeligibilityValidator) EXPECT() *MockeligibilityValidatorMockRecorder

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

type MockeligibilityValidatorMockRecorder 

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

MockeligibilityValidatorMockRecorder is the mock recorder for MockeligibilityValidator.

func (*MockeligibilityValidatorMockRecorder) CheckEligibility 

func (mr *MockeligibilityValidatorMockRecorder) CheckEligibility(arg0, arg1 interface{}) *gomock.Call

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 

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) 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 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) (*types.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 

func (m *MockmeshProvider) EXPECT() *MockmeshProviderMockRecorder

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

type MockmeshProviderMockRecorder 

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

MockmeshProviderMockRecorder is the mock recorder for MockmeshProvider.

func (*MockmeshProviderMockRecorder) AddBallot 

func (mr *MockmeshProviderMockRecorder) AddBallot(arg0, arg1 interface{}) *gomock.Call

AddBallot indicates an expected call of AddBallot.

func (*MockmeshProviderMockRecorder) AddTXsFromProposal 

func (mr *MockmeshProviderMockRecorder) AddTXsFromProposal(arg0, arg1, arg2, arg3 interface{}) *gomock.Call

AddTXsFromProposal indicates an expected call of AddTXsFromProposal.

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

func (m *MockvrfVerifier) EXPECT() *MockvrfVerifierMockRecorder

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 interface{}) *gomock.Call

Verify indicates an expected call of Verify.

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 log.Log) 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 uint64, cdb *datastore.CachedDB, bc system.BeaconCollector, m meshProvider, lg log.Log, vrfVerifier vrfVerifier, opts ...ValidatorOpt,
) *Validator

NewEligibilityValidator returns a new EligibilityValidator.

func (*Validator) CheckEligibility 

func (v *Validator) CheckEligibility(ctx context.Context, ballot *types.Ballot) (bool, 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.

func WithNonceFetcher 

func WithNonceFetcher(nf nonceFetcher) ValidatorOpt

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)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.