feat: Move c value bounds to per-chain params

CHANGELOG.md

@@ -38,6 +38,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### Features
 
+- [732](https://github.com/persistenceOne/pstake-native/pull/732) Move c value bounds to per-chain params.
 - [729](https://github.com/persistenceOne/pstake-native/pull/729) Add rewards account query (hence autocompound) OnChanOpenAck.
 - [727](https://github.com/persistenceOne/pstake-native/pull/727) Send LSM redeem messages in chunks.
 - [721](https://github.com/persistenceOne/pstake-native/pull/721) Add Query host chain user unbondings.

app/app.go

@@ -1019,28 +1019,51 @@
 	app.UpgradeKeeper.SetUpgradeHandler(
 		UpgradeName,
 		func(ctx sdk.Context, _ upgradetypes.Plan, fromVM module.VersionMap) (module.VersionMap, error) {
-			// stuck unbonding epoch numbers
-			RemovableUnbondings := map[string]map[int64]any{"cosmoshub-4": {312: nil}, "osmosis-1": {429: nil, 432: nil}}
-
-			// get the stuck unbondings from the store
-			unbondings := app.LiquidStakeIBCKeeper.FilterUnbondings(
-				ctx,
-				func(u liquidstakeibctypes.Unbonding) bool {
-					_, chain := RemovableUnbondings[u.ChainId]
-					if chain {
-						_, epoch := RemovableUnbondings[u.ChainId][u.EpochNumber]
-						if epoch {
-							return true
-						}
-					}
-					return false
-				},
-			)
-
-			// mark the stuck unbondings as failed, so they can be processed
-			for _, unbonding := range unbondings {
-				unbonding.State = liquidstakeibctypes.Unbonding_UNBONDING_FAILED
-				app.LiquidStakeIBCKeeper.SetUnbonding(ctx, unbonding)
+			for _, hc := range app.LiquidStakeIBCKeeper.GetAllHostChains(ctx) {
+				switch hc.ChainId {
+				case "cosmoshub-4":
+					upperLimit, _ := sdk.NewDecFromStr("1.01")
+					lowerLimit, _ := sdk.NewDecFromStr("0.85")
+					hc.Params.UpperCValueLimit = upperLimit
+					hc.Params.LowerCValueLimit = lowerLimit
+					app.LiquidStakeIBCKeeper.SetHostChain(ctx, hc)
+					break
+				case "osmosis-1":
+					upperLimit, _ := sdk.NewDecFromStr("1.01")
+					lowerLimit, _ := sdk.NewDecFromStr("0.97")
+					hc.Params.UpperCValueLimit = upperLimit
+					hc.Params.LowerCValueLimit = lowerLimit
+					app.LiquidStakeIBCKeeper.SetHostChain(ctx, hc)
+					break
+				case "theta-testnet-001":
+					upperLimit, _ := sdk.NewDecFromStr("1.01")
+					lowerLimit, _ := sdk.NewDecFromStr("0.9")
+					hc.Params.UpperCValueLimit = upperLimit
+					hc.Params.LowerCValueLimit = lowerLimit
+					app.LiquidStakeIBCKeeper.SetHostChain(ctx, hc)
+					break
+				case "osmo-test-5":
+					upperLimit, _ := sdk.NewDecFromStr("1.01")
+					lowerLimit, _ := sdk.NewDecFromStr("0.95")
+					hc.Params.UpperCValueLimit = upperLimit
+					hc.Params.LowerCValueLimit = lowerLimit
+					app.LiquidStakeIBCKeeper.SetHostChain(ctx, hc)
+					break
+				case "dydx-test-4":
+					upperLimit, _ := sdk.NewDecFromStr("1.01")
+					lowerLimit, _ := sdk.NewDecFromStr("0.95")
+					hc.Params.UpperCValueLimit = upperLimit
+					hc.Params.LowerCValueLimit = lowerLimit
+					app.LiquidStakeIBCKeeper.SetHostChain(ctx, hc)
+					break
+				case "gaia-1":
+					upperLimit, _ := sdk.NewDecFromStr("1.01")
+					lowerLimit, _ := sdk.NewDecFromStr("0.95")
+					hc.Params.UpperCValueLimit = upperLimit
+					hc.Params.LowerCValueLimit = lowerLimit
+					app.LiquidStakeIBCKeeper.SetHostChain(ctx, hc)
+					break
+				}
 			}
 
 			return app.mm.RunMigrations(ctx, app.configurator, fromVM)

app/const.go

@@ -2,5 +2,5 @@ package app
 
 const (
 	appName     = "pStake"
-	UpgradeName = "v2.8.2"
+	UpgradeName = "v2.9.0"
 )

proto/pstake/liquidstakeibc/v1beta1/liquidstakeibc.proto

@@ -116,14 +116,25 @@
     (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int",
     (gogoproto.nullable) = false
   ];
+  string upper_c_value_limit = 10 [
+    (cosmos_proto.scalar) = "cosmos.Dec",
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable) = false
+  ]; // upper limit for the c value of the host chain
+
+  string lower_c_value_limit = 11 [
+    (cosmos_proto.scalar) = "cosmos.Dec",
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable) = false
+  ]; // lower limit for the c value of the host chain
 }
 
 message ICAAccount {
   enum ChannelState {
     // ICA channel is being created
     ICA_CHANNEL_CREATING = 0;
     // ICA is established and the account can be used
     ICA_CHANNEL_CREATED = 1;
   }
 
   // address of the ica on the controller chain
@@ -173,7 +184,7 @@
 message Deposit {
   enum DepositState {
     // no action has been initiated on the deposit
     DEPOSIT_PENDING = 0;
     // deposit sent to the host chain delegator address
     DEPOSIT_SENT = 1;
     // deposit received by the host chain delegator address

proto/pstake/liquidstakeibc/v1beta1/params.proto

@@ -8,7 +8,7 @@
 option go_package = "github.com/persistenceOne/pstake-native/v2/x/liquidstakeibc/types";
 
 // Params defines the parameters for the module.
 message Params {
   option (amino.name) = "pstake/x/liquidstakeibc/Params";
 
   string admin_address = 1
@@ -18,15 +18,8 @@
   string fee_address = 2 [ (cosmos_proto.scalar) =
                                "cosmos.AddressString" ]; // protocol fee address
 
-  string upper_c_value_limit = 3 [
-    (cosmos_proto.scalar) = "cosmos.Dec",
-    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
-    (gogoproto.nullable) = false
-  ]; // upper limit for the c value of a host chain
-
-  string lower_c_value_limit = 4 [
-    (cosmos_proto.scalar) = "cosmos.Dec",
-    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
-    (gogoproto.nullable) = false
-  ]; // lower limit for the c value of a host chain
+  // fields 3 and 4 were migrated to on-chain params.
+  // check https://github.com/persistenceOne/pstake-native/pull/732.
+  reserved 3; // upper_c_value_limit
+  reserved 4; // lower_c_value_limit
 }

x/liquidstakeibc/genesis_test.go

@@ -15,18 +15,23 @@ import (
 )
 
 func TestGenesis(t *testing.T) {
+	upperCValueLimit, _ := sdk.NewDecFromStr("1.05")
+	lowerCValueLimit, _ := sdk.NewDecFromStr("0.95")
+
 	genesisState := &types.GenesisState{
 		Params: types.DefaultParams(),
 		HostChains: []*types.HostChain{{
 			ChainId:      "chainA-1",
 			ConnectionId: "connection-1",
 			Params: &types.HostChainLSParams{
-				DepositFee:      sdk.ZeroDec(),
-				RestakeFee:      sdk.ZeroDec(),
-				UnstakeFee:      sdk.ZeroDec(),
-				RedemptionFee:   sdk.ZeroDec(),
-				LsmValidatorCap: sdk.NewDec(1),
-				LsmBondFactor:   sdk.NewDec(-1),
+				DepositFee:       sdk.ZeroDec(),
+				RestakeFee:       sdk.ZeroDec(),
+				UnstakeFee:       sdk.ZeroDec(),
+				RedemptionFee:    sdk.ZeroDec(),
+				LsmValidatorCap:  sdk.NewDec(1),
+				LsmBondFactor:    sdk.NewDec(-1),
+				UpperCValueLimit: upperCValueLimit,
+				LowerCValueLimit: lowerCValueLimit,
 			},
 			HostDenom: "uatom",
 			ChannelId: "channel-1",

x/liquidstakeibc/keeper/grpc_querier_test.go

@@ -37,10 +37,8 @@ func (suite *IntegrationTestSuite) TestQueryParams() {
 			req:  &types.QueryParamsRequest{},
 			resp: &types.QueryParamsResponse{
 				Params: types.Params{
-					AdminAddress:     "persistence1gztc3y3k52hjds5nqvl7h9jvfnc33spz47zcjy",
-					FeeAddress:       "persistence1gztc3y3k52hjds5nqvl7h9jvfnc33spz47zcjy",
-					UpperCValueLimit: decFromStr("1.1"),
-					LowerCValueLimit: decFromStr("0.85"),
+					AdminAddress: "persistence1gztc3y3k52hjds5nqvl7h9jvfnc33spz47zcjy",
+					FeeAddress:   "persistence1gztc3y3k52hjds5nqvl7h9jvfnc33spz47zcjy",
 				},
 			},
 		},

x/liquidstakeibc/keeper/invariants.go

@@ -19,7 +19,7 @@ func CValueLimits(k Keeper) sdk.Invariant {
 		str := ""
 		broken := false
 		for _, hc := range hostChains {
-			if !k.CValueWithinLimits(ctx, hc) {
+			if !k.CValueWithinLimits(hc) {
 				str = fmt.Sprintf("chainID: %s, cValue: %s \n", hc.ChainId, hc.CValue)
 			}
 		}

x/liquidstakeibc/keeper/keeper.go

@@ -329,7 +329,7 @@ func (k *Keeper) UpdateCValues(ctx sdk.Context) {
 		}()
 
 		// if the c value is out of bounds, disable the chain
-		if !k.CValueWithinLimits(ctx, hc) {
+		if !k.CValueWithinLimits(hc) {
 			hc.Active = false
 			k.SetHostChain(ctx, hc)
 
@@ -350,8 +350,8 @@ func (k *Keeper) UpdateCValues(ctx sdk.Context) {
 	}
 }
 
-func (k *Keeper) CValueWithinLimits(ctx sdk.Context, hc *types.HostChain) bool {
-	return hc.CValue.LT(k.GetParams(ctx).UpperCValueLimit) && hc.CValue.GT(k.GetParams(ctx).LowerCValueLimit)
+func (k *Keeper) CValueWithinLimits(hc *types.HostChain) bool {
+	return hc.CValue.LT(hc.Params.UpperCValueLimit) && hc.CValue.GT(hc.Params.LowerCValueLimit)
 }
 
 func (k *Keeper) CalculateAutocompoundLimit(autocompoundFactor sdk.Dec) sdk.Dec {

x/liquidstakeibc/keeper/keeper_test.go

@@ -22,16 +22,12 @@ func (suite *IntegrationTestSuite) TestGetSetParams() {
 		{
 			name: "normal params",
 			params: types.Params{
-				AdminAddress:     "persistence10khgeppewe4rgfrcy809r9h00aquwxxxrk6glr",
-				FeeAddress:       "persistence1xruvjju28j0a5ud5325rfdak8f5a04h0s30mld",
-				UpperCValueLimit: decFromStr("1.1"),
-				LowerCValueLimit: decFromStr("0.9"),
+				AdminAddress: "persistence10khgeppewe4rgfrcy809r9h00aquwxxxrk6glr",
+				FeeAddress:   "persistence1xruvjju28j0a5ud5325rfdak8f5a04h0s30mld",
 			},
 			expected: types.Params{
-				AdminAddress:     "persistence10khgeppewe4rgfrcy809r9h00aquwxxxrk6glr",
-				FeeAddress:       "persistence1xruvjju28j0a5ud5325rfdak8f5a04h0s30mld",
-				UpperCValueLimit: decFromStr("1.1"),
-				LowerCValueLimit: decFromStr("0.9"),
+				AdminAddress: "persistence10khgeppewe4rgfrcy809r9h00aquwxxxrk6glr",
+				FeeAddress:   "persistence1xruvjju28j0a5ud5325rfdak8f5a04h0s30mld",
 			},
 		},
 	}
@@ -274,9 +270,8 @@ func (suite *IntegrationTestSuite) TestUpdateCValues() {
 	suite.Require().NotPanics(func() { pstakeApp.LiquidStakeIBCKeeper.UpdateCValues(ctx) })
 
 	// lower limits so that chain goes out of limits
-	params := pstakeApp.LiquidStakeIBCKeeper.GetParams(ctx)
-	params.UpperCValueLimit = sdk.MustNewDecFromStr("0.5")
-	pstakeApp.LiquidStakeIBCKeeper.SetParams(ctx, params)
+	hc.Params.UpperCValueLimit = sdk.MustNewDecFromStr("0.5")
+	pstakeApp.LiquidStakeIBCKeeper.SetHostChain(ctx, hc)
 	suite.Require().NotPanics(func() { pstakeApp.LiquidStakeIBCKeeper.UpdateCValues(ctx) })
 	hc, _ = pstakeApp.LiquidStakeIBCKeeper.GetHostChain(ctx, suite.chainB.ChainID)
 	suite.Require().Equal(false, hc.Active)

x/liquidstakeibc/keeper/msg_server.go

@@ -236,6 +236,20 @@ func (k msgServer) UpdateHostChain(
 				return nil, err
 			}
 			hc.Params.MaxEntries = uint32(entries)
+		case types.KeyUpperCValueLimit:
+			limit, err := sdktypes.NewDecFromStr(update.Value)
+			if err != nil {
+				return nil, fmt.Errorf("unable to parse string to sdk.Dec: %w", err)
+			}
+			// limit validated in msg.ValidateBasic()
+			hc.Params.UpperCValueLimit = limit
+		case types.KeyLowerCValueLimit:
+			limit, err := sdktypes.NewDecFromStr(update.Value)
+			if err != nil {
+				return nil, fmt.Errorf("unable to parse string to sdk.Dec: %w", err)
+			}
+			// limit validated in msg.ValidateBasic()
+			hc.Params.LowerCValueLimit = limit
 		case types.KeyRedelegationAcceptableDelta:
 			redelegationAcceptableDelta, ok := sdktypes.NewIntFromString(update.Value)
 			if !ok {

x/liquidstakeibc/keeper/msg_server_test.go

@@ -536,10 +536,8 @@ func (suite *IntegrationTestSuite) Test_msgServer_UpdateParams() {
 				msg: &types.MsgUpdateParams{
 					Authority: suite.chainA.SenderAccount.GetAddress().String(),
 					Params: types.Params{
-						AdminAddress:     suite.chainA.SenderAccount.GetAddress().String(),
-						FeeAddress:       suite.chainA.SenderAccount.GetAddress().String(),
-						UpperCValueLimit: sdk.OneDec(),
-						LowerCValueLimit: sdk.ZeroDec(),
+						AdminAddress: suite.chainA.SenderAccount.GetAddress().String(),
+						FeeAddress:   suite.chainA.SenderAccount.GetAddress().String(),
 					},
 				},
 			},

x/liquidstakeibc/keeper/setup_suite_test.go

@@ -155,13 +155,21 @@ func (suite *IntegrationTestSuite) SetupHostChainAB() {
 	lsmBondFactor, err := sdk.NewDecFromStr("50")
 	suite.NoError(err)
 
+	upperCValueLimit, err := sdk.NewDecFromStr("1.05")
+	suite.NoError(err)
+
+	lowerCValueLimit, err := sdk.NewDecFromStr("0.95")
+	suite.NoError(err)
+
 	hostChainLSParams := &types.HostChainLSParams{
-		DepositFee:      depositFee,
-		RestakeFee:      restakeFee,
-		UnstakeFee:      unstakeFee,
-		RedemptionFee:   redemptionFee,
-		LsmValidatorCap: lsmValidatorCap,
-		LsmBondFactor:   lsmBondFactor,
+		DepositFee:       depositFee,
+		RestakeFee:       restakeFee,
+		UnstakeFee:       unstakeFee,
+		RedemptionFee:    redemptionFee,
+		LsmValidatorCap:  lsmValidatorCap,
+		LsmBondFactor:    lsmBondFactor,
+		UpperCValueLimit: upperCValueLimit,
+		LowerCValueLimit: lowerCValueLimit,
 	}
 
 	validators := make([]*types.Validator, 0)

x/liquidstakeibc/types/genesis_test.go

@@ -269,18 +269,23 @@ func TestGenesisState_Validate(t *testing.T) {
 }
 
 func ValidGenesis() *types.GenesisState {
+	upperCValueLimit, _ := sdk.NewDecFromStr("1.05")
+	lowerCValueLimit, _ := sdk.NewDecFromStr("0.95")
+
 	return &types.GenesisState{
 		Params: types.DefaultParams(),
 		HostChains: []*types.HostChain{{
 			ChainId:      "chainA-1",
 			ConnectionId: "connection-1",
 			Params: &types.HostChainLSParams{
-				DepositFee:      sdk.ZeroDec(),
-				RestakeFee:      sdk.ZeroDec(),
-				UnstakeFee:      sdk.ZeroDec(),
-				RedemptionFee:   sdk.ZeroDec(),
-				LsmValidatorCap: sdk.NewDec(1),
-				LsmBondFactor:   sdk.NewDec(-1),
+				DepositFee:       sdk.ZeroDec(),
+				RestakeFee:       sdk.ZeroDec(),
+				UnstakeFee:       sdk.ZeroDec(),
+				RedemptionFee:    sdk.ZeroDec(),
+				LsmValidatorCap:  sdk.NewDec(1),
+				LsmBondFactor:    sdk.NewDec(-1),
+				UpperCValueLimit: upperCValueLimit,
+				LowerCValueLimit: lowerCValueLimit,
 			},
 			HostDenom: "uatom",
 			ChannelId: "channel-1",

x/liquidstakeibc/types/keys.go

@@ -70,6 +70,8 @@ const (
 	KeyLSMValidatorCap             string = "lsm_validator_cap"
 	KeyLSMBondFactor               string = "lsm_bond_factor"
 	KeyMaxEntries                  string = "max_entries"
+	KeyUpperCValueLimit            string = "upper_c_value_limit"
+	KeyLowerCValueLimit            string = "lower_c_value_limit"
 	KeyRedelegationAcceptableDelta string = "redelegation_acceptable_delta"
 	KeyMinimumDeposit              string = "min_deposit"
 	KeyActive                      string = "active"