types

package
v0.34.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 25, 2019 License: Apache-2.0 Imports: 12 Imported by: 6,273

Documentation

Overview

nolint

Index

Constants

View Source 
const (
	// ModuleName is the name of the staking module
	ModuleName = "staking"

	// StoreKey is the string store representation
	StoreKey = ModuleName

	// TStoreKey is the string transient store representation
	TStoreKey = "transient_" + ModuleName

	// QuerierRoute is the querier route for the staking module
	QuerierRoute = ModuleName

	// RouterKey is the msg router key for the staking module
	RouterKey = ModuleName
)
View Source 
const (
	// DefaultUnbondingTime reflects three weeks in seconds as the default
	// unbonding time.
	// TODO: Justify our choice of default here.
	DefaultUnbondingTime time.Duration = time.Second * 60 * 60 * 24 * 3

	// Default maximum number of bonded validators
	DefaultMaxValidators uint16 = 100

	// Default maximum entries in a UBD/RED pair
	DefaultMaxEntries uint16 = 7
)
View Source 
const (
	// TODO: Why can't we just have one string description which can be JSON by convention
	MaxMonikerLength  = 70
	MaxIdentityLength = 3000
	MaxWebsiteLength  = 140
	MaxDetailsLength  = 280
)

nolint

View Source 
const DoNotModifyDesc = "[do-not-modify]"

constant used in flags to indicate that description field should not be updated

Variables

View Source 
var (
	KeyUnbondingTime = []byte("UnbondingTime")
	KeyMaxValidators = []byte("MaxValidators")
	KeyMaxEntries    = []byte("KeyMaxEntries")
	KeyBondDenom     = []byte("BondDenom")
)

nolint - Keys for parameter access

View Source 
var MsgCdc *codec.Codec

generic sealed codec to be used throughout sdk

Functions

func ErrBadDelegationAddr 

func ErrBadDelegationAddr(codespace sdk.CodespaceType) sdk.Error

func ErrBadDelegationAmount 

func ErrBadDelegationAmount(codespace sdk.CodespaceType) sdk.Error

func ErrBadDelegatorAddr 

func ErrBadDelegatorAddr(codespace sdk.CodespaceType) sdk.Error

func ErrBadDenom 

func ErrBadDenom(codespace sdk.CodespaceType) sdk.Error

func ErrBadRedelegationAddr 

func ErrBadRedelegationAddr(codespace sdk.CodespaceType) sdk.Error

func ErrBadRedelegationDst 

func ErrBadRedelegationDst(codespace sdk.CodespaceType) sdk.Error

func ErrBadRemoveValidator 

func ErrBadRemoveValidator(codespace sdk.CodespaceType) sdk.Error

func ErrBadSharesAmount 

func ErrBadSharesAmount(codespace sdk.CodespaceType) sdk.Error

func ErrBadSharesPercent 

func ErrBadSharesPercent(codespace sdk.CodespaceType) sdk.Error

func ErrBadValidatorAddr 

func ErrBadValidatorAddr(codespace sdk.CodespaceType) sdk.Error

func ErrBothShareMsgsGiven 

func ErrBothShareMsgsGiven(codespace sdk.CodespaceType) sdk.Error

func ErrCommissionChangeRateGTMaxRate 

func ErrCommissionChangeRateGTMaxRate(codespace sdk.CodespaceType) sdk.Error

func ErrCommissionChangeRateNegative 

func ErrCommissionChangeRateNegative(codespace sdk.CodespaceType) sdk.Error

func ErrCommissionGTMaxChangeRate 

func ErrCommissionGTMaxChangeRate(codespace sdk.CodespaceType) sdk.Error

func ErrCommissionGTMaxRate 

func ErrCommissionGTMaxRate(codespace sdk.CodespaceType) sdk.Error

func ErrCommissionHuge 

func ErrCommissionHuge(codespace sdk.CodespaceType) sdk.Error

func ErrCommissionNegative 

func ErrCommissionNegative(codespace sdk.CodespaceType) sdk.Error

func ErrCommissionUpdateTime 

func ErrCommissionUpdateTime(codespace sdk.CodespaceType) sdk.Error

func ErrDelegationValidatorEmpty 

func ErrDelegationValidatorEmpty(codespace sdk.CodespaceType) sdk.Error

func ErrDelegatorShareExRateInvalid 

func ErrDelegatorShareExRateInvalid(codespace sdk.CodespaceType) sdk.Error

func ErrDescriptionLength added in v0.30.0 

func ErrDescriptionLength(codespace sdk.CodespaceType, descriptor string, got, max int) sdk.Error

func ErrInsufficientShares 

func ErrInsufficientShares(codespace sdk.CodespaceType) sdk.Error

func ErrMaxRedelegationEntries 

func ErrMaxRedelegationEntries(codespace sdk.CodespaceType) sdk.Error

func ErrMaxUnbondingDelegationEntries 

