use decCoin for reward debts

RogerKSI · RogerKSI · commit 374a398dee75 · 2024-07-23T02:11:31.000+07:00
diff --git a/proto/restake/v1beta1/types.proto b/proto/restake/v1beta1/types.proto
@@ -64,15 +64,15 @@ message Lock {
 
   // PosRewardDebts is a list of reward debt for each reward (only the positive side).
   // Note: Coin and DecCoin can't have negative amounts. so, we split it into two numbers.
-  repeated cosmos.base.v1beta1.Coin pos_reward_debts = 4 [
-    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins",
+  repeated cosmos.base.v1beta1.DecCoin pos_reward_debts = 4 [
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.DecCoins",
     (gogoproto.nullable)     = false,
     (amino.dont_omitempty)   = true
   ];
 
   // NegRewardDebts is a list of reward debt for each reward (only negative side).
-  repeated cosmos.base.v1beta1.Coin neg_reward_debts = 5 [
-    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins",
+  repeated cosmos.base.v1beta1.DecCoin neg_reward_debts = 5 [
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.DecCoins",
     (gogoproto.nullable)     = false,
     (amino.dont_omitempty)   = true
   ];
diff --git a/x/restake/client/cli/tx.go b/x/restake/client/cli/tx.go
@@ -100,6 +100,10 @@ func GetTxCmdClaimRewards() *cobra.Command {
 				msgs = append(msgs, msg)
 			}
 
+			if len(msgs) == 0 {
+				return fmt.Errorf("no rewards to claim")
+			}
+
 			return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), msgs...)
 		},
 	}
