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

p0mvn · web-flow · commit 253098715018 · 2022-08-12T18:23:42.000-07:00
* refactor(x/mint): remove unused parameter from AfterDistributeMintedCoin

* remove param from mint hook mock

* changelog
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -72,6 +72,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * [#1667](https://github.com/osmosis-labs/osmosis/pull/1673) Move wasm-bindings code out of app package into its own root level package.
 * [#2013](https://github.com/osmosis-labs/osmosis/pull/2013) Make `SetParams`, `SetPool`, `SetTotalLiquidity`, and `SetDenomLiquidity` GAMM APIs private
 * [#1857](https://github.com/osmosis-labs/osmosis/pull/1857) x/mint rename GetLastHalvenEpochNum to GetLastReductionEpochNum
+* [#2390](https://github.com/osmosis-labs/osmosis/pull/2390) x/mint remove unused mintCoins parameter from AfterDistributeMintedCoin
 
 ### Features
 
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
@@ -6,7 +6,7 @@ import (
 
 // MintHooks defines an interface for mint module's hooks.
 type MintHooks interface {
-	AfterDistributeMintedCoin(ctx sdk.Context, mintedCoin sdk.Coin)
+	AfterDistributeMintedCoin(ctx sdk.Context)
 }
 
 var _ MintHooks = MultiMintHooks{}
@@ -22,8 +22,8 @@ func NewMultiMintHooks(hooks ...MintHooks) MultiMintHooks {
 
 // 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, mintedCoin sdk.Coin) {
+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
@@ -40,7 +40,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
`@@ -6,7 +6,7 @@ import (`
`6`	`6`
`7`	`7`	`// MintHooks defines an interface for mint module's hooks.`
`8`	`8`	`type MintHooks interface {`
`9`		`- AfterDistributeMintedCoin(ctx sdk.Context, mintedCoin sdk.Coin)`
	`9`	`+ AfterDistributeMintedCoin(ctx sdk.Context)`
`10`	`10`	`}`
`11`	`11`
`12`	`12`	`var _ MintHooks = MultiMintHooks{}`
`@@ -22,8 +22,8 @@ func NewMultiMintHooks(hooks ...MintHooks) MultiMintHooks {`
`22`	`22`
`23`	`23`	`// AfterDistributeMintedCoin is a hook that runs after minter mints and distributes coins`
`24`	`24`	`// at the beginning of each epoch.`
`25`		`-func (h MultiMintHooks) AfterDistributeMintedCoin(ctx sdk.Context, mintedCoin sdk.Coin) {`
	`25`	`+func (h MultiMintHooks) AfterDistributeMintedCoin(ctx sdk.Context) {`
`26`	`26`	`for i := range h {`
`27`		`- h[i].AfterDistributeMintedCoin(ctx, mintedCoin)`
	`27`	`+ h[i].AfterDistributeMintedCoin(ctx)`
`28`	`28`	`}`
`29`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ func (h Hooks) AfterSwap(ctx sdk.Context, sender sdk.AccAddress, poolId uint64,`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`// Distribute coins after minter module allocate assets to pool-incentives module.`
`43`		`-func (h Hooks) AfterDistributeMintedCoin(ctx sdk.Context, mintedCoin sdk.Coin) {`
	`43`	`+func (h Hooks) AfterDistributeMintedCoin(ctx sdk.Context) {`
`44`	`44`	`// @Sunny, @Tony, @Dev, what comments should we keep after modifying own BeginBlocker to hooks?`
`45`	`45`
`46`	`46`	`// WARNING: The order of how modules interact with the default distribution module matters if the distribution module is used in a similar way to:`