func ErrMaxUnbondingDelegationEntries(codespace sdk.CodespaceType) sdk.Error

func ErrMinSelfDelegationDecreased 

func ErrMinSelfDelegationDecreased(codespace sdk.CodespaceType) sdk.Error

func ErrMinSelfDelegationInvalid 

func ErrMinSelfDelegationInvalid(codespace sdk.CodespaceType) sdk.Error

func ErrMissingSignature added in v0.30.0 

func ErrMissingSignature(codespace sdk.CodespaceType) sdk.Error

func ErrNeitherShareMsgsGiven 

func ErrNeitherShareMsgsGiven(codespace sdk.CodespaceType) sdk.Error

func ErrNilDelegatorAddr added in v0.30.0 

func ErrNilDelegatorAddr(codespace sdk.CodespaceType) sdk.Error

func ErrNilValidatorAddr added in v0.30.0 

func ErrNilValidatorAddr(codespace sdk.CodespaceType) sdk.Error

validator

func ErrNoDelegation 

func ErrNoDelegation(codespace sdk.CodespaceType) sdk.Error

func ErrNoDelegatorForAddress 

func ErrNoDelegatorForAddress(codespace sdk.CodespaceType) sdk.Error

func ErrNoRedelegation 

func ErrNoRedelegation(codespace sdk.CodespaceType) sdk.Error

func ErrNoUnbondingDelegation 

func ErrNoUnbondingDelegation(codespace sdk.CodespaceType) sdk.Error

func ErrNoValidatorFound 

func ErrNoValidatorFound(codespace sdk.CodespaceType) sdk.Error

func ErrNotEnoughDelegationShares 

func ErrNotEnoughDelegationShares(codespace sdk.CodespaceType, shares string) sdk.Error

func ErrNotMature 

func ErrNotMature(codespace sdk.CodespaceType, operation, descriptor string, got, min time.Time) sdk.Error

func ErrSelfDelegationBelowMinimum 

func ErrSelfDelegationBelowMinimum(codespace sdk.CodespaceType) sdk.Error

func ErrSelfRedelegation 

func ErrSelfRedelegation(codespace sdk.CodespaceType) sdk.Error

func ErrTransitiveRedelegation 

func ErrTransitiveRedelegation(codespace sdk.CodespaceType) sdk.Error

func ErrValidatorJailed 

func ErrValidatorJailed(codespace sdk.CodespaceType) sdk.Error

func ErrValidatorOwnerExists 

func ErrValidatorOwnerExists(codespace sdk.CodespaceType) sdk.Error

func ErrValidatorPubKeyExists 

func ErrValidatorPubKeyExists(codespace sdk.CodespaceType) sdk.Error

func ErrValidatorPubKeyTypeNotSupported 

func ErrValidatorPubKeyTypeNotSupported(codespace sdk.CodespaceType, keyType string, supportedTypes []string) sdk.Error

func ErrVerySmallRedelegation added in v0.30.0 

func ErrVerySmallRedelegation(codespace sdk.CodespaceType) sdk.Error

func MustMarshalDelegation 

func MustMarshalDelegation(cdc *codec.Codec, delegation Delegation) []byte

return the delegation

func MustMarshalRED 

func MustMarshalRED(cdc *codec.Codec, red Redelegation) []byte

return the redelegation

func MustMarshalUBD 

func MustMarshalUBD(cdc *codec.Codec, ubd UnbondingDelegation) []byte

return the unbonding delegation

func MustMarshalValidator 

func MustMarshalValidator(cdc *codec.Codec, validator Validator) []byte

return the redelegation

func RegisterCodec 

func RegisterCodec(cdc *codec.Codec)

Register concrete types on codec codec

Types

type BankKeeper 

type BankKeeper interface {
	DelegateCoins(ctx sdk.Context, addr sdk.AccAddress, amt sdk.Coins) (sdk.Tags, sdk.Error)
	UndelegateCoins(ctx sdk.Context, addr sdk.AccAddress, amt sdk.Coins) (sdk.Tags, sdk.Error)
}

expected bank keeper

type CodeType added in v0.30.0 

type CodeType = sdk.CodeType
const (
	DefaultCodespace sdk.CodespaceType = ModuleName

	CodeInvalidValidator  CodeType = 101
	CodeInvalidDelegation CodeType = 102
	CodeInvalidInput      CodeType = 103
	CodeValidatorJailed   CodeType = 104
	CodeInvalidAddress    CodeType = sdk.CodeInvalidAddress
	CodeUnauthorized      CodeType = sdk.CodeUnauthorized
	CodeInternal          CodeType = sdk.CodeInternal
	CodeUnknownRequest    CodeType = sdk.CodeUnknownRequest
)

type Commission 

type Commission struct {
	Rate          sdk.Dec   `json:"rate"`            // the commission rate charged to delegators, as a fraction
	MaxRate       sdk.Dec   `json:"max_rate"`        // maximum commission rate which this validator can ever charge, as a fraction
	MaxChangeRate sdk.Dec   `json:"max_change_rate"` // maximum daily increase of the validator commission, as a fraction
	UpdateTime    time.Time `json:"update_time"`     // the last time the commission rate was changed
}