diff --git a/x/restake/keeper/grpc_query.go b/x/restake/keeper/grpc_query.go
@@ -105,7 +105,7 @@ func (k Querier) Locks(
 		keyStore,
 		req.Pagination,
 		func(key []byte, s *types.Lock) (*types.LockResponse, error) {
-			if !k.IsActiveKey(ctx, s.Key) {
+			if !k.IsActiveKey(ctx, s.Key) || s.Amount.IsZero() {
 				return nil, nil
 			}
 
diff --git a/x/restake/keeper/keeper_key.go b/x/restake/keeper/keeper_key.go
@@ -43,7 +43,7 @@ func (k Keeper) AddRewards(ctx sdk.Context, sender sdk.AccAddress, keyName strin
 	}
 
 	if key.TotalPower.IsZero() {
-		return types.ErrTotalLockZero
+		return types.ErrTotalPowerZero
 	}
 
 	err = k.bankKeeper.SendCoins(ctx, sender, sdk.MustAccAddressFromBech32(key.PoolAddress), rewards)
diff --git a/x/restake/keeper/keeper_lock.go b/x/restake/keeper/keeper_lock.go
@@ -37,8 +37,8 @@ func (k Keeper) SetLockedPower(ctx sdk.Context, lockerAddr sdk.AccAddress, keyNa
 			LockerAddress:  lockerAddr.String(),
 			Key:            keyName,
 			Amount:         sdkmath.NewInt(0),
-			PosRewardDebts: sdk.NewCoins(),
-			NegRewardDebts: sdk.NewCoins(),
+			PosRewardDebts: sdk.NewDecCoins(),
+			NegRewardDebts: sdk.NewDecCoins(),
 		}
 	}
 
@@ -48,12 +48,10 @@ func (k Keeper) SetLockedPower(ctx sdk.Context, lockerAddr sdk.AccAddress, keyNa
 	k.SetKey(ctx, key)
 
 	addtionalDebts := key.RewardPerPowers.MulDecTruncate(sdkmath.LegacyNewDecFromInt(diffAmount.Abs()))
-	truncatedAdditionalDebts, _ := addtionalDebts.TruncateDecimal()
-	truncatedAdditionalDebts = truncatedAdditionalDebts.Sort()
 	if diffAmount.IsPositive() {
-		lock.PosRewardDebts = lock.PosRewardDebts.Add(truncatedAdditionalDebts...)
+		lock.PosRewardDebts = lock.PosRewardDebts.Add(addtionalDebts...)
 	} else {
-		lock.NegRewardDebts = lock.NegRewardDebts.Add(truncatedAdditionalDebts...)
+		lock.NegRewardDebts = lock.NegRewardDebts.Add(addtionalDebts...)
 	}
 	lock.Amount = amount
 	k.SetLock(ctx, lock)
@@ -99,9 +97,8 @@ func (k Keeper) getReward(ctx sdk.Context, lock types.Lock) types.Reward {
 	totalRewards := k.getTotalRewards(ctx, lock)
 
 	return types.Reward{
-		Key: lock.Key,
-		Rewards: totalRewards.Add(sdk.NewDecCoinsFromCoins(lock.NegRewardDebts...)...).
-			Sub(sdk.NewDecCoinsFromCoins(lock.PosRewardDebts...)),
+		Key:     lock.Key,
+		Rewards: totalRewards.Add(lock.NegRewardDebts...).Sub(lock.PosRewardDebts),
 	}
 }
 
diff --git a/x/restake/keeper/keeper_lock_test.go b/x/restake/keeper/keeper_lock_test.go
@@ -117,9 +117,9 @@ func (suite *KeeperTestSuite) TestSetLockedPower() {
 				LockerAddress: ValidAddress1.String(),
 				Key:           ValidKey1,
 				Amount:        sdkmath.NewInt(100),
-				PosRewardDebts: sdk.NewCoins(
-					sdk.NewCoin("aaaa", sdkmath.NewInt(0)),
-					sdk.NewCoin("bbbb", sdkmath.NewInt(1)),
+				PosRewardDebts: sdk.NewDecCoins(
+					sdk.NewDecCoinFromDec("aaaa", sdkmath.LegacyNewDecWithPrec(1, 1)),
+					sdk.NewDecCoinFromDec("bbbb", sdkmath.LegacyNewDecWithPrec(1, 0)),
 				),
 				NegRewardDebts: nil,
 			},
@@ -154,9 +154,9 @@ func (suite *KeeperTestSuite) TestSetLockedPower() {
 				LockerAddress: ValidAddress1.String(),
 				Key:           ValidKey1,
 				Amount:        sdkmath.NewInt(1000),
-				PosRewardDebts: sdk.NewCoins(
-					sdk.NewCoin("aaaa", sdkmath.NewInt(0)),
-					sdk.NewCoin("bbbb", sdkmath.NewInt(9)),
+				PosRewardDebts: sdk.NewDecCoins(
+					sdk.NewDecCoinFromDec("aaaa", sdkmath.LegacyNewDecWithPrec(9, 1)),
+					sdk.NewDecCoinFromDec("bbbb", sdkmath.LegacyNewDecWithPrec(9, 0)),
 				),
 				NegRewardDebts: nil,
 			},
@@ -192,9 +192,9 @@ func (suite *KeeperTestSuite) TestSetLockedPower() {
 				Key:            ValidKey1,
 				Amount:         sdkmath.NewInt(100),
 				PosRewardDebts: nil,
-				NegRewardDebts: sdk.NewCoins(
-					sdk.NewCoin("aaaa", sdkmath.NewInt(0)),
-					sdk.NewCoin("bbbb", sdkmath.NewInt(9)),
+				NegRewardDebts: sdk.NewDecCoins(
+					sdk.NewDecCoinFromDec("aaaa", sdkmath.LegacyNewDecWithPrec(9, 1)),
+					sdk.NewDecCoinFromDec("bbbb", sdkmath.LegacyNewDecWithPrec(9, 0)),
 				),
 			},
 		},
diff --git a/x/restake/keeper/msg_server.go b/x/restake/keeper/msg_server.go
@@ -42,13 +42,12 @@ func (k msgServer) ClaimRewards(
 		return nil, err
 	}
 
-	totalRewards := k.getTotalRewards(ctx, lock)
-	truncatedTotalRewards, remainders := totalRewards.TruncateDecimal()
-	finalRewards := truncatedTotalRewards.Add(lock.NegRewardDebts...).Sub(lock.PosRewardDebts...)
+	reward := k.getReward(ctx, lock)
+	finalRewards, remainders := reward.Rewards.TruncateDecimal()
 
 	if !finalRewards.IsZero() {
-		lock.PosRewardDebts = truncatedTotalRewards
-		lock.NegRewardDebts = sdk.NewCoins()
+		lock.PosRewardDebts = sdk.NewDecCoins()
+		lock.NegRewardDebts = remainders
 		k.SetLock(ctx, lock)
 
 		err = k.bankKeeper.SendCoins(ctx, sdk.MustAccAddressFromBech32(key.PoolAddress), address, finalRewards)
diff --git a/x/restake/keeper/msg_server_test.go b/x/restake/keeper/msg_server_test.go
@@ -49,7 +49,7 @@ func (suite *KeeperTestSuite) TestMsgClaimRewards() {
 			postCheck: func() {
 				lock, err := suite.restakeKeeper.GetLock(ctx, ValidAddress1, ValidKey1)
 				suite.Require().NoError(err)
-				suite.Require().Equal(sdk.NewCoins(sdk.NewCoin("uband", sdkmath.NewInt(1))), lock.PosRewardDebts)
+				suite.Require().Equal(sdk.NewDecCoins(sdk.NewDecCoin("uband", sdkmath.NewInt(1))), lock.PosRewardDebts)
 			},
 		},
 	}
diff --git a/x/restake/types/errors.go b/x/restake/types/errors.go
@@ -13,7 +13,7 @@ var (
 	ErrLockNotFound          = errorsmod.Register(ModuleName, 6, "lock not found")
 	ErrDelegationNotEnough   = errorsmod.Register(ModuleName, 7, "delegation not enough")
 	ErrInvalidAmount         = errorsmod.Register(ModuleName, 8, "invalid amount")
-	ErrTotalLockZero         = errorsmod.Register(ModuleName, 9, "total lock is zero")
+	ErrTotalPowerZero        = errorsmod.Register(ModuleName, 9, "total power is zero")
 	ErrAccountAlreadyExist   = errorsmod.Register(ModuleName, 10, "account already exist")
 	ErrInvalidLength         = errorsmod.Register(ModuleName, 11, "invalid length")
 )
diff --git a/x/restake/types/genesis_test.go b/x/restake/types/genesis_test.go
@@ -40,15 +40,15 @@ func TestGenesisStateValidate(t *testing.T) {
 						LockerAddress:  "address1",
 						Key:            "key",
 						Amount:         sdkmath.NewInt(4),
-						PosRewardDebts: sdk.NewCoins(),
-						NegRewardDebts: sdk.NewCoins(),
+						PosRewardDebts: sdk.NewDecCoins(),
+						NegRewardDebts: sdk.NewDecCoins(),
 					},
 					{
 						LockerAddress:  "address2",
 						Key:            "key",
 						Amount:         sdkmath.NewInt(6),
-						PosRewardDebts: sdk.NewCoins(),
-						NegRewardDebts: sdk.NewCoins(),
+						PosRewardDebts: sdk.NewDecCoins(),
+						NegRewardDebts: sdk.NewDecCoins(),
 					},
 				},
 			},
@@ -72,15 +72,15 @@ func TestGenesisStateValidate(t *testing.T) {
 						LockerAddress:  "address1",
 						Key:            "key",
 						Amount:         sdkmath.NewInt(4),
-						PosRewardDebts: sdk.NewCoins(),
-						NegRewardDebts: sdk.NewCoins(),
+						PosRewardDebts: sdk.NewDecCoins(),
+						NegRewardDebts: sdk.NewDecCoins(),
 					},
 					{
 						LockerAddress:  "address2",
 						Key:            "key",
 						Amount:         sdkmath.NewInt(6),
-						PosRewardDebts: sdk.NewCoins(),
-						NegRewardDebts: sdk.NewCoins(),
+						PosRewardDebts: sdk.NewDecCoins(),
+						NegRewardDebts: sdk.NewDecCoins(),
 					},
 				},
 			},
diff --git a/x/restake/types/keys_test.go b/x/restake/types/keys_test.go
@@ -59,8 +59,8 @@ func TestLockByAmountIndexKey(t *testing.T) {
 		LockerAddress:  acc.String(),
 		Key:            keyName,
 		Amount:         sdkmath.NewInt(100),
-		PosRewardDebts: sdk.NewCoins(),
-		NegRewardDebts: sdk.NewCoins(),
+		PosRewardDebts: sdk.NewDecCoins(),
+		NegRewardDebts: sdk.NewDecCoins(),
 	}
 
 	expect, err := hex.DecodeString(
diff --git a/x/restake/types/types.pb.go b/x/restake/types/types.pb.go

Original file line number	Diff line number	Diff line change
`@@ -100,6 +100,10 @@ func GetTxCmdClaimRewards() *cobra.Command {`
`100`	`100`	`msgs = append(msgs, msg)`
`101`	`101`	`}`
`102`	`102`
	`103`	`+ if len(msgs) == 0 {`
	`104`	`+ return fmt.Errorf("no rewards to claim")`
	`105`	`+ }`
	`106`	`+`
`103`	`107`	`return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), msgs...)`
`104`	`108`	`},`
`105`	`109`	`}`
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ func (k Querier) Locks(`
`105`	`105`	`keyStore,`
`106`	`106`	`req.Pagination,`
`107`	`107`	`func(key []byte, s types.Lock) (types.LockResponse, error) {`
`108`		`- if !k.IsActiveKey(ctx, s.Key) {`
	`108`	`+ if !k.IsActiveKey(ctx, s.Key) \|\| s.Amount.IsZero() {`
`109`	`109`	`return nil, nil`
`110`	`110`	`}`
`111`	`111`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ func (k Keeper) AddRewards(ctx sdk.Context, sender sdk.AccAddress, keyName strin`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`if key.TotalPower.IsZero() {`
`46`		`- return types.ErrTotalLockZero`
	`46`	`+ return types.ErrTotalPowerZero`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`err = k.bankKeeper.SendCoins(ctx, sender, sdk.MustAccAddressFromBech32(key.PoolAddress), rewards)`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ func (suite *KeeperTestSuite) TestMsgClaimRewards() {`
`49`	`49`	`postCheck: func() {`
`50`	`50`	`lock, err := suite.restakeKeeper.GetLock(ctx, ValidAddress1, ValidKey1)`
`51`	`51`	`suite.Require().NoError(err)`
`52`		`- suite.Require().Equal(sdk.NewCoins(sdk.NewCoin("uband", sdkmath.NewInt(1))), lock.PosRewardDebts)`
	`52`	`+ suite.Require().Equal(sdk.NewDecCoins(sdk.NewDecCoin("uband", sdkmath.NewInt(1))), lock.PosRewardDebts)`
`53`	`53`	`},`
`54`	`54`	`},`
`55`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ var (`
`13`	`13`	`ErrLockNotFound = errorsmod.Register(ModuleName, 6, "lock not found")`
`14`	`14`	`ErrDelegationNotEnough = errorsmod.Register(ModuleName, 7, "delegation not enough")`
`15`	`15`	`ErrInvalidAmount = errorsmod.Register(ModuleName, 8, "invalid amount")`
`16`		`- ErrTotalLockZero = errorsmod.Register(ModuleName, 9, "total lock is zero")`
	`16`	`+ ErrTotalPowerZero = errorsmod.Register(ModuleName, 9, "total power is zero")`
`17`	`17`	`ErrAccountAlreadyExist = errorsmod.Register(ModuleName, 10, "account already exist")`
`18`	`18`	`ErrInvalidLength = errorsmod.Register(ModuleName, 11, "invalid length")`
`19`	`19`	`)`