cleanup trading reward candidates after expiration

bze-alphateam · Apr 8, 2024 · 749f148 · 749f148
1 parent 2511be4
commit 749f148
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/x/rewards/keeper/trading_reward_distribution.go b/x/rewards/keeper/trading_reward_distribution.go
@@ -25,6 +25,7 @@ func (k Keeper) distributeTradingRewards(ctx sdk.Context, epochNumber int64) {
 			k.RemoveActiveTradingRewardExpiration(ctx, exp.ExpireAt, exp.RewardId)
 			k.RemoveActiveTradingReward(ctx, exp.RewardId)
 			k.RemoveTradingRewardLeaderboard(ctx, exp.RewardId)
+			k.cleanupTradingRewardCandidates(ctx, exp.RewardId)
 
 			continue
 		}
@@ -57,3 +58,10 @@ func (k Keeper) distributeTradingRewards(ctx sdk.Context, epochNumber int64) {
 		k.SetActiveTradingRewardExpiration(ctx, exp)
 	}
 }
+
+func (k Keeper) cleanupTradingRewardCandidates(ctx sdk.Context, rewardId string) {
+	toRemove := k.GetTradingRewardCandidateByRewardId(ctx, rewardId)
+	for _, trc := range toRemove {
+		k.RemoveTradingRewardCandidate(ctx, trc.RewardId, trc.Address)
+	}
+}
diff --git a/x/rewards/keeper/trading_reward_leaderboard.go b/x/rewards/keeper/trading_reward_leaderboard.go
@@ -66,6 +66,11 @@ func (k Keeper) GetTradingRewardCandidate(ctx sdk.Context, rewardId, address str
 	return val, true
 }
 
+func (k Keeper) RemoveTradingRewardCandidate(ctx sdk.Context, rewardId, address string) {
+	store := prefix.NewStore(ctx.KVStore(k.storeKey), types.KeyPrefix(types.RewardCandidateKeyPrefix))
+	store.Delete(types.TradingRewardCandidateKey(rewardId, address))
+}
+
 // GetAllTradingRewardCandidate returns all []types.TradingRewardCandidate
 func (k Keeper) GetAllTradingRewardCandidate(ctx sdk.Context) (list []types.TradingRewardCandidate) {
 	store := prefix.NewStore(ctx.KVStore(k.storeKey), types.KeyPrefix(types.RewardCandidateKeyPrefix))
@@ -81,3 +86,19 @@ func (k Keeper) GetAllTradingRewardCandidate(ctx sdk.Context) (list []types.Trad
 
 	return
 }
+
+// GetTradingRewardCandidateByRewardId returns all []types.TradingRewardCandidate for a rewardId
+func (k Keeper) GetTradingRewardCandidateByRewardId(ctx sdk.Context, rewardId string) (list []types.TradingRewardCandidate) {
+	store := prefix.NewStore(ctx.KVStore(k.storeKey), types.KeyPrefix(types.RewardCandidateKeyPrefix))
+	iterator := sdk.KVStorePrefixIterator(store, []byte(rewardId+"/"))
+
+	defer iterator.Close()
+
+	for ; iterator.Valid(); iterator.Next() {
+		var val types.TradingRewardCandidate
+		k.cdc.MustUnmarshal(iterator.Value(), &val)
+		list = append(list, val)
+	}
+
+	return
+}