refactor(x/mint): remove unused parameter from AfterDistributeMintedCoin (backport #2390) (#2396)

mergify[bot] · p0mvn · web-flow · commit bd4174096d19 · 2022-08-12T19:06:19.000-07:00
Co-authored-by: Roman &lt;ackhtariev@gmail.com&gt;
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:

Original file line number	Diff line number	Diff line change
`@@ -229,7 +229,7 @@ func (k Keeper) DistributeMintedCoin(ctx sdk.Context, mintedCoin sdk.Coin) error`
`229`	`229`	`}`
`230`	`230`
`231`	`231`	`// call an hook after the minting and distribution of new coins`
`232`		`- k.hooks.AfterDistributeMintedCoin(ctx, mintedCoin)`
	`232`	`+ k.hooks.AfterDistributeMintedCoin(ctx)`
`233`	`233`
`234`	`234`	`return err`
`235`	`235`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ type mintHooksMock struct {`
`29`	`29`	`hookCallCount int`
`30`	`30`	`}`
`31`	`31`
`32`		`-func (hm *mintHooksMock) AfterDistributeMintedCoin(ctx sdk.Context, mintedCoin sdk.Coin) {`
	`32`	`+func (hm *mintHooksMock) AfterDistributeMintedCoin(ctx sdk.Context) {`
`33`	`33`	`hm.hookCallCount++`
`34`	`34`	`}`
`35`	`35`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import (`
`5`	`5`	`)`
`6`	`6`
`7`	`7`	`type MintHooks interface {`
`8`		`- AfterDistributeMintedCoin(ctx sdk.Context, mintedCoin sdk.Coin)`
	`8`	`+ AfterDistributeMintedCoin(ctx sdk.Context)`
`9`	`9`	`}`
`10`	`10`
`11`	`11`	`var _ MintHooks = MultiMintHooks{}`
`@@ -17,8 +17,10 @@ func NewMultiMintHooks(hooks ...MintHooks) MultiMintHooks {`
`17`	`17`	`return hooks`
`18`	`18`	`}`
`19`	`19`
`20`		`-func (h MultiMintHooks) AfterDistributeMintedCoin(ctx sdk.Context, mintedCoin sdk.Coin) {`
	`20`	`+// AfterDistributeMintedCoin is a hook that runs after minter mints and distributes coins`
	`21`	`+// at the beginning of each epoch.`
	`22`	`+func (h MultiMintHooks) AfterDistributeMintedCoin(ctx sdk.Context) {`
`21`	`23`	`for i := range h {`
`22`		`- h[i].AfterDistributeMintedCoin(ctx, mintedCoin)`
	`24`	`+ h[i].AfterDistributeMintedCoin(ctx)`
`23`	`25`	`}`
`24`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ func (h Hooks) AfterSwap(ctx sdk.Context, sender sdk.AccAddress, poolId uint64,`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`// Distribute coins after minter module allocate assets to pool-incentives module.`
`39`		`-func (h Hooks) AfterDistributeMintedCoin(ctx sdk.Context, mintedCoin sdk.Coin) {`
	`39`	`+func (h Hooks) AfterDistributeMintedCoin(ctx sdk.Context) {`
`40`	`40`	`// @Sunny, @Tony, @Dev, what comments should we keep after modifying own BeginBlocker to hooks?`
`41`	`41`
`42`	`42`	`// WARNING: The order of how modules interact with the default distribution module matters if the distribution module is used in a similar way to:`