Module staking
Expand description
Proof-of-Stake layer for public blockchains.
Modules§
- msg_
client - Generated client implementations.
- msg_
server - Generated server implementations.
- query_
client - Generated client implementations.
- query_
server - Generated server implementations.
- stake_
authorization - Nested message and enum types in
StakeAuthorization.
Structs§
- Commission
- Commission defines commission parameters for a given validator.
- Commission
Rates - CommissionRates defines the initial commission rates to be used for creating a validator.
- Delegation
- 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.
- Delegation
Response - DelegationResponse is equivalent to Delegation except that it contains a balance in addition to shares which is more suitable for client responses.
- Description
- Description defines a validator description.
- DvPair
- 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.
- DvPairs
- DVPairs defines an array of DVPair objects.
- DvvTriplet
- 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.
- DvvTriplets
- DVVTriplets defines an array of DVVTriplet objects.
- Genesis
State - GenesisState defines the staking module’s genesis state.
- Historical
Info - HistoricalInfo contains header and validator information for a given block.
It is stored as part of staking module’s state, which persists the
nmost recent HistoricalInfo (nis set by the staking module’shistorical_entriesparameter). - Last
Validator Power - LastValidatorPower required for validator set update logic.
- MsgBegin
Redelegate - MsgBeginRedelegate defines a SDK message for performing a redelegation of coins from a delegator and source validator to a destination validator.
- MsgBegin
Redelegate Response - MsgBeginRedelegateResponse defines the Msg/BeginRedelegate response type.
- MsgCancel
Unbonding Delegation - MsgCancelUnbondingDelegation defines the SDK message for performing a cancel unbonding delegation for delegator
- MsgCancel
Unbonding Delegation Response - MsgCancelUnbondingDelegationResponse
- MsgCreate
Validator - MsgCreateValidator defines a SDK message for creating a new validator.
- MsgCreate
Validator Response - MsgCreateValidatorResponse defines the Msg/CreateValidator response type.
- MsgDelegate
- MsgDelegate defines a SDK message for performing a delegation of coins from a delegator to a validator.
- MsgDelegate
Response - MsgDelegateResponse defines the Msg/Delegate response type.
- MsgEdit
Validator - MsgEditValidator defines a SDK message for editing an existing validator.
- MsgEdit
Validator Response - MsgEditValidatorResponse defines the Msg/EditValidator response type.
- MsgUndelegate
- MsgUndelegate defines a SDK message for performing an undelegation from a delegate and a validator.
- MsgUndelegate
Response - MsgUndelegateResponse defines the Msg/Undelegate response type.
- MsgUpdate
Params - MsgUpdateParams is the Msg/UpdateParams request type.
- MsgUpdate
Params Response - MsgUpdateParamsResponse defines the response structure for executing a MsgUpdateParams message.
- Params
- Params defines the parameters for the x/staking module.
- Pool
- Pool is used for tracking bonded and not-bonded token supply of the bond denomination.
- Query
Delegation Request - QueryDelegationRequest is request type for the Query/Delegation RPC method.
- Query
Delegation Response - QueryDelegationResponse is response type for the Query/Delegation RPC method.
- Query
Delegator Delegations Request - QueryDelegatorDelegationsRequest is request type for the Query/DelegatorDelegations RPC method.
- Query
Delegator Delegations Response - QueryDelegatorDelegationsResponse is response type for the Query/DelegatorDelegations RPC method.
- Query
Delegator Unbonding Delegations Request - QueryDelegatorUnbondingDelegationsRequest is request type for the Query/DelegatorUnbondingDelegations RPC method.
- Query
Delegator Unbonding Delegations Response - QueryUnbondingDelegatorDelegationsResponse is response type for the Query/UnbondingDelegatorDelegations RPC method.
- Query
Delegator Validator Request - QueryDelegatorValidatorRequest is request type for the Query/DelegatorValidator RPC method.
- Query
Delegator Validator Response - QueryDelegatorValidatorResponse response type for the Query/DelegatorValidator RPC method.
- Query
Delegator Validators Request - QueryDelegatorValidatorsRequest is request type for the Query/DelegatorValidators RPC method.
- Query
Delegator Validators Response - QueryDelegatorValidatorsResponse is response type for the Query/DelegatorValidators RPC method.
- Query
Historical Info Request - QueryHistoricalInfoRequest is request type for the Query/HistoricalInfo RPC method.
- Query
Historical Info Response - QueryHistoricalInfoResponse is response type for the Query/HistoricalInfo RPC method.
- Query
Params Request - QueryParamsRequest is request type for the Query/Params RPC method.
- Query
Params Response - QueryParamsResponse is response type for the Query/Params RPC method.
- Query
Pool Request - QueryPoolRequest is request type for the Query/Pool RPC method.
- Query
Pool Response - QueryPoolResponse is response type for the Query/Pool RPC method.
- Query
Redelegations Request - QueryRedelegationsRequest is request type for the Query/Redelegations RPC method.
- Query
Redelegations Response - QueryRedelegationsResponse is response type for the Query/Redelegations RPC method.
- Query
Unbonding Delegation Request - QueryUnbondingDelegationRequest is request type for the Query/UnbondingDelegation RPC method.
- Query
Unbonding Delegation Response - QueryDelegationResponse is response type for the Query/UnbondingDelegation RPC method.
- Query
Validator Delegations Request - QueryValidatorDelegationsRequest is request type for the Query/ValidatorDelegations RPC method
- Query
Validator Delegations Response - QueryValidatorDelegationsResponse is response type for the Query/ValidatorDelegations RPC method
- Query
Validator Request - QueryValidatorRequest is response type for the Query/Validator RPC method
- Query
Validator Response - QueryValidatorResponse is response type for the Query/Validator RPC method
- Query
Validator Unbonding Delegations Request - QueryValidatorUnbondingDelegationsRequest is required type for the Query/ValidatorUnbondingDelegations RPC method
- Query
Validator Unbonding Delegations Response - QueryValidatorUnbondingDelegationsResponse is response type for the Query/ValidatorUnbondingDelegations RPC method.
- Query
Validators Request - QueryValidatorsRequest is request type for Query/Validators RPC method.
- Query
Validators Response - QueryValidatorsResponse is response type for the Query/Validators RPC method
- Redelegation
- Redelegation contains the list of a particular delegator’s redelegating bonds from a particular source validator to a particular destination validator.
- Redelegation
Entry - RedelegationEntry defines a redelegation object with relevant metadata.
- Redelegation
Entry Response - RedelegationEntryResponse is equivalent to a RedelegationEntry except that it contains a balance in addition to shares which is more suitable for client responses.
- Redelegation
Response - RedelegationResponse is equivalent to a Redelegation except that its entries contain a balance in addition to shares which is more suitable for client responses.
- Stake
Authorization - StakeAuthorization defines authorization for delegate/undelegate/redelegate.
- Unbonding
Delegation - UnbondingDelegation stores all of a single delegator’s unbonding bonds for a single validator in an time-ordered list.
- Unbonding
Delegation Entry - UnbondingDelegationEntry defines an unbonding object with relevant metadata.
- ValAddresses
- ValAddresses defines a repeated set of validator addresses.
- Validator
- Validator defines a validator, together with the total amount of the Validator’s 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.
- Validator
Updates - ValidatorUpdates defines an array of abci.ValidatorUpdate objects. TODO: explore moving this to proto/cosmos/base to separate modules from tendermint dependence
Enums§
- Authorization
Type - AuthorizationType defines the type of staking module authorization type
- Bond
Status - BondStatus is the status of a validator.
- Infraction
- Infraction indicates the infraction a validator commited.