optimize incentive

Author: keithsue

x/btcbridge/keeper/deposit.go

@@ -25,9 +25,9 @@ func (k Keeper) ProcessBitcoinDepositTransaction(ctx sdk.Context, msg *types.Msg
 		return nil, nil, err
 	}
 
-	// distribute deposit reward
-	if k.incentiveKeeper.IncentiveEnabled(ctx) {
-		_ = k.incentiveKeeper.DistributeDepositReward(ctx, recipient.EncodeAddress())
+	// hook
+	if err := k.AfterDeposit(ctx, recipient.EncodeAddress()); err != nil {
+		return nil, nil, err
 	}
 
 	return tx.Hash(), recipient, nil

x/btcbridge/keeper/hooks.go

@@ -0,0 +1,28 @@
+package keeper
+
+import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
+)
+
+// AfterDeposit performs the extended logic after deposit
+func (k Keeper) AfterDeposit(ctx sdk.Context, addr string) error {
+	// distribute deposit reward
+	if k.incentiveKeeper.DepositIncentiveEnabled(ctx) {
+		_ = k.incentiveKeeper.DistributeDepositReward(ctx, addr)
+	}
+
+	return nil
+}
+
+// AfterWithdraw performs the extended logic after withdrawal
+func (k Keeper) AfterWithdraw(ctx sdk.Context, txHash string) error {
+	// distribute rewards for all withdrawals
+	if k.incentiveKeeper.WithdrawIncentiveEnabled(ctx) {
+		withdrawRequests := k.GetWithdrawRequestsByTxHash(ctx, txHash)
+		for _, req := range withdrawRequests {
+			_ = k.incentiveKeeper.DistributeWithdrawReward(ctx, req.Address)
+		}
+	}
+
+	return nil
+}

x/btcbridge/keeper/withdraw.go

