fix: fix some logics and sync spec to latest source code

app/weights.go

@@ -12,4 +12,5 @@ const (
 	DefaultWeightMsgClaimDiscountedReward       int = 10
 
 	DefaultWeightUpdateDynamicFeeRateProposal int = 2
+	DefaultWeightUpdateMaximumDiscountRate        = 2
 )

proto/canto/liquidstaking/v1/liquidstaking.proto

@@ -70,8 +70,13 @@ message DynamicFeeRate {
 // Params defines the parameters for the module.
 message Params {
   option (gogoproto.goproto_getters) = false;
+  option (gogoproto.goproto_stringer) = false;
 
   DynamicFeeRate dynamic_fee_rate = 1 [ (gogoproto.nullable) = false ];
+  string maximum_discount_rate = 2 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable) = false
+  ];
 }
 
 // ChunkStatus defines the status of the chunk.
@@ -88,29 +93,29 @@ enum ChunkStatus {
   // designated by the insurance provider.
   CHUNK_STATUS_PAIRED = 2;
   // A paired chunk enters this status when paired insurance is started to be
-  // withdrawn or is insufficient (meaning the insurance balance is below the
-  // minimum requirement to be considered valid insurance) or the validator of
-  // the insurance becomes tombstoned.
+  // withdrawn or it's balance <= 5.75%(double_sign_fraction +
+  // down_time_fraction) of chunk size tokens or the validator becomes
+  // tombstoned.
   CHUNK_STATUS_UNPAIRING = 3;
   // When a delegator (also known as a liquid staker) sends a MsgLiquidUnstake,
-  // it is queued as a PendingLiquidUnstake. At the end of the epoch,
+  // it is queued as a UnpairingForUnstakingChunkInfo. At the end of the epoch,
   // the actual undelegation is triggered and the chunk enters this state.
-  // Once the unbonding period is over in next epoch, the staked tokens are
-  // returned to the delegator's account and the associated chunk object is
-  // removed.
+  // Once the unbonding period is over in next epoch, the tokens corresponding
+  // chunk size are returned to the delegator's account and the associated chunk
+  // object is removed.
   CHUNK_STATUS_UNPAIRING_FOR_UNSTAKING = 4;
 }
 
 // Chunk defines the chunk of the module.
 message Chunk {
   option (gogoproto.goproto_getters) = false;
 
-  // Id of the chunk
+  // Unique id increased by 1
   uint64 id = 1;
   // Id of Paired insurance, 0 means no insurance
   uint64 paired_insurance_id = 2;
+  // Id of Unpairing insurance, 0 means no insurance
   uint64 unpairing_insurance_id = 3;
-  // Status of the chunk
   ChunkStatus status = 4;
 }
 
@@ -133,15 +138,16 @@ enum InsuranceStatus {
   // the chunk remains same size and maximize its staking rewards.
   INSURANCE_STATUS_PAIRED = 2;
   // A paired insurance enters this status when it no longer has enough balance
-  // to cover slashing penalties, when the validator is tombstoned, or
-  // when the paired chunk is started to be undelegated.
-  // At the next epoch, unpairing will be unpaired.
+  // (=5.75% of chunk size tokens) to cover slashing penalties, when the
+  // validator is tombstoned, or when the paired chunk is started to be
+  // undelegated by MsgLiquidUnstake. At the next epoch, unpairing will be
+  // unpaired or pairing if it still valid.
   INSURANCE_STATUS_UNPAIRING = 3;
-  // A paired insurance enters this status when there are
-  // queued withdrawal insurance requests created by MsgWithdrawInsurance at the
+  // A paired insurance enters this status when there was a
+  // queued WithdrawalInsuranceRequest created by MsgWithdrawInsurance at the
   // epoch.
   INSURANCE_STATUS_UNPAIRING_FOR_WITHDRAWAL = 4;
-  // Unpairing insurances from previous epoch enters this status.
+  // Unpairing insurances from previous epoch can enter this status.
   // Unpaired insurance can be withdrawn immediately by MsgWithdrawInsurance.
   INSURANCE_STATUS_UNPAIRED = 5;
 }
