You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
211 lines
5.0 KiB
211 lines
5.0 KiB
package types
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/tendermint/tendermint/crypto"
|
|
"github.com/tendermint/tendermint/crypto/encoding"
|
|
"github.com/tendermint/tendermint/internal/jsontypes"
|
|
tmproto "github.com/tendermint/tendermint/proto/tendermint/types"
|
|
)
|
|
|
|
// Volatile state for each Validator
|
|
// NOTE: The ProposerPriority is not included in Validator.Hash();
|
|
// make sure to update that method if changes are made here
|
|
type Validator struct {
|
|
Address Address
|
|
PubKey crypto.PubKey
|
|
VotingPower int64
|
|
ProposerPriority int64
|
|
}
|
|
|
|
type validatorJSON struct {
|
|
Address Address `json:"address"`
|
|
PubKey json.RawMessage `json:"pub_key,omitempty"`
|
|
VotingPower int64 `json:"voting_power,string"`
|
|
ProposerPriority int64 `json:"proposer_priority,string"`
|
|
}
|
|
|
|
func (v Validator) MarshalJSON() ([]byte, error) {
|
|
val := validatorJSON{
|
|
Address: v.Address,
|
|
VotingPower: v.VotingPower,
|
|
ProposerPriority: v.ProposerPriority,
|
|
}
|
|
if v.PubKey != nil {
|
|
pk, err := jsontypes.Marshal(v.PubKey)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
val.PubKey = pk
|
|
}
|
|
return json.Marshal(val)
|
|
}
|
|
|
|
func (v *Validator) UnmarshalJSON(data []byte) error {
|
|
var val validatorJSON
|
|
if err := json.Unmarshal(data, &val); err != nil {
|
|
return err
|
|
}
|
|
if err := jsontypes.Unmarshal(val.PubKey, &v.PubKey); err != nil {
|
|
return err
|
|
}
|
|
v.Address = val.Address
|
|
v.VotingPower = val.VotingPower
|
|
v.ProposerPriority = val.ProposerPriority
|
|
return nil
|
|
}
|
|
|
|
// NewValidator returns a new validator with the given pubkey and voting power.
|
|
func NewValidator(pubKey crypto.PubKey, votingPower int64) *Validator {
|
|
return &Validator{
|
|
Address: pubKey.Address(),
|
|
PubKey: pubKey,
|
|
VotingPower: votingPower,
|
|
ProposerPriority: 0,
|
|
}
|
|
}
|
|
|
|
// ValidateBasic performs basic validation.
|
|
func (v *Validator) ValidateBasic() error {
|
|
if v == nil {
|
|
return errors.New("nil validator")
|
|
}
|
|
if v.PubKey == nil {
|
|
return errors.New("validator does not have a public key")
|
|
}
|
|
|
|
if v.VotingPower < 0 {
|
|
return errors.New("validator has negative voting power")
|
|
}
|
|
|
|
if len(v.Address) != crypto.AddressSize {
|
|
return fmt.Errorf("validator address is the wrong size: %v", v.Address)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// Creates a new copy of the validator so we can mutate ProposerPriority.
|
|
// Panics if the validator is nil.
|
|
func (v *Validator) Copy() *Validator {
|
|
vCopy := *v
|
|
return &vCopy
|
|
}
|
|
|
|
// Returns the one with higher ProposerPriority.
|
|
func (v *Validator) CompareProposerPriority(other *Validator) *Validator {
|
|
if v == nil {
|
|
return other
|
|
}
|
|
switch {
|
|
case v.ProposerPriority > other.ProposerPriority:
|
|
return v
|
|
case v.ProposerPriority < other.ProposerPriority:
|
|
return other
|
|
default:
|
|
result := bytes.Compare(v.Address, other.Address)
|
|
switch {
|
|
case result < 0:
|
|
return v
|
|
case result > 0:
|
|
return other
|
|
default:
|
|
panic("Cannot compare identical validators")
|
|
}
|
|
}
|
|
}
|
|
|
|
// String returns a string representation of String.
|
|
//
|
|
// 1. address
|
|
// 2. public key
|
|
// 3. voting power
|
|
// 4. proposer priority
|
|
func (v *Validator) String() string {
|
|
if v == nil {
|
|
return "nil-Validator"
|
|
}
|
|
return fmt.Sprintf("Validator{%v %v VP:%v A:%v}",
|
|
v.Address,
|
|
v.PubKey,
|
|
v.VotingPower,
|
|
v.ProposerPriority)
|
|
}
|
|
|
|
// ValidatorListString returns a prettified validator list for logging purposes.
|
|
func ValidatorListString(vals []*Validator) string {
|
|
chunks := make([]string, len(vals))
|
|
for i, val := range vals {
|
|
chunks[i] = fmt.Sprintf("%s:%d", val.Address, val.VotingPower)
|
|
}
|
|
|
|
return strings.Join(chunks, ",")
|
|
}
|
|
|
|
// Bytes computes the unique encoding of a validator with a given voting power.
|
|
// These are the bytes that gets hashed in consensus. It excludes address
|
|
// as its redundant with the pubkey. This also excludes ProposerPriority
|
|
// which changes every round.
|
|
func (v *Validator) Bytes() []byte {
|
|
pk, err := encoding.PubKeyToProto(v.PubKey)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
pbv := tmproto.SimpleValidator{
|
|
PubKey: &pk,
|
|
VotingPower: v.VotingPower,
|
|
}
|
|
|
|
bz, err := pbv.Marshal()
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
return bz
|
|
}
|
|
|
|
// ToProto converts Valiator to protobuf
|
|
func (v *Validator) ToProto() (*tmproto.Validator, error) {
|
|
if v == nil {
|
|
return nil, errors.New("nil validator")
|
|
}
|
|
|
|
pk, err := encoding.PubKeyToProto(v.PubKey)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
vp := tmproto.Validator{
|
|
Address: v.Address,
|
|
PubKey: pk,
|
|
VotingPower: v.VotingPower,
|
|
ProposerPriority: v.ProposerPriority,
|
|
}
|
|
|
|
return &vp, nil
|
|
}
|
|
|
|
// FromProto sets a protobuf Validator to the given pointer.
|
|
// It returns an error if the public key is invalid.
|
|
func ValidatorFromProto(vp *tmproto.Validator) (*Validator, error) {
|
|
if vp == nil {
|
|
return nil, errors.New("nil validator")
|
|
}
|
|
|
|
pk, err := encoding.PubKeyFromProto(vp.PubKey)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
v := new(Validator)
|
|
v.Address = vp.GetAddress()
|
|
v.PubKey = pk
|
|
v.VotingPower = vp.GetVotingPower()
|
|
v.ProposerPriority = vp.GetProposerPriority()
|
|
|
|
return v, nil
|
|
}
|