cb31043d35
## Description Upgrades the math library in the repo root and find/replaces many usages of sdk.Dec, sdk.ZeroDec, sdk.OneDec, sdk.NewDec with their legacy-ified-math-lib replacements. Note for review: I assume that I did not find 100% of usages --- ### 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... - [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### 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... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
80 lines
2.8 KiB
Go
80 lines
2.8 KiB
Go
package keeper
|
|
|
|
import (
|
|
"cosmossdk.io/math"
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
|
|
"github.com/cosmos/cosmos-sdk/x/staking/types"
|
|
)
|
|
|
|
// GetBondedPool returns the bonded tokens pool's module account
|
|
func (k Keeper) GetBondedPool(ctx sdk.Context) (bondedPool authtypes.ModuleAccountI) {
|
|
return k.authKeeper.GetModuleAccount(ctx, types.BondedPoolName)
|
|
}
|
|
|
|
// GetNotBondedPool returns the not bonded tokens pool's module account
|
|
func (k Keeper) GetNotBondedPool(ctx sdk.Context) (notBondedPool authtypes.ModuleAccountI) {
|
|
return k.authKeeper.GetModuleAccount(ctx, types.NotBondedPoolName)
|
|
}
|
|
|
|
// bondedTokensToNotBonded transfers coins from the bonded to the not bonded pool within staking
|
|
func (k Keeper) bondedTokensToNotBonded(ctx sdk.Context, tokens math.Int) {
|
|
coins := sdk.NewCoins(sdk.NewCoin(k.BondDenom(ctx), tokens))
|
|
if err := k.bankKeeper.SendCoinsFromModuleToModule(ctx, types.BondedPoolName, types.NotBondedPoolName, coins); err != nil {
|
|
panic(err)
|
|
}
|
|
}
|
|
|
|
// notBondedTokensToBonded transfers coins from the not bonded to the bonded pool within staking
|
|
func (k Keeper) notBondedTokensToBonded(ctx sdk.Context, tokens math.Int) {
|
|
coins := sdk.NewCoins(sdk.NewCoin(k.BondDenom(ctx), tokens))
|
|
if err := k.bankKeeper.SendCoinsFromModuleToModule(ctx, types.NotBondedPoolName, types.BondedPoolName, coins); err != nil {
|
|
panic(err)
|
|
}
|
|
}
|
|
|
|
// burnBondedTokens removes coins from the bonded pool module account
|
|
func (k Keeper) burnBondedTokens(ctx sdk.Context, amt math.Int) error {
|
|
if !amt.IsPositive() {
|
|
// skip as no coins need to be burned
|
|
return nil
|
|
}
|
|
|
|
coins := sdk.NewCoins(sdk.NewCoin(k.BondDenom(ctx), amt))
|
|
|
|
return k.bankKeeper.BurnCoins(ctx, types.BondedPoolName, coins)
|
|
}
|
|
|
|
// burnNotBondedTokens removes coins from the not bonded pool module account
|
|
func (k Keeper) burnNotBondedTokens(ctx sdk.Context, amt math.Int) error {
|
|
if !amt.IsPositive() {
|
|
// skip as no coins need to be burned
|
|
return nil
|
|
}
|
|
|
|
coins := sdk.NewCoins(sdk.NewCoin(k.BondDenom(ctx), amt))
|
|
|
|
return k.bankKeeper.BurnCoins(ctx, types.NotBondedPoolName, coins)
|
|
}
|
|
|
|
// TotalBondedTokens total staking tokens supply which is bonded
|
|
func (k Keeper) TotalBondedTokens(ctx sdk.Context) math.Int {
|
|
bondedPool := k.GetBondedPool(ctx)
|
|
return k.bankKeeper.GetBalance(ctx, bondedPool.GetAddress(), k.BondDenom(ctx)).Amount
|
|
}
|
|
|
|
// StakingTokenSupply staking tokens from the total supply
|
|
func (k Keeper) StakingTokenSupply(ctx sdk.Context) math.Int {
|
|
return k.bankKeeper.GetSupply(ctx, k.BondDenom(ctx)).Amount
|
|
}
|
|
|
|
// BondedRatio the fraction of the staking tokens which are currently bonded
|
|
func (k Keeper) BondedRatio(ctx sdk.Context) math.LegacyDec {
|
|
stakeSupply := k.StakingTokenSupply(ctx)
|
|
if stakeSupply.IsPositive() {
|
|
return sdk.NewDecFromInt(k.TotalBondedTokens(ctx)).QuoInt(stakeSupply)
|
|
}
|
|
|
|
return math.LegacyZeroDec()
|
|
}
|