nodesCoordinator

Nov 11, 2022

Changes in this version

+ var ErrNilEnableEpochsHandler = errors.New("nil enable epochs handler")

+ var ErrNilValidatorInfoCacher = errors.New("validator info cacher is nil")

type ArgNodesCoordinator

+ EnableEpochsHandler common.EnableEpochsHandler

+ ValidatorInfoCacher epochStart.ValidatorInfoCacher

type NodesShufflerArgs

+ EnableEpochsHandler common.EnableEpochsHandler

Jun 17, 2022

Changes in this version

+ var ErrEpochNodesConfigDoesNotExist = errors.New("epoch nodes configuration does not exist")

+ var ErrInvalidConsensusGroupSize = errors.New("invalid consensus group size")

+ var ErrInvalidNumberOfShards = errors.New("the number of shards must be greater than zero")

+ var ErrInvalidNumberPubKeys = errors.New("invalid number of public keys")

+ var ErrInvalidSampleSize = errors.New("invalid sample size")

+ var ErrInvalidShardId = errors.New("shard id must be smaller than the total number of shards")

+ var ErrInvalidWeight = errors.New("invalid weight")

+ var ErrMapSizeZero = errors.New("map size zero")

+ var ErrNilBlockBody = errors.New("nil block body")

+ var ErrNilBootStorer = errors.New("nil boot storer provided")

+ var ErrNilCacher = errors.New("nil cacher")

+ var ErrNilChanceComputer = errors.New("nil chance computer")

+ var ErrNilEndOfProcessingHandler = errors.New("nil end of processing handler")

+ var ErrNilEpochNotifier = errors.New("nil epoch notifier")

+ var ErrNilHasher = errors.New("nil hasher")

+ var ErrNilInputNodesMap = errors.New("nil input nodes map")

+ var ErrNilMarshalizer = errors.New("nil marshalizer")

+ var ErrNilNodeShufflerArguments = errors.New("nil arguments for the creation of a node shuffler")

+ var ErrNilNodeStopChannel = errors.New("nil node stop channel")

+ var ErrNilNodeTypeProvider = errors.New("nil node type provider")

+ var ErrNilNodesCoordinator = errors.New("nil nodesCoordinator")

+ var ErrNilOrEmptyDestinationForDistribute = errors.New("nil or empty destination list for distributeNodes")

+ var ErrNilPreviousEpochConfig = errors.New("nil previous epoch config")

+ var ErrNilPubKey = errors.New("nil public key")

+ var ErrNilPubkeyConverter = errors.New("trying to set nil pubkey converter")

+ var ErrNilRandomSelector = errors.New("nil selector")

+ var ErrNilRandomness = errors.New("nil randomness source")

+ var ErrNilShuffledOutHandler = errors.New("nil shuffled out handler")

+ var ErrNilShuffler = errors.New("nil nodes shuffler provided")

+ var ErrNilWeights = errors.New("nil weights")

+ var ErrNotImplemented = errors.New("feature not implemented")

+ var ErrSmallMetachainEligibleListSize = errors.New("small metachain eligible list size")

+ var ErrSmallShardEligibleListSize = errors.New("small shard eligible list size")

+ var ErrValidatorCannotBeFullArchive = errors.New("validator cannot be a full archive node")

+ var ErrValidatorNotFound = errors.New("validator not found")

+ var ErrWrongTypeAssertion = errors.New("wrong type assertion")

+ func NewHashValidatorsShuffler(args *NodesShufflerArgs) (*randHashShuffler, error)

+ func NewIndexHashedNodesCoordinator(arguments ArgNodesCoordinator) (*indexHashedNodesCoordinator, error)

+ func NewIndexHashedNodesCoordinatorWithRater(indexNodesCoordinator *indexHashedNodesCoordinator, ...) (*indexHashedNodesCoordinatorWithRater, error)

+ func NewSelectorExpandedList(weightList []uint32, hasher hashing.Hasher) (*selectorExpandedList, error)

