refactor(x/mint): remove unused parameter from AfterDistributeMintedC…

…oin (backport #2390) (#2396) Co-authored-by: Roman <[email protected]>
osmosis-labs · Aug 13, 2022 · bd41740 · bd41740
1 parent f012c56
commit bd41740
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -45,6 +45,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### Golang API breaks
 
 * [#1893](https://github.com/osmosis-labs/osmosis/pull/1893) Change `EpochsKeeper.SetEpochInfo` to `AddEpochInfo`, which has more safety checks with it. (Makes it suitable to be called within upgrades)
+* [#2396](https://github.com/osmosis-labs/osmosis/pull/2396) x/mint remove unused mintCoins parameter from AfterDistributeMintedCoin
 
 #### Bug Fixes
 * [2291](https://github.com/osmosis-labs/osmosis/pull/2291) Remove liquidity event that was emitted twice per message.

diff --git a/x/mint/keeper/keeper.go b/x/mint/keeper/keeper.go
@@ -229,7 +229,7 @@ func (k Keeper) DistributeMintedCoin(ctx sdk.Context, mintedCoin sdk.Coin) error
 	}
 
 	// call an hook after the minting and distribution of new coins
-	k.hooks.AfterDistributeMintedCoin(ctx, mintedCoin)
+	k.hooks.AfterDistributeMintedCoin(ctx)
 
 	return err
 }

diff --git a/x/mint/keeper/keeper_test.go b/x/mint/keeper/keeper_test.go
@@ -29,7 +29,7 @@ type mintHooksMock struct {
 	hookCallCount int
 }
 
-func (hm *mintHooksMock) AfterDistributeMintedCoin(ctx sdk.Context, mintedCoin sdk.Coin) {
+func (hm *mintHooksMock) AfterDistributeMintedCoin(ctx sdk.Context) {
 	hm.hookCallCount++
 }
 

diff --git a/x/mint/types/hooks.go b/x/mint/types/hooks.go
@@ -5,7 +5,7 @@ import (
 )
 
 type MintHooks interface {
-	AfterDistributeMintedCoin(ctx sdk.Context, mintedCoin sdk.Coin)
+	AfterDistributeMintedCoin(ctx sdk.Context)
 }
 
 var _ MintHooks = MultiMintHooks{}
@@ -17,8 +17,10 @@ func NewMultiMintHooks(hooks ...MintHooks) MultiMintHooks {
 	return hooks
 }
 
-func (h MultiMintHooks) AfterDistributeMintedCoin(ctx sdk.Context, mintedCoin sdk.Coin) {
+// AfterDistributeMintedCoin is a hook that runs after minter mints and distributes coins
+// at the beginning of each epoch.
+func (h MultiMintHooks) AfterDistributeMintedCoin(ctx sdk.Context) {
 	for i := range h {
-		h[i].AfterDistributeMintedCoin(ctx, mintedCoin)
+		h[i].AfterDistributeMintedCoin(ctx)
 	}
 }
diff --git a/x/pool-incentives/keeper/hooks.go b/x/pool-incentives/keeper/hooks.go
@@ -36,7 +36,7 @@ func (h Hooks) AfterSwap(ctx sdk.Context, sender sdk.AccAddress, poolId uint64,
 }
 
 // Distribute coins after minter module allocate assets to pool-incentives module.
-func (h Hooks) AfterDistributeMintedCoin(ctx sdk.Context, mintedCoin sdk.Coin) {
+func (h Hooks) AfterDistributeMintedCoin(ctx sdk.Context) {
 	// @Sunny, @Tony, @Dev, what comments should we keep after modifying own BeginBlocker to hooks?
 
 	// WARNING: The order of how modules interact with the default distribution module matters if the distribution module is used in a similar way to: