2018-06-26 19:00:12 -07:00
|
|
|
package types
|
2018-01-25 19:31:07 -08:00
|
|
|
|
|
|
|
import (
|
2018-04-30 23:07:06 -07:00
|
|
|
"bytes"
|
2018-05-26 14:21:29 -07:00
|
|
|
"fmt"
|
2018-08-24 18:47:31 -07:00
|
|
|
"time"
|
2018-04-30 23:07:06 -07:00
|
|
|
|
2018-06-28 17:54:47 -07:00
|
|
|
abci "github.com/tendermint/tendermint/abci/types"
|
|
|
|
"github.com/tendermint/tendermint/crypto"
|
2018-06-04 16:42:01 -07:00
|
|
|
tmtypes "github.com/tendermint/tendermint/types"
|
2018-06-26 19:00:12 -07:00
|
|
|
|
2018-09-13 11:17:32 -07:00
|
|
|
"github.com/cosmos/cosmos-sdk/codec"
|
2018-06-26 19:00:12 -07:00
|
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
2018-01-25 19:31:07 -08:00
|
|
|
)
|
|
|
|
|
2018-05-09 21:01:58 -07:00
|
|
|
// Validator defines the total amount of bond shares and their exchange rate to
|
2018-01-25 19:31:07 -08:00
|
|
|
// coins. Accumulation of interest is modelled as an in increase in the
|
|
|
|
// exchange rate, and slashing as a decrease. When coins are delegated to this
|
2018-05-09 21:01:58 -07:00
|
|
|
// validator, the validator is credited with a Delegation whose number of
|
2018-01-25 19:31:07 -08:00
|
|
|
// bond shares is based on the amount of coins delegated divided by the current
|
|
|
|
// exchange rate. Voting power can be calculated as total bonds multiplied by
|
|
|
|
// exchange rate.
|
2018-05-09 21:01:58 -07:00
|
|
|
type Validator struct {
|
2018-09-10 15:37:03 -07:00
|
|
|
OperatorAddr sdk.ValAddress `json:"operator_address"` // address of the validator's operator; bech encoded in JSON
|
|
|
|
ConsPubKey crypto.PubKey `json:"consensus_pubkey"` // the consensus public key of the validator; bech encoded in JSON
|
2018-09-08 01:44:58 -07:00
|
|
|
Jailed bool `json:"jailed"` // has the validator been jailed from bonded status?
|
2018-05-11 14:58:28 -07:00
|
|
|
|
2018-07-13 13:46:14 -07:00
|
|
|
Status sdk.BondStatus `json:"status"` // validator status (bonded/unbonding/unbonded)
|
2018-08-14 17:15:02 -07:00
|
|
|
Tokens sdk.Dec `json:"tokens"` // delegated tokens (incl. self-delegation)
|
|
|
|
DelegatorShares sdk.Dec `json:"delegator_shares"` // total shares issued to a validator's delegators
|
2018-05-11 14:58:28 -07:00
|
|
|
|
2018-05-18 15:57:47 -07:00
|
|
|
Description Description `json:"description"` // description terms for the validator
|
|
|
|
BondHeight int64 `json:"bond_height"` // earliest height as a bonded validator
|
|
|
|
BondIntraTxCounter int16 `json:"bond_intra_tx_counter"` // block-local tx index of validator change
|
2018-08-24 18:47:31 -07:00
|
|
|
|
|
|
|
UnbondingHeight int64 `json:"unbonding_height"` // if unbonding, height at which this validator has begun unbonding
|
|
|
|
UnbondingMinTime time.Time `json:"unbonding_time"` // if unbonding, min time for the validator to complete unbonding
|
2018-05-04 12:38:25 -07:00
|
|
|
|
2018-09-24 15:23:58 -07:00
|
|
|
Commission Commission `json:"commission"` // commission parameters
|
2018-01-25 19:31:07 -08:00
|
|
|
}
|
|
|
|
|
2018-05-09 21:01:58 -07:00
|
|
|
// NewValidator - initialize a new validator
|
2018-08-30 21:06:44 -07:00
|
|
|
func NewValidator(operator sdk.ValAddress, pubKey crypto.PubKey, description Description) Validator {
|
2018-05-09 21:01:58 -07:00
|
|
|
return Validator{
|
2018-09-24 15:23:58 -07:00
|
|
|
OperatorAddr: operator,
|
|
|
|
ConsPubKey: pubKey,
|
|
|
|
Jailed: false,
|
|
|
|
Status: sdk.Unbonded,
|
|
|
|
Tokens: sdk.ZeroDec(),
|
|
|
|
DelegatorShares: sdk.ZeroDec(),
|
|
|
|
Description: description,
|
|
|
|
BondHeight: int64(0),
|
|
|
|
BondIntraTxCounter: int16(0),
|
|
|
|
UnbondingHeight: int64(0),
|
|
|
|
UnbondingMinTime: time.Unix(0, 0).UTC(),
|
|
|
|
Commission: NewCommission(sdk.ZeroDec(), sdk.ZeroDec(), sdk.ZeroDec()),
|
2018-01-25 19:31:07 -08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-07-03 22:32:49 -07:00
|
|
|
// what's kept in the store value
|
|
|
|
type validatorValue struct {
|
2018-09-24 15:23:58 -07:00
|
|
|
ConsPubKey crypto.PubKey
|
|
|
|
Jailed bool
|
|
|
|
Status sdk.BondStatus
|
|
|
|
Tokens sdk.Dec
|
|
|
|
DelegatorShares sdk.Dec
|
|
|
|
Description Description
|
|
|
|
BondHeight int64
|
|
|
|
BondIntraTxCounter int16
|
|
|
|
UnbondingHeight int64
|
|
|
|
UnbondingMinTime time.Time
|
|
|
|
Commission Commission
|
2018-07-03 22:32:49 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
// return the redelegation without fields contained within the key for the store
|
2018-09-13 11:17:32 -07:00
|
|
|
func MustMarshalValidator(cdc *codec.Codec, validator Validator) []byte {
|
2018-07-03 22:32:49 -07:00
|
|
|
val := validatorValue{
|
2018-09-24 15:23:58 -07:00
|
|
|
ConsPubKey: validator.ConsPubKey,
|
|
|
|
Jailed: validator.Jailed,
|
|
|
|
Status: validator.Status,
|
|
|
|
Tokens: validator.Tokens,
|
|
|
|
DelegatorShares: validator.DelegatorShares,
|
|
|
|
Description: validator.Description,
|
|
|
|
BondHeight: validator.BondHeight,
|
|
|
|
BondIntraTxCounter: validator.BondIntraTxCounter,
|
|
|
|
UnbondingHeight: validator.UnbondingHeight,
|
|
|
|
UnbondingMinTime: validator.UnbondingMinTime,
|
|
|
|
Commission: validator.Commission,
|
2018-07-03 22:32:49 -07:00
|
|
|
}
|
|
|
|
return cdc.MustMarshalBinary(val)
|
|
|
|
}
|
|
|
|
|
|
|
|
// unmarshal a redelegation from a store key and value
|
2018-09-13 11:17:32 -07:00
|
|
|
func MustUnmarshalValidator(cdc *codec.Codec, operatorAddr, value []byte) Validator {
|
2018-08-16 13:47:59 -07:00
|
|
|
validator, err := UnmarshalValidator(cdc, operatorAddr, value)
|
2018-07-04 14:07:06 -07:00
|
|
|
if err != nil {
|
|
|
|
panic(err)
|
|
|
|
}
|
|
|
|
return validator
|
|
|
|
}
|
|
|
|
|
|
|
|
// unmarshal a redelegation from a store key and value
|
2018-09-13 11:17:32 -07:00
|
|
|
func UnmarshalValidator(cdc *codec.Codec, operatorAddr, value []byte) (validator Validator, err error) {
|
2018-08-16 13:47:59 -07:00
|
|
|
if len(operatorAddr) != sdk.AddrLen {
|
2018-08-15 12:49:06 -07:00
|
|
|
err = fmt.Errorf("%v", ErrBadValidatorAddr(DefaultCodespace).Data())
|
|
|
|
return
|
|
|
|
}
|
2018-07-03 22:32:49 -07:00
|
|
|
var storeValue validatorValue
|
2018-07-04 14:07:06 -07:00
|
|
|
err = cdc.UnmarshalBinary(value, &storeValue)
|
|
|
|
if err != nil {
|
|
|
|
return
|
|
|
|
}
|
2018-07-03 22:32:49 -07:00
|
|
|
|
|
|
|
return Validator{
|
2018-09-24 15:23:58 -07:00
|
|
|
OperatorAddr: operatorAddr,
|
|
|
|
ConsPubKey: storeValue.ConsPubKey,
|
|
|
|
Jailed: storeValue.Jailed,
|
|
|
|
Tokens: storeValue.Tokens,
|
|
|
|
Status: storeValue.Status,
|
|
|
|
DelegatorShares: storeValue.DelegatorShares,
|
|
|
|
Description: storeValue.Description,
|
|
|
|
BondHeight: storeValue.BondHeight,
|
|
|
|
BondIntraTxCounter: storeValue.BondIntraTxCounter,
|
|
|
|
UnbondingHeight: storeValue.UnbondingHeight,
|
|
|
|
UnbondingMinTime: storeValue.UnbondingMinTime,
|
|
|
|
Commission: storeValue.Commission,
|
2018-07-04 14:07:06 -07:00
|
|
|
}, nil
|
2018-07-03 22:32:49 -07:00
|
|
|
}
|
|
|
|
|
2018-07-18 13:09:40 -07:00
|
|
|
// HumanReadableString returns a human readable string representation of a
|
2018-08-16 13:47:59 -07:00
|
|
|
// validator. An error is returned if the operator or the operator's public key
|
2018-07-18 13:09:40 -07:00
|
|
|
// cannot be converted to Bech32 format.
|
|
|
|
func (v Validator) HumanReadableString() (string, error) {
|
2018-09-08 01:44:58 -07:00
|
|
|
bechConsPubKey, err := sdk.Bech32ifyConsPub(v.ConsPubKey)
|
2018-07-18 13:09:40 -07:00
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
|
|
|
|
resp := "Validator \n"
|
2018-09-08 01:44:58 -07:00
|
|
|
resp += fmt.Sprintf("Operator Address: %s\n", v.OperatorAddr)
|
|
|
|
resp += fmt.Sprintf("Validator Consensus Pubkey: %s\n", bechConsPubKey)
|
2018-08-22 08:56:13 -07:00
|
|
|
resp += fmt.Sprintf("Jailed: %v\n", v.Jailed)
|
2018-07-18 13:09:40 -07:00
|
|
|
resp += fmt.Sprintf("Status: %s\n", sdk.BondStatusToString(v.Status))
|
2018-09-24 15:23:58 -07:00
|
|
|
resp += fmt.Sprintf("Tokens: %s\n", v.Tokens)
|
|
|
|
resp += fmt.Sprintf("Delegator Shares: %s\n", v.DelegatorShares)
|
2018-07-18 13:09:40 -07:00
|
|
|
resp += fmt.Sprintf("Description: %s\n", v.Description)
|
|
|
|
resp += fmt.Sprintf("Bond Height: %d\n", v.BondHeight)
|
2018-08-24 18:47:31 -07:00
|
|
|
resp += fmt.Sprintf("Unbonding Height: %d\n", v.UnbondingHeight)
|
2018-08-26 21:20:40 -07:00
|
|
|
resp += fmt.Sprintf("Minimum Unbonding Time: %v\n", v.UnbondingMinTime)
|
2018-09-24 15:23:58 -07:00
|
|
|
resp += fmt.Sprintf("Commission: {%s}\n", v.Commission)
|
2018-07-18 13:09:40 -07:00
|
|
|
|
|
|
|
return resp, nil
|
|
|
|
}
|
|
|
|
|
2018-07-13 13:46:14 -07:00
|
|
|
//___________________________________________________________________
|
|
|
|
|
2018-09-10 15:37:03 -07:00
|
|
|
// this is a helper struct used for JSON de- and encoding only
|
|
|
|
type bechValidator struct {
|
2018-09-08 01:44:58 -07:00
|
|
|
OperatorAddr sdk.ValAddress `json:"operator_address"` // the bech32 address of the validator's operator
|
|
|
|
ConsPubKey string `json:"consensus_pubkey"` // the bech32 consensus public key of the validator
|
|
|
|
Jailed bool `json:"jailed"` // has the validator been jailed from bonded status?
|
2018-07-13 13:46:14 -07:00
|
|
|
|
|
|
|
Status sdk.BondStatus `json:"status"` // validator status (bonded/unbonding/unbonded)
|
2018-08-14 17:15:02 -07:00
|
|
|
Tokens sdk.Dec `json:"tokens"` // delegated tokens (incl. self-delegation)
|
|
|
|
DelegatorShares sdk.Dec `json:"delegator_shares"` // total shares issued to a validator's delegators
|
2018-07-13 13:46:14 -07:00
|
|
|
|
|
|
|
Description Description `json:"description"` // description terms for the validator
|
|
|
|
BondHeight int64 `json:"bond_height"` // earliest height as a bonded validator
|
|
|
|
BondIntraTxCounter int16 `json:"bond_intra_tx_counter"` // block-local tx index of validator change
|
2018-08-24 18:47:31 -07:00
|
|
|
|
|
|
|
UnbondingHeight int64 `json:"unbonding_height"` // if unbonding, height at which this validator has begun unbonding
|
|
|
|
UnbondingMinTime time.Time `json:"unbonding_time"` // if unbonding, min time for the validator to complete unbonding
|
2018-07-13 13:46:14 -07:00
|
|
|
|
2018-09-24 15:23:58 -07:00
|
|
|
Commission Commission `json:"commission"` // commission parameters
|
2018-07-13 13:46:14 -07:00
|
|
|
}
|
|
|
|
|
2018-09-10 15:37:03 -07:00
|
|
|
// MarshalJSON marshals the validator to JSON using Bech32
|
|
|
|
func (v Validator) MarshalJSON() ([]byte, error) {
|
2018-09-08 01:44:58 -07:00
|
|
|
bechConsPubKey, err := sdk.Bech32ifyConsPub(v.ConsPubKey)
|
2018-07-13 13:46:14 -07:00
|
|
|
if err != nil {
|
2018-09-10 15:37:03 -07:00
|
|
|
return nil, err
|
2018-07-13 13:46:14 -07:00
|
|
|
}
|
|
|
|
|
2018-09-13 11:17:32 -07:00
|
|
|
return codec.Cdc.MarshalJSON(bechValidator{
|
2018-09-24 15:23:58 -07:00
|
|
|
OperatorAddr: v.OperatorAddr,
|
|
|
|
ConsPubKey: bechConsPubKey,
|
|
|
|
Jailed: v.Jailed,
|
|
|
|
Status: v.Status,
|
|
|
|
Tokens: v.Tokens,
|
|
|
|
DelegatorShares: v.DelegatorShares,
|
|
|
|
Description: v.Description,
|
|
|
|
BondHeight: v.BondHeight,
|
|
|
|
BondIntraTxCounter: v.BondIntraTxCounter,
|
|
|
|
UnbondingHeight: v.UnbondingHeight,
|
|
|
|
UnbondingMinTime: v.UnbondingMinTime,
|
|
|
|
Commission: v.Commission,
|
2018-09-10 15:37:03 -07:00
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// UnmarshalJSON unmarshals the validator from JSON using Bech32
|
|
|
|
func (v *Validator) UnmarshalJSON(data []byte) error {
|
|
|
|
bv := &bechValidator{}
|
2018-09-13 11:17:32 -07:00
|
|
|
if err := codec.Cdc.UnmarshalJSON(data, bv); err != nil {
|
2018-09-10 15:37:03 -07:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
consPubKey, err := sdk.GetConsPubKeyBech32(bv.ConsPubKey)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
*v = Validator{
|
2018-09-24 15:23:58 -07:00
|
|
|
OperatorAddr: bv.OperatorAddr,
|
|
|
|
ConsPubKey: consPubKey,
|
|
|
|
Jailed: bv.Jailed,
|
|
|
|
Tokens: bv.Tokens,
|
|
|
|
Status: bv.Status,
|
|
|
|
DelegatorShares: bv.DelegatorShares,
|
|
|
|
Description: bv.Description,
|
|
|
|
BondHeight: bv.BondHeight,
|
|
|
|
BondIntraTxCounter: bv.BondIntraTxCounter,
|
|
|
|
UnbondingHeight: bv.UnbondingHeight,
|
|
|
|
UnbondingMinTime: bv.UnbondingMinTime,
|
|
|
|
Commission: bv.Commission,
|
2018-09-10 15:37:03 -07:00
|
|
|
}
|
|
|
|
return nil
|
2018-07-13 13:46:14 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
//___________________________________________________________________
|
|
|
|
|
2018-05-12 15:22:59 -07:00
|
|
|
// only the vitals - does not check bond height of IntraTxCounter
|
2018-09-24 15:23:58 -07:00
|
|
|
func (v Validator) Equal(v2 Validator) bool {
|
|
|
|
return v.ConsPubKey.Equals(v2.ConsPubKey) &&
|
|
|
|
bytes.Equal(v.OperatorAddr, v2.OperatorAddr) &&
|
|
|
|
v.Status.Equal(v2.Status) &&
|
|
|
|
v.Tokens.Equal(v2.Tokens) &&
|
|
|
|
v.DelegatorShares.Equal(v2.DelegatorShares) &&
|
|
|
|
v.Description == v2.Description &&
|
|
|
|
v.Commission.Equal(v2.Commission)
|
2018-04-30 23:07:06 -07:00
|
|
|
}
|
|
|
|
|
2018-08-31 17:01:23 -07:00
|
|
|
// return the TM validator address
|
|
|
|
func (v Validator) ConsAddress() sdk.ConsAddress {
|
2018-09-08 01:44:58 -07:00
|
|
|
return sdk.ConsAddress(v.ConsPubKey.Address())
|
2018-08-31 17:01:23 -07:00
|
|
|
}
|
|
|
|
|
2018-07-26 10:41:34 -07:00
|
|
|
// constant used in flags to indicate that description field should not be updated
|
|
|
|
const DoNotModifyDesc = "[do-not-modify]"
|
|
|
|
|
2018-05-09 21:01:58 -07:00
|
|
|
// Description - description fields for a validator
|
2018-03-26 07:48:15 -07:00
|
|
|
type Description struct {
|
2018-05-23 12:42:37 -07:00
|
|
|
Moniker string `json:"moniker"` // name
|
|
|
|
Identity string `json:"identity"` // optional identity signature (ex. UPort or Keybase)
|
|
|
|
Website string `json:"website"` // optional website link
|
|
|
|
Details string `json:"details"` // optional details
|
2018-03-26 07:48:15 -07:00
|
|
|
}
|
|
|
|
|
2018-07-03 21:21:36 -07:00
|
|
|
// NewDescription returns a new Description with the provided values.
|
2018-03-26 07:48:15 -07:00
|
|
|
func NewDescription(moniker, identity, website, details string) Description {
|
|
|
|
return Description{
|
|
|
|
Moniker: moniker,
|
|
|
|
Identity: identity,
|
|
|
|
Website: website,
|
|
|
|
Details: details,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-07-03 21:21:36 -07:00
|
|
|
// UpdateDescription updates the fields of a given description. An error is
|
|
|
|
// returned if the resulting description contains an invalid length.
|
2018-06-26 19:00:12 -07:00
|
|
|
func (d Description) UpdateDescription(d2 Description) (Description, sdk.Error) {
|
2018-07-26 10:41:34 -07:00
|
|
|
if d2.Moniker == DoNotModifyDesc {
|
2018-06-26 19:00:12 -07:00
|
|
|
d2.Moniker = d.Moniker
|
|
|
|
}
|
2018-07-26 10:41:34 -07:00
|
|
|
if d2.Identity == DoNotModifyDesc {
|
2018-06-26 19:00:12 -07:00
|
|
|
d2.Identity = d.Identity
|
|
|
|
}
|
2018-07-26 10:41:34 -07:00
|
|
|
if d2.Website == DoNotModifyDesc {
|
2018-06-26 19:00:12 -07:00
|
|
|
d2.Website = d.Website
|
|
|
|
}
|
2018-07-26 10:41:34 -07:00
|
|
|
if d2.Details == DoNotModifyDesc {
|
2018-06-26 19:00:12 -07:00
|
|
|
d2.Details = d.Details
|
|
|
|
}
|
2018-07-03 21:21:36 -07:00
|
|
|
|
2018-06-26 19:00:12 -07:00
|
|
|
return Description{
|
|
|
|
Moniker: d2.Moniker,
|
|
|
|
Identity: d2.Identity,
|
|
|
|
Website: d2.Website,
|
|
|
|
Details: d2.Details,
|
|
|
|
}.EnsureLength()
|
|
|
|
}
|
|
|
|
|
2018-07-03 21:21:36 -07:00
|
|
|
// EnsureLength ensures the length of a validator's description.
|
2018-06-26 19:00:12 -07:00
|
|
|
func (d Description) EnsureLength() (Description, sdk.Error) {
|
|
|
|
if len(d.Moniker) > 70 {
|
|
|
|
return d, ErrDescriptionLength(DefaultCodespace, "moniker", len(d.Moniker), 70)
|
|
|
|
}
|
|
|
|
if len(d.Identity) > 3000 {
|
|
|
|
return d, ErrDescriptionLength(DefaultCodespace, "identity", len(d.Identity), 3000)
|
|
|
|
}
|
|
|
|
if len(d.Website) > 140 {
|
|
|
|
return d, ErrDescriptionLength(DefaultCodespace, "website", len(d.Website), 140)
|
|
|
|
}
|
|
|
|
if len(d.Details) > 280 {
|
|
|
|
return d, ErrDescriptionLength(DefaultCodespace, "details", len(d.Details), 280)
|
|
|
|
}
|
2018-07-03 21:21:36 -07:00
|
|
|
|
2018-06-26 19:00:12 -07:00
|
|
|
return d, nil
|
|
|
|
}
|
2018-05-12 15:54:50 -07:00
|
|
|
|
2018-07-03 21:21:36 -07:00
|
|
|
// ABCIValidator returns an abci.Validator from a staked validator type.
|
2018-06-29 15:22:24 -07:00
|
|
|
func (v Validator) ABCIValidator() abci.Validator {
|
2018-05-06 07:18:45 -07:00
|
|
|
return abci.Validator{
|
2018-09-08 01:44:58 -07:00
|
|
|
PubKey: tmtypes.TM2PB.PubKey(v.ConsPubKey),
|
|
|
|
Address: v.ConsPubKey.Address(),
|
2018-08-16 08:36:15 -07:00
|
|
|
Power: v.BondedTokens().RoundInt64(),
|
2018-04-04 20:22:13 -07:00
|
|
|
}
|
2018-01-31 18:56:46 -08:00
|
|
|
}
|
|
|
|
|
2018-07-03 21:21:36 -07:00
|
|
|
// ABCIValidatorZero returns an abci.Validator from a staked validator type
|
|
|
|
// with with zero power used for validator updates.
|
2018-06-29 15:22:24 -07:00
|
|
|
func (v Validator) ABCIValidatorZero() abci.Validator {
|
2018-05-06 07:18:45 -07:00
|
|
|
return abci.Validator{
|
2018-09-08 01:44:58 -07:00
|
|
|
PubKey: tmtypes.TM2PB.PubKey(v.ConsPubKey),
|
|
|
|
Address: v.ConsPubKey.Address(),
|
2018-08-16 08:36:15 -07:00
|
|
|
Power: 0,
|
2018-04-05 09:31:36 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-07-13 13:46:14 -07:00
|
|
|
// UpdateStatus updates the location of the shares within a validator
|
|
|
|
// to reflect the new status
|
2018-05-20 14:39:04 -07:00
|
|
|
func (v Validator) UpdateStatus(pool Pool, NewStatus sdk.BondStatus) (Validator, Pool) {
|
2018-05-12 15:54:50 -07:00
|
|
|
|
2018-07-13 13:46:14 -07:00
|
|
|
switch v.Status {
|
2018-05-20 14:39:04 -07:00
|
|
|
case sdk.Unbonded:
|
2018-07-13 13:46:14 -07:00
|
|
|
|
|
|
|
switch NewStatus {
|
|
|
|
case sdk.Unbonded:
|
2018-05-20 14:39:04 -07:00
|
|
|
return v, pool
|
2018-07-13 13:46:14 -07:00
|
|
|
case sdk.Bonded:
|
|
|
|
pool = pool.looseTokensToBonded(v.Tokens)
|
2018-05-12 15:54:50 -07:00
|
|
|
}
|
2018-05-20 14:39:04 -07:00
|
|
|
case sdk.Unbonding:
|
2018-07-13 13:46:14 -07:00
|
|
|
|
|
|
|
switch NewStatus {
|
|
|
|
case sdk.Unbonding:
|
2018-05-20 14:39:04 -07:00
|
|
|
return v, pool
|
2018-07-13 13:46:14 -07:00
|
|
|
case sdk.Bonded:
|
|
|
|
pool = pool.looseTokensToBonded(v.Tokens)
|
2018-05-12 15:54:50 -07:00
|
|
|
}
|
2018-05-20 14:39:04 -07:00
|
|
|
case sdk.Bonded:
|
2018-07-13 13:46:14 -07:00
|
|
|
|
|
|
|
switch NewStatus {
|
|
|
|
case sdk.Bonded:
|
2018-05-20 14:39:04 -07:00
|
|
|
return v, pool
|
2018-07-13 13:46:14 -07:00
|
|
|
default:
|
|
|
|
pool = pool.bondedTokensToLoose(v.Tokens)
|
2018-05-12 15:54:50 -07:00
|
|
|
}
|
|
|
|
}
|
2018-07-03 21:21:36 -07:00
|
|
|
|
2018-07-13 13:46:14 -07:00
|
|
|
v.Status = NewStatus
|
2018-05-20 14:39:04 -07:00
|
|
|
return v, pool
|
2018-05-12 15:54:50 -07:00
|
|
|
}
|
|
|
|
|
2018-07-13 13:46:14 -07:00
|
|
|
// removes tokens from a validator
|
2018-08-14 17:15:02 -07:00
|
|
|
func (v Validator) RemoveTokens(pool Pool, tokens sdk.Dec) (Validator, Pool) {
|
2018-07-13 13:46:14 -07:00
|
|
|
if v.Status == sdk.Bonded {
|
|
|
|
pool = pool.bondedTokensToLoose(tokens)
|
2018-05-24 16:03:26 -07:00
|
|
|
}
|
2018-07-03 21:21:36 -07:00
|
|
|
|
2018-07-13 13:46:14 -07:00
|
|
|
v.Tokens = v.Tokens.Sub(tokens)
|
|
|
|
return v, pool
|
2018-05-12 15:54:50 -07:00
|
|
|
}
|
|
|
|
|
2018-09-24 15:23:58 -07:00
|
|
|
// SetInitialCommission attempts to set a validator's initial commission. An
|
|
|
|
// error is returned if the commission is invalid.
|
|
|
|
func (v Validator) SetInitialCommission(commission Commission) (Validator, sdk.Error) {
|
|
|
|
if err := commission.Validate(); err != nil {
|
|
|
|
return v, err
|
|
|
|
}
|
|
|
|
|
|
|
|
v.Commission = commission
|
|
|
|
return v, nil
|
|
|
|
}
|
|
|
|
|
2018-05-15 20:32:18 -07:00
|
|
|
//_________________________________________________________________________________________________________
|
2018-05-12 15:54:50 -07:00
|
|
|
|
2018-07-03 21:21:36 -07:00
|
|
|
// AddTokensFromDel adds tokens to a validator
|
2018-08-27 15:18:18 -07:00
|
|
|
func (v Validator) AddTokensFromDel(pool Pool, amount sdk.Int) (Validator, Pool, sdk.Dec) {
|
2018-05-12 15:54:50 -07:00
|
|
|
|
2018-07-03 21:21:36 -07:00
|
|
|
// bondedShare/delegatedShare
|
2018-07-13 13:46:14 -07:00
|
|
|
exRate := v.DelegatorShareExRate()
|
2018-08-27 15:18:18 -07:00
|
|
|
amountDec := sdk.NewDecFromInt(amount)
|
2018-05-15 21:41:21 -07:00
|
|
|
|
2018-07-13 13:46:14 -07:00
|
|
|
if v.Status == sdk.Bonded {
|
2018-08-14 17:15:02 -07:00
|
|
|
pool = pool.looseTokensToBonded(amountDec)
|
2018-05-12 15:54:50 -07:00
|
|
|
}
|
|
|
|
|
2018-08-14 17:15:02 -07:00
|
|
|
v.Tokens = v.Tokens.Add(amountDec)
|
|
|
|
issuedShares := amountDec.Quo(exRate)
|
2018-07-13 13:46:14 -07:00
|
|
|
v.DelegatorShares = v.DelegatorShares.Add(issuedShares)
|
2018-05-12 15:54:50 -07:00
|
|
|
|
2018-07-13 13:46:14 -07:00
|
|
|
return v, pool, issuedShares
|
2018-05-12 15:54:50 -07:00
|
|
|
}
|
|
|
|
|
2018-07-03 21:21:36 -07:00
|
|
|
// RemoveDelShares removes delegator shares from a validator.
|
2018-08-14 17:15:02 -07:00
|
|
|
func (v Validator) RemoveDelShares(pool Pool, delShares sdk.Dec) (Validator, Pool, sdk.Dec) {
|
2018-07-13 13:46:14 -07:00
|
|
|
issuedTokens := v.DelegatorShareExRate().Mul(delShares)
|
|
|
|
v.Tokens = v.Tokens.Sub(issuedTokens)
|
2018-05-12 15:54:50 -07:00
|
|
|
v.DelegatorShares = v.DelegatorShares.Sub(delShares)
|
2018-05-15 06:06:56 -07:00
|
|
|
|
2018-07-13 13:46:14 -07:00
|
|
|
if v.Status == sdk.Bonded {
|
|
|
|
pool = pool.bondedTokensToLoose(issuedTokens)
|
2018-05-15 06:06:56 -07:00
|
|
|
}
|
2018-07-03 21:21:36 -07:00
|
|
|
|
2018-07-13 13:46:14 -07:00
|
|
|
return v, pool, issuedTokens
|
2018-05-12 15:54:50 -07:00
|
|
|
}
|
2018-05-06 07:18:45 -07:00
|
|
|
|
2018-07-03 21:21:36 -07:00
|
|
|
// DelegatorShareExRate gets the exchange rate of tokens over delegator shares.
|
2018-07-13 13:46:14 -07:00
|
|
|
// UNITS: tokens/delegator-shares
|
2018-08-14 17:15:02 -07:00
|
|
|
func (v Validator) DelegatorShareExRate() sdk.Dec {
|
2018-05-15 21:41:21 -07:00
|
|
|
if v.DelegatorShares.IsZero() {
|
2018-08-14 17:15:02 -07:00
|
|
|
return sdk.OneDec()
|
2018-05-15 21:41:21 -07:00
|
|
|
}
|
2018-07-13 13:46:14 -07:00
|
|
|
return v.Tokens.Quo(v.DelegatorShares)
|
|
|
|
}
|
2018-07-03 21:21:36 -07:00
|
|
|
|
2018-07-13 13:46:14 -07:00
|
|
|
// Get the bonded tokens which the validator holds
|
2018-08-14 17:15:02 -07:00
|
|
|
func (v Validator) BondedTokens() sdk.Dec {
|
2018-07-13 13:46:14 -07:00
|
|
|
if v.Status == sdk.Bonded {
|
|
|
|
return v.Tokens
|
|
|
|
}
|
2018-08-14 17:15:02 -07:00
|
|
|
return sdk.ZeroDec()
|
2018-05-15 21:41:21 -07:00
|
|
|
}
|
|
|
|
|
2018-08-29 15:44:40 -07:00
|
|
|
// Returns if the validator should be considered unbonded
|
|
|
|
func (v Validator) IsUnbonded(ctx sdk.Context) bool {
|
2018-08-30 18:16:23 -07:00
|
|
|
switch v.Status {
|
|
|
|
case sdk.Unbonded:
|
2018-08-29 15:44:40 -07:00
|
|
|
return true
|
2018-08-30 18:16:23 -07:00
|
|
|
case sdk.Unbonding:
|
2018-08-29 15:44:40 -07:00
|
|
|
ctxTime := ctx.BlockHeader().Time
|
|
|
|
if ctxTime.After(v.UnbondingMinTime) {
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
2018-05-09 18:39:14 -07:00
|
|
|
//______________________________________________________________________
|
2018-05-06 07:18:45 -07:00
|
|
|
|
2018-05-09 18:39:14 -07:00
|
|
|
// ensure fulfills the sdk validator types
|
|
|
|
var _ sdk.Validator = Validator{}
|
2018-05-06 07:18:45 -07:00
|
|
|
|
2018-05-09 18:39:14 -07:00
|
|
|
// nolint - for sdk.Validator
|
2018-09-24 21:09:31 -07:00
|
|
|
func (v Validator) GetJailed() bool { return v.Jailed }
|
|
|
|
func (v Validator) GetMoniker() string { return v.Description.Moniker }
|
|
|
|
func (v Validator) GetStatus() sdk.BondStatus { return v.Status }
|
|
|
|
func (v Validator) GetOperator() sdk.ValAddress { return v.OperatorAddr }
|
|
|
|
func (v Validator) GetConsPubKey() crypto.PubKey { return v.ConsPubKey }
|
|
|
|
func (v Validator) GetConsAddr() sdk.ConsAddress { return sdk.ConsAddress(v.ConsPubKey.Address()) }
|
|
|
|
func (v Validator) GetPower() sdk.Dec { return v.BondedTokens() }
|
|
|
|
func (v Validator) GetTokens() sdk.Dec { return v.Tokens }
|
|
|
|
func (v Validator) GetCommission() sdk.Dec { return v.Commission.Rate }
|
|
|
|
func (v Validator) GetDelegatorShares() sdk.Dec { return v.DelegatorShares }
|
|
|
|
func (v Validator) GetBondHeight() int64 { return v.BondHeight }
|