Commission defines a commission parameters for a given validator.

func NewCommission 

func NewCommission(rate, maxRate, maxChangeRate sdk.Dec) Commission

NewCommission returns an initialized validator commission.

func NewCommissionWithTime 

func NewCommissionWithTime(rate, maxRate, maxChangeRate sdk.Dec, updatedAt time.Time) Commission

NewCommission returns an initialized validator commission with a specified update time which should be the current block BFT time.

func (Commission) Equal 

func (c Commission) Equal(c2 Commission) bool

Equal checks if the given Commission object is equal to the receiving Commission object.

func (Commission) String 

func (c Commission) String() string

String implements the Stringer interface for a Commission.

func (Commission) Validate added in v0.30.0 

func (c Commission) Validate() sdk.Error

Validate performs basic sanity validation checks of initial commission parameters. If validation fails, an SDK error is returned.

func (Commission) ValidateNewRate 

func (c Commission) ValidateNewRate(newRate sdk.Dec, blockTime time.Time) sdk.Error

ValidateNewRate performs basic sanity validation checks of a new commission rate. If validation fails, an SDK error is returned.

type CommissionMsg added in v0.30.0 

type CommissionMsg struct {
	Rate          sdk.Dec `json:"rate"`            // the commission rate charged to delegators, as a fraction
	MaxRate       sdk.Dec `json:"max_rate"`        // maximum commission rate which validator can ever charge, as a fraction
	MaxChangeRate sdk.Dec `json:"max_change_rate"` // maximum daily increase of the validator commission, as a fraction
}

CommissionMsg defines a commission message to be used for creating a validator.

func NewCommissionMsg added in v0.30.0 

func NewCommissionMsg(rate, maxRate, maxChangeRate sdk.Dec) CommissionMsg

NewCommissionMsg returns an initialized validator commission message.

type CrisisKeeper added in v0.34.0 

type CrisisKeeper interface {
	RegisterRoute(moduleName, route string, invar sdk.Invariant)
}

expected crisis keeper

type DVPair 

type DVPair struct {
	DelegatorAddress sdk.AccAddress
	ValidatorAddress sdk.ValAddress
}

DVPair is struct that just has a delegator-validator pair with no other data. It is intended to be used as a marshalable pointer. For example, a DVPair can be used to construct the key to getting an UnbondingDelegation from state.

type DVVTriplet 

type DVVTriplet struct {
	DelegatorAddress    sdk.AccAddress
	ValidatorSrcAddress sdk.ValAddress
	ValidatorDstAddress sdk.ValAddress
}

DVVTriplet is struct that just has a delegator-validator-validator triplet with no other data. It is intended to be used as a marshalable pointer. For example, a DVVTriplet can be used to construct the key to getting a Redelegation from state.

type Delegation 

type Delegation struct {
	DelegatorAddress sdk.AccAddress `json:"delegator_address"`
	ValidatorAddress sdk.ValAddress `json:"validator_address"`
	Shares           sdk.Dec        `json:"shares"`
}

Delegation represents the bond with tokens held by an account. It is owned by one delegator, and is associated with the voting power of one validator.

func MustUnmarshalDelegation 

func MustUnmarshalDelegation(cdc *codec.Codec, value []byte) Delegation

return the delegation

func NewDelegation 

func NewDelegation(delegatorAddr sdk.AccAddress, validatorAddr sdk.ValAddress,
	shares sdk.Dec) Delegation

NewDelegation creates a new delegation object

func UnmarshalDelegation 

func UnmarshalDelegation(cdc *codec.Codec, value []byte) (delegation Delegation, err error)

return the delegation

func (Delegation) Equal 

func (d Delegation) Equal(d2 Delegation) bool

nolint

func (Delegation) GetDelegatorAddr 

func (d Delegation) GetDelegatorAddr() sdk.AccAddress

nolint - for sdk.Delegation

func (Delegation) GetShares 

func (d Delegation) GetShares() sdk.Dec

func (Delegation) GetValidatorAddr 

func (d Delegation) GetValidatorAddr() sdk.ValAddress

func (Delegation) String 

func (d Delegation) String() string

String returns a human readable string representation of a Delegation.

type Delegations 

type Delegations []Delegation

Delegations is a collection of delegations

func (Delegations) String 

func (d Delegations) String() (out string)

type Description 

type Description struct {
	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
}

Description - description fields for a validator

func NewDescription 

func NewDescription(moniker, identity, website, details string) Description

NewDescription returns a new Description with the provided values.

func (Description) EnsureLength 

func (d Description) EnsureLength() (Description, sdk.Error)

EnsureLength ensures the length of a validator's description.

func (Description) UpdateDescription 

func (d Description) UpdateDescription(d2 Description) (Description, sdk.Error)

