wip: remove abci logic

x/mint/README.md

@@ -13,13 +13,8 @@ sidebar_position: 1
 * [Begin Epoch](#begin-epoch)
     * [NextEpochProvisions](#nextepochprovisions)
     * [EpochProvision](#epochprovision)
-* [Begin-Block](#begin-block)
-    * [NextInflationRate](#nextinflationrate)
-    * [NextAnnualProvisions](#nextannualprovisions)
-    * [BlockProvision](#blockprovision)
 * [Parameters](#parameters)
-* [Events](#events)
-    * [BeginBlocker](#beginblocker)
+* [Hooks](#hooks)
 * [Client](#client)
     * [CLI](#cli)
     * [gRPC](#grpc)
@@ -101,72 +96,6 @@ provisions. The provisions are then minted by the `mint` module's
 `FeeCollector`, which handles distributing the rewards per the chain's needs.
 This fee collector is specified as the `auth` module's `FeeCollector` `ModuleAccount`.
 
-## Begin-Block
-
-Minting parameters are recalculated and inflation paid at the beginning of each block.
-
-The minting logic in the `BeginBlocker` function provides an optional feature for controlling token minting based on the maximum allowable supply (MaxSupply). This feature allows users to adjust the minting process according to their specific requirements and use cases. However, it's important to note that the MaxSupply parameter is independent of the minting process and assumes that any adjustments to the total supply, including burning tokens, are handled by external modules.
-
-NOTE: Only one of the BeginBlock or BeginEpoch hooks should be enabled for minting.
-
-### Inflation rate calculation
-
-The inflation rate is calculated using an "inflation calculation function" that's
-passed to the `NewAppModule` function. If no function is passed, then the SDK's
-default inflation function will be used (`NextInflationRate`). In case a custom
-inflation calculation logic is needed, this can be achieved by defining and
-passing a function that matches `InflationCalculationFn`'s signature.
-
-```go
-type InflationCalculationFn func(ctx sdk.Context, minter Minter, params Params, bondedRatio math.LegacyDec) math.LegacyDec
-```
-
-#### NextInflationRate
-
-The target annual inflation rate is recalculated each block.
-The inflation is also subject to a rate change (positive or negative)
-depending on the distance from the desired ratio (67%). The maximum rate change
-possible is defined to be 13% per year, however, the annual inflation is capped
-as between 7% and 20%.
-
-```go
-NextInflationRate(params Params, bondedRatio math.LegacyDec) (inflation math.LegacyDec) {
-	inflationRateChangePerYear = (1 - bondedRatio/params.GoalBonded) * params.InflationRateChange
-	inflationRateChange = inflationRateChangePerYear/blocksPerYr
-
-	// increase the new annual inflation for this next block
-	inflation += inflationRateChange
-	if inflation > params.InflationMax {
-		inflation = params.InflationMax
-	}
-	if inflation < params.InflationMin {
-		inflation = params.InflationMin
-	}
-
-	return inflation
-}
-```
-
-### NextAnnualProvisions
-
-Calculate the annual provisions based on current total supply and inflation
-rate. This parameter is calculated once per block.
-
-```go
-NextAnnualProvisions(params Params, totalSupply math.LegacyDec) (provisions math.LegacyDec) {
-	return Inflation * totalSupply
-```
-
-### BlockProvision
-
-Calculate the provisions generated for each block based on current annual provisions. The provisions are then minted by the `mint` module's `ModuleMinterAccount` and then transferred to the `auth`'s `FeeCollector` `ModuleAccount`.
-
-```go
-BlockProvision(params Params) sdk.Coin {
-	provisionAmt = AnnualProvisions/ params.BlocksPerYear
-	return sdk.NewCoin(params.MintDenom, provisionAmt.Truncate())
-```
-
 
 ## Parameters
 
@@ -187,19 +116,7 @@ Note: `0` indicates unlimited supply for MaxSupply param
 | ReductionFactor        | string (dec)     | "0.500000000000000000" |
 | ReductionPeriodInEpochs| string (int64)   | "156"                  |
 
-
-## Events
-
-The minting module emits the following events:
-
-### BeginBlocker
-
-| Type | Attribute Key     | Attribute Value    |
-|------|-------------------|--------------------|
-| mint | bonded_ratio      | {bondedRatio}      |
-| mint | inflation         | {inflation}        |
-| mint | annual_provisions | {annualProvisions} |
-| mint | amount            | {amount}           |
+## Hooks
 
 
 ## Client

x/mint/depinject.go

@@ -26,15 +26,13 @@ func init() {
 type ModuleInputs struct {
 	depinject.In
 
-	ModuleKey              depinject.OwnModuleKey
-	Config                 *modulev1.Module
-	Environment            appmodule.Environment
-	Cdc                    codec.Codec
-	InflationCalculationFn types.InflationCalculationFn `optional:"true"`
+	ModuleKey   depinject.OwnModuleKey
+	Config      *modulev1.Module
+	Environment appmodule.Environment
+	Cdc         codec.Codec
 
 	AccountKeeper types.AccountKeeper
 	BankKeeper    types.BankKeeper
-	StakingKeeper types.StakingKeeper
 }
 
 type ModuleOutputs struct {
@@ -64,15 +62,13 @@ func ProvideModule(in ModuleInputs) ModuleOutputs {
 	k := keeper.NewKeeper(
 		in.Cdc,
 		in.Environment,
-		in.StakingKeeper,
 		in.AccountKeeper,
 		in.BankKeeper,
 		feeCollectorName,
 		as,
 	)
 
-	// when no inflation calculation function is provided it will use the default types.DefaultInflationCalculationFn
-	m := NewAppModule(in.Cdc, k, in.AccountKeeper, in.InflationCalculationFn)
+	m := NewAppModule(in.Cdc, k, in.AccountKeeper)
 
 	return ModuleOutputs{MintKeeper: k, Module: m}
 }

x/mint/keeper/genesis_test.go

@@ -51,14 +51,13 @@ func (s *GenesisTestSuite) SetupTest() {
 	s.sdkCtx = testCtx.Ctx
 	s.key = key
 
-	stakingKeeper := minttestutil.NewMockStakingKeeper(ctrl)
 	accountKeeper := minttestutil.NewMockAccountKeeper(ctrl)
 	bankKeeper := minttestutil.NewMockBankKeeper(ctrl)
 	s.accountKeeper = accountKeeper
 	accountKeeper.EXPECT().GetModuleAddress(minterAcc.Name).Return(minterAcc.GetAddress())
 	accountKeeper.EXPECT().GetModuleAccount(s.sdkCtx, minterAcc.Name).Return(minterAcc)
 
-	s.keeper = keeper.NewKeeper(s.cdc, runtime.NewEnvironment(runtime.NewKVStoreService(key), log.NewNopLogger()), stakingKeeper, accountKeeper, bankKeeper, "", "")
+	s.keeper = keeper.NewKeeper(s.cdc, runtime.NewEnvironment(runtime.NewKVStoreService(key), log.NewNopLogger()), accountKeeper, bankKeeper, "", "")
 }
 
 func (s *GenesisTestSuite) TestImportExportGenesis() {

x/mint/keeper/grpc_query_test.go

@@ -42,14 +42,12 @@ func (suite *MintTestSuite) SetupTest() {
 	ctrl := gomock.NewController(suite.T())
 	accountKeeper := minttestutil.NewMockAccountKeeper(ctrl)
 	bankKeeper := minttestutil.NewMockBankKeeper(ctrl)
-	stakingKeeper := minttestutil.NewMockStakingKeeper(ctrl)
 
 	accountKeeper.EXPECT().GetModuleAddress("mint").Return(sdk.AccAddress{})
 
 	suite.mintKeeper = keeper.NewKeeper(
 		encCfg.Codec,
 		storeService,
-		stakingKeeper,
 		accountKeeper,
 		bankKeeper,
 		authtypes.FeeCollectorName,

x/mint/keeper/keeper.go

@@ -7,7 +7,6 @@ import (
 	"cosmossdk.io/collections"
 	"cosmossdk.io/core/appmodule"
 	"cosmossdk.io/log"
-	"cosmossdk.io/math"
 	"cosmossdk.io/x/mint/types"
 
 	"github.com/cosmos/cosmos-sdk/codec"
@@ -19,7 +18,6 @@ type Keeper struct {
 	appmodule.Environment
 
 	cdc              codec.BinaryCodec
-	stakingKeeper    types.StakingKeeper
 	bankKeeper       types.BankKeeper
 	logger           log.Logger
 	feeCollectorName string
@@ -37,7 +35,6 @@ type Keeper struct {
 func NewKeeper(
 	cdc codec.BinaryCodec,
 	env appmodule.Environment,
-	sk types.StakingKeeper,
 	ak types.AccountKeeper,
 	bk types.BankKeeper,
 	feeCollectorName string,
@@ -52,7 +49,6 @@ func NewKeeper(
 	k := Keeper{
 		Environment:        env,
 		cdc:                cdc,
-		stakingKeeper:      sk,
 		bankKeeper:         bk,
 		logger:             env.Logger,
 		feeCollectorName:   feeCollectorName,
@@ -75,20 +71,8 @@ func (k Keeper) GetAuthority() string {
 	return k.authority
 }
 
-// StakingTokenSupply implements an alias call to the underlying staking keeper's
-// StakingTokenSupply to be used in BeginBlocker.
-func (k Keeper) StakingTokenSupply(ctx context.Context) (math.Int, error) {
-	return k.stakingKeeper.StakingTokenSupply(ctx)
-}
-
-// BondedRatio implements an alias call to the underlying staking keeper's
-// BondedRatio to be used in BeginBlocker.
-func (k Keeper) BondedRatio(ctx context.Context) (math.LegacyDec, error) {
-	return k.stakingKeeper.BondedRatio(ctx)
-}
-
 // MintCoins implements an alias call to the underlying supply keeper's
-// MintCoins to be used in BeginBlocker.
+// MintCoins to be used in epochs hooks for minting.
 func (k Keeper) MintCoins(ctx context.Context, newCoins sdk.Coins) error {
 	if newCoins.Empty() {
 		// skip as no coins need to be minted
@@ -99,7 +83,7 @@ func (k Keeper) MintCoins(ctx context.Context, newCoins sdk.Coins) error {
 }
 
 // AddCollectedFees implements an alias call to the underlying supply keeper's
-// AddCollectedFees to be used in BeginBlocker.
+// AddCollectedFees to be used in epochs hooks for minting.
 func (k Keeper) AddCollectedFees(ctx context.Context, fees sdk.Coins) error {
 	return k.bankKeeper.SendCoinsFromModuleToModule(ctx, types.ModuleName, k.feeCollectorName, fees)
 }

x/mint/keeper/keeper_test.go

@@ -27,11 +27,10 @@ const govModuleNameStr = "cosmos10d07y265gmmuvt4z0w9aw880jnsr700j6zn9kn"
 type IntegrationTestSuite struct {
 	suite.Suite
 
-	mintKeeper    keeper.Keeper
-	ctx           sdk.Context
-	msgServer     types.MsgServer
-	stakingKeeper *minttestutil.MockStakingKeeper
-	bankKeeper    *minttestutil.MockBankKeeper
+	mintKeeper keeper.Keeper
+	ctx        sdk.Context
+	msgServer  types.MsgServer
+	bankKeeper *minttestutil.MockBankKeeper
 }
 
 func TestKeeperTestSuite(t *testing.T) {
@@ -50,20 +49,17 @@ func (s *IntegrationTestSuite) SetupTest() {
 	ctrl := gomock.NewController(s.T())
 	accountKeeper := minttestutil.NewMockAccountKeeper(ctrl)
 	bankKeeper := minttestutil.NewMockBankKeeper(ctrl)
-	stakingKeeper := minttestutil.NewMockStakingKeeper(ctrl)
 
 	accountKeeper.EXPECT().GetModuleAddress(types.ModuleName).Return(sdk.AccAddress{})
 
 	s.mintKeeper = keeper.NewKeeper(
 		encCfg.Codec,
 		env,
-		stakingKeeper,
 		accountKeeper,
 		bankKeeper,
 		authtypes.FeeCollectorName,
 		govModuleNameStr,
 	)
-	s.stakingKeeper = stakingKeeper
 	s.bankKeeper = bankKeeper
 
 	err := s.mintKeeper.Params.Set(s.ctx, types.DefaultParams())
@@ -74,18 +70,6 @@ func (s *IntegrationTestSuite) SetupTest() {
 }
 
 func (s *IntegrationTestSuite) TestAliasFunctions() {
-	stakingTokenSupply := math.NewIntFromUint64(100000000000)
-	s.stakingKeeper.EXPECT().StakingTokenSupply(s.ctx).Return(stakingTokenSupply, nil)
-	tokenSupply, err := s.mintKeeper.StakingTokenSupply(s.ctx)
-	s.Require().NoError(err)
-	s.Require().Equal(tokenSupply, stakingTokenSupply)
-
-	bondedRatio := math.LegacyNewDecWithPrec(15, 2)
-	s.stakingKeeper.EXPECT().BondedRatio(s.ctx).Return(bondedRatio, nil)
-	ratio, err := s.mintKeeper.BondedRatio(s.ctx)
-	s.Require().NoError(err)
-	s.Require().Equal(ratio, bondedRatio)
-
 	coins := sdk.NewCoins(sdk.NewCoin("stake", math.NewInt(1000000)))
 	s.bankKeeper.EXPECT().MintCoins(s.ctx, types.ModuleName, coins).Return(nil)
 	s.Require().Equal(s.mintKeeper.MintCoins(s.ctx, sdk.NewCoins()), nil)