docs: fix toc links (#13770)
This commit is contained in:
+108
-114
@@ -57,33 +57,33 @@ network.
|
||||
* [gRPC](#grpc)
|
||||
* [REST](#rest)
|
||||
|
||||
# State
|
||||
## State
|
||||
|
||||
## Pool
|
||||
### Pool
|
||||
|
||||
Pool is used for tracking bonded and not-bonded token supply of the bond denomination.
|
||||
|
||||
## LastTotalPower
|
||||
### LastTotalPower
|
||||
|
||||
LastTotalPower tracks the total amounts of bonded tokens recorded during the previous end block.
|
||||
Store entries prefixed with "Last" must remain unchanged until EndBlock.
|
||||
|
||||
* LastTotalPower: `0x12 -> ProtocolBuffer(math.Int)`
|
||||
|
||||
## ValidatorUpdates
|
||||
### ValidatorUpdates
|
||||
|
||||
ValidatorUpdates contains the validator updates returned to ABCI at the end of every block.
|
||||
The values are overwritten in every block.
|
||||
|
||||
* ValidatorUpdates `0x61 -> []abci.ValidatorUpdate`
|
||||
|
||||
## UnbondingID
|
||||
### UnbondingID
|
||||
|
||||
UnbondingID stores the ID of the latest unbonding operation. It enables to create unique IDs for unbonding operation, i.e., UnbondingID is incremented every time a new unbonding operation (validator unbonding, unbonding delegation, redelegation) is initiated.
|
||||
|
||||
* UnbondingID: `0x37 -> uint64`
|
||||
|
||||
## Params
|
||||
### Params
|
||||
|
||||
The staking module stores its params in state with the prefix of `0x51`,
|
||||
it can be updated with governance or the address with authority.
|
||||
@@ -94,7 +94,7 @@ it can be updated with governance or the address with authority.
|
||||
https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/proto/cosmos/staking/v1beta1/staking.proto#L285-L306
|
||||
```
|
||||
|
||||
## Validator
|
||||
### Validator
|
||||
|
||||
Validators can have one of three statuses
|
||||
|
||||
@@ -157,7 +157,7 @@ https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/proto/cosmos/staking/v1beta1/s
|
||||
https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/proto/cosmos/staking/v1beta1/staking.proto#L24-L76
|
||||
```
|
||||
|
||||
## Delegation
|
||||
### Delegation
|
||||
|
||||
Delegations are identified by combining `DelegatorAddr` (the address of the delegator)
|
||||
with the `ValidatorAddr` Delegators are indexed in the store as follows:
|
||||
@@ -173,7 +173,7 @@ the transaction is the owner of the bond.
|
||||
https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/proto/cosmos/staking/v1beta1/staking.proto#L187-L205
|
||||
```
|
||||
|
||||
### Delegator Shares
|
||||
#### Delegator Shares
|
||||
|
||||
When one Delegates tokens to a Validator they are issued a number of delegator shares based on a
|
||||
dynamic exchange rate, calculated as follows from the total number of tokens delegated to the
|
||||
@@ -192,7 +192,7 @@ this mechanism is to simplify the accounting around slashing. Rather than iterat
|
||||
tokens of every delegation entry, instead the Validators total bonded tokens can be slashed,
|
||||
effectively reducing the value of each issued delegator share.
|
||||
|
||||
## UnbondingDelegation
|
||||
### UnbondingDelegation
|
||||
|
||||
Shares in a `Delegation` can be unbonded, but they must for some time exist as
|
||||
an `UnbondingDelegation`, where shares can be reduced if Byzantine behavior is
|
||||
@@ -221,7 +221,7 @@ A UnbondingDelegation object is created every time an unbonding is initiated.
|
||||
https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/proto/cosmos/staking/v1beta1/staking.proto#L207-L220
|
||||
```
|
||||
|
||||
## Redelegation
|
||||
### Redelegation
|
||||
|
||||
The bonded tokens worth of a `Delegation` may be instantly redelegated from a
|
||||
source validator to a different validator (destination validator). However when
|
||||
@@ -263,7 +263,7 @@ A redelegation object is created every time a redelegation occurs. To prevent
|
||||
https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/proto/cosmos/staking/v1beta1/staking.proto#L245-L283
|
||||
```
|
||||
|
||||
## Queues
|
||||
### Queues
|
||||
|
||||
All queues objects are sorted by timestamp. The time used within any queue is
|
||||
first rounded to the nearest nanosecond then sorted. The sortable time format
|
||||
@@ -276,7 +276,7 @@ used is a slight modification of the RFC3339Nano and uses the format string
|
||||
In all cases, the stored timestamp represents the maturation time of the queue
|
||||
element.
|
||||
|
||||
### UnbondingDelegationQueue
|
||||
#### UnbondingDelegationQueue
|
||||
|
||||
For the purpose of tracking progress of unbonding delegations the unbonding
|
||||
delegations queue is kept.
|
||||
@@ -287,7 +287,7 @@ delegations queue is kept.
|
||||
https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/proto/cosmos/staking/v1beta1/staking.proto#L151-L161
|
||||
```
|
||||
|
||||
### RedelegationQueue
|
||||
#### RedelegationQueue
|
||||
|
||||
For the purpose of tracking progress of redelegations the redelegation queue is
|
||||
kept.
|
||||
@@ -298,7 +298,7 @@ kept.
|
||||
https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/proto/cosmos/staking/v1beta1/staking.proto#L168-L179
|
||||
```
|
||||
|
||||
### ValidatorQueue
|
||||
#### ValidatorQueue
|
||||
|
||||
For the purpose of tracking progress of unbonding validators the validator
|
||||
queue is kept.
|
||||
@@ -310,7 +310,7 @@ which the validator object can be accessed. Typically it is expected that only
|
||||
a single validator record will be associated with a given timestamp however it is possible
|
||||
that multiple validators exist in the queue at the same location.
|
||||
|
||||
## HistoricalInfo
|
||||
### HistoricalInfo
|
||||
|
||||
HistoricalInfo objects are stored and pruned at each block such that the staking keeper persists
|
||||
the `n` most recent historical info defined by staking module parameter: `HistoricalEntries`.
|
||||
@@ -325,15 +325,9 @@ they are in a deterministic order.
|
||||
The oldest HistoricalEntries will be pruned to ensure that there only exist the parameter-defined number of
|
||||
historical entries.
|
||||
|
||||
# State Transitions
|
||||
## State Transitions
|
||||
|
||||
This document describes the state transition operations pertaining to:
|
||||
|
||||
1. [Validators](#validators)
|
||||
2. [Delegations](#delegations)
|
||||
3. [Slashing](#slashing)
|
||||
|
||||
## Validators
|
||||
### Validators
|
||||
|
||||
State transitions in validators are performed on every [`EndBlock`](#validator-set-changes)
|
||||
in order to check for changes in the active `ValidatorSet`.
|
||||
@@ -342,7 +336,7 @@ A validator can be `Unbonded`, `Unbonding` or `Bonded`. `Unbonded`
|
||||
and `Unbonding` are collectively called `Not Bonded`. A validator can move
|
||||
directly between all the states, except for from `Bonded` to `Unbonded`.
|
||||
|
||||
### Not bonded to Bonded
|
||||
#### Not bonded to Bonded
|
||||
|
||||
The following transition occurs when a validator's ranking in the `ValidatorPowerIndex` surpasses
|
||||
that of the `LastValidator`.
|
||||
@@ -354,7 +348,7 @@ that of the `LastValidator`.
|
||||
* update the `Validator` object for this validator
|
||||
* if it exists, delete any `ValidatorQueue` record for this validator
|
||||
|
||||
### Bonded to Unbonding
|
||||
#### Bonded to Unbonding
|
||||
|
||||
When a validator begins the unbonding process the following operations occur:
|
||||
|
||||
@@ -365,7 +359,7 @@ When a validator begins the unbonding process the following operations occur:
|
||||
* update the `Validator` object for this validator
|
||||
* insert a new record into the `ValidatorQueue` for this validator
|
||||
|
||||
### Unbonding to Unbonded
|
||||
#### Unbonding to Unbonded
|
||||
|
||||
A validator moves from unbonding to unbonded when the `ValidatorQueue` object
|
||||
moves from bonded to unbonded
|
||||
@@ -373,7 +367,7 @@ moves from bonded to unbonded
|
||||
* update the `Validator` object for this validator
|
||||
* set `validator.Status` to `Unbonded`
|
||||
|
||||
### Jail/Unjail
|
||||
#### Jail/Unjail
|
||||
|
||||
when a validator is jailed it is effectively removed from the Tendermint set.
|
||||
this process may be also be reversed. the following operations occur:
|
||||
@@ -386,9 +380,9 @@ Jailed validators are not present in any of the following stores:
|
||||
|
||||
* the power store (from consensus power to address)
|
||||
|
||||
## Delegations
|
||||
### Delegations
|
||||
|
||||
### Delegate
|
||||
#### Delegate
|
||||
|
||||
When a delegation occurs both the validator and the delegation objects are affected
|
||||
|
||||
@@ -400,7 +394,7 @@ When a delegation occurs both the validator and the delegation objects are affec
|
||||
* delete the existing record from `ValidatorByPowerIndex`
|
||||
* add an new updated record to the `ValidatorByPowerIndex`
|
||||
|
||||
### Begin Unbonding
|
||||
#### Begin Unbonding
|
||||
|
||||
As a part of the Undelegate and Complete Unbonding state transitions Unbond
|
||||
Delegation may be called.
|
||||
@@ -418,7 +412,7 @@ Delegation may be called.
|
||||
* call the `AfterUnbondingInitiated(unbondingId)` hook
|
||||
* add the unbonding delegation to `UnbondingDelegationQueue` with the completion time set to `UnbondingTime`
|
||||
|
||||
### Cancel an `UnbondingDelegation` Entry
|
||||
#### Cancel an `UnbondingDelegation` Entry
|
||||
|
||||
When a `cancel unbond delegation` occurs both the `validator`, the `delegation` and an `UnbondingDelegationQueue` state will be updated.
|
||||
|
||||
@@ -426,7 +420,7 @@ When a `cancel unbond delegation` occurs both the `validator`, the `delegation`
|
||||
* if the `cancel unbonding delegation amount is less than the `UnbondingDelegation` entry balance, then the `UnbondingDelegation` entry will be updated with new balance in the `UnbondingDelegationQueue`.
|
||||
* cancel `amount` is [Delegated](#delegations) back to the original `validator`.
|
||||
|
||||
### Complete Unbonding
|
||||
#### Complete Unbonding
|
||||
|
||||
For undelegations which do not complete immediately, the following operations
|
||||
occur when the unbonding delegation queue element matures:
|
||||
@@ -434,7 +428,7 @@ occur when the unbonding delegation queue element matures:
|
||||
* remove the entry from the `UnbondingDelegation` object
|
||||
* transfer the tokens from the `NotBondedPool` `ModuleAccount` to the delegator `Account`
|
||||
|
||||
### Begin Redelegation
|
||||
#### Begin Redelegation
|
||||
|
||||
Redelegations affect the delegation, source and destination validators.
|
||||
|
||||
@@ -449,15 +443,15 @@ Redelegations affect the delegation, source and destination validators.
|
||||
From when a redelegation begins until it completes, the delegator is in a state of "pseudo-unbonding", and can still be
|
||||
slashed for infractions that occurred before the redelegation began.
|
||||
|
||||
### Complete Redelegation
|
||||
#### Complete Redelegation
|
||||
|
||||
When a redelegations complete the following occurs:
|
||||
|
||||
* remove the entry from the `Redelegation` object
|
||||
|
||||
## Slashing
|
||||
### Slashing
|
||||
|
||||
### Slash Validator
|
||||
#### Slash Validator
|
||||
|
||||
When a Validator is slashed, the following occurs:
|
||||
|
||||
@@ -474,14 +468,14 @@ In the case of a slash due to any infraction that requires evidence to submitted
|
||||
occurs at the block where the evidence is included, not at the block where the infraction occured.
|
||||
Put otherwise, validators are not slashed retroactively, only when they are caught.
|
||||
|
||||
### Slash Unbonding Delegation
|
||||
#### Slash Unbonding Delegation
|
||||
|
||||
When a validator is slashed, so are those unbonding delegations from the validator that began unbonding
|
||||
after the time of the infraction. Every entry in every unbonding delegation from the validator
|
||||
is slashed by `slashFactor`. The amount slashed is calculated from the `InitialBalance` of the
|
||||
delegation and is capped to prevent a resulting negative balance. Completed (or mature) unbondings are not slashed.
|
||||
|
||||
### Slash Redelegation
|
||||
#### Slash Redelegation
|
||||
|
||||
When a validator is slashed, so are all redelegations from the validator that began after the
|
||||
infraction. Redelegations are slashed by `slashFactor`.
|
||||
@@ -490,7 +484,7 @@ The amount slashed is calculated from the `InitialBalance` of the delegation and
|
||||
prevent a resulting negative balance.
|
||||
Mature redelegations (that have completed pseudo-unbonding) are not slashed.
|
||||
|
||||
## How Shares are calculated
|
||||
### How Shares are calculated
|
||||
|
||||
At any given point in time, each validator has a number of tokens, `T`, and has a number of shares issued, `S`.
|
||||
Each delegator, `i`, holds a number of shares, `S_i`.
|
||||
@@ -508,11 +502,11 @@ A special case is the initial delegation, when `T = 0` and `S = 0`, so `T_j / T`
|
||||
For the initial delegation, delegator `j` who delegates `T_j` tokens receive `S_j = T_j` shares.
|
||||
So a validator that hasn't received any rewards and has not been slashed will have `T = S`.
|
||||
|
||||
# Messages
|
||||
## Messages
|
||||
|
||||
In this section we describe the processing of the staking messages and the corresponding updates to the state. All created/modified state objects specified by each message are defined within the [state](#state) section.
|
||||
|
||||
## MsgCreateValidator
|
||||
### MsgCreateValidator
|
||||
|
||||
A validator is created using the `MsgCreateValidator` message.
|
||||
The validator must be created with an initial delegation from the operator.
|
||||
@@ -541,7 +535,7 @@ Additionally a self-delegation is made with the initial tokens delegation
|
||||
tokens `Delegation`. The validator always starts as unbonded but may be bonded
|
||||
in the first end-block.
|
||||
|
||||
## MsgEditValidator
|
||||
### MsgEditValidator
|
||||
|
||||
The `Description`, `CommissionRate` of a validator can be updated using the
|
||||
`MsgEditValidator` message.
|
||||
@@ -563,7 +557,7 @@ This message is expected to fail if:
|
||||
|
||||
This message stores the updated `Validator` object.
|
||||
|
||||
## MsgDelegate
|
||||
### MsgDelegate
|
||||
|
||||
Within this message the delegator provides coins, and in return receives
|
||||
some amount of their validator's (newly created) delegator-shares that are
|
||||
@@ -600,7 +594,7 @@ will not be added to the power index until it is unjailed.
|
||||
|
||||

|
||||
|
||||
## MsgUndelegate
|
||||
### MsgUndelegate
|
||||
|
||||
The `MsgUndelegate` message allows delegators to undelegate their tokens from
|
||||
validator.
|
||||
@@ -640,7 +634,7 @@ When this message is processed the following actions occur:
|
||||
|
||||

|
||||
|
||||
## MsgCancelUnbondingDelegation
|
||||
### MsgCancelUnbondingDelegation
|
||||
|
||||
The `MsgCancelUnbondingDelegation` message allows delegators to cancel the `unbondingDelegation` entry and delegate back to a previous validator.
|
||||
|
||||
@@ -665,7 +659,7 @@ When this message is processed the following actions occur:
|
||||
* otherwise `unbondingDelegationQueue` will be updated with new `unbondingDelegation` entry balance and initial balance
|
||||
* the validator's `DelegatorShares` and the delegation's `Shares` are both increased by the message `Amount`.
|
||||
|
||||
## MsgBeginRedelegate
|
||||
### MsgBeginRedelegate
|
||||
|
||||
The redelegation command allows delegators to instantly switch validators. Once
|
||||
the unbonding period has passed, the redelegation is automatically completed in
|
||||
@@ -709,7 +703,7 @@ When this message is processed the following actions occur:
|
||||

|
||||
|
||||
|
||||
## MsgUpdateParams
|
||||
### MsgUpdateParams
|
||||
|
||||
The `MsgUpdateParams` update the staking module parameters.
|
||||
The params are updated through a governance proposal where the signer is the gov module account address.
|
||||
@@ -722,12 +716,12 @@ The message handling can fail if:
|
||||
|
||||
* signer is not the authority defined in the staking keeper (usually the gov module account).
|
||||
|
||||
# Begin-Block
|
||||
## Begin-Block
|
||||
|
||||
Each abci begin block call, the historical info will get stored and pruned
|
||||
according to the `HistoricalEntries` parameter.
|
||||
|
||||
## Historical Info Tracking
|
||||
### Historical Info Tracking
|
||||
|
||||
If the `HistoricalEntries` parameter is 0, then the `BeginBlock` performs a no-op.
|
||||
|
||||
@@ -735,12 +729,12 @@ Otherwise, the latest historical info is stored under the key `historicalInfoKey
|
||||
In most cases, this results in a single entry being pruned per block.
|
||||
However, if the parameter `HistoricalEntries` has changed to a lower value there will be multiple entries in the store that must be pruned.
|
||||
|
||||
# End-Block
|
||||
## End-Block
|
||||
|
||||
Each abci end block call, the operations to update queues and validator set
|
||||
changes are specified to execute.
|
||||
|
||||
## Validator Set Changes
|
||||
### Validator Set Changes
|
||||
|
||||
The staking validator set is updated during this process by state transitions
|
||||
that run at the end of every block. As a part of this process any updated
|
||||
@@ -765,7 +759,7 @@ and validator power from the end of the last block, and are used to check for
|
||||
changes that have occurred in `ValidatorsByPower` and the total new power, which
|
||||
is calculated during `EndBlock`.
|
||||
|
||||
## Queues
|
||||
### Queues
|
||||
|
||||
Within staking, certain state-transitions are not instantaneous but take place
|
||||
over a duration of time (typically the unbonding period). When these
|
||||
@@ -773,7 +767,7 @@ transitions are mature certain operations must take place in order to complete
|
||||
the state operation. This is achieved through the use of queues which are
|
||||
checked/processed at the end of each block.
|
||||
|
||||
### Unbonding Validators
|
||||
#### Unbonding Validators
|
||||
|
||||
When a validator is kicked out of the bonded validator set (either through
|
||||
being jailed, or not having sufficient bonded tokens) it begins the unbonding
|
||||
@@ -796,7 +790,7 @@ Unbonding operations can be put on hold by external modules via the `PutUnbondin
|
||||
(after it reaches maturity), every call to `PutUnbondingOnHold(unbondingId)` must be matched
|
||||
by a call to `UnbondingCanComplete(unbondingId)`.
|
||||
|
||||
### Unbonding Delegations
|
||||
#### Unbonding Delegations
|
||||
|
||||
Complete the unbonding of all mature `UnbondingDelegations.Entries` within the
|
||||
`UnbondingDelegations` queue with the following procedure:
|
||||
@@ -806,7 +800,7 @@ Complete the unbonding of all mature `UnbondingDelegations.Entries` within the
|
||||
* remove the `UnbondingDelegation` object from the store if there are no
|
||||
remaining entries.
|
||||
|
||||
### Redelegations
|
||||
#### Redelegations
|
||||
|
||||
Complete the unbonding of all mature `Redelegation.Entries` within the
|
||||
`Redelegations` queue with the following procedure:
|
||||
@@ -815,7 +809,7 @@ Complete the unbonding of all mature `Redelegation.Entries` within the
|
||||
* remove the `Redelegation` object from the store if there are no
|
||||
remaining entries.
|
||||
|
||||
# Hooks
|
||||
## Hooks
|
||||
|
||||
Other modules may register operations to execute when a certain event has
|
||||
occurred within staking. These events can be registered to execute either
|
||||
@@ -844,11 +838,11 @@ following hooks can registered with staking:
|
||||
* called when an unbonding operation (validator unbonding, unbonding delegation, redelegation) was initiated
|
||||
|
||||
|
||||
# Events
|
||||
## Events
|
||||
|
||||
The staking module emits the following events:
|
||||
|
||||
## EndBlocker
|
||||
### EndBlocker
|
||||
|
||||
| Type | Attribute Key | Attribute Value |
|
||||
| --------------------- | --------------------- | ------------------------- |
|
||||
@@ -931,7 +925,7 @@ The staking module emits the following events:
|
||||
|
||||
* [0] Time is formatted in the RFC3339 standard
|
||||
|
||||
# Parameters
|
||||
## Parameters
|
||||
|
||||
The staking module contains the following parameters:
|
||||
|
||||
@@ -944,13 +938,13 @@ The staking module contains the following parameters:
|
||||
| BondDenom | string | "stake" |
|
||||
| MinCommissionRate | string | "0.000000000000000000" |
|
||||
|
||||
# Client
|
||||
## Client
|
||||
|
||||
## CLI
|
||||
### CLI
|
||||
|
||||
A user can query and interact with the `staking` module using the CLI.
|
||||
|
||||
### Query
|
||||
#### Query
|
||||
|
||||
The `query` commands allows users to query `staking` state.
|
||||
|
||||
@@ -958,7 +952,7 @@ The `query` commands allows users to query `staking` state.
|
||||
simd query staking --help
|
||||
```
|
||||
|
||||
#### delegation
|
||||
##### delegation
|
||||
|
||||
The `delegation` command allows users to query delegations for an individual delegator on an individual validator.
|
||||
|
||||
@@ -986,7 +980,7 @@ delegation:
|
||||
validator_address: cosmosvaloper1gghjut3ccd8ay0zduzj64hwre2fxs9ldmqhffj
|
||||
```
|
||||
|
||||
#### delegations
|
||||
##### delegations
|
||||
|
||||
The `delegations` command allows users to query delegations for an individual delegator on all validators.
|
||||
|
||||
@@ -1025,7 +1019,7 @@ pagination:
|
||||
total: "0"
|
||||
```
|
||||
|
||||
#### delegations-to
|
||||
##### delegations-to
|
||||
|
||||
The `delegations-to` command allows users to query delegations on an individual validator.
|
||||
|
||||
@@ -1063,7 +1057,7 @@ pagination:
|
||||
total: "0"
|
||||
```
|
||||
|
||||
#### historical-info
|
||||
##### historical-info
|
||||
|
||||
The `historical-info` command allows users to query historical information at given height.
|
||||
|
||||
@@ -1129,7 +1123,7 @@ valset:
|
||||
unbonding_time: "1970-01-01T00:00:00Z"
|
||||
```
|
||||
|
||||
#### params
|
||||
##### params
|
||||
|
||||
The `params` command allows users to query values set as staking parameters.
|
||||
|
||||
@@ -1155,7 +1149,7 @@ max_validators: 50
|
||||
unbonding_time: 1814400s
|
||||
```
|
||||
|
||||
#### pool
|
||||
##### pool
|
||||
|
||||
The `pool` command allows users to query values for amounts stored in the staking pool.
|
||||
|
||||
@@ -1178,7 +1172,7 @@ bonded_tokens: "10000000"
|
||||
not_bonded_tokens: "0"
|
||||
```
|
||||
|
||||
#### redelegation
|
||||
##### redelegation
|
||||
|
||||
The `redelegation` command allows users to query a redelegation record based on delegator and a source and destination validator address.
|
||||
|
||||
@@ -1219,7 +1213,7 @@ redelegation_responses:
|
||||
validator_src_address: cosmosvaloper1l2rsakp388kuv9k8qzq6lrm9taddae7fpx59wm
|
||||
```
|
||||
|
||||
#### redelegations
|
||||
##### redelegations
|
||||
|
||||
The `redelegations` command allows users to query all redelegation records for an individual delegator.
|
||||
|
||||
@@ -1274,7 +1268,7 @@ redelegation_responses:
|
||||
validator_src_address: cosmosvaloper1zppjyal5emta5cquje8ndkpz0rs046m7zqxrpp
|
||||
```
|
||||
|
||||
#### redelegations-from
|
||||
##### redelegations-from
|
||||
|
||||
The `redelegations-from` command allows users to query delegations that are redelegating _from_ a validator.
|
||||
|
||||
@@ -1329,7 +1323,7 @@ redelegation_responses:
|
||||
validator_src_address: cosmosvaloper1y4rzzrgl66eyhzt6gse2k7ej3zgwmngeleucjy
|
||||
```
|
||||
|
||||
#### unbonding-delegation
|
||||
##### unbonding-delegation
|
||||
|
||||
The `unbonding-delegation` command allows users to query unbonding delegations for an individual delegator on an individual validator.
|
||||
|
||||
@@ -1357,7 +1351,7 @@ entries:
|
||||
validator_address: cosmosvaloper1gghjut3ccd8ay0zduzj64hwre2fxs9ldmqhffj
|
||||
```
|
||||
|
||||
#### unbonding-delegations
|
||||
##### unbonding-delegations
|
||||
|
||||
The `unbonding-delegations` command allows users to query all unbonding-delegations records for one delegator.
|
||||
|
||||
@@ -1390,7 +1384,7 @@ unbonding_responses:
|
||||
|
||||
```
|
||||
|
||||
#### unbonding-delegations-from
|
||||
##### unbonding-delegations-from
|
||||
|
||||
The `unbonding-delegations-from` command allows users to query delegations that are unbonding _from_ a validator.
|
||||
|
||||
@@ -1429,7 +1423,7 @@ unbonding_responses:
|
||||
validator_address: cosmosvaloper1gghjut3ccd8ay0zduzj64hwre2fxs9ldmqhffj
|
||||
```
|
||||
|
||||
#### validator
|
||||
##### validator
|
||||
|
||||
The `validator` command allows users to query details about an individual validator.
|
||||
|
||||
@@ -1476,7 +1470,7 @@ unbonding_height: "0"
|
||||
unbonding_time: "1970-01-01T00:00:00Z"
|
||||
```
|
||||
|
||||
#### validators
|
||||
##### validators
|
||||
|
||||
The `validators` command allows users to query details about all validators on a network.
|
||||
|
||||
@@ -1553,7 +1547,7 @@ description:
|
||||
unbonding_time: "1970-01-01T00:00:00Z"
|
||||
```
|
||||
|
||||
### Transactions
|
||||
#### Transactions
|
||||
|
||||
The `tx` commands allows users to interact with the `staking` module.
|
||||
|
||||
@@ -1561,7 +1555,7 @@ The `tx` commands allows users to interact with the `staking` module.
|
||||
simd tx staking --help
|
||||
```
|
||||
|
||||
#### create-validator
|
||||
##### create-validator
|
||||
|
||||
The command `create-validator` allows users to create new validator initialized with a self-delegation to it.
|
||||
|
||||
@@ -1591,7 +1585,7 @@ simd tx staking create-validator \
|
||||
--from=mykey
|
||||
```
|
||||
|
||||
#### delegate
|
||||
##### delegate
|
||||
|
||||
The command `delegate` allows users to delegate liquid tokens to a validator.
|
||||
|
||||
@@ -1607,7 +1601,7 @@ Example:
|
||||
simd tx staking delegate cosmosvaloper1l2rsakp388kuv9k8qzq6lrm9taddae7fpx59wm 1000stake --from mykey
|
||||
```
|
||||
|
||||
#### edit-validator
|
||||
##### edit-validator
|
||||
|
||||
The command `edit-validator` allows users to edit an existing validator account.
|
||||
|
||||
@@ -1623,7 +1617,7 @@ Example:
|
||||
simd tx staking edit-validator --moniker "new_moniker_name" --website "new_webiste_url" --from mykey
|
||||
```
|
||||
|
||||
#### redelegate
|
||||
##### redelegate
|
||||
|
||||
The command `redelegate` allows users to redelegate illiquid tokens from one validator to another.
|
||||
|
||||
@@ -1639,7 +1633,7 @@ Example:
|
||||
simd tx staking redelegate cosmosvaloper1gghjut3ccd8ay0zduzj64hwre2fxs9ldmqhffj cosmosvaloper1l2rsakp388kuv9k8qzq6lrm9taddae7fpx59wm 100stake --from mykey
|
||||
```
|
||||
|
||||
#### unbond
|
||||
##### unbond
|
||||
|
||||
The command `unbond` allows users to unbond shares from a validator.
|
||||
|
||||
@@ -1655,7 +1649,7 @@ Example:
|
||||
simd tx staking unbond cosmosvaloper1gghjut3ccd8ay0zduzj64hwre2fxs9ldmqhffj 100stake --from mykey
|
||||
```
|
||||
|
||||
#### cancel unbond
|
||||
##### cancel unbond
|
||||
|
||||
The command `cancel-unbond` allow users to cancel the unbonding delegation entry and delegate back to the original validator.
|
||||
|
||||
@@ -1672,11 +1666,11 @@ simd tx staking cancel-unbond cosmosvaloper1gghjut3ccd8ay0zduzj64hwre2fxs9ldmqhf
|
||||
```
|
||||
|
||||
|
||||
## gRPC
|
||||
### gRPC
|
||||
|
||||
A user can query the `staking` module using gRPC endpoints.
|
||||
|
||||
### Validators
|
||||
#### Validators
|
||||
|
||||
The `Validators` endpoint queries all validators that match the given status.
|
||||
|
||||
@@ -1722,7 +1716,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### Validator
|
||||
#### Validator
|
||||
|
||||
The `Validator` endpoint queries validator information for given validator address.
|
||||
|
||||
@@ -1764,7 +1758,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### ValidatorDelegations
|
||||
#### ValidatorDelegations
|
||||
|
||||
The `ValidatorDelegations` endpoint queries delegate information for given validator.
|
||||
|
||||
@@ -1802,7 +1796,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### ValidatorUnbondingDelegations
|
||||
#### ValidatorUnbondingDelegations
|
||||
|
||||
The `ValidatorUnbondingDelegations` endpoint queries delegate information for given validator.
|
||||
|
||||
@@ -1854,7 +1848,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### Delegation
|
||||
#### Delegation
|
||||
|
||||
The `Delegation` endpoint queries delegate information for given validator delegator pair.
|
||||
|
||||
@@ -1891,7 +1885,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### UnbondingDelegation
|
||||
#### UnbondingDelegation
|
||||
|
||||
The `UnbondingDelegation` endpoint queries unbonding information for given validator delegator.
|
||||
|
||||
@@ -1932,7 +1926,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### DelegatorDelegations
|
||||
#### DelegatorDelegations
|
||||
|
||||
The `DelegatorDelegations` endpoint queries all delegations of a given delegator address.
|
||||
|
||||
@@ -1962,7 +1956,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### DelegatorUnbondingDelegations
|
||||
#### DelegatorUnbondingDelegations
|
||||
|
||||
The `DelegatorUnbondingDelegations` endpoint queries all unbonding delegations of a given delegator address.
|
||||
|
||||
@@ -2009,7 +2003,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### Redelegations
|
||||
#### Redelegations
|
||||
|
||||
The `Redelegations` endpoint queries redelegations of given address.
|
||||
|
||||
@@ -2054,7 +2048,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### DelegatorValidators
|
||||
#### DelegatorValidators
|
||||
|
||||
The `DelegatorValidators` endpoint queries all validators information for given delegator.
|
||||
|
||||
@@ -2112,7 +2106,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### DelegatorValidator
|
||||
#### DelegatorValidator
|
||||
|
||||
The `DelegatorValidator` endpoint queries validator information for given delegator validator
|
||||
|
||||
@@ -2164,7 +2158,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### HistoricalInfo
|
||||
#### HistoricalInfo
|
||||
|
||||
```bash
|
||||
cosmos.staking.v1beta1.Query/HistoricalInfo
|
||||
@@ -2242,7 +2236,7 @@ Example Output:
|
||||
|
||||
```
|
||||
|
||||
### Pool
|
||||
#### Pool
|
||||
|
||||
The `Pool` endpoint queries the pool information.
|
||||
|
||||
@@ -2267,7 +2261,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### Params
|
||||
#### Params
|
||||
|
||||
The `Params` endpoint queries the pool information.
|
||||
|
||||
@@ -2295,11 +2289,11 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
## REST
|
||||
### REST
|
||||
|
||||
A user can query the `staking` module using REST endpoints.
|
||||
|
||||
### DelegatorDelegations
|
||||
#### DelegatorDelegations
|
||||
|
||||
The `DelegtaorDelegations` REST endpoint queries all delegations of a given delegator address.
|
||||
|
||||
@@ -2348,7 +2342,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### Redelegations
|
||||
#### Redelegations
|
||||
|
||||
The `Redelegations` REST endpoint queries redelegations of given address.
|
||||
|
||||
@@ -2393,7 +2387,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### DelegatorUnbondingDelegations
|
||||
#### DelegatorUnbondingDelegations
|
||||
|
||||
The `DelegatorUnbondingDelegations` REST endpoint queries all unbonding delegations of a given delegator address.
|
||||
|
||||
@@ -2434,7 +2428,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### DelegatorValidators
|
||||
#### DelegatorValidators
|
||||
|
||||
The `DelegatorValidators` REST endpoint queries all validators information for given delegator address.
|
||||
|
||||
@@ -2492,7 +2486,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### DelegatorValidator
|
||||
#### DelegatorValidator
|
||||
|
||||
The `DelegatorValidator` REST endpoint queries validator information for given delegator validator pair.
|
||||
|
||||
@@ -2544,7 +2538,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### HistoricalInfo
|
||||
#### HistoricalInfo
|
||||
|
||||
The `HistoricalInfo` REST endpoint queries the historical information for given height.
|
||||
|
||||
@@ -2652,7 +2646,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
#### Parameters
|
||||
|
||||
The `Parameters` REST endpoint queries the staking parameters.
|
||||
|
||||
@@ -2680,7 +2674,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### Pool
|
||||
#### Pool
|
||||
|
||||
The `Pool` REST endpoint queries the pool information.
|
||||
|
||||
@@ -2705,7 +2699,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### Validators
|
||||
#### Validators
|
||||
|
||||
The `Validators` REST endpoint queries all validators that match the given status.
|
||||
|
||||
@@ -2790,7 +2784,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### Validator
|
||||
#### Validator
|
||||
|
||||
The `Validator` REST endpoint queries validator information for given validator address.
|
||||
|
||||
@@ -2842,7 +2836,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### ValidatorDelegations
|
||||
#### ValidatorDelegations
|
||||
|
||||
The `ValidatorDelegations` REST endpoint queries delegate information for given validator.
|
||||
|
||||
@@ -2924,7 +2918,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### Delegation
|
||||
#### Delegation
|
||||
|
||||
The `Delegation` REST endpoint queries delegate information for given validator delegator pair.
|
||||
|
||||
@@ -2958,7 +2952,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### UnbondingDelegation
|
||||
#### UnbondingDelegation
|
||||
|
||||
The `UnbondingDelegation` REST endpoint queries unbonding information for given validator delegator pair.
|
||||
|
||||
@@ -2993,7 +2987,7 @@ Example Output:
|
||||
}
|
||||
```
|
||||
|
||||
### ValidatorUnbondingDelegations
|
||||
#### ValidatorUnbondingDelegations
|
||||
|
||||
The `ValidatorUnbondingDelegations` REST endpoint queries unbonding delegations of a validator.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user