mirror of
https://github.com/luxfi/consensus.git
synced 2026-09-24 00:26:58 +00:00
zeekay
8e45bcd029
Reorganize consensus packages following Go conventions and best practices: Protocol Consolidation: - Move prism/, photon/, wave/ → protocol/ directory - Consolidate all protocol implementations under single namespace - Follows standard library pattern (encoding/json, encoding/xml) Package Naming: - Rename validators/ → validator/ (singular, lowercase per Go convention) - Aligns with stdlib patterns (net/http, database/sql) Import Path Updates: - Update all 241 Go files with new import paths - github.com/luxfi/consensus/prism → protocol/prism - github.com/luxfi/consensus/photon → protocol/photon - github.com/luxfi/consensus/wave → protocol/wave - github.com/luxfi/consensus/validators → validator Benefits: - Clear separation: core (contracts) vs protocol (algorithms) vs engine (runtime) - Improved discoverability (all protocols under protocol/) - Consistent with Go naming conventions - Zero breaking changes to core APIs - Easier to add new protocol implementations Test Results: - All 67+ tests passing across 21 packages - 100% test coverage maintained - No performance regression Structure: consensus/ ├── core/ # Pure contracts (interfaces, zero deps) ├── protocol/ # Consensus algorithms & mechanics │ ├── prism/ # Polling/quorum primitives │ ├── photon/ # Unary consensus │ ├── wave/ # N-ary consensus (FPC) │ └── ... # Other protocol phases ├── engine/ # Runtime glue (runs protocols) └── validator/ # Validator management (singular)
105 lines
3.4 KiB
Go
105 lines
3.4 KiB
Go
package validators
|
|
|
|
//go:generate go run go.uber.org/mock/mockgen -package=validatorsmock -destination=validatorsmock/state.go -mock_names=State=State . State
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/luxfi/consensus/version"
|
|
"github.com/luxfi/ids"
|
|
"github.com/luxfi/math/set"
|
|
)
|
|
|
|
// State provides validator state management
|
|
type State interface {
|
|
GetValidatorSet(ctx context.Context, height uint64, netID ids.ID) (map[ids.NodeID]*GetValidatorOutput, error)
|
|
GetCurrentValidators(ctx context.Context, height uint64, netID ids.ID) (map[ids.NodeID]*GetValidatorOutput, error)
|
|
GetCurrentHeight(ctx context.Context) (uint64, error)
|
|
}
|
|
|
|
// GetValidatorOutput provides validator information
|
|
type GetValidatorOutput struct {
|
|
NodeID ids.NodeID
|
|
PublicKey []byte
|
|
Light uint64
|
|
Weight uint64 // Alias for Light for backward compatibility
|
|
TxID ids.ID // Transaction ID that added this validator
|
|
}
|
|
|
|
// Set represents a set of validators
|
|
type Set interface {
|
|
Has(ids.NodeID) bool
|
|
Len() int
|
|
List() []Validator
|
|
Light() uint64
|
|
Sample(size int) ([]ids.NodeID, error)
|
|
}
|
|
|
|
// Validator represents a validator
|
|
type Validator interface {
|
|
ID() ids.NodeID
|
|
Light() uint64
|
|
}
|
|
|
|
// ValidatorImpl is a concrete implementation of Validator
|
|
type ValidatorImpl struct {
|
|
NodeID ids.NodeID
|
|
LightVal uint64
|
|
}
|
|
|
|
// ID returns the node ID
|
|
func (v *ValidatorImpl) ID() ids.NodeID {
|
|
return v.NodeID
|
|
}
|
|
|
|
// Light returns the validator light
|
|
func (v *ValidatorImpl) Light() uint64 {
|
|
return v.LightVal
|
|
}
|
|
|
|
// Manager manages validator sets
|
|
type Manager interface {
|
|
GetValidators(netID ids.ID) (Set, error)
|
|
GetValidator(netID ids.ID, nodeID ids.NodeID) (*GetValidatorOutput, bool)
|
|
GetLight(netID ids.ID, nodeID ids.NodeID) uint64
|
|
GetWeight(netID ids.ID, nodeID ids.NodeID) uint64 // Deprecated: use GetLight
|
|
TotalLight(netID ids.ID) (uint64, error)
|
|
TotalWeight(netID ids.ID) (uint64, error) // Deprecated: use TotalLight
|
|
|
|
// Mutable operations
|
|
AddStaker(netID ids.ID, nodeID ids.NodeID, publicKey []byte, txID ids.ID, light uint64) error
|
|
AddWeight(netID ids.ID, nodeID ids.NodeID, light uint64) error
|
|
RemoveWeight(netID ids.ID, nodeID ids.NodeID, light uint64) error
|
|
NumNets() int
|
|
|
|
// Additional utility methods
|
|
Count(netID ids.ID) int
|
|
NumValidators(netID ids.ID) int // Alias for Count
|
|
Sample(netID ids.ID, size int) ([]ids.NodeID, error)
|
|
GetValidatorIDs(netID ids.ID) []ids.NodeID
|
|
SubsetWeight(netID ids.ID, nodeIDs set.Set[ids.NodeID]) (uint64, error)
|
|
GetMap(netID ids.ID) map[ids.NodeID]*GetValidatorOutput
|
|
RegisterCallbackListener(listener ManagerCallbackListener)
|
|
RegisterSetCallbackListener(netID ids.ID, listener SetCallbackListener)
|
|
}
|
|
|
|
// SetCallbackListener listens to validator set changes
|
|
type SetCallbackListener interface {
|
|
OnValidatorAdded(nodeID ids.NodeID, light uint64)
|
|
OnValidatorRemoved(nodeID ids.NodeID, light uint64)
|
|
OnValidatorLightChanged(nodeID ids.NodeID, oldLight, newLight uint64)
|
|
}
|
|
|
|
// ManagerCallbackListener listens to manager changes
|
|
type ManagerCallbackListener interface {
|
|
OnValidatorAdded(netID ids.ID, nodeID ids.NodeID, light uint64)
|
|
OnValidatorRemoved(netID ids.ID, nodeID ids.NodeID, light uint64)
|
|
OnValidatorLightChanged(netID ids.ID, nodeID ids.NodeID, oldLight, newLight uint64)
|
|
}
|
|
|
|
// Connector handles validator connections
|
|
type Connector interface {
|
|
Connected(ctx context.Context, nodeID ids.NodeID, nodeVersion *version.Application) error
|
|
Disconnected(ctx context.Context, nodeID ids.NodeID) error
|
|
}
|