feat(x/mint)!: Replace InflationCalculationFn with MintFn + simple epoch minting #20363
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| package simapp | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "cosmossdk.io/core/appmodule" | ||
| "cosmossdk.io/core/event" | ||
| "cosmossdk.io/math" | ||
| authtypes "cosmossdk.io/x/auth/types" | ||
| bankkeeper "cosmossdk.io/x/bank/keeper" | ||
| banktypes "cosmossdk.io/x/bank/types" | ||
| minttypes "cosmossdk.io/x/mint/types" | ||
| stakingtypes "cosmossdk.io/x/staking/types" | ||
| "github.com/cosmos/cosmos-sdk/telemetry" | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| ) | ||
|
|
||
| // ProvideMintFn returns the function used in x/mint's endblocker to mint new tokens. | ||
| // Note that this function can not have the mint keeper as a parameter because it would create a cyclic dependency. | ||
| func ProvideMintFn(bankKeeper bankkeeper.Keeper) minttypes.MintFn { | ||
| return func(ctx context.Context, env appmodule.Environment, minter *minttypes.Minter) error { | ||
| var stakingParams stakingtypes.QueryParamsResponse | ||
| err := env.RouterService.QueryRouterService().InvokeTyped(ctx, &stakingtypes.QueryParamsRequest{}, &stakingParams) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| var bankSupply banktypes.QuerySupplyOfResponse | ||
| err = env.RouterService.QueryRouterService().InvokeTyped(ctx, &banktypes.QuerySupplyOfRequest{Denom: stakingParams.Params.BondDenom}, &bankSupply) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| stakingTokenSupply := bankSupply.Amount | ||
|
|
||
| var mintParams minttypes.QueryParamsResponse | ||
| err = env.RouterService.QueryRouterService().InvokeTyped(ctx, &minttypes.QueryParamsRequest{}, &mintParams) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| var stakingPool stakingtypes.QueryPoolResponse | ||
| err = env.RouterService.QueryRouterService().InvokeTyped(ctx, &stakingtypes.QueryPoolRequest{}, &stakingPool) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // bondedRatio | ||
| bondedRatio := math.LegacyNewDecFromInt(stakingPool.Pool.BondedTokens).QuoInt(stakingTokenSupply.Amount) | ||
| minter.Inflation = minter.NextInflationRate(mintParams.Params, bondedRatio) | ||
| minter.AnnualProvisions = minter.NextAnnualProvisions(mintParams.Params, stakingTokenSupply.Amount) | ||
| // TODO: store minter afterwards | ||
|
|
||
| mintedCoin := minter.BlockProvision(mintParams.Params) | ||
| mintedCoins := sdk.NewCoins(mintedCoin) | ||
| maxSupply := mintParams.Params.MaxSupply | ||
| totalSupply := stakingTokenSupply.Amount | ||
|
|
||
| // if maxSupply is not infinite, check against max_supply parameter | ||
| if !maxSupply.IsZero() { | ||
| if totalSupply.Add(mintedCoins.AmountOf(mintParams.Params.MintDenom)).GT(maxSupply) { | ||
| // calculate the difference between maxSupply and totalSupply | ||
| diff := maxSupply.Sub(totalSupply) | ||
|
There was a problem hiding this comment. I have not seen a check in the module that ensures maxSupply > totalSupply. Therefore this can be negative 🙈 There was a problem hiding this comment. I thought that I had pushed that fix, found it yesterday while adding more tests 😅 There was a problem hiding this comment. Looking at it again, no, I didn't add a fix. Should we return an error if totalSupply > maxSupply here? It should never be the case tho, as the minting only happens here and we don't mint over maxSupply |
||
| // mint the difference | ||
| diffCoin := sdk.NewCoin(mintParams.Params.MintDenom, diff) | ||
| diffCoins := sdk.NewCoins(diffCoin) | ||
|
|
||
| // mint coins | ||
| if diffCoins.Empty() { | ||
| // skip as no coins need to be minted | ||
| return nil | ||
| } | ||
|
|
||
| if err := bankKeeper.MintCoins(ctx, minttypes.ModuleName, diffCoins); err != nil { | ||
| return err | ||
| } | ||
| mintedCoins = diffCoins | ||
| } | ||
| } | ||
|
|
||
| // mint coins if maxSupply is infinite or total staking supply is less than maxSupply | ||
| if maxSupply.IsZero() || totalSupply.Add(mintedCoins.AmountOf(mintParams.Params.MintDenom)).LT(maxSupply) { | ||
|
There was a problem hiding this comment. when total + minted == max supply, then neither L67 or this condition fits and no coins would be minted although a sub amount would be possible. I think L67 should handle this There was a problem hiding this comment. I'm simplifying it like this: if !maxSupply.IsZero() {
// supply is not infinite, check the amount to mint
remainingSupply := maxSupply.Sub(totalSupply)
if remainingSupply.LTE(math.ZeroInt()) {
// max supply reached, no new tokens will be minted
// also handles the case where totalSupply > maxSupply
return nil
}
// if the amount to mint is greater than the remaining supply, mint the remaining supply
if mintedCoin.Amount.GT(remainingSupply) {
mintedCoin.Amount = remainingSupply
}
}
if mintedCoin.Amount.IsZero() {
// skip as no coins need to be minted
return nil
}
mintedCoins := sdk.NewCoins(mintedCoin)
if err := bankKeeper.MintCoins(ctx, minttypes.ModuleName, mintedCoins); err != nil {
return err
} |
||
| // mint coins | ||
| if mintedCoins.Empty() { | ||
| // skip as no coins need to be minted | ||
| return nil | ||
| } | ||
|
|
||
| if err := bankKeeper.MintCoins(ctx, minttypes.ModuleName, mintedCoins); err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| // Example of custom send while minting | ||
| // Send some tokens to a "team account" | ||
| // if err = bankKeeper.SendCoinsFromModuleToAccount(ctx, minttypes.ModuleName, ... ); err != nil { | ||
| // return err | ||
| // } | ||
|
|
||
| // TODO: figure how to get FeeCollectorName from mint module without generating a cyclic dependency | ||
facundomedica marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if err = bankKeeper.SendCoinsFromModuleToModule(ctx, minttypes.ModuleName, authtypes.FeeCollectorName, mintedCoins); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if mintedCoin.Amount.IsInt64() { | ||
| defer telemetry.ModuleSetGauge(minttypes.ModuleName, float32(mintedCoin.Amount.Int64()), "minted_tokens") | ||
|
There was a problem hiding this comment. should be be called in bank.MintCoins instead? |
||
| } | ||
facundomedica marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| return env.EventService.EventManager(ctx).EmitKV( | ||
| minttypes.EventTypeMint, | ||
| event.NewAttribute(minttypes.AttributeKeyBondedRatio, bondedRatio.String()), | ||
| event.NewAttribute(minttypes.AttributeKeyInflation, minter.Inflation.String()), | ||
| event.NewAttribute(minttypes.AttributeKeyAnnualProvisions, minter.AnnualProvisions.String()), | ||
| event.NewAttribute(sdk.AttributeKeyAmount, mintedCoin.Amount.String()), | ||
| ) | ||
| } | ||
| } | ||
|
There was a problem hiding this comment. Some unit tests on the edge cases would be great |
||
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
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
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.
Why is this in simapp? I would expect this code to be in the mint module.
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.
Because this is the example that developers can use to develop their own mint function. The idea here is that anyone creates their own minting function if they want to, and it works without requiring direct usage of keepers as it uses the query routers.
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.
Thanks for the explanation! Personally, I would prefer something like
x/mint/example. I do understand your point of keeping it decoupled but it still relates more the mint package than to simapp for me. This is personal preference of course.