validator

Documentation

Overview

Package validator provides functionality for managing validator information.

Index

• type Validator
  • func FromBytes(data []byte) (*Validator, error)
  • func NewValidator(publicKey *bls.PublicKey, number int32) *Validator
  • func (val *Validator) AddToStake(amt int64)
  • func (val *Validator) Address() crypto.Address
  • func (val *Validator) Bytes() ([]byte, error)
  • func (val *Validator) Clone() *Validator
  • func (val *Validator) Hash() hash.Hash
  • func (val *Validator) IncSequence()
  • func (val *Validator) LastBondingHeight() uint32
  • func (val *Validator) LastJoinedHeight() uint32
  • func (val *Validator) Number() int32
  • func (val Validator) Power() int64
  • func (val *Validator) PublicKey() *bls.PublicKey
  • func (val *Validator) Sequence() int32
  • func (val *Validator) SerializeSize() int
  • func (val *Validator) Stake() int64
  • func (val *Validator) SubtractFromStake(amt int64)
  • func (val *Validator) UnbondingHeight() uint32
  • func (val *Validator) UpdateLastBondingHeight(height uint32)
  • func (val *Validator) UpdateLastJoinedHeight(height uint32)
  • func (val *Validator) UpdateUnbondingHeight(height uint32)

Types

type Validator

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

The Validator struct represents a validator object.

func FromBytes

func FromBytes(data []byte) (*Validator, error)

FromBytes constructs a new validator from a byte array.

func NewValidator

func NewValidator(publicKey *bls.PublicKey, number int32) *Validator

NewValidator constructs a new validator from the given public key and number.

func (*Validator) AddToStake

func (val *Validator) AddToStake(amt int64)

AddToStake adds the given amount to the validator's stake.

func (*Validator) Address

func (val *Validator) Address() crypto.Address

Address returns the address of the validator.

func (*Validator) Bytes

func (val *Validator) Bytes() ([]byte, error)

Bytes returns returns the serialized byte representation of the validator.

func (*Validator) Clone

func (val *Validator) Clone() *Validator

Clone creates a deep copy of the validator.

func (*Validator) Hash

func (val *Validator) Hash() hash.Hash

Hash calculates and returns the hash of the validator.

func (*Validator) IncSequence

func (val *Validator) IncSequence()

IncSequence increases the sequence anytime this validator signs a transaction.

func (*Validator) LastBondingHeight

func (val *Validator) LastBondingHeight() uint32

LastBondingHeight returns the last height in which the validator bonded stake.

func (*Validator) LastJoinedHeight

func (val *Validator) LastJoinedHeight() uint32

LastJoinedHeight returns the last height in which the validator joined the committee.

func (*Validator) Number

func (val *Validator) Number() int32

Number returns the number of the validator.

func (Validator) Power

func (val Validator) Power() int64

Power returns the power of the validator.

func (*Validator) PublicKey

func (val *Validator) PublicKey() *bls.PublicKey

PublicKey returns the public key of the validator.

func (*Validator) Sequence

func (val *Validator) Sequence() int32

Sequence returns the sequence number of the validator.

func (*Validator) SerializeSize

func (val *Validator) SerializeSize() int

SerializeSize returns the size in bytes required to serialize the validator.

func (*Validator) Stake

func (val *Validator) Stake() int64

Stake returns the stake of the validator.

func (*Validator) SubtractFromStake

func (val *Validator) SubtractFromStake(amt int64)

SubtractFromStake subtracts the given amount from the validator's stake.

func (*Validator) UnbondingHeight

func (val *Validator) UnbondingHeight() uint32

UnbondingHeight returns the last height in which the validator unbonded stake.

func (*Validator) UpdateLastBondingHeight

func (val *Validator) UpdateLastBondingHeight(height uint32)

UpdateLastBondingHeight updates the last height at which the validator bonded some stakes.

func (*Validator) UpdateLastJoinedHeight

func (val *Validator) UpdateLastJoinedHeight(height uint32)

UpdateLastJoinedHeight updates the last height at which the validator joined the committee.

func (*Validator) UpdateUnbondingHeight

func (val *Validator) UpdateUnbondingHeight(height uint32)

UpdateUnbondingHeight updates the unbonding height for the validator.