optimize reward distribution

Author: keithsue

x/incentive/keeper/params.go

@@ -2,11 +2,14 @@ package keeper
 
 import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
+
+	"github.com/sideprotocol/side/x/incentive/types"
 )
 
 // IncentiveEnabled returns true if the incentive mechanism is enabled, false otherwise
 func (k Keeper) IncentiveEnabled(ctx sdk.Context) bool {
-	return k.GetParams(ctx).Enabled
+	return k.GetParams(ctx).Enabled && !k.bankKeeper.SpendableCoins(ctx, authtypes.NewModuleAddress(types.ModuleName)).IsZero()
 }
 
 // RewardPerDeposit returns the reward amount for each deposit

x/incentive/keeper/reward.go

@@ -6,6 +6,17 @@ import (
 	"github.com/sideprotocol/side/x/incentive/types"
 )
 
+// GetReward gets the reward of the given address
+func (k Keeper) GetReward(ctx sdk.Context, address string) *types.Reward {
+	store := ctx.KVStore(k.storeKey)
+
+	var reward types.Reward
+	bz := store.Get(types.RewardKey(address))
+	k.cdc.MustUnmarshal(bz, &reward)
+
+	return &reward
+}
+
 // SetReward sets the given reward
 func (k Keeper) SetReward(ctx sdk.Context, reward *types.Reward) {
 	store := ctx.KVStore(k.storeKey)
@@ -15,35 +26,46 @@ func (k Keeper) SetReward(ctx sdk.Context, reward *types.Reward) {
 	store.Set(types.RewardKey(reward.Address), bz)
 }
 
-// GetReward gets the reward of the given address
-func (k Keeper) GetReward(ctx sdk.Context, address string) *types.Reward {
-	store := ctx.KVStore(k.storeKey)
+// AddDepositReward adds the deposit reward for the specified address by the given amount
+func (k Keeper) AddDepositReward(ctx sdk.Context, address string, amount sdk.Coin) {
+	reward := k.GetReward(ctx, address)
 
-	var reward types.Reward
-	bz := store.Get(types.RewardKey(address))
-	k.cdc.MustUnmarshal(bz, &reward)
+	reward.Address = address
+	reward.DepositCount += 1
+	reward.TotalAmount = amount.AddAmount(reward.TotalAmount.Amount)
 
-	return &reward
+	k.SetReward(ctx, reward)
 }
 
-// SetTotalRewards sets the total rewards
-func (k Keeper) SetTotalRewards(ctx sdk.Context, totalRewards sdk.Coin) {
-	store := ctx.KVStore(k.storeKey)
+// AddWithdrawReward adds the withdrawal reward for the specified address by the given amount
+func (k Keeper) AddWithdrawReward(ctx sdk.Context, address string, amount sdk.Coin) {
+	reward := k.GetReward(ctx, address)
 
-	bz := k.cdc.MustMarshal(&totalRewards)
+	reward.Address = address
+	reward.WithdrawCount += 1
+	reward.TotalAmount = amount.AddAmount(reward.TotalAmount.Amount)
 
-	store.Set(types.TotalRewardsKey, bz)
+	k.SetReward(ctx, reward)
 }
 
 // GetTotalRewards gets the total rewards
 func (k Keeper) GetTotalRewards(ctx sdk.Context) sdk.Coin {
 	store := ctx.KVStore(k.storeKey)
 
-	var rewards sdk.Coin
+	var totalRewards sdk.Coin
 	bz := store.Get(types.TotalRewardsKey)
-	k.cdc.MustUnmarshal(bz, &rewards)
+	k.cdc.MustUnmarshal(bz, &totalRewards)
+
+	return totalRewards
+}
+
+// SetTotalRewards sets the total rewards
+func (k Keeper) SetTotalRewards(ctx sdk.Context, totalRewards sdk.Coin) {
+	store := ctx.KVStore(k.storeKey)
 
-	return rewards
+	bz := k.cdc.MustMarshal(&totalRewards)
+
+	store.Set(types.TotalRewardsKey, bz)
 }
 
 // UpdateTotalRewards updates the total rewards by delta
@@ -57,45 +79,35 @@ 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 nil
+		return types.ErrIncentiveNotEnabled
 	}
 
-	if err := k.bankKeeper.SendCoinsFromModuleToAccount(ctx, types.ModuleName, sdk.MustAccAddressFromBech32(address), sdk.NewCoins(k.RewardPerDeposit(ctx))); err != nil {
-		// ignore error
-		return nil
-	}
+	rewardAmount := k.RewardPerDeposit(ctx)
 
-	reward := k.GetReward(ctx, address)
-
-	reward.Address = address
-	reward.DepositCount += 1
-	reward.TotalAmount = k.RewardPerDeposit(ctx).AddAmount(reward.TotalAmount.Amount)
+	if err := k.bankKeeper.SendCoinsFromModuleToAccount(ctx, types.ModuleName, sdk.MustAccAddressFromBech32(address), sdk.NewCoins(rewardAmount)); err != nil {
+		return err
+	}
 
-	k.SetReward(ctx, reward)
-	k.UpdateTotalRewards(ctx, k.RewardPerDeposit(ctx))
+	k.AddDepositReward(ctx, address, rewardAmount)
+	k.UpdateTotalRewards(ctx, rewardAmount)
 
 	return nil
 }
 
 // DistributeWithdrawReward distributes reward for withdrawal
 func (k Keeper) DistributeWithdrawReward(ctx sdk.Context, address string) error {
 	if !k.IncentiveEnabled(ctx) {
-		return nil
+		return types.ErrIncentiveNotEnabled
 	}
 
-	if err := k.bankKeeper.SendCoinsFromModuleToAccount(ctx, types.ModuleName, sdk.MustAccAddressFromBech32(address), sdk.NewCoins(k.RewardPerWithdraw(ctx))); err != nil {
-		// ignore error
-		return nil
-	}
+	rewardAmount := k.RewardPerWithdraw(ctx)
 
-	reward := k.GetReward(ctx, address)
-
-	reward.Address = address
-	reward.WithdrawCount += 1
-	reward.TotalAmount = k.RewardPerWithdraw(ctx).AddAmount(reward.TotalAmount.Amount)
+	if err := k.bankKeeper.SendCoinsFromModuleToAccount(ctx, types.ModuleName, sdk.MustAccAddressFromBech32(address), sdk.NewCoins(rewardAmount)); err != nil {
+		return err
+	}
 
-	k.SetReward(ctx, reward)
-	k.UpdateTotalRewards(ctx, k.RewardPerWithdraw(ctx))
+	k.AddWithdrawReward(ctx, address, rewardAmount)
+	k.UpdateTotalRewards(ctx, rewardAmount)
 
 	return nil
 }

x/incentive/types/errors.go

@@ -8,5 +8,6 @@ import (
 
 // x/incentive module sentinel errors
 var (
-	ErrInvalidParams = errorsmod.Register(ModuleName, 1001, "invalid params")
+	ErrIncentiveNotEnabled = errorsmod.Register(ModuleName, 1001, "incentive not enabled")
+	ErrInvalidParams       = errorsmod.Register(ModuleName, 1002, "invalid params")
 )