Merge pull request #844 from persistenceOne/puneet/UpdateLiquidValida…

…torSet

refactor: re-add UpdateLiquidValidatorSet to begin blocker

x/liquidstake/abci.go

@@ -0,0 +1,20 @@
+package liquidstake
+
+import (
+	"time"
+
+	"github.com/cosmos/cosmos-sdk/telemetry"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+
+	"github.com/persistenceOne/pstake-native/v2/x/liquidstake/keeper"
+	"github.com/persistenceOne/pstake-native/v2/x/liquidstake/types"
+)
+
+func BeginBlock(ctx sdk.Context, k keeper.Keeper) {
+	defer telemetry.ModuleMeasureSince(types.ModuleName, time.Now(), telemetry.MetricKeyBeginBlocker)
+
+	if !k.GetParams(ctx).ModulePaused {
+		// return value of UpdateLiquidValidatorSet is useful only in testing
+		_ = k.UpdateLiquidValidatorSet(ctx, false)
+	}
+}

x/liquidstake/keeper/genesis_test.go

@@ -25,7 +25,7 @@ func (s *KeeperTestSuite) TestImportExportGenesis() {
 	}
 	params.ModulePaused = false
 	k.SetParams(ctx, params)
-	k.UpdateLiquidValidatorSet(ctx)
+	k.UpdateLiquidValidatorSet(ctx, true)
 
 	stakingAmt := math.NewInt(100000000)
 	s.Require().NoError(s.liquidStaking(s.delAddrs[0], stakingAmt))