@@ -606,12 +606,9 @@ func (k Keeper) ProcessBitcoinWithdrawTransaction(ctx sdk.Context, msg *types.Ms
 	// unlock the change utxos
 	k.unlockChangeUTXOs(ctx, txHash.String())
 
-	// distribute rewards for all withdrawals
-	if k.incentiveKeeper.IncentiveEnabled(ctx) {
-		withdrawRequests := k.GetWithdrawRequestsByTxHash(ctx, txHash.String())
-		for _, req := range withdrawRequests {
-			_ = k.incentiveKeeper.DistributeWithdrawReward(ctx, req.Address)
-		}
+	// hook
+	if err := k.AfterWithdraw(ctx, txHash.String()); err != nil {
+		return nil, err
 	}
 
 	return txHash, nil

x/btcbridge/types/expected_keepers.go

@@ -42,7 +42,8 @@ type StakingKeeper interface {
 
 // IncentiveKeeper defines the expected incentive keeper
 type IncentiveKeeper interface {
-	IncentiveEnabled(ctx sdk.Context) bool
+	DepositIncentiveEnabled(ctx sdk.Context) bool
+	WithdrawIncentiveEnabled(ctx sdk.Context) bool
 
 	DistributeDepositReward(ctx sdk.Context, addr string) error
 	DistributeWithdrawReward(ctx sdk.Context, addr string) error

x/incentive/keeper/params.go

@@ -12,6 +12,16 @@ func (k Keeper) IncentiveEnabled(ctx sdk.Context) bool {
 	return k.GetParams(ctx).Enabled && !k.bankKeeper.SpendableCoins(ctx, authtypes.NewModuleAddress(types.ModuleName)).IsZero()
 }
 
+// DepositIncentiveEnabled returns true if the incentive is enabled for deposit, false otherwise
+func (k Keeper) DepositIncentiveEnabled(ctx sdk.Context) bool {
+	return k.IncentiveEnabled(ctx) && k.RewardPerDeposit(ctx).IsPositive() && k.bankKeeper.GetBalance(ctx, authtypes.NewModuleAddress(types.ModuleName), k.DepositRewardDenom(ctx)).IsPositive()
+}
+
+// WithdrawIncentiveEnabled returns true if the incentive is enabled for withdrawal, false otherwise
+func (k Keeper) WithdrawIncentiveEnabled(ctx sdk.Context) bool {
+	return k.IncentiveEnabled(ctx) && k.RewardPerWithdraw(ctx).IsPositive() && k.bankKeeper.GetBalance(ctx, authtypes.NewModuleAddress(types.ModuleName), k.WithdrawRewardDenom(ctx)).IsPositive()
+}
+
 // RewardPerDeposit returns the reward amount for each deposit
 func (k Keeper) RewardPerDeposit(ctx sdk.Context) sdk.Coin {
 	return k.GetParams(ctx).RewardPerDeposit
@@ -21,3 +31,13 @@ func (k Keeper) RewardPerDeposit(ctx sdk.Context) sdk.Coin {
 func (k Keeper) RewardPerWithdraw(ctx sdk.Context) sdk.Coin {
 	return k.GetParams(ctx).RewardPerWithdraw
 }
+
+// DepositRewardDenom returns the denom for deposit reward
+func (k Keeper) DepositRewardDenom(ctx sdk.Context) string {
+	return k.GetParams(ctx).RewardPerDeposit.Denom
+}
+
+// WithdrawRewardDenom returns the denom for withdrawal reward
+func (k Keeper) WithdrawRewardDenom(ctx sdk.Context) string {
+	return k.GetParams(ctx).RewardPerWithdraw.Denom
+}

x/incentive/keeper/reward.go

@@ -78,8 +78,8 @@ func (k Keeper) UpdateTotalRewards(ctx sdk.Context, delta sdk.Coin) {
 
 // DistributeDepositReward distributes reward for deposit
 func (k Keeper) DistributeDepositReward(ctx sdk.Context, address string) error {
-	if !k.IncentiveEnabled(ctx) {
-		return types.ErrIncentiveNotEnabled
+	if !k.DepositIncentiveEnabled(ctx) {
+		return types.ErrDepositIncentiveNotEnabled
 	}
 
 	rewardAmount := k.RewardPerDeposit(ctx)
@@ -96,8 +96,8 @@ func (k Keeper) DistributeDepositReward(ctx sdk.Context, address string) error {
 
 // DistributeWithdrawReward distributes reward for withdrawal
 func (k Keeper) DistributeWithdrawReward(ctx sdk.Context, address string) error {
-	if !k.IncentiveEnabled(ctx) {
-		return types.ErrIncentiveNotEnabled
+	if !k.WithdrawIncentiveEnabled(ctx) {
+		return types.ErrWithdrawIncentiveNotEnabled
 	}
 
 	rewardAmount := k.RewardPerWithdraw(ctx)

x/incentive/types/errors.go

@@ -8,6 +8,7 @@ import (
 
 // x/incentive module sentinel errors
 var (
-	ErrIncentiveNotEnabled = errorsmod.Register(ModuleName, 1001, "incentive not enabled")
-	ErrInvalidParams       = errorsmod.Register(ModuleName, 1002, "invalid params")
+	ErrDepositIncentiveNotEnabled  = errorsmod.Register(ModuleName, 1001, "incentive not enabled for deposit")
+	ErrWithdrawIncentiveNotEnabled = errorsmod.Register(ModuleName, 1002, "incentive not enabled for withdrawal")
+	ErrInvalidParams               = errorsmod.Register(ModuleName, 1003, "invalid params")
 )

x/incentive/types/params.go

@@ -29,11 +29,11 @@ func DefaultParams() Params {
 
 // Validate validates the set of params
 func (p Params) Validate() error {
-	if !p.RewardPerDeposit.IsValid() || !p.RewardPerDeposit.IsPositive() {
+	if !p.RewardPerDeposit.IsValid() {
 		return errorsmod.Wrap(ErrInvalidParams, "invalid deposit reward")
 	}
 
-	if !p.RewardPerDeposit.IsValid() || !p.RewardPerDeposit.IsPositive() {
+	if !p.RewardPerWithdraw.IsValid() {
 		return errorsmod.Wrap(ErrInvalidParams, "invalid withdrawal reward")
 	}