UpdateDescription updates the fields of a given description. An error is returned if the resulting description contains an invalid length.

type DistributionKeeper 

type DistributionKeeper interface {
	GetFeePoolCommunityCoins(ctx sdk.Context) sdk.DecCoins
	GetValidatorOutstandingRewardsCoins(ctx sdk.Context, val sdk.ValAddress) sdk.DecCoins
}

expected coin keeper

type FeeCollectionKeeper added in v0.32.0 

type FeeCollectionKeeper interface {
	GetCollectedFees(ctx sdk.Context) sdk.Coins
}

expected fee collection keeper

type GenesisState 

type GenesisState struct {
	Pool                 Pool                  `json:"pool"`
	Params               Params                `json:"params"`
	LastTotalPower       sdk.Int               `json:"last_total_power"`
	LastValidatorPowers  []LastValidatorPower  `json:"last_validator_powers"`
	Validators           Validators            `json:"validators"`
	Delegations          Delegations           `json:"delegations"`
	UnbondingDelegations []UnbondingDelegation `json:"unbonding_delegations"`
	Redelegations        []Redelegation        `json:"redelegations"`
	Exported             bool                  `json:"exported"`
}

GenesisState - all staking state that must be provided at genesis

func DefaultGenesisState 

func DefaultGenesisState() GenesisState

get raw genesis raw message for testing

func NewGenesisState 

func NewGenesisState(pool Pool, params Params, validators []Validator, delegations []Delegation) GenesisState

type LastValidatorPower 

type LastValidatorPower struct {
	Address sdk.ValAddress
	Power   int64
}

Last validator power, needed for validator set update logic

type MsgBeginRedelegate 

type MsgBeginRedelegate struct {
	DelegatorAddress    sdk.AccAddress `json:"delegator_address"`
	ValidatorSrcAddress sdk.ValAddress `json:"validator_src_address"`
	ValidatorDstAddress sdk.ValAddress `json:"validator_dst_address"`
	Amount              sdk.Coin       `json:"amount"`
}

MsgDelegate - struct for bonding transactions

func NewMsgBeginRedelegate 

func NewMsgBeginRedelegate(delAddr sdk.AccAddress, valSrcAddr,
	valDstAddr sdk.ValAddress, amount sdk.Coin) MsgBeginRedelegate

func (MsgBeginRedelegate) GetSignBytes 

func (msg MsgBeginRedelegate) GetSignBytes() []byte

get the bytes for the message signer to sign on

func (MsgBeginRedelegate) GetSigners 

func (msg MsgBeginRedelegate) GetSigners() []sdk.AccAddress

func (MsgBeginRedelegate) Route 

func (msg MsgBeginRedelegate) Route() string

nolint

func (MsgBeginRedelegate) Type 

func (msg MsgBeginRedelegate) Type() string

func (MsgBeginRedelegate) ValidateBasic 

func (msg MsgBeginRedelegate) ValidateBasic() sdk.Error

quick validity check

type MsgCreateValidator 

type MsgCreateValidator struct {
	Description       Description    `json:"description"`
	Commission        CommissionMsg  `json:"commission"`
	MinSelfDelegation sdk.Int        `json:"min_self_delegation"`
	DelegatorAddress  sdk.AccAddress `json:"delegator_address"`
	ValidatorAddress  sdk.ValAddress `json:"validator_address"`
	PubKey            crypto.PubKey  `json:"pubkey"`
	Value             sdk.Coin       `json:"value"`
}

MsgCreateValidator - struct for bonding transactions

func NewMsgCreateValidator 

func NewMsgCreateValidator(
	valAddr sdk.ValAddress, pubKey crypto.PubKey, selfDelegation sdk.Coin,
	description Description, commission CommissionMsg, minSelfDelegation sdk.Int,
) MsgCreateValidator

Default way to create validator. Delegator address and validator address are the same

func (MsgCreateValidator) GetSignBytes 

func (msg MsgCreateValidator) GetSignBytes() []byte

GetSignBytes returns the message bytes to sign over.

func (MsgCreateValidator) GetSigners 

func (msg MsgCreateValidator) GetSigners() []sdk.AccAddress

Return address(es) that must sign over msg.GetSignBytes()

func (MsgCreateValidator) MarshalJSON added in v0.30.0 

func (msg MsgCreateValidator) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface to provide custom JSON serialization of the MsgCreateValidator type.

func (MsgCreateValidator) Route 

func (msg MsgCreateValidator) Route() string

nolint

func (MsgCreateValidator) Type 

func (msg MsgCreateValidator) Type() string

func (*MsgCreateValidator) UnmarshalJSON added in v0.30.0 

func (msg *MsgCreateValidator) UnmarshalJSON(bz []byte) error

UnmarshalJSON implements the json.Unmarshaler interface to provide custom JSON deserialization of the MsgCreateValidator type.

func (MsgCreateValidator) ValidateBasic 

func (msg MsgCreateValidator) ValidateBasic() sdk.Error

