# Functions
AddressFromLastValidatorPowerKey creates the validator operator address from LastValidatorPowerKey.
AddressFromValidatorsKey creates the validator operator address from ValidatorsKey.
DefaultGenesisState gets the raw genesis raw message for testing.
DefaultParams returns a default set of parameters.
DefaultParams returns a default set of parameters.
GetDelegationKey creates the key for delegator bond with validator VALUE: staking/Delegation.
GetDelegationsByValKey creates the key for delegations by validator address VALUE: staking/Delegation.
GetDelegationsByValPrefixKey builds a prefix key bytes with the given validator address bytes.
GetDelegationsKey creates the prefix for a delegator for all validators.
GetGenesisStateFromAppState returns x/staking GenesisState given raw application genesis state.
GetHistoricalInfoKey returns a key prefix for indexing HistoricalInfo objects.
GetLastValidatorPowerKey creates the bonded validator index key for an operator address.
GetREDByValDstIndexKey creates the index-key for a redelegation, stored by destination-validator-index VALUE: none (key rearrangement used).
GetREDByValSrcIndexKey creates the index-key for a redelegation, stored by source-validator-index VALUE: none (key rearrangement used).
GetRedelegationTimeKey returns a key prefix for indexing an unbonding redelegation based on a completion time.
GetREDKey returns a key prefix for indexing a redelegation from a delegator and source validator to a destination validator.
GetREDKeyFromValDstIndexKey rearranges the ValDstIndexKey to get the REDKey.
GetREDKeyFromValSrcIndexKey rearranges the ValSrcIndexKey to get the REDKey.
GetREDsByDelToValDstIndexKey returns a key prefix for indexing a redelegation from an address to a source validator.
GetREDsFromValSrcIndexKey returns a key prefix for indexing a redelegation to a source validator.
GetREDsKey returns a key prefix for indexing a redelegation from a delegator address.
GetREDsToValDstIndexKey returns a key prefix for indexing a redelegation to a destination (target) validator.
GetUBDByValIndexKey creates the index-key for an unbonding delegation, stored by validator-index VALUE: none (key rearrangement used).
GetUBDKey creates the key for an unbonding delegation by delegator and validator addr VALUE: staking/UnbondingDelegation.
GetUBDKeyFromValIndexKey rearranges the ValIndexKey to get the UBDKey.
GetUBDsByValIndexKey creates the prefix keyspace for the indexes of unbonding delegations for a validator.
GetUBDsKey creates the prefix for all unbonding delegations from a delegator.
GetUnbondingDelegationTimeKey creates the prefix for all unbonding delegations from a delegator.
GetUnbondingIndexKey returns a key for the index for looking up UnbondingDelegations by the UnbondingDelegationEntries they contain.
GetUnbondingTypeKey returns a key for an index containing the type of unbonding operations.
GetValidatorByConsAddrKey creates the key for the validator with pubkey VALUE: validator operator address ([]byte).
GetValidatorKey creates the key for the validator with address VALUE: staking/Validator.
GetValidatorQueueKey returns the prefix key used for getting a set of unbonding validators whose unbonding completion occurs at the given time and height.
GetValidatorsByPowerIndexKey creates the validator by power index.
MustMarshalDelegation returns the delegation bytes.
MustMarshalRED returns the Redelegation bytes.
return the unbonding delegation.
return the unbonding delegation entry.
return the redelegation.
MustUnmarshalDelegation return the unmarshaled delegation from bytes.
MustUnmarshalHistoricalInfo wll unmarshal historical info and panic on error.
unmarshal the current staking params value from store key or panic.
MustUnmarshalRED unmarshals a redelegation from a store value.
unmarshal a unbonding delegation from a store value.
unmarshal a unbonding delegation entry from a store value.
unmarshal a redelegation from a store value.
NewCommission returns an initialized validator commission.
NewCommissionRates returns an initialized validator commission rates.
NewCommissionWithTime returns an initialized validator commission with a specified update time which should be the current block BFT time.
NewDelegation creates a new delegation object.
NewDelegationResp creates a new DelegationResponse instance.
No description provided by the author
NewGenesisState creates a new GenesisState instanc e.
NewHistoricalInfo will create a historical information struct from header and valset it will first sort valset before inclusion into historical info.
NewParams creates a new Params instance.
NewMsgBeginRedelegate creates a new MsgBeginRedelegate instance.
NewMsgCancelUnbondingDelegation creates a new MsgCancelUnbondingDelegation instance.
No description provided by the author
NewMsgCreateValidator creates a new MsgCreateValidator instance.
NewMsgDelegate creates a new MsgDelegate instance.
NewMsgEditValidator creates a new MsgEditValidator instance.
NewMsgUndelegate creates a new MsgUndelegate instance.
No description provided by the author
NewParams creates a new Params instance.
NewPool creates a new Pool instance used for queries.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewRedelegationEntryResponse creates a new RedelegationEntryResponse instance.
NewRedelegationResponse crates a new RedelegationEntryResponse instance.
NewStakeAuthorization creates a new StakeAuthorization object.
NewUnbondingDelegation - create a new unbonding delegation object.
No description provided by the author
NewValidator constructs a new Validator.
Deprecated: now params can be accessed on key `0x51` on the staking store.
ParseDelegationsByValKey parses given key and returns validator, delegator address bytes.
ParseValidatorPowerRankKey parses the validators operator address from power rank key.
ParseValidatorQueueKey returns the encoded time and height from a key created from GetValidatorQueueKey.
RegisterInterfaces registers the x/staking interfaces types with the interface registry.
RegisterLegacyAminoCodec registers the necessary x/staking interfaces and concrete types on the provided LegacyAmino codec.
No description provided by the author
RegisterQueryHandler registers the http handlers for service Query to "mux".
RegisterQueryHandlerClient registers the http handlers for service Query to "mux".
RegisterQueryHandlerFromEndpoint is same as RegisterQueryHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterQueryHandlerServer registers the http handlers for service Query to "mux".
No description provided by the author
No description provided by the author
return the delegation.
UnmarshalHistoricalInfo will unmarshal historical info and return any error.
unmarshal the current staking params value from store key.
UnmarshalRED unmarshals a redelegation from a store value.
unmarshal a unbonding delegation from a store value.
unmarshal a unbonding delegation entry from a store value.
unmarshal a redelegation from a store value.
ValidateBasic will ensure HistoricalInfo is not nil and sorted.
No description provided by the author
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
staking module event types.
staking module event types.
staking module event types.
staking module event types.
staking module event types.
staking module event types.
staking module event types.
staking module event types.
staking module event types.
AUTHORIZATION_TYPE_CANCEL_UNBONDING_DELEGATION defines an authorization type for Msg/MsgCancelUnbondingDelegation.
AUTHORIZATION_TYPE_DELEGATE defines an authorization type for Msg/Delegate.
AUTHORIZATION_TYPE_REDELEGATE defines an authorization type for Msg/BeginRedelegate.
AUTHORIZATION_TYPE_UNDELEGATE defines an authorization type for Msg/Undelegate.
AUTHORIZATION_TYPE_UNSPECIFIED specifies an unknown authorization type.
BONDED defines a validator that is bonded.
names used as root for pool module accounts:
- NotBondedPool -> "not_bonded_tokens_pool"
- BondedPool -> "bonded_tokens_pool".
DefaultHistorical entries is 10000.
Default maximum entries in a UBD/RED pair.
Default maximum number of bonded validators.
DefaultUnbondingTime reflects three weeks in seconds as the default unbonding time.
constant used in flags to indicate that description field should not be updated.
staking module event types.
staking module event types.
staking module event types.
staking module event types.
staking module event types.
staking module event types.
staking module event types.
staking module event types.
DOUBLE_SIGN defines a validator that double-signs a block.
DOWNTIME defines a validator that missed signing too many blocks.
UNSPECIFIED defines an empty infraction.
No description provided by the author
No description provided by the author
TODO: Why can't we just have one string description which can be JSON by convention.
No description provided by the author
No description provided by the author
ModuleName is the name of the staking module.
names used as root for pool module accounts:
- NotBondedPool -> "not_bonded_tokens_pool"
- BondedPool -> "bonded_tokens_pool".
query endpoints supported by the staking Querier.
query endpoints supported by the staking Querier.
query endpoints supported by the staking Querier.
query endpoints supported by the staking Querier.
query endpoints supported by the staking Querier.
query endpoints supported by the staking Querier.
query endpoints supported by the staking Querier.
query endpoints supported by the staking Querier.
query endpoints supported by the staking Querier.
query endpoints supported by the staking Querier.
query endpoints supported by the staking Querier.
query endpoints supported by the staking Querier.
query endpoints supported by the staking Querier.
query endpoints supported by the staking Querier.
query endpoints supported by the staking Querier.
RouterKey is the msg router key for the staking module.
StoreKey is the string store representation.
UNBONDED defines a validator that is not bonded.
UNBONDING defines a validator that is unbonding.
nolint:revive // we want these underscores, they make life easier.
nolint:revive // we want these underscores, they make life easier.
nolint:revive // we want these underscores, they make life easier.
nolint:revive // we want these underscores, they make life easier.
UNSPECIFIED defines an invalid validator status.
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
0.03 == 3% APR.
seconds.
No description provided by the author
DefaultMinCommissionRate is set to 0%.
No description provided by the author
key for delegations by a validator.
key for a delegation.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
x/staking module sentinel errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
x/staking module sentinel errors.
No description provided by the author
No description provided by the author
prefix for the historical info.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
prefix for the total power.
No description provided by the author
No description provided by the author
prefix for each key to a validator index, for bonded validators.
No description provided by the author
prefix for parameters for module x/staking.
No description provided by the author
prefix for each key for an redelegation, by destination validator operator.
prefix for each key for an redelegation, by source validator operator.
key for a redelegation.
prefix for the timestamps in redelegations queue.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
prefix for each key for an unbonding-delegation, by validator operator.
key for an unbonding-delegation.
key for the counter for the incrementing id for UnbondingOperations.
prefix for an index for looking up unbonding operations by their IDs.
prefix for the timestamps in unbonding queue.
prefix for an index containing the type of unbonding operations.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
prefix for the timestamps in validator queue.
prefix for each key to a validator index, by pubkey.
prefix for each key to a validator index, sorted by power.
prefix for each key to a validator.
prefix for the end block validator updates key.
# Structs
AssetData is a struct that contains the price in USD + decimals of precision of an asset.
AssetKey represents a collections.KeyCodec for Asset enum.
Commission defines commission parameters for a given validator.
CommissionRates defines the initial commission rates to be used for creating a validator.
Delegation represents the bond with tokens held by an account.
DelegationResponse is equivalent to Delegation except that it contains a balance in addition to shares which is more suitable for client responses.
Description defines a validator description.
DVPair is struct that just has a delegator-validator pair with no other data.
DVPairs defines an array of DVPair objects.
DVVTriplet is struct that just has a delegator-validator-validator triplet with no other data.
DVVTriplets defines an array of DVVTriplet objects.
GenesisState defines the staking module's genesis state.
HistoricalInfo contains header and validator information for a given block.
No description provided by the author
LastValidatorPower required for validator set update logic.
MsgBeginRedelegate defines a SDK message for performing a redelegation of coins from a delegator and source validator to a destination validator.
MsgBeginRedelegateResponse defines the Msg/BeginRedelegate response type.
MsgCancelUnbondingDelegation defines the SDK message for performing a cancel unbonding delegation for delegator
Since: cosmos-sdk 0.46.
MsgCancelUnbondingDelegationResponse
Since: cosmos-sdk 0.46.
MsgCreateValidator defines a SDK message for creating a new validator.
MsgCreateValidatorResponse defines the Msg/CreateValidator response type.
MsgDelegate defines a SDK message for performing a delegation of coins from a delegator to a validator.
MsgDelegateResponse defines the Msg/Delegate response type.
MsgEditValidator defines a SDK message for editing an existing validator.
MsgEditValidatorResponse defines the Msg/EditValidator response type.
MsgUndelegate defines a SDK message for performing an undelegation from a delegate and a validator.
MsgUndelegateResponse defines the Msg/Undelegate response type.
No description provided by the author
No description provided by the author
MsgUpdateParams is the Msg/UpdateParams request type.
MsgUpdateParamsResponse defines the response structure for executing a MsgUpdateParams message.
Params defines the parameters for the x/staking module.
Pool is used for tracking bonded and not-bonded token supply of the bond denomination.
QueryDelegationRequest is request type for the Query/Delegation RPC method.
QueryDelegationResponse is response type for the Query/Delegation RPC method.
QueryDelegatorDelegationsRequest is request type for the Query/DelegatorDelegations RPC method.
QueryDelegatorDelegationsResponse is response type for the Query/DelegatorDelegations RPC method.
defines the params for the following queries: - 'custom/staking/delegatorDelegations' - 'custom/staking/delegatorUnbondingDelegations' - 'custom/staking/delegatorValidators'.
QueryDelegatorUnbondingDelegationsRequest is request type for the Query/DelegatorUnbondingDelegations RPC method.
QueryUnbondingDelegatorDelegationsResponse is response type for the Query/UnbondingDelegatorDelegations RPC method.
QueryDelegatorValidatorRequest is request type for the Query/DelegatorValidator RPC method.
QueryDelegatorValidatorResponse response type for the Query/DelegatorValidator RPC method.
QueryDelegatorValidatorsRequest is request type for the Query/DelegatorValidators RPC method.
QueryDelegatorValidatorsResponse is response type for the Query/DelegatorValidators RPC method.
QueryHistoricalInfoRequest is request type for the Query/HistoricalInfo RPC method.
QueryHistoricalInfoResponse is response type for the Query/HistoricalInfo RPC method.
QueryParamsRequest is request type for the Query/Params RPC method.
QueryParamsResponse is response type for the Query/Params RPC method.
QueryPoolRequest is request type for the Query/Pool RPC method.
QueryPoolResponse is response type for the Query/Pool RPC method.
No description provided by the author
No description provided by the author
defines the params for the following queries: - 'custom/staking/redelegation'.
QueryRedelegationsRequest is request type for the Query/Redelegations RPC method.
QueryRedelegationsResponse is response type for the Query/Redelegations RPC method.
QueryUnbondingDelegationRequest is request type for the Query/UnbondingDelegation RPC method.
QueryDelegationResponse is response type for the Query/UnbondingDelegation RPC method.
QueryValidatorDelegationsRequest is request type for the Query/ValidatorDelegations RPC method.
QueryValidatorDelegationsResponse is response type for the Query/ValidatorDelegations RPC method.
defines the params for the following queries: - 'custom/staking/validator' - 'custom/staking/validatorDelegations' - 'custom/staking/validatorUnbondingDelegations'.
QueryValidatorRequest is response type for the Query/Validator RPC method.
QueryValidatorResponse is response type for the Query/Validator RPC method.
QueryValidatorsParams defines the params for the following queries: - 'custom/staking/validators'.
QueryValidatorsRequest is request type for Query/Validators RPC method.
QueryValidatorsResponse is response type for the Query/Validators RPC method.
QueryValidatorUnbondingDelegationsRequest is required type for the Query/ValidatorUnbondingDelegations RPC method.
QueryValidatorUnbondingDelegationsResponse is response type for the Query/ValidatorUnbondingDelegations RPC method.
Redelegation contains the list of a particular delegator's redelegating bonds from a particular source validator to a particular destination validator.
RedelegationEntry defines a redelegation object with relevant metadata.
RedelegationEntryResponse is equivalent to a RedelegationEntry except that it contains a balance in addition to shares which is more suitable for client responses.
RedelegationResponse is equivalent to a Redelegation except that its entries contain a balance in addition to shares which is more suitable for client responses.
No description provided by the author
StakeAuthorization defines authorization for delegate/undelegate/redelegate.
No description provided by the author
No description provided by the author
Validators defines list of validator addresses.
StakingHooksWrapper is a wrapper for modules to inject StakingHooks using depinject.
UnbondingDelegation stores all of a single delegator's unbonding bonds for a single validator in an time-ordered list.
UnbondingDelegationEntry defines an unbonding object with relevant metadata.
UnimplementedMsgServer can be embedded to have forward compatible implementations.
UnimplementedQueryServer can be embedded to have forward compatible implementations.
ValAddresses defines a repeated set of validator addresses.
No description provided by the author
Validator defines a validator, together with the total amount of the Validator's bond shares and their exchange rate to coins.
No description provided by the author
Validators is a collection of Validator.
ValidatorUpdates defines an array of abci.ValidatorUpdate objects.
# Interfaces
AccountKeeper defines the expected account keeper (noalias).
BankKeeper defines the expected interface needed to retrieve account balances.
DelegationI delegation bond for a delegated proof of stake system.
DelegationSet expected properties for the set of all delegations for a particular (noalias).
MsgClient is the client API for Msg service.
MsgServer is the server API for Msg service.
QueryClient is the client API for Query service.
QueryServer is the server API for Query service.
StakingHooks event hooks for staking validator object (noalias).
ValidatorI expected validator functions.
ValidatorSet expected properties for the set of all validators (noalias).
# Type aliases
Asset is an enum that represents the assets we store pricing for.
AuthorizationType defines the type of staking module authorization type
Since: cosmos-sdk 0.43.
BondStatus is the status of a validator.
DelegationResponses is a collection of DelegationResp.
Delegations is a collection of delegations.
Infraction indicates the infraction a validator commited.
No description provided by the author
RedelegationResponses are a collection of RedelegationResp.
Redelegations are a collection of Redelegation.
UnbondingDelegations is a collection of UnbondingDelegation.
UnbondingType defines the type of unbonding operation.
ValidatorsByVotingPower implements sort.Interface for []Validator based on the VotingPower and Address fields.