osmosis-labs · AlpinYukseloglu · Mar 15, 2023 · Jan 26, 2023 · Jan 26, 2023 · Jan 26, 2023
diff --git a/go.work.sum b/go.work.sum
@@ -326,6 +326,8 @@ github.com/GoogleCloudPlatform/cloudsql-proxy v0.0.0-20191009163259-e802c2cb94ae
 github.com/GoogleCloudPlatform/k8s-cloud-provider v0.0.0-20190822182118-27a4ced34534/go.mod h1:iroGtC8B3tQiqtds1l+mgk/BBOrxbqjH+eUfFQYRc14=
 github.com/HdrHistogram/hdrhistogram-go v1.1.0/go.mod h1:yDgFjdqOqDEKOvasDdhWNXYg9BVp4O+o5f6V/ehm6Oo=
 github.com/HdrHistogram/hdrhistogram-go v1.1.2/go.mod h1:yDgFjdqOqDEKOvasDdhWNXYg9BVp4O+o5f6V/ehm6Oo=
+github.com/Jeffail/gabs/v2 v2.6.0 h1:WdCnGaDhNa4LSRTMwhLZzJ7SRDXjABNP13SOKvCpL5w=
+github.com/Jeffail/gabs/v2 v2.6.0/go.mod h1:xCn81vdHKxFUuWWAaD5jCTQDNPBMh5pPs9IJ+NcziBI=
 github.com/Masterminds/goutils v1.1.0/go.mod h1:8cTjp+g8YejhMuvIA5y2vz3BpJxksy863GQaJW2MFNU=
 github.com/Masterminds/semver v1.4.2/go.mod h1:MB6lktGJrhw8PrUyiEoblNEGEQ+RzHPF078ddwwvV3Y=
 github.com/Masterminds/semver/v3 v3.0.3/go.mod h1:VPu/7SZ7ePZ3QOrcuXROw5FAcLl4a0cBrbBpGY/8hQs=

@@ -243,3 +243,11 @@ func GetUptimeTrackerValues(uptimeTrackers []model.UptimeTracker) []sdk.DecCoins
 func (k Keeper) CreateIncentive(ctx sdk.Context, poolId uint64, sender sdk.AccAddress, incentiveDenom string, incentiveAmount sdk.Int, emissionRate sdk.Dec, startTime time.Time, minUptime time.Duration) (types.IncentiveRecord, error) {
 	return k.createIncentive(ctx, poolId, sender, incentiveDenom, incentiveAmount, emissionRate, startTime, minUptime)
 }
+
+func PrepareAccumAndClaimRewards(accum accum.AccumulatorObject, positionKey string, growthOutside sdk.DecCoins) (sdk.Coins, error) {
+	return prepareAccumAndClaimRewards(accum, positionKey, growthOutside)
+}
+
+func (k Keeper) ClaimAllIncentivesForPosition(ctx sdk.Context, poolId uint64, owner sdk.AccAddress, lowerTick int64, upperTick int64, joinTime time.Time, freezeDuration time.Duration, forfeitIncentives bool) (sdk.Coins, error) {
+	return k.claimAllIncentivesForPosition(ctx, poolId, owner, lowerTick, upperTick, joinTime, freezeDuration, forfeitIncentives)
+}
@@ -17,9 +17,7 @@ const (
 	uintBase       = 10
 )
 
-var (
-	emptyCoins = sdk.DecCoins(nil)
-)
+var emptyCoins = sdk.DecCoins(nil)
 
 // createFeeAccumulator creates an accumulator object in the store using the given poolId.
 // The accumulator is initialized with the default(zero) values.
@@ -216,32 +214,11 @@ func (k Keeper) collectFees(ctx sdk.Context, poolId uint64, owner sdk.AccAddress
 		return sdk.Coins{}, err
 	}
 
-	// replace position's accumulator before calculating unclaimed rewards
-	err = preparePositionAccumulator(feeAccumulator, positionKey, feeGrowthOutside)
-	if err != nil {
-		return sdk.Coins{}, err
-	}
-
-	// claim fees.
-	feesClaimed, err := feeAccumulator.ClaimRewards(positionKey)
-	if err != nil {
-		return sdk.Coins{}, err
-	}
-
-	// Check if feeAccumulator was deleted after claiming rewards. If not, we update the custom accumulator value.
-	hasPosition, err = feeAccumulator.HasPosition(positionKey)
+	feesClaimed, err := prepareAccumAndClaimRewards(feeAccumulator, positionKey, feeGrowthOutside)
 	if err != nil {
 		return sdk.Coins{}, err
 	}
 