quick validity check

type MsgDelegate 

type MsgDelegate struct {
	DelegatorAddress sdk.AccAddress `json:"delegator_address"`
	ValidatorAddress sdk.ValAddress `json:"validator_address"`
	Amount           sdk.Coin       `json:"amount"`
}

MsgDelegate - struct for bonding transactions

func NewMsgDelegate 

func NewMsgDelegate(delAddr sdk.AccAddress, valAddr sdk.ValAddress, amount sdk.Coin) MsgDelegate

func (MsgDelegate) GetSignBytes 

func (msg MsgDelegate) GetSignBytes() []byte

get the bytes for the message signer to sign on

func (MsgDelegate) GetSigners 

func (msg MsgDelegate) GetSigners() []sdk.AccAddress

func (MsgDelegate) Route 

func (msg MsgDelegate) Route() string

nolint

func (MsgDelegate) Type 

func (msg MsgDelegate) Type() string

func (MsgDelegate) ValidateBasic 

func (msg MsgDelegate) ValidateBasic() sdk.Error

quick validity check

type MsgEditValidator 

type MsgEditValidator struct {
	Description
	ValidatorAddress sdk.ValAddress `json:"address"`

	// We pass a reference to the new commission rate and min self delegation as it's not mandatory to
	// update. If not updated, the deserialized rate will be zero with no way to
	// distinguish if an update was intended.
	//
	// REF: #2373
	CommissionRate    *sdk.Dec `json:"commission_rate"`
	MinSelfDelegation *sdk.Int `json:"min_self_delegation"`
}

MsgEditValidator - struct for editing a validator

func NewMsgEditValidator 

func NewMsgEditValidator(valAddr sdk.ValAddress, description Description, newRate *sdk.Dec, newMinSelfDelegation *sdk.Int) MsgEditValidator

func (MsgEditValidator) GetSignBytes 

func (msg MsgEditValidator) GetSignBytes() []byte

get the bytes for the message signer to sign on

func (MsgEditValidator) GetSigners 

func (msg MsgEditValidator) GetSigners() []sdk.AccAddress

func (MsgEditValidator) Route 

func (msg MsgEditValidator) Route() string

nolint

func (MsgEditValidator) Type 

func (msg MsgEditValidator) Type() string

func (MsgEditValidator) ValidateBasic 

func (msg MsgEditValidator) ValidateBasic() sdk.Error

quick validity check

type MsgUndelegate 

type MsgUndelegate struct {
	DelegatorAddress sdk.AccAddress `json:"delegator_address"`
	ValidatorAddress sdk.ValAddress `json:"validator_address"`
	Amount           sdk.Coin       `json:"amount"`
}

MsgUndelegate - struct for unbonding transactions

func NewMsgUndelegate 

func NewMsgUndelegate(delAddr sdk.AccAddress, valAddr sdk.ValAddress, amount sdk.Coin) MsgUndelegate

func (MsgUndelegate) GetSignBytes 

func (msg MsgUndelegate) GetSignBytes() []byte

get the bytes for the message signer to sign on

func (MsgUndelegate) GetSigners 

func (msg MsgUndelegate) GetSigners() []sdk.AccAddress

func (MsgUndelegate) Route 

func (msg MsgUndelegate) Route() string

nolint

func (MsgUndelegate) Type 

func (msg MsgUndelegate) Type() string

func (MsgUndelegate) ValidateBasic 

func (msg MsgUndelegate) ValidateBasic() sdk.Error

quick validity check

type Params 

type Params struct {
	UnbondingTime time.Duration `json:"unbonding_time"` // time duration of unbonding
	MaxValidators uint16        `json:"max_validators"` // maximum number of validators (max uint16 = 65535)
	MaxEntries    uint16        `json:"max_entries"`    // max entries for either unbonding delegation or redelegation (per pair/trio)
	// note: we need to be a bit careful about potential overflow here, since this is user-determined
	BondDenom string `json:"bond_denom"` // bondable coin denomination
}

Params defines the high level settings for staking

func DefaultParams 

func DefaultParams() Params

DefaultParams returns a default set of parameters.

func MustUnmarshalParams 

func MustUnmarshalParams(cdc *codec.Codec, value []byte) Params

unmarshal the current staking params value from store key or panic

func NewParams 

func NewParams(unbondingTime time.Duration, maxValidators, maxEntries uint16,
	bondDenom string) Params

func UnmarshalParams 

func UnmarshalParams(cdc *codec.Codec, value []byte) (params Params, err error)

unmarshal the current staking params value from store key

func (Params) Equal 

func (p Params) Equal(p2 Params) bool

Equal returns a boolean determining if two Param types are identical. TODO: This is slower than comparing struct fields directly

func (*Params) ParamSetPairs 

func (p *Params) ParamSetPairs() params.ParamSetPairs

Implements params.ParamSet

func (Params) String 

func (p Params) String() string

String returns a human readable string representation of the parameters.