+ func NewSelectorWRS(weightList []uint32, hasher hashing.Hasher) (*selectorWRS, error)

+ func NewValidator(pubKey []byte, chances uint32, index uint32) (*validator, error)

+ func NodesInfoToValidators(nodesInfo map[uint32][]GenesisNodeInfoHandler) (map[uint32][]Validator, error)

+ func SerializableValidatorsToValidators(nodeRegistryValidators map[string][]*SerializableValidator) (map[uint32][]Validator, error)

+ type ArgNodesCoordinator struct

+ BootStorer storage.Storer

+ ChanStopNode chan endProcess.ArgEndProcess

+ ConsensusGroupCache Cacher

+ EligibleNodes map[uint32][]Validator

+ Epoch uint32

+ EpochStartNotifier EpochStartEventNotifier

+ Hasher hashing.Hasher

+ IsFullArchive bool

+ Marshalizer marshal.Marshalizer

+ MetaConsensusGroupSize int

+ NbShards uint32

+ NodeTypeProvider NodeTypeProviderHandler

+ SelfPublicKey []byte

+ ShardConsensusGroupSize int

+ ShardIDAsObserver uint32

+ ShuffledOutHandler ShuffledOutHandler

+ Shuffler NodesShuffler

+ StartEpoch uint32

+ WaitingListFixEnabledEpoch uint32

+ WaitingNodes map[uint32][]Validator

+ type ArgsUpdateNodes struct

+ AdditionalLeaving []Validator

+ Eligible map[uint32][]Validator

+ Epoch uint32

+ NbShards uint32

+ NewNodes []Validator

+ Rand []byte

+ UnStakeLeaving []Validator

+ Waiting map[uint32][]Validator

+ type Cacher interface

+ Clear func()

+ Get func(key []byte) (value interface{}, ok bool)

+ Put func(key []byte, value interface{}, sizeInBytes int) (evicted bool)

+ type ChanceComputer interface

+ GetChance func(uint32) uint32

+ IsInterfaceNil func() bool

+ type CrossShardValidatorDistributor struct

+ func (vd *CrossShardValidatorDistributor) DistributeValidators(destination map[uint32][]Validator, source map[uint32][]Validator, rand []byte, ...) error

+ func (vd *CrossShardValidatorDistributor) IsInterfaceNil() bool

+ type EpochStartActionHandler interface

+ EpochStartAction func(hdr data.HeaderHandler)

+ EpochStartPrepare func(metaHdr data.HeaderHandler, body data.BodyHandler)

+ NotifyOrder func() uint32

+ type EpochStartEventNotifier interface

+ IsInterfaceNil func() bool

+ RegisterHandler func(handler epochStart.ActionHandler)

+ UnregisterHandler func(handler epochStart.ActionHandler)

+ type EpochValidators struct

+ EligibleValidators map[string][]*SerializableValidator

+ LeavingValidators map[string][]*SerializableValidator

+ WaitingValidators map[string][]*SerializableValidator

+ type EpochsConfigUpdateHandler interface

+ IsEpochInConfig func(epoch uint32) bool

+ SetNodesConfigFromValidatorsInfo func(epoch uint32, randomness []byte, validatorsInfo []*state.ShardValidatorInfo) error

+ type GenesisNodeInfoHandler interface

+ AddressBytes func() []byte

+ AssignedShard func() uint32

+ GetInitialRating func() uint32

+ IsInterfaceNil func() bool

+ PubKeyBytes func() []byte

+ type IntraShardValidatorDistributor struct

+ func (vd *IntraShardValidatorDistributor) DistributeValidators(destination map[uint32][]Validator, source map[uint32][]Validator, _ []byte, ...) error

+ func (vd *IntraShardValidatorDistributor) IsInterfaceNil() bool

+ type NodeTypeProviderHandler interface

+ GetType func() core.NodeType

+ IsInterfaceNil func() bool

+ SetType func(nodeType core.NodeType)

+ type NodesCoordinator interface