@@ -55,7 +55,7 @@ func (s *KeeperTestSuite) TestImportExportGenesis() {
 func (s *KeeperTestSuite) TestImportExportGenesisEmpty() {
 	k, ctx := s.keeper, s.ctx
 	k.SetParams(ctx, types.DefaultParams())
-	k.UpdateLiquidValidatorSet(ctx)
+	k.UpdateLiquidValidatorSet(ctx, true)
 	genState := k.ExportGenesis(ctx)
 
 	var genState2 types.GenesisState

x/liquidstake/keeper/grpc_query_test.go

@@ -21,7 +21,7 @@ func (s *KeeperTestSuite) TestGRPCQueries() {
 	params := s.keeper.GetParams(s.ctx)
 	params.MinLiquidStakeAmount = math.NewInt(50000)
 	s.keeper.SetParams(s.ctx, params)
-	s.keeper.UpdateLiquidValidatorSet(s.ctx)
+	s.keeper.UpdateLiquidValidatorSet(s.ctx, true)
 
 	// add active validator
 	params.WhitelistedValidators = []types.WhitelistedValidator{
@@ -30,7 +30,7 @@ func (s *KeeperTestSuite) TestGRPCQueries() {
 		{ValidatorAddress: valOpers[2].String(), TargetWeight: math.NewInt(3333)},
 	}
 	s.keeper.SetParams(s.ctx, params)
-	s.keeper.UpdateLiquidValidatorSet(s.ctx)
+	s.keeper.UpdateLiquidValidatorSet(s.ctx, true)
 
 	// Test LiquidValidators grpc query
 	res := s.keeper.GetAllLiquidValidatorStates(s.ctx)

x/liquidstake/keeper/hooks.go

@@ -35,7 +35,7 @@ func (k Keeper) BeforeEpochStart(ctx sdk.Context, epochIdentifier string, _ int6
 
 		if epochIdentifier == liquidstake.RebalanceEpoch {
 			// return value of UpdateLiquidValidatorSet is useful only in testing
-			_ = k.UpdateLiquidValidatorSet(ctx)
+			_ = k.UpdateLiquidValidatorSet(ctx, true)
 		}
 	}
 

x/liquidstake/keeper/keeper_test.go

@@ -64,7 +64,7 @@ func (s *KeeperTestSuite) SetupTest() {
 	params.UnstakeFeeRate = sdk.ZeroDec()
 	params.AutocompoundFeeRate = types.DefaultAutocompoundFeeRate
 	s.Require().NoError(s.keeper.SetParams(s.ctx, params))
-	s.keeper.UpdateLiquidValidatorSet(s.ctx)
+	s.keeper.UpdateLiquidValidatorSet(s.ctx, true)
 	// call mint.BeginBlocker for init k.SetLastBlockTime(ctx, ctx.BlockTime())
 	mint.BeginBlocker(s.ctx, s.app.MintKeeper, minttypes.DefaultInflationCalculationFn)
 }

x/liquidstake/keeper/liquidstake_test.go

@@ -18,7 +18,7 @@ func (s *KeeperTestSuite) TestLiquidStake() {
 	params.MinLiquidStakeAmount = math.NewInt(50000)
 	params.ModulePaused = false
 	s.keeper.SetParams(s.ctx, params)
-	s.keeper.UpdateLiquidValidatorSet(s.ctx)
+	s.keeper.UpdateLiquidValidatorSet(s.ctx, true)
 
 	stakingAmt := params.MinLiquidStakeAmount
 
@@ -38,7 +38,7 @@ func (s *KeeperTestSuite) TestLiquidStake() {
 		{ValidatorAddress: valOpers[2].String(), TargetWeight: math.NewInt(2000)},
 	}
 	s.keeper.SetParams(s.ctx, params)
-	s.keeper.UpdateLiquidValidatorSet(s.ctx)
+	s.keeper.UpdateLiquidValidatorSet(s.ctx, true)
 
 	res := s.keeper.GetAllLiquidValidatorStates(s.ctx)
 	s.Require().Equal(params.WhitelistedValidators[0].ValidatorAddress,
@@ -254,7 +254,7 @@ func (s *KeeperTestSuite) TestLiquidStakeFromVestingAccount() {
 	}
 	params.ModulePaused = false
 	s.keeper.SetParams(s.ctx, params)
-	s.keeper.UpdateLiquidValidatorSet(s.ctx)
+	s.keeper.UpdateLiquidValidatorSet(s.ctx, true)
 
 	from := s.delAddrs[0]
 	vestingAmt := s.app.BankKeeper.GetAllBalances(s.ctx, from)
@@ -294,7 +294,7 @@ func (s *KeeperTestSuite) TestLiquidStakeFromVestingAccount() {
 func (s *KeeperTestSuite) TestLiquidStakeEdgeCases() {
 	_, valOpers, _ := s.CreateValidators([]int64{1000000, 2000000, 3000000})
 	params := s.keeper.GetParams(s.ctx)
-	s.keeper.UpdateLiquidValidatorSet(s.ctx)
+	s.keeper.UpdateLiquidValidatorSet(s.ctx, true)
 	stakingAmt := math.NewInt(5000000)
 
 	// add active validator
@@ -305,7 +305,7 @@ func (s *KeeperTestSuite) TestLiquidStakeEdgeCases() {
 	}
 	params.ModulePaused = false
 	s.keeper.SetParams(s.ctx, params)
-	s.keeper.UpdateLiquidValidatorSet(s.ctx)
+	s.keeper.UpdateLiquidValidatorSet(s.ctx, true)
 
 	// fail Invalid BondDenom case
 	_, err := s.keeper.LiquidStake(s.ctx, types.LiquidStakeProxyAcc, s.delAddrs[0], sdk.NewCoin("bad", stakingAmt))
@@ -318,7 +318,7 @@ func (s *KeeperTestSuite) TestLiquidStakeEdgeCases() {
 	s.Require().NoError(s.liquidStaking(s.delAddrs[0], hugeAmt))
 	s.Require().NoError(s.liquidUnstaking(s.delAddrs[0], math.NewInt(10), true))
 	s.Require().NoError(s.liquidUnstaking(s.delAddrs[0], hugeAmt, true))
-	s.keeper.UpdateLiquidValidatorSet(s.ctx)
+	s.keeper.UpdateLiquidValidatorSet(s.ctx, true)
 	s.completeRedelegationUnbonding()
 	states := s.keeper.GetNetAmountState(s.ctx)
 	states.TotalLiquidTokens.Equal(hugeAmt)
@@ -333,7 +333,7 @@ func (s *KeeperTestSuite) TestLiquidUnstakeEdgeCases() {
 
 	_, valOpers, _ := s.CreateValidators([]int64{1000000, 2000000, 3000000})
 	params := s.keeper.GetParams(s.ctx)
-	s.keeper.UpdateLiquidValidatorSet(s.ctx)
+	s.keeper.UpdateLiquidValidatorSet(s.ctx, true)
 	stakingAmt := math.NewInt(5000000)
 
 	// add active validator
@@ -344,7 +344,7 @@ func (s *KeeperTestSuite) TestLiquidUnstakeEdgeCases() {
 	}
 	params.ModulePaused = false
 	s.Require().NoError(s.keeper.SetParams(s.ctx, params))
-	s.keeper.UpdateLiquidValidatorSet(s.ctx)
+	s.keeper.UpdateLiquidValidatorSet(s.ctx, true)
 
 	// success liquid stake
 	s.Require().NoError(s.liquidStaking(s.delAddrs[0], stakingAmt))
@@ -379,7 +379,7 @@ func (s *KeeperTestSuite) TestLiquidUnstakeEdgeCases() {
 	// set empty whitelisted, active liquid validator
 	params.WhitelistedValidators = []types.WhitelistedValidator{}
 	s.keeper.SetParams(s.ctx, params)
-	s.keeper.UpdateLiquidValidatorSet(s.ctx)
+	s.keeper.UpdateLiquidValidatorSet(s.ctx, true)
 
 	// error case where there is a quantity that are unbonding balance or remaining rewards that is not re-stake or withdrawn in netAmount.
 	// NOT APPLICABLE since we do not validator unbond if validator goes inactive.
@@ -413,7 +413,7 @@ func (s *KeeperTestSuite) TestShareInflation() {
 	}
 	params.ModulePaused = false
 	s.keeper.SetParams(s.ctx, params)
-	s.keeper.UpdateLiquidValidatorSet(s.ctx)
+	s.keeper.UpdateLiquidValidatorSet(s.ctx, true)
 
 	initialStakingAmt := math.NewInt(1)          // little amount
 	initializingStakingAmt := math.NewInt(10000) // normal amount

x/liquidstake/keeper/rebalancing.go

@@ -149,7 +149,7 @@ func (k Keeper) Rebalance(
 	return redelegations
 }
 
-func (k Keeper) UpdateLiquidValidatorSet(ctx sdk.Context) (redelegations []types.Redelegation) {
+func (k Keeper) UpdateLiquidValidatorSet(ctx sdk.Context, redelegate bool) (redelegations []types.Redelegation) {
 	params := k.GetParams(ctx)
 	liquidValidators := k.GetAllLiquidValidators(ctx)
 	liquidValsMap := liquidValidators.Map()
@@ -177,18 +177,21 @@ func (k Keeper) UpdateLiquidValidatorSet(ctx sdk.Context) (redelegations []types
 
 	// rebalancing based updated liquid validators status with threshold, try by cachedCtx
 	// tombstone status also handled on Rebalance
-	redelegations = k.Rebalance(
-		ctx,
-		types.LiquidStakeProxyAcc,
-		liquidValidators,
-		whitelistedValsMap,
-		types.RebalancingTrigger,
-	)
+	if redelegate {
+		redelegations = k.Rebalance(
+			ctx,
+			types.LiquidStakeProxyAcc,
+			liquidValidators,
+			whitelistedValsMap,
+			types.RebalancingTrigger,
+		)
 
-	// if there are inactive liquid validators, do not unbond,
-	// instead let validator selection and rebalancing take care of it.
+		// if there are inactive liquid validators, do not unbond,
+		// instead let validator selection and rebalancing take care of it.
 
-	return redelegations
+		return redelegations
+	}
+	return nil
 }
 
 // AutocompoundStakingRewards withdraws staking rewards and re-stakes when over threshold.