func (Params) Validate 

func (p Params) Validate() error

validate a set of params

type Pool 

type Pool struct {
	NotBondedTokens sdk.Int `json:"not_bonded_tokens"` // tokens which are not bonded to a validator (unbonded or unbonding)
	BondedTokens    sdk.Int `json:"bonded_tokens"`     // tokens which are currently bonded to a validator
}

Pool - tracking bonded and not-bonded token supply of the bond denomination

func InitialPool added in v0.30.0 

func InitialPool() Pool

initial pool for testing

func MustUnmarshalPool added in v0.30.0 

func MustUnmarshalPool(cdc *codec.Codec, value []byte) Pool

unmarshal the current pool value from store key or panics

func UnmarshalPool added in v0.30.0 

func UnmarshalPool(cdc *codec.Codec, value []byte) (pool Pool, err error)

unmarshal the current pool value from store key

func (Pool) BondedRatio added in v0.30.0 

func (p Pool) BondedRatio() sdk.Dec

Get the fraction of the staking token which is currently bonded

func (Pool) Equal added in v0.30.0 

func (p Pool) Equal(p2 Pool) bool

nolint TODO: This is slower than comparing struct fields directly

func (Pool) String 

func (p Pool) String() string

String returns a human readable string representation of a pool.

func (Pool) TokenSupply added in v0.30.0 

func (p Pool) TokenSupply() sdk.Int

Sum total of all staking tokens in the pool

type Redelegation 

type Redelegation struct {
	DelegatorAddress    sdk.AccAddress      `json:"delegator_address"`     // delegator
	ValidatorSrcAddress sdk.ValAddress      `json:"validator_src_address"` // validator redelegation source operator addr
	ValidatorDstAddress sdk.ValAddress      `json:"validator_dst_address"` // validator redelegation destination operator addr
	Entries             []RedelegationEntry `json:"entries"`               // redelegation entries
}

Redelegation contains the list of a particular delegator's redelegating bonds from a particular source validator to a particular destination validator

func MustUnmarshalRED 

func MustUnmarshalRED(cdc *codec.Codec, value []byte) Redelegation

unmarshal a redelegation from a store value

func NewRedelegation 

func NewRedelegation(delegatorAddr sdk.AccAddress, validatorSrcAddr,
	validatorDstAddr sdk.ValAddress, creationHeight int64,
	minTime time.Time, balance sdk.Int,
	sharesDst sdk.Dec) Redelegation

NewRedelegation - create a new redelegation object

func UnmarshalRED 

func UnmarshalRED(cdc *codec.Codec, value []byte) (red Redelegation, err error)

unmarshal a redelegation from a store value

func (*Redelegation) AddEntry 

func (d *Redelegation) AddEntry(creationHeight int64,
	minTime time.Time, balance sdk.Int,
	sharesDst sdk.Dec)

AddEntry - append entry to the unbonding delegation

func (Redelegation) Equal 

func (d Redelegation) Equal(d2 Redelegation) bool

nolint inefficient but only used in tests

func (*Redelegation) RemoveEntry 

func (d *Redelegation) RemoveEntry(i int64)

RemoveEntry - remove entry at index i to the unbonding delegation

func (Redelegation) String 

func (d Redelegation) String() string

String returns a human readable string representation of a Redelegation.

type RedelegationEntry 

type RedelegationEntry struct {
	CreationHeight int64     `json:"creation_height"` // height at which the redelegation took place
	CompletionTime time.Time `json:"completion_time"` // time at which the redelegation will complete
	InitialBalance sdk.Int   `json:"initial_balance"` // initial balance when redelegation started
	SharesDst      sdk.Dec   `json:"shares_dst"`      // amount of destination-validator shares created by redelegation
}

RedelegationEntry - entry to a Redelegation

func NewRedelegationEntry 

func NewRedelegationEntry(creationHeight int64,
	completionTime time.Time, balance sdk.Int,
	sharesDst sdk.Dec) RedelegationEntry

NewRedelegation - create a new redelegation object

func (RedelegationEntry) IsMature 

func (e RedelegationEntry) IsMature(currentTime time.Time) bool

IsMature - is the current entry mature

type Redelegations 

type Redelegations []Redelegation

Redelegations are a collection of Redelegation

func (Redelegations) String 

func (d Redelegations) String() (out string)

type UnbondingDelegation 

type UnbondingDelegation struct {
	DelegatorAddress sdk.AccAddress             `json:"delegator_address"` // delegator
	ValidatorAddress sdk.ValAddress             `json:"validator_address"` // validator unbonding from operator addr
	Entries          []UnbondingDelegationEntry `json:"entries"`           // unbonding delegation entries
}

UnbondingDelegation stores all of a single delegator's unbonding bonds for a single validator in an time-ordered list

func MustUnmarshalUBD 

func MustUnmarshalUBD(cdc *codec.Codec, value []byte) UnbondingDelegation

unmarshal a unbonding delegation from a store value