+ ComputeConsensusGroup func(randomness []byte, round uint64, shardId uint32, epoch uint32) (validatorsGroup []Validator, err error)

+ ConsensusGroupSize func(uint32) int

+ GetConsensusWhitelistedNodes func(epoch uint32) (map[string]struct{}, error)

+ GetNumTotalEligible func() uint64

+ GetSavedStateKey func() []byte

+ GetValidatorWithPublicKey func(publicKey []byte) (validator Validator, shardId uint32, err error)

+ IsInterfaceNil func() bool

+ LoadState func(key []byte) error

+ ShardIdForEpoch func(epoch uint32) (uint32, error)

+ ShuffleOutForEpoch func(_ uint32)

+ type NodesCoordinatorHelper interface

+ ComputeAdditionalLeaving func(allValidators []*state.ShardValidatorInfo) (map[uint32][]Validator, error)

+ GetChance func(uint32) uint32

+ ValidatorsWeights func(validators []Validator) ([]uint32, error)

+ type NodesCoordinatorRegistry struct

+ CurrentEpoch uint32

+ EpochsConfig map[string]*EpochValidators

+ type NodesShuffler interface

+ IsInterfaceNil func() bool

+ UpdateNodeLists func(args ArgsUpdateNodes) (*ResUpdateNodes, error)

+ UpdateParams func(numNodesShard uint32, numNodesMeta uint32, hysteresis float32, adaptivity bool)

+ type NodesShufflerArgs struct

+ Adaptivity bool

+ BalanceWaitingListsEnableEpoch uint32

+ Hysteresis float32

+ MaxNodesEnableConfig []config.MaxNodesChangeConfig

+ NodesMeta uint32

+ NodesShard uint32

+ ShuffleBetweenShards bool

+ WaitingListFixEnableEpoch uint32

+ type PublicKeysSelector interface

+ GetAllEligibleValidatorsPublicKeys func(epoch uint32) (map[uint32][][]byte, error)

+ GetAllLeavingValidatorsPublicKeys func(epoch uint32) (map[uint32][][]byte, error)

+ GetAllWaitingValidatorsPublicKeys func(epoch uint32) (map[uint32][][]byte, error)

+ GetConsensusValidatorsPublicKeys func(randomness []byte, round uint64, shardId uint32, epoch uint32) ([]string, error)

+ GetOwnPublicKey func() []byte

+ GetValidatorsIndexes func(publicKeys []string, epoch uint32) ([]uint64, error)

+ type RandomSelector interface

+ IsInterfaceNil func() bool

+ Select func(randSeed []byte, sampleSize uint32) ([]uint32, error)

+ type ResUpdateNodes struct

+ Eligible map[uint32][]Validator

+ Leaving []Validator

+ StillRemaining []Validator

+ Waiting map[uint32][]Validator

+ type SelectionBasedProvider struct

+ func NewSelectionBasedProvider(hasher hashing.Hasher, maxSize uint32) *SelectionBasedProvider

+ func (sbp *SelectionBasedProvider) Get(randomness []byte, numValidators int64, expandedEligibleList []uint32) ([]uint32, error)

+ type SerializableValidator struct

+ Chances uint32

+ Index uint32

+ PubKey []byte

+ func ValidatorArrayToSerializableValidatorArray(validators []Validator) []*SerializableValidator

+ type ShuffledOutHandler interface

+ CurrentShardID func() uint32

+ IsInterfaceNil func() bool

+ Process func(newShardID uint32) error

+ RegisterHandler func(handler func(newShardID uint32))

+ type Validator interface

+ Chances func() uint32

+ Index func() uint32

+ PubKey func() []byte

+ Size func() int

+ func SerializableShardValidatorListToValidatorList(shardValidators []*SerializableValidator) ([]Validator, error)

+ type ValidatorsDistributor interface

+ DistributeValidators func(destination map[uint32][]Validator, source map[uint32][]Validator, rand []byte, ...) error

+ IsInterfaceNil func() bool