chore: update staking doc #12
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sainoe
commented
Jan 9, 2024
| @@ -1,16 +1,17 @@ | |||
| # ADR ADR-061: Liquid Staking | |||
| # ADR 061: Liquid Staking Module | |||
There was a problem hiding this comment.
Updated ADR version from SDK v0.45.16-ics-lsm.
mpoke
reviewed
Jan 9, 2024
| PendingTokenizeShareAuthorizations stores a queue of addresses that have their tokenize share re-enablement/unlocking in progress. When an address is enqueued, it will sit for 1 unbonding period before the tokenize share lock is removed. | ||
|
|
||
| ```go reference | ||
| https://github.com/cosmos/cosmos-sdk/blob/v0.45.16-ics-lsm/proto/cosmos/staking/v1beta1/staking.proto#L417-L421 |
x/staking/README.md
Outdated
| @@ -442,6 +474,8 @@ Redelegations affect the delegation, source and destination validators. | |||
| * otherwise, if the `sourceValidator.Status` is not `Bonded`, and the `destinationValidator` | |||
| is `Bonded`, transfer the newly delegated tokens from the `NotBondedPool` to the `BondedPool` `ModuleAccount` | |||
| * record the token amount in an new entry in the relevant `Redelegation` | |||
| * decrement the source validator's `LiquidShares` | |||
There was a problem hiding this comment.
Add the if condition, i.e., "if delegator is a liquid staking provider"
x/staking/README.md
Outdated
Comment on lines
747
to
749
| * if the delegation if is a validator bond, the `ValidatorBondShares` of the validator is decreased. | ||
| * if the delegator is a liquid staking provider, the `TotalLiquidStakedTokens`` increased | ||
| and the validator's `LiquidShares` is decreased. |
There was a problem hiding this comment.
Differentiate between the two validators.
| The `MsgTokenizeShares` message allows users to tokenize their delegated tokens. Share tokens have denom using the validator address and record id of the underlying delegation with the format `{validatorAddress}/{recordId}`. | ||
|
|
||
| ```protobuf reference | ||
| https://github.com/cosmos/cosmos-sdk/blob/v0.45.16-ics-lsm/proto/cosmos/staking/v1beta1/tx.proto#L49-L50 |
mpoke
approved these changes
Jan 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add missing docs in staking REAMDE, see comment.
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!to the type prefix if API or client breaking changeCHANGELOG.mdmake lintandmake testReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
!in the type prefix if API or client breaking change