cosmos-sdk/types/stake.go

package types

import (
	abci "github.com/tendermint/abci/types"
	"github.com/tendermint/go-crypto"
)

// status of a validator
type BondStatus byte

// nolint
const (
	Unbonded  BondStatus = 0x00
	Unbonding BondStatus = 0x01
	Bonded    BondStatus = 0x02
	Revoked   BondStatus = 0x03
)

// validator for a delegated proof of stake system
type Validator interface {
	GetStatus() BondStatus    // status of the validator
	GetAddress() Address      // owner address to receive/return validators coins
	GetPubKey() crypto.PubKey // validation pubkey
	GetPower() Rat            // validation power
	GetBondHeight() int64     // height in which the validator became active
}

// validator which fulfills abci validator interface for use in Tendermint
func ABCIValidator(v Validator) abci.Validator {
	return abci.Validator{
		PubKey: v.GetPubKey().Bytes(),
		Power:  v.GetPower().Evaluate(),
	}
}

// properties for the set of all validators
type ValidatorSet interface {
	IterateValidatorsBonded(Context, func(index int64, validator Validator)) // execute arbitrary logic for each validator
	Validator(Context, Address) Validator                                    // get a particular validator by owner address
	TotalPower(Context) Rat                                                  // total power of the validator set
}

//_______________________________________________________________________________

// delegation bond for a delegated proof of stake system
type Delegation interface {
	GetDelegator() Address // delegator address for the bond
	GetValidator() Address // validator owner address for the bond
	GetBondShares() Rat    // amount of validator's shares
}

// properties for the set of all delegations for a particular
type DelegationSet interface {

	// execute arbitrary logic for each validator which a delegator has a delegation for
	IterateDelegators(Context, delegator Address, fn func(index int64, delegation Delegation))
}