func NewUnbondingDelegation 

func NewUnbondingDelegation(delegatorAddr sdk.AccAddress,
	validatorAddr sdk.ValAddress, creationHeight int64, minTime time.Time,
	balance sdk.Int) UnbondingDelegation

NewUnbondingDelegation - create a new unbonding delegation object

func UnmarshalUBD 

func UnmarshalUBD(cdc *codec.Codec, value []byte) (ubd UnbondingDelegation, err error)

unmarshal a unbonding delegation from a store value

func (*UnbondingDelegation) AddEntry 

func (d *UnbondingDelegation) AddEntry(creationHeight int64,
	minTime time.Time, balance sdk.Int)

AddEntry - append entry to the unbonding delegation

func (UnbondingDelegation) Equal 

func (d UnbondingDelegation) Equal(d2 UnbondingDelegation) bool

nolint inefficient but only used in testing

func (*UnbondingDelegation) RemoveEntry 

func (d *UnbondingDelegation) RemoveEntry(i int64)

RemoveEntry - remove entry at index i to the unbonding delegation

func (UnbondingDelegation) String 

func (d UnbondingDelegation) String() string

String returns a human readable string representation of an UnbondingDelegation.

type UnbondingDelegationEntry 

type UnbondingDelegationEntry struct {
	CreationHeight int64     `json:"creation_height"` // height which the unbonding took place
	CompletionTime time.Time `json:"completion_time"` // time at which the unbonding delegation will complete
	InitialBalance sdk.Int   `json:"initial_balance"` // atoms initially scheduled to receive at completion
	Balance        sdk.Int   `json:"balance"`         // atoms to receive at completion
}

UnbondingDelegationEntry - entry to an UnbondingDelegation

func NewUnbondingDelegationEntry 

func NewUnbondingDelegationEntry(creationHeight int64, completionTime time.Time,
	balance sdk.Int) UnbondingDelegationEntry

NewUnbondingDelegation - create a new unbonding delegation object

func (UnbondingDelegationEntry) IsMature 

func (e UnbondingDelegationEntry) IsMature(currentTime time.Time) bool

IsMature - is the current entry mature

type UnbondingDelegations 

type UnbondingDelegations []UnbondingDelegation

UnbondingDelegations is a collection of UnbondingDelegation

func (UnbondingDelegations) String 

func (ubds UnbondingDelegations) String() (out string)

type Validator 

type Validator struct {
	OperatorAddress         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
	Jailed                  bool           `json:"jailed"`              // has the validator been jailed from bonded status?
	Status                  sdk.BondStatus `json:"status"`              // validator status (bonded/unbonding/unbonded)
	Tokens                  sdk.Int        `json:"tokens"`              // delegated tokens (incl. self-delegation)
	DelegatorShares         sdk.Dec        `json:"delegator_shares"`    // total shares issued to a validator's delegators
	Description             Description    `json:"description"`         // description terms for the validator
	UnbondingHeight         int64          `json:"unbonding_height"`    // if unbonding, height at which this validator has begun unbonding
	UnbondingCompletionTime time.Time      `json:"unbonding_time"`      // if unbonding, min time for the validator to complete unbonding
	Commission              Commission     `json:"commission"`          // commission parameters
	MinSelfDelegation       sdk.Int        `json:"min_self_delegation"` // validator's self declared minimum self delegation
}

Validator defines the total amount of bond shares and their exchange rate to coins. Slashing results in a decrease in the exchange rate, allowing correct calculation of future undelegations without iterating over delegators. When coins are delegated to this validator, the validator is credited with a delegation whose number of bond shares is based on the amount of coins delegated divided by the current exchange rate. Voting power can be calculated as total bonded shares multiplied by exchange rate.

func MustUnmarshalValidator 

func MustUnmarshalValidator(cdc *codec.Codec, value []byte) Validator

unmarshal a redelegation from a store value

func NewValidator 

func NewValidator(operator sdk.ValAddress, pubKey crypto.PubKey, description Description) Validator

NewValidator - initialize a new validator

func UnmarshalValidator 

func UnmarshalValidator(cdc *codec.Codec, value []byte) (validator Validator, err error)

unmarshal a redelegation from a store value

func (Validator) ABCIValidatorUpdate 

func (v Validator) ABCIValidatorUpdate() abci.ValidatorUpdate

ABCIValidatorUpdate returns an abci.ValidatorUpdate from a staking validator type with the full validator power

func (Validator) ABCIValidatorUpdateZero 

func (v Validator) ABCIValidatorUpdateZero() abci.ValidatorUpdate

ABCIValidatorUpdateZero returns an abci.ValidatorUpdate from a staking validator type with zero power used for validator updates.

func (Validator) AddTokensFromDel 

func (v Validator) AddTokensFromDel(pool Pool, amount sdk.Int) (Validator, Pool, sdk.Dec)

AddTokensFromDel adds tokens to a validator CONTRACT: Tokens are assumed to have come from not-bonded pool.

