add validator cap and bond checks + tests

persistenceOne · Apr 8, 2024 · 060360a · 060360a
1 parent 4528a2f
commit 060360a
Show file tree

Hide file tree

Showing 8 changed files with 216 additions and 127 deletions.
diff --git a/x/liquidstake/keeper/genesis_test.go b/x/liquidstake/keeper/genesis_test.go
@@ -27,7 +27,7 @@ func (s *KeeperTestSuite) TestImportExportGenesis() {
 	k.SetParams(ctx, params)
 	k.UpdateLiquidValidatorSet(ctx)
 
-	stakingAmt := math.NewInt(100000000)
+	stakingAmt := math.NewInt(100000)
 	s.Require().NoError(s.liquidStaking(s.delAddrs[0], stakingAmt))
 	lvs := k.GetAllLiquidValidators(ctx)
 	s.Require().Len(lvs, 2)

diff --git a/x/liquidstake/keeper/keeper_test.go b/x/liquidstake/keeper/keeper_test.go
@@ -82,7 +82,11 @@ func (s *KeeperTestSuite) CreateValidators(powers []int64) ([]sdk.AccAddress, []
 	valAddrs := testhelpers.ConvertAddrsToValAddrs(addrs)
 	pks := testhelpers.CreateTestPubKeys(num)
 	skParams := s.app.StakingKeeper.GetParams(s.ctx)
-	skParams.ValidatorLiquidStakingCap = sdk.OneDec()
+	globalCap, _ := sdk.NewDecFromStr("0.1")
+	skParams.GlobalLiquidStakingCap = globalCap
+	validatorCap, _ := sdk.NewDecFromStr("0.5")
+	skParams.ValidatorLiquidStakingCap = validatorCap
+	skParams.ValidatorBondFactor = sdk.NewDec(250)
 	s.app.StakingKeeper.SetParams(s.ctx, skParams)
 	for i, power := range powers {
 		val, err := stakingtypes.NewValidator(valAddrs[i], pks[i], stakingtypes.Description{})

diff --git a/x/liquidstake/keeper/liquidstake.go b/x/liquidstake/keeper/liquidstake.go
@@ -548,8 +548,9 @@ func (k Keeper) LSMDelegate(
 
 // LiquidDelegate delegates staking amount to active validators by proxy account.
 func (k Keeper) LiquidDelegate(ctx sdk.Context, proxyAcc sdk.AccAddress, activeVals types.ActiveLiquidValidators, stakingAmt math.Int, whitelistedValsMap types.WhitelistedValsMap) (err error) {
-	// crumb may occur due to a decimal point error in dividing the staking amount into the weight of liquid validators, It added on first active liquid validator
-	weightedAmt, crumb := types.DivideByWeight(activeVals, stakingAmt, whitelistedValsMap)
+	// crumb may occur due to a decimal point error in dividing the staking amount into the weight of liquid validators
+	// it is added to the first active liquid validator
+	weightedAmt, crumb := k.DivideByWeight(ctx, activeVals, stakingAmt, whitelistedValsMap)
 	if len(weightedAmt) == 0 {
 		return types.ErrInvalidActiveLiquidValidators
 	}
@@ -719,6 +720,54 @@ func (k Keeper) LiquidUnbond(
 	return completionTime, returnAmount, ubd, nil
 }
 
+// DivideByWeight divide the input value by the ratio of the param weight of the liquid validator and return it with crumb
+// which is may occur while dividing according to the weight of active liquid validators by decimal error.
+func (k Keeper) DivideByWeight(
+	ctx sdk.Context,
+	avs types.ActiveLiquidValidators,
+	input math.Int,
+	whitelistedValsMap types.WhitelistedValsMap,
+) (outputs []math.Int, crumb math.Int) {
+	totalWeight := avs.TotalWeight(whitelistedValsMap)
+	if !totalWeight.IsPositive() {
+		return []math.Int{}, sdk.ZeroInt()
+	}
+
+	totalOutput := sdk.ZeroInt()
+	unitInput := math.LegacyNewDecFromInt(input).QuoTruncate(math.LegacyNewDecFromInt(totalWeight))
+	for _, val := range avs {
+		validator, _ := k.stakingKeeper.GetValidator(ctx, val.GetOperator())
+
+		// calculate the shares the input would receive
+		output := unitInput.MulInt(val.GetWeight(whitelistedValsMap, true)).TruncateInt()
+		outputShares := validator.GetDelegatorShares().MulInt(output).QuoInt(validator.GetTokens())
+
+		// just delegate if the validator does not exceed any of the validator specific caps
+		if !k.stakingKeeper.CheckExceedsValidatorBondCap(ctx, validator, outputShares) &&
+			!k.stakingKeeper.CheckExceedsValidatorLiquidStakingCap(ctx, validator, outputShares, false) {
+			totalOutput = totalOutput.Add(output)
+			outputs = append(outputs, output)
+		}
+	}
+
+	if len(outputs) == 0 {
+		return []math.Int{}, sdk.ZeroInt()
+	}
+
+	// redistribute crumb evenly to the other outputs if there is enough
+	numOutputs := sdk.NewInt(int64(len(outputs)))
+	totalCrumb := input.Sub(totalOutput)
+	crumbPerOutput := totalCrumb.Quo(numOutputs)
+	if totalCrumb.GTE(numOutputs) {
+		for i := range outputs {
+			totalOutput = totalOutput.Add(crumbPerOutput)
+			outputs[i] = outputs[i].Add(crumbPerOutput)
+		}
+	}
+
+	return outputs, input.Sub(totalOutput)
+}
+
 // PrioritiseInactiveLiquidValidators sorts LiquidValidators array to have inactive validators first. Used for the case when
 // unbonding should begin from the inactive validators first.
 func (k Keeper) PrioritiseInactiveLiquidValidators(

diff --git a/x/liquidstake/keeper/liquidstake_test.go b/x/liquidstake/keeper/liquidstake_test.go
@@ -1,11 +1,13 @@
 package keeper_test
 
 import (
+	"testing"
 	"time"
 
 	"cosmossdk.io/math"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+	"github.com/stretchr/testify/require"
 
 	testhelpers "github.com/persistenceOne/pstake-native/v2/app/helpers"
 	"github.com/persistenceOne/pstake-native/v2/x/liquidstake/types"
@@ -243,7 +245,7 @@ func (s *KeeperTestSuite) TestLiquidStake() {
 }
 
 func (s *KeeperTestSuite) TestLiquidStakeFromVestingAccount() {
-	_, valOpers, _ := s.CreateValidators([]int64{1000000, 2000000, 3000000})
+	_, valOpers, _ := s.CreateValidators([]int64{1000000000, 2000000000, 3000000000})
 	params := s.keeper.GetParams(s.ctx)
 
 	// add active validator
@@ -312,6 +314,11 @@ func (s *KeeperTestSuite) TestLiquidStakeEdgeCases() {
 	s.Require().ErrorIs(err, types.ErrInvalidBondDenom)
 
 	// liquid stake, unstaking with huge amount
+	stakingParams := s.app.StakingKeeper.GetParams(s.ctx)
+	stakingParams.GlobalLiquidStakingCap = sdk.OneDec()
+	stakingParams.ValidatorLiquidStakingCap = sdk.OneDec()
+	stakingParams.ValidatorBondFactor = sdk.NewDec(10000000000000)
+	s.app.StakingKeeper.SetParams(s.ctx, stakingParams)
 	hugeAmt := math.NewInt(1_000_000_000_000_000_000)
 	s.fundAddr(s.delAddrs[0], sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, hugeAmt.MulRaw(2))))
 	s.Require().NoError(s.liquidStaking(s.delAddrs[0], hugeAmt))
@@ -334,7 +341,7 @@ func (s *KeeperTestSuite) TestLiquidUnstakeEdgeCases() {
 	_, valOpers, _ := s.CreateValidators([]int64{1000000, 2000000, 3000000})
 	params := s.keeper.GetParams(s.ctx)
 	s.keeper.UpdateLiquidValidatorSet(s.ctx)
-	stakingAmt := math.NewInt(5000000)
+	stakingAmt := math.NewInt(100000)
 
 	// add active validator
 	params.WhitelistedValidators = []types.WhitelistedValidator{
@@ -458,3 +465,143 @@ func (s *KeeperTestSuite) TestShareInflation() {
 	attackerProfit := unbondingAmt.Sub(initialStakingAmt).Sub(attackerTransferAmount)
 	s.Require().LessOrEqual(attackerProfit.Int64(), math.ZeroInt().Int64())
 }
+
+func (s *KeeperTestSuite) TestDivideByWeight() {
+	_, valOpers, _ := s.CreateValidators([]int64{2000000, 2000000, 2000000})
+
+	testCases := []struct {
+		name            string
+		whitelistedVals []types.WhitelistedValidator
+		addStakingAmt   math.Int
+		expectedOutputs []math.Int
+		expectedCrumb   math.Int
+	}{
+		{
+			name: "Success with crumbs",
+			whitelistedVals: []types.WhitelistedValidator{
+				{
+					ValidatorAddress: valOpers[0].String(),
+					TargetWeight:     math.NewInt(1),
+				},
+				{
+					ValidatorAddress: valOpers[1].String(),
+					TargetWeight:     math.NewInt(1),
+				},
+				{
+					ValidatorAddress: valOpers[2].String(),
+					TargetWeight:     math.NewInt(1),
+				},
+			},
+			addStakingAmt:   math.NewInt(100000),
+			expectedOutputs: []math.Int{math.NewInt(33333), math.NewInt(33333), math.NewInt(33333)},
+			expectedCrumb:   math.NewInt(1),
+		},
+		{
+			name: "Success without crumb",
+			whitelistedVals: []types.WhitelistedValidator{
+				{
+					ValidatorAddress: valOpers[0].String(),
+					TargetWeight:     math.NewInt(2),
+				},
+				{
+					ValidatorAddress: valOpers[1].String(),
+					TargetWeight:     math.NewInt(2),
+				},
+				{
+					ValidatorAddress: valOpers[2].String(),
+					TargetWeight:     math.NewInt(1),
+				},
+			},
+			addStakingAmt:   math.NewInt(100000),
+			expectedOutputs: []math.Int{math.NewInt(40000), math.NewInt(40000), math.NewInt(20000)},
+			expectedCrumb:   math.NewInt(0),
+		},
+		{
+			name: "First validator reaches the cap, part of the crumb gets divided among validators",
+			whitelistedVals: []types.WhitelistedValidator{
+				{
+					ValidatorAddress: valOpers[0].String(),
+					TargetWeight:     math.NewInt(8),
+				},
+				{
+					ValidatorAddress: valOpers[1].String(),
+					TargetWeight:     math.NewInt(1),
+				},
+				{
+					ValidatorAddress: valOpers[2].String(),
+					TargetWeight:     math.NewInt(1),
+				},
+			},
+			addStakingAmt:   math.NewInt(2500003),
+			expectedOutputs: []math.Int{math.NewInt(1250001), math.NewInt(1250001)},
+			expectedCrumb:   math.NewInt(1),
+		},
+		{
+			name: "First validator reaches the cap, all the crumb gets divided among validators",
+			whitelistedVals: []types.WhitelistedValidator{
+				{
+					ValidatorAddress: valOpers[0].String(),
+					TargetWeight:     math.NewInt(8),
+				},
+				{
+					ValidatorAddress: valOpers[1].String(),
+					TargetWeight:     math.NewInt(1),
+				},
+				{
+					ValidatorAddress: valOpers[2].String(),
+					TargetWeight:     math.NewInt(1),
+				},
+			},
+			addStakingAmt:   math.NewInt(2500002),
+			expectedOutputs: []math.Int{math.NewInt(1250001), math.NewInt(1250001)},
+			expectedCrumb:   math.NewInt(0),
+		},
+		{
+			name: "All validators reach the cap",
+			whitelistedVals: []types.WhitelistedValidator{
+				{
+					ValidatorAddress: valOpers[0].String(),
+					TargetWeight:     math.NewInt(1),
+				},
+				{
+					ValidatorAddress: valOpers[1].String(),
+					TargetWeight:     math.NewInt(1),
+				},
+				{
+					ValidatorAddress: valOpers[2].String(),
+					TargetWeight:     math.NewInt(1),
+				},
+			},
+			addStakingAmt:   math.NewInt(1000000000),
+			expectedOutputs: []math.Int{},
+			expectedCrumb:   math.NewInt(0),
+		},
+	}
+
+	for _, tc := range testCases {
+		s.T().Run(tc.name, func(t *testing.T) {
+			require.IsType(t, []types.WhitelistedValidator{}, tc.whitelistedVals)
+			require.IsType(t, math.Int{}, tc.addStakingAmt)
+			require.IsType(t, math.Int{}, tc.expectedCrumb)
+			require.IsType(t, []math.Int{}, tc.expectedOutputs)
+
+			totalTargetAmt := sdk.ZeroInt()
+			valsMap := types.GetWhitelistedValsMap(tc.whitelistedVals)
+			var activeVals types.ActiveLiquidValidators
+			for _, v := range tc.whitelistedVals {
+				activeVals = append(activeVals, types.LiquidValidator{
+					OperatorAddress: v.ValidatorAddress,
+				})
+			}
+			outputs, crumb := s.keeper.DivideByWeight(s.ctx, activeVals, tc.addStakingAmt, valsMap)
+			for _, v := range outputs {
+				totalTargetAmt = totalTargetAmt.Add(v)
+			}
+			require.EqualValues(t, tc.expectedOutputs, outputs)
+			require.Equal(t, tc.expectedCrumb.String(), crumb.String())
+			if !(len(outputs) == 0) && !crumb.IsZero() {
+				require.EqualValues(t, tc.addStakingAmt, totalTargetAmt.Add(crumb))
+			}
+		})
+	}
+}
diff --git a/x/liquidstake/keeper/rebalancing_test.go b/x/liquidstake/keeper/rebalancing_test.go
@@ -46,9 +46,9 @@ func (s *KeeperTestSuite) TestRebalancingCase1() {
 	proxyAccDel3, found := s.app.StakingKeeper.GetDelegation(s.ctx, types.LiquidStakeProxyAcc, valOpers[2])
 	s.Require().True(found)
 
-	s.Require().EqualValues(proxyAccDel1.Shares.TruncateInt(), math.NewInt(16668))
-	s.Require().EqualValues(proxyAccDel2.Shares.TruncateInt(), math.NewInt(16665))
-	s.Require().EqualValues(proxyAccDel3.Shares.TruncateInt(), math.NewInt(16665))
+	s.Require().EqualValues(proxyAccDel1.Shares.TruncateInt(), math.NewInt(16666))
+	s.Require().EqualValues(proxyAccDel2.Shares.TruncateInt(), math.NewInt(16666))
+	s.Require().EqualValues(proxyAccDel3.Shares.TruncateInt(), math.NewInt(16666))
 	totalLiquidTokens, _ := s.keeper.GetAllLiquidValidators(s.ctx).TotalLiquidTokens(s.ctx, s.app.StakingKeeper, false)
 	s.Require().EqualValues(stakingAmt, totalLiquidTokens)
 	s.printRedelegationsLiquidTokens()
@@ -269,7 +269,7 @@ func (s *KeeperTestSuite) TestRebalancingConsecutiveCase() {
 	s.keeper.SetParams(s.ctx, params)
 	s.keeper.UpdateLiquidValidatorSet(s.ctx)
 
-	stakingAmt := math.NewInt(10000000000000)
+	stakingAmt := math.NewInt(1000000000000)
 	s.fundAddr(s.delAddrs[0], sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, stakingAmt)))
 	// add active validator
 	params.WhitelistedValidators = []types.WhitelistedValidator{
@@ -452,7 +452,7 @@ func (s *KeeperTestSuite) TestRebalancingConsecutiveCase() {
 }
 
 func (s *KeeperTestSuite) TestAutocompoundStakingRewards() {
-	_, valOpers, _ := s.CreateValidators([]int64{2000000, 2000000, 2000000})
+	_, valOpers, _ := s.CreateValidators([]int64{1000000000, 1000000000, 1000000000})
 	params := s.keeper.GetParams(s.ctx)
 
 	params.WhitelistedValidators = []types.WhitelistedValidator{
@@ -507,7 +507,7 @@ func (s *KeeperTestSuite) TestLimitAutocompoundStakingRewards() {
 	s.keeper.SetParams(s.ctx, params)
 	s.keeper.UpdateLiquidValidatorSet(s.ctx)
 
-	stakingAmt := math.NewInt(100000000)
+	stakingAmt := math.NewInt(100000)
 	s.Require().NoError(s.liquidStaking(s.delAddrs[0], stakingAmt))
 
 	// allocate rewards
@@ -541,7 +541,7 @@ func (s *KeeperTestSuite) TestRemoveAllLiquidValidator() {
 	s.Require().NoError(s.keeper.SetParams(s.ctx, params))
 	s.keeper.UpdateLiquidValidatorSet(s.ctx)
 
-	stakingAmt := math.NewInt(100000000)
+	stakingAmt := math.NewInt(100000)
 	s.Require().NoError(s.liquidStaking(s.delAddrs[0], stakingAmt))
 
 	// allocate rewards
@@ -587,7 +587,7 @@ func (s *KeeperTestSuite) TestUndelegatedFundsNotBecomeFees() {
 	s.keeper.UpdateLiquidValidatorSet(s.ctx)
 
 	// stake funds
-	stakingAmt := math.NewInt(100000000)
+	stakingAmt := math.NewInt(100000)
 	s.Require().NoError(s.liquidStaking(s.delAddrs[0], stakingAmt))
 
 	// remove one validator

diff --git a/x/liquidstake/types/expected_keepers.go b/x/liquidstake/types/expected_keepers.go
@@ -81,6 +81,8 @@ type StakingKeeper interface {
 	SafelyIncreaseTotalLiquidStakedTokens(ctx sdk.Context, amount math.Int, sharesAlreadyBonded bool) error
 	DecreaseTotalLiquidStakedTokens(ctx sdk.Context, amount math.Int) error
 	GetBondedPool(ctx sdk.Context) (bondedPool authtypes.ModuleAccountI)
+	CheckExceedsValidatorBondCap(ctx sdk.Context, validator stakingtypes.Validator, shares sdk.Dec) bool
+	CheckExceedsValidatorLiquidStakingCap(ctx sdk.Context, validator stakingtypes.Validator, shares sdk.Dec, sharesAlreadyBonded bool) bool
 }
 
 // MintKeeper expected minting keeper (noalias)

diff --git a/x/liquidstake/types/rebalancing.go b/x/liquidstake/types/rebalancing.go
@@ -14,25 +14,6 @@ type Redelegation struct {
 	Error        error
 }
 
-// DivideByWeight divide the input value by the ratio of the param weight of the liquid validator and return it with crumb
-// which is may occur while dividing according to the weight of active liquid validators by decimal error.
-func DivideByWeight(avs ActiveLiquidValidators, input math.Int, whitelistedValsMap WhitelistedValsMap) (outputs []math.Int, crumb math.Int) {
-	totalWeight := avs.TotalWeight(whitelistedValsMap)
-	if !totalWeight.IsPositive() {
-		return []math.Int{}, sdk.ZeroInt()
-	}
-
-	totalOutput := sdk.ZeroInt()
-	unitInput := math.LegacyNewDecFromInt(input).QuoTruncate(math.LegacyNewDecFromInt(totalWeight))
-	for _, val := range avs {
-		output := unitInput.MulInt(val.GetWeight(whitelistedValsMap, true)).TruncateInt()
-		totalOutput = totalOutput.Add(output)
-		outputs = append(outputs, output)
-	}
-
-	return outputs, input.Sub(totalOutput)
-}
-
 // DivideByCurrentWeight divide the input value by the ratio of the weight of the liquid validator's liquid token and return it with crumb
 // which is may occur while dividing according to the weight of liquid validators by decimal error, outputs is truncated decimal.
 func DivideByCurrentWeight(lvs LiquidValidators, input math.LegacyDec, totalLiquidTokens math.Int, liquidTokenMap map[string]math.Int) (outputs []math.LegacyDec, crumb math.LegacyDec) {