feat(x/mint)!: Replace InflationCalculationFn with MintFn + simple epoch minting #20363
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,125 @@ | ||
| package simapp | ||
|
Contributor
There was a problem hiding this comment. Why is this in simapp? I would expect this code to be in the mint module.
Contributor
Author
There was a problem hiding this comment. 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.
Contributor
There was a problem hiding this comment. Thanks for the explanation! Personally, I would prefer something like |
||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/binary" | ||
|
|
||
| "cosmossdk.io/core/appmodule" | ||
| "cosmossdk.io/core/event" | ||
| "cosmossdk.io/math" | ||
| authtypes "cosmossdk.io/x/auth/types" | ||
| banktypes "cosmossdk.io/x/bank/types" | ||
| minttypes "cosmossdk.io/x/mint/types" | ||
| stakingtypes "cosmossdk.io/x/staking/types" | ||
|
|
||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| ) | ||
|
|
||
| type MintBankKeeper interface { | ||
| MintCoins(ctx context.Context, moduleName string, coins sdk.Coins) error | ||
| SendCoinsFromModuleToModule(ctx context.Context, senderModule string, recipientModule string, amt sdk.Coins) error | ||
| } | ||
|
|
||
| // ProvideExampleMintFn returns the function used in x/mint's endblocker to mint new tokens. | ||
|
alpe marked this conversation as resolved.
|
||
| // Note that this function can not have the mint keeper as a parameter because it would create a cyclic dependency. | ||
| func ProvideExampleMintFn(bankKeeper MintBankKeeper) minttypes.MintFn { | ||
| return func(ctx context.Context, env appmodule.Environment, minter *minttypes.Minter, epochID string, epochNumber int64) error { | ||
| // in this example we ignore epochNumber as we don't care what epoch we are in, we just assume we are being called every minute. | ||
| if epochID != "minute" { | ||
| return nil | ||
| } | ||
|
|
||
| var stakingParams stakingtypes.QueryParamsResponse | ||
| err := env.QueryRouterService.InvokeTyped(ctx, &stakingtypes.QueryParamsRequest{}, &stakingParams) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| var bankSupply banktypes.QuerySupplyOfResponse | ||
| err = env.QueryRouterService.InvokeTyped(ctx, &banktypes.QuerySupplyOfRequest{Denom: stakingParams.Params.BondDenom}, &bankSupply) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| stakingTokenSupply := bankSupply.Amount | ||
|
|
||
| var mintParams minttypes.QueryParamsResponse | ||
| err = env.QueryRouterService.InvokeTyped(ctx, &minttypes.QueryParamsRequest{}, &mintParams) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| var stakingPool stakingtypes.QueryPoolResponse | ||
| err = env.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) | ||
|
|
||
| // to get a more accurate amount of tokens minted, we get, and later store, last minting time. | ||
|
|
||
| // if this is the first time minting, we initialize the minter.Data with the current time - 60s | ||
| // to mint tokens at the beginning. Note: this is a custom behavior to avoid breaking tests. | ||
| if minter.Data == nil { | ||
| minter.Data = make([]byte, 8) | ||
| binary.BigEndian.PutUint64(minter.Data, (uint64)(env.HeaderService.HeaderInfo(ctx).Time.Unix()-60)) | ||
| } | ||
|
|
||
| lastMint := binary.BigEndian.Uint64(minter.Data) | ||
| binary.BigEndian.PutUint64(minter.Data, (uint64)(env.HeaderService.HeaderInfo(ctx).Time.Unix())) | ||
|
|
||
| // calculate the amount of tokens to mint, based on the time since the last mint | ||
| secsSinceLastMint := env.HeaderService.HeaderInfo(ctx).Time.Unix() - (int64)(lastMint) | ||
| provisionAmt := minter.AnnualProvisions.QuoInt64(31536000).MulInt64(secsSinceLastMint) // 31536000 = seconds in a year | ||
| mintedCoin := sdk.NewCoin(mintParams.Params.MintDenom, provisionAmt.TruncateInt()) | ||
| maxSupply := mintParams.Params.MaxSupply | ||
| totalSupply := stakingTokenSupply.Amount | ||
|
|
||
| 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() { | ||
|
facundomedica marked this conversation as resolved.
|
||
| // 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 | ||
| } | ||
|
|
||
| // Example of custom send while minting | ||
| // Send some tokens to a "team account" | ||
| // if err = bankKeeper.SendCoinsFromModuleToAccount(ctx, minttypes.ModuleName, ... ); err != nil { | ||
| // return err | ||
| // } | ||
|
|
||
| if err = bankKeeper.SendCoinsFromModuleToModule(ctx, minttypes.ModuleName, authtypes.FeeCollectorName, mintedCoins); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| 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()), | ||
| ) | ||
| } | ||
| } | ||
|
Contributor
There was a problem hiding this comment. Some unit tests on the edge cases would be great |
||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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.
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.
Uh oh!
There was an error while loading. Please reload this page.