-	if hasPosition {
-		customAccumulatorValue := feeAccumulator.GetValue().Sub(feeGrowthOutside)
-		err := feeAccumulator.SetPositionCustomAcc(positionKey, customAccumulatorValue)
-		if err != nil {
-			return sdk.Coins{}, err
-		}
-	}
-
 	// Once we have iterated through all the positions, we do a single bank send from the pool to the owner.
 	pool, err := k.getPoolById(ctx, poolId)
 	if err != nil {

@@ -416,28 +416,44 @@ func (k Keeper) initOrUpdatePositionUptime(ctx sdk.Context, poolId uint64, liqui
 	return nil
 }
 
-// collectIncentives collects incentives for all uptime accumulators for all positions belonging to `owner` that have exactly
-// the same lower and upper ticks.
-//
-// Upon successful collection, it bank sends the incentives from the pool address to the owner and returns the collected coins.
-// Returns error if:
-// - pool with the given id does not exist
-// - no position given by pool id, owner, lower tick and upper tick exists
-// - other internal database or math errors.
-func (k Keeper) collectIncentives(ctx sdk.Context, poolId uint64, owner sdk.AccAddress, lowerTick int64, upperTick int64) (sdk.Coins, error) {
-	uptimeAccumulators, err := k.getUptimeAccumulators(ctx, poolId)
+// prepareAccumAndClaimRewards claims and returns the rewards that `positionKey` is entitled to, updating the accumulator's value before
+// and after claiming to ensure that rewards are never overdistributed.
+func prepareAccumAndClaimRewards(accum accum.AccumulatorObject, positionKey string, growthOutside sdk.DecCoins) (sdk.Coins, error) {
+	err := preparePositionAccumulator(accum, positionKey, growthOutside)
 	if err != nil {
 		return sdk.Coins{}, err
 	}
 
-	// Get all of owner's positions with the same lower and upper ticks
-	positionsInRange, err := osmoutils.GatherValuesFromStorePrefixWithKeyParser(ctx.KVStore(k.storeKey), types.KeyPosition(poolId, owner, lowerTick, upperTick), ParseFullPositionFromBytes)
+	// Claim incentives
+	incentivesClaimedCurrAccum, err := accum.ClaimRewards(positionKey)
 	if err != nil {
 		return sdk.Coins{}, err
 	}
 
-	if len(positionsInRange) == 0 {
-		return sdk.Coins{}, types.PositionNotFoundError{PoolId: poolId, LowerTick: lowerTick, UpperTick: upperTick}
+	// Check if position record was deleted after claiming rewards. If not, we update the custom accumulator value.
+	hasPosition, err := accum.HasPosition(positionKey)
+	if err != nil {
+		return sdk.Coins{}, err
+	}
+
+	if hasPosition {
+		customAccumulatorValue := accum.GetValue().Sub(growthOutside)
+		err := accum.SetPositionCustomAcc(positionKey, customAccumulatorValue)
+		if err != nil {
+			return sdk.Coins{}, err
+		}
+	}
+
+	return incentivesClaimedCurrAccum, nil
+}
+
+// claimAllIncentivesForPosition claims and returns all the incentives for a given position.
+// It takes in a `forfeitIncentives` boolean to indicate whether the accrued incentives should be forfeited, in which case it
+// redeposits the accrued rewards back into the accumulator as additional rewards for other participants.
+func (k Keeper) claimAllIncentivesForPosition(ctx sdk.Context, poolId uint64, owner sdk.AccAddress, lowerTick int64, upperTick int64, joinTime time.Time, freezeDuration time.Duration, forfeitIncentives bool) (sdk.Coins, error) {
+	uptimeAccumulators, err := k.getUptimeAccumulators(ctx, poolId)
+	if err != nil {
+		return sdk.Coins{}, err
 	}
 
 	// Compute uptime growth outside of the range between lower tick and upper tick
@@ -446,52 +462,67 @@ func (k Keeper) collectIncentives(ctx sdk.Context, poolId uint64, owner sdk.AccA
 		return sdk.Coins{}, err
 	}
 
-	collectedIncentives := sdk.Coins{}
-	for _, position := range positionsInRange {
-		positionName := string(types.KeyFullPosition(poolId, owner, lowerTick, upperTick, position.JoinTime, position.FreezeDuration))
+	positionName := string(types.KeyFullPosition(poolId, owner, lowerTick, upperTick, joinTime, freezeDuration))
+	collectedIncentivesForPosition := sdk.Coins{}
+	for uptimeIndex, uptimeAccum := range uptimeAccumulators {
+		hasPosition, err := uptimeAccum.HasPosition(positionName)
+		if err != nil {
+			return sdk.Coins{}, err
+		}
 
-		for uptimeIndex, uptimeAccum := range uptimeAccumulators {
-			hasPosition, err := uptimeAccum.HasPosition(positionName)
+		if hasPosition {
+			collectedIncentivesForUptime, err := prepareAccumAndClaimRewards(uptimeAccum, positionName, uptimeGrowthOutside[uptimeIndex])
 			if err != nil {
 				return sdk.Coins{}, err
 			}
 
-			if hasPosition {
-				// Replace position's accumulator before calculating unclaimed rewards
-				err = preparePositionAccumulator(uptimeAccum, positionName, uptimeGrowthOutside[uptimeIndex])
-				if err != nil {
-					return sdk.Coins{}, err
-				}
+			// If the collected incentives are forfeited, we deposit them back into the accumulator to be distributed
+			// to other qualifying positions.
+			if forfeitIncentives {
+				uptimeAccum.AddToAccumulator(sdk.NewDecCoinsFromCoins(collectedIncentivesForUptime...))
+			}
 
-				// Claim incentives
-				incentivesClaimedCurrAccum, err := uptimeAccum.ClaimRewards(positionName)
-				if err != nil {
-					return sdk.Coins{}, err
-				}
-				collectedIncentives = collectedIncentives.Add(incentivesClaimedCurrAccum...)
+			collectedIncentivesForPosition = collectedIncentivesForPosition.Add(collectedIncentivesForUptime...)
+		}
+	}
 
-				// Check if position record was deleted after claiming rewards. If not, we update the custom accumulator value.
-				hasPosition, err = uptimeAccum.HasPosition(positionName)
-				if err != nil {
-					return sdk.Coins{}, err
-				}
+	return collectedIncentivesForPosition, nil
+}
 
-				if hasPosition {
-					customAccumulatorValue := uptimeAccum.GetValue().Sub(uptimeGrowthOutside[uptimeIndex])
-					err := uptimeAccum.SetPositionCustomAcc(positionName, customAccumulatorValue)
-					if err != nil {
-						return sdk.Coins{}, err
-					}
-				}
-			}
+// collectIncentives collects incentives for all uptime accumulators for all positions belonging to `owner` that have exactly
+// the same lower and upper ticks.
+//
+// Upon successful collection, it bank sends the incentives from the pool address to the owner and returns the collected coins.
+// Returns error if:
+// - pool with the given id does not exist
+// - no position given by pool id, owner, lower tick and upper tick exists
+// - other internal database or math errors.
+func (k Keeper) collectIncentives(ctx sdk.Context, poolId uint64, owner sdk.AccAddress, lowerTick int64, upperTick int64) (sdk.Coins, error) {
+	positionsInRange, err := osmoutils.GatherValuesFromStorePrefixWithKeyParser(ctx.KVStore(k.storeKey), types.KeyPosition(poolId, owner, lowerTick, upperTick), ParseFullPositionFromBytes)
+	if err != nil {
+		return sdk.Coins{}, err
+	}
+
+	if len(positionsInRange) == 0 {
+		return sdk.Coins{}, types.PositionNotFoundError{PoolId: poolId, LowerTick: lowerTick, UpperTick: upperTick}
+	}
+
+	collectedIncentives := sdk.Coins{}
+	for _, position := range positionsInRange {
+		collectedIncentivesForPosition, err := k.claimAllIncentivesForPosition(ctx, poolId, owner, lowerTick, upperTick, position.JoinTime, position.FreezeDuration, false)
+		if err != nil {
+			return sdk.Coins{}, err
 		}
+
+		collectedIncentives = collectedIncentives.Add(collectedIncentivesForPosition...)
 	}
 
 	// Once we have iterated through all the positions, we do a single bank send from the pool to the owner.
 	// We skip this step if collected incentives are zero.
 	if collectedIncentives.IsZero() {
 		return collectedIncentives, nil
 	}
+
 	pool, err := k.getPoolById(ctx, poolId)
 	if err != nil {
 		return sdk.Coins{}, err