@@ -150,13 +156,12 @@ enum InsuranceStatus {
 message Insurance {
   option (gogoproto.goproto_getters) = false;
 
-  // Id of the insurance
+  // Unique id increased by 1
   uint64 id = 1;
   // Address of the validator
   string validator_address = 2;
   // Address of the insurance provider
   string provider_address = 3;
-  // Fee rate of the insurance
   string fee_rate = 4 [
     (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
     (gogoproto.nullable) = false
@@ -189,8 +194,9 @@ message NetAmountState {
     (gogoproto.nullable) = false
   ];
 
-  // Calculated by reward module account's native token balance + all paired
-  // chunk's native token balance + all delegation tokens of paired chunks
+  // Calculated by reward module account's native token balance + all
+  // all chunk's native token balance + sum of token values of all chunk's
+  // delegation shares + sum of all remaining rewards of paired chunks since
   // last Epoch + all unbonding delegation tokens of unpairing chunks
   string net_amount = 3 [
     (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
@@ -246,7 +252,8 @@ message NetAmountState {
     (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int",
     (gogoproto.nullable) = false
   ];
-  // Total shares of all paired chunks
+
+  // Total delegation shares of all paired chunks
   string total_del_shares = 12 [
     (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
     (gogoproto.nullable) = false
@@ -267,7 +274,7 @@ message NetAmountState {
     (gogoproto.nullable) = false
   ];
 
-  // The sum of unbonding balance of all chunks in Unpairing and
+  // The sum of unbonding balance of all chunks in Unpairing or
   // UnpairingForUnstaking
   string total_unbonding_chunks_balance = 15 [
     (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int",
@@ -303,24 +310,23 @@ message NetAmountState {
 }
 
 message UnpairingForUnstakingChunkInfo {
-  // The id of chunk
+  // Which chunk is unpairing for unstaking
   uint64 chunk_id = 1;
   // Address of delegator (=liquid unstaker)
   string delegator_address = 2;
-  // Amount of ls tokens to burn
+  // How much lstokens will be burned when unbonding finished
   string escrowed_lstokens = 3 [
     (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Coin",
     (gogoproto.nullable) = false
   ];
 }
 
 message WithdrawInsuranceRequest {
-  // The id of insurance
+  // Which insurance is requested for withdrawal
   uint64 insurance_id = 1;
 }
 
 message RedelegationInfo {
-  // The id of chunk
   uint64 chunk_id = 1;
   google.protobuf.Timestamp completion_time = 2
       [ (gogoproto.stdtime) = true, (gogoproto.nullable) = false ];

proto/canto/liquidstaking/v1/tx.proto

@@ -53,7 +53,7 @@ message MsgLiquidStake {
   // delegator_address is the address of the user who requests the liquid
   // staking.
   string delegator_address = 1;
-  // amount is the amount of native token to be liquid staked.
+  // (How many chunks to liquid stake?) x ChunkSize
   string amount = 2 [
     (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Coin",
     (gogoproto.nullable) = false
@@ -65,8 +65,7 @@ message MsgLiquidStakeResponse {}
 message MsgLiquidUnstake {
   // delegator_address is the address of the user who want to liquid unstaking.
   string delegator_address = 1;
-  // amount is the number calculated by (number of chunks want to unstake) *
-  // chunk.size. The delegator must have corresponding ls tokens to unstake.
+  // (How many chunks to be unstaked?) x ChunkSize
   string amount = 2 [
     (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Coin",
     (gogoproto.nullable) = false

x/liquidstaking/client/testutil/suite.go

@@ -66,7 +66,7 @@ func (suite *IntegrationTestSuite) TestCmdQueryParams() {
 		{
 			"json output",
 			[]string{fmt.Sprintf("--%s=json", tmcli.OutputFlag)},
-			`{"params":{"dynamic_fee_rate":{"r0":"0.000000000000000000","u_soft_cap":"0.050000000000000000","u_hard_cap":"0.100000000000000000","u_optimal":"0.090000000000000000","slope1":"0.100000000000000000","slope2":"0.400000000000000000","max_fee_rate":"0.500000000000000000"}}}`,
+			`{"params":{"dynamic_fee_rate":{"r0":"0.000000000000000000","u_soft_cap":"0.050000000000000000","u_hard_cap":"0.100000000000000000","u_optimal":"0.090000000000000000","slope1":"0.100000000000000000","slope2":"0.400000000000000000","max_fee_rate":"0.500000000000000000"},"maximum_discount_rate":"0.030000000000000000"}}`,
 		},
 		{
 			"text output",
@@ -80,6 +80,7 @@ func (suite *IntegrationTestSuite) TestCmdQueryParams() {
     u_hard_cap: "0.100000000000000000"
     u_optimal: "0.090000000000000000"
     u_soft_cap: "0.050000000000000000"
+  maximum_discount_rate: "0.030000000000000000"
 `,
 		},
 	}