-
Notifications
You must be signed in to change notification settings - Fork 3.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: prevent panic in RedeemTokensForShares
when too few tokens are redeemed
#19076
Conversation
x/staking/keeper/msg_server.go
Outdated
shareDenomSupply := k.bankKeeper.GetSupply(ctx, shareToken.Denom) | ||
shares := delegation.Shares.Mul(sdk.NewDecFromInt(shareToken.Amount)).QuoInt(shareDenomSupply.Amount) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apologies for the confusion, but can you elaborate on why this is inaccurate in the case of a validator having pending rewards or being slashed?
The LSM token is intended to map 1:1 with shares (it is minted based on shares, not tokens), so I was under the assumption that it would naturally capture rewards/slashing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The LSM token is intended to map 1:1 with shares (it is minted based on shares, not tokens), so I was under the assumption that it would naturally capture rewards/slashing.
You're 100% right. Sorry, I got it the wrong way. The simulation tests were failing due to these lines, which don't use a 1:1 mapping between LSM tokens and shares.
Description
InRedeemTokensForShares()
, this line establishes a 1:1 mapping between the redeemed token amount and shares.However, this mapping is accurate only when a validator hasn't received any rewards and hasn't been slashed.
This PR changes the mapping by calculating shares as a fraction of the redeemed tokensand the total share token supply, akin to the approach taken here.
Edit: This PR updates RedeemTokensForShares to return an error when the redemption amount is too small and truncates to 0 shares. That prevents a panic in SendCoins.
cc @sampocs
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...
!
in the type prefix if API or client breaking changeCHANGELOG.md
Reviewers 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...