func (Validator) BondedTokens 

func (v Validator) BondedTokens() sdk.Int

get the bonded tokens which the validator holds

func (Validator) ConsAddress added in v0.30.0 

func (v Validator) ConsAddress() sdk.ConsAddress

return the TM validator address

func (Validator) GetBondedTokens 

func (v Validator) GetBondedTokens() sdk.Int

func (Validator) GetCommission 

func (v Validator) GetCommission() sdk.Dec

func (Validator) GetConsAddr 

func (v Validator) GetConsAddr() sdk.ConsAddress

func (Validator) GetConsPubKey 

func (v Validator) GetConsPubKey() crypto.PubKey

func (Validator) GetDelegatorShares 

func (v Validator) GetDelegatorShares() sdk.Dec

func (Validator) GetMinSelfDelegation 

func (v Validator) GetMinSelfDelegation() sdk.Int

func (Validator) GetMoniker 

func (v Validator) GetMoniker() string

func (Validator) GetOperator 

func (v Validator) GetOperator() sdk.ValAddress

func (Validator) GetStatus 

func (v Validator) GetStatus() sdk.BondStatus

func (Validator) GetTendermintPower added in v0.31.0 

func (v Validator) GetTendermintPower() int64

func (Validator) GetTokens 

func (v Validator) GetTokens() sdk.Int

func (Validator) InvalidExRate 

func (v Validator) InvalidExRate() bool

In some situations, the exchange rate becomes invalid, e.g. if Validator loses all tokens due to slashing. In this case, make all future delegations invalid.

func (Validator) IsJailed 

func (v Validator) IsJailed() bool

nolint - for sdk.Validator

func (Validator) MarshalJSON added in v0.30.0 

func (v Validator) MarshalJSON() ([]byte, error)

MarshalJSON marshals the validator to JSON using Bech32

func (Validator) PotentialTendermintPower added in v0.31.0 

func (v Validator) PotentialTendermintPower() int64

potential Tendermint power

func (Validator) RemoveDelShares 

func (v Validator) RemoveDelShares(pool Pool, delShares sdk.Dec) (Validator, Pool, sdk.Int)

RemoveDelShares removes delegator shares from a validator. NOTE: because token fractions are left in the valiadator, 

the exchange rate of future shares of this validator can increase.

CONTRACT: Tokens are assumed to move to the not-bonded pool.

func (Validator) RemoveTokens 

func (v Validator) RemoveTokens(pool Pool, tokens sdk.Int) (Validator, Pool)

removes tokens from a validator

func (Validator) SetInitialCommission 

func (v Validator) SetInitialCommission(commission Commission) (Validator, sdk.Error)

SetInitialCommission attempts to set a validator's initial commission. An error is returned if the commission is invalid.

func (Validator) SharesFromTokens 

func (v Validator) SharesFromTokens(amt sdk.Int) (sdk.Dec, sdk.Error)

SharesFromTokens returns the shares of a delegation given a bond amount. It returns an error if the validator has no tokens.

func (Validator) SharesFromTokensTruncated 

func (v Validator) SharesFromTokensTruncated(amt sdk.Int) (sdk.Dec, sdk.Error)

SharesFromTokensTruncated returns the truncated shares of a delegation given a bond amount. It returns an error if the validator has no tokens.

func (Validator) String 

func (v Validator) String() string

String returns a human readable string representation of a validator.

func (Validator) TendermintPower added in v0.31.0 

func (v Validator) TendermintPower() int64

get the Tendermint Power a reduction of 10^6 from validator tokens is applied

func (Validator) TestEquivalent added in v0.31.0 

func (v Validator) TestEquivalent(v2 Validator) bool

only the vitals

func (Validator) TokensFromShares 

func (v Validator) TokensFromShares(shares sdk.Dec) sdk.Dec

calculate the token worth of provided shares

func (Validator) TokensFromSharesRoundUp 

func (v Validator) TokensFromSharesRoundUp(shares sdk.Dec) sdk.Dec

TokensFromSharesRoundUp returns the token worth of provided shares, rounded up.

func (Validator) TokensFromSharesTruncated 

func (v Validator) TokensFromSharesTruncated(shares sdk.Dec) sdk.Dec

calculate the token worth of provided shares, truncated

func (*Validator) UnmarshalJSON added in v0.30.0 

func (v *Validator) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshals the validator from JSON using Bech32

func (Validator) UpdateStatus 

func (v Validator) UpdateStatus(pool Pool, NewStatus sdk.BondStatus) (Validator, Pool)

UpdateStatus updates the location of the shares within a validator to reflect the new status

type Validators 

type Validators []Validator

Validators is a collection of Validator

func (Validators) String 

func (v Validators) String() (out string)

func (Validators) ToSDKValidators 

func (v Validators) ToSDKValidators() (validators []sdk.Validator)

ToSDKValidators - convenience function convert []Validators to []sdk.Validators

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.