feat(staking): add locked token type param (cosmos#7)

proto/cosmos/staking/v1beta1/staking.proto

@@ -399,7 +399,8 @@ message Params {
   int32           flexible_period_type = 8;
   repeated Period periods              = 9 [(gogoproto.nullable) = false, (amino.dont_omitempty) = true];
 
-  repeated TokenTypeInfo token_types = 10 [(gogoproto.nullable) = false, (amino.dont_omitempty) = true];
+  int32                  locked_token_type = 10;
+  repeated TokenTypeInfo token_types       = 11 [(gogoproto.nullable) = false, (amino.dont_omitempty) = true];
 }
 
 // DelegationResponse is equivalent to Delegation except that it contains a

tests/fixtures/adr-024-coin-metadata_genesis.json

@@ -226,6 +226,7 @@
             "rewards_multiplier": "1.34"
           }
         ],
+        "locked_token_type": 0,
         "token_types":[
           {
             "token_type": 0,

x/staking/keeper/params.go

@@ -129,7 +129,7 @@ func (k Keeper) GetTokenTypes(ctx context.Context) ([]types.TokenTypeInfo, error
 }
 
 // GetFlexiblePeriodType gets the flexible period type from x/staking module parameters.
-func (k Keeper) GetFlexiblePeriodType(ctx context.Context) (periodType int32, err error) {
+func (k Keeper) GetFlexiblePeriodType(ctx context.Context) (int32, error) {
 	store := k.storeService.OpenKVStore(ctx)
 
 	bz, err := store.Get(types.ParamsKey)
@@ -147,6 +147,25 @@ func (k Keeper) GetFlexiblePeriodType(ctx context.Context) (periodType int32, er
 	return params.FlexiblePeriodType, nil
 }
 
+// GetLockedTokenType gets the locked token type from x/staking module parameters.
+func (k Keeper) GetLockedTokenType(ctx context.Context) (int32, error) {
+	store := k.storeService.OpenKVStore(ctx)
+
+	bz, err := store.Get(types.ParamsKey)
+	if err != nil {
+		return 0, err
+	} else if bz == nil {
+		return 0, nil
+	}
+
+	var params types.Params
+	if err := k.cdc.Unmarshal(bz, &params); err != nil {
+		return 0, err
+	}
+
+	return params.LockedTokenType, nil
+}
+
 // GetPeriodInfo gets the period info from x/staking module parameters.
 func (k Keeper) GetPeriodInfo(ctx context.Context, periodType int32) (types.Period, error) {
 	store := k.storeService.OpenKVStore(ctx)

x/staking/migrations/v3/json_test.go

@@ -44,6 +44,7 @@ func TestMigrateJSON(t *testing.T) {
 		"bond_denom": "stake",
 		"flexible_period_type": 0,
 		"historical_entries": 10000,
+		"locked_token_type": 0,
 		"max_entries": 7,
 		"max_validators": 100,
 		"min_commission_rate": "0.000000000000000000",

x/staking/simulation/genesis.go

@@ -55,7 +55,7 @@ func RandomizedGenState(simState *module.SimulationState) {
 	// NOTE: the slashing module need to be defined after the staking module on the
 	// NewSimulationManager constructor for this to work
 	simState.UnbondTime = unbondTime
-	params := types.NewParams(simState.UnbondTime, maxVals, 7, histEntries, simState.BondDenom, minCommissionRate, types.DefaultMinDelegation, types.DefaultFlexiblePeriodType, types.DefaultPeriods, types.DefaultTokenTypes)
+	params := types.NewParams(simState.UnbondTime, maxVals, 7, histEntries, simState.BondDenom, minCommissionRate, types.DefaultMinDelegation, types.DefaultFlexiblePeriodType, types.DefaultPeriods, types.DefaultLockedTokenType, types.DefaultTokenTypes)
 
 	// validators & delegations
 	var (

x/staking/types/params.go

@@ -31,6 +31,8 @@ const (
 	DefaultHistoricalEntries uint32 = 10000
 
 	DefaultFlexiblePeriodType = 0
+
+	DefaultLockedTokenType = 0
 )
 
 // DefaultMinCommissionRate is set to 0%
@@ -75,7 +77,7 @@ var DefaultTokenTypes = []TokenTypeInfo{
 // NewParams creates a new Params instance
 func NewParams(
 	unbondingTime time.Duration, maxValidators, maxEntries, historicalEntries uint32, bondDenom string, minCommissionRate math.LegacyDec,
-	minDelegation math.Int, flexiblePeriodType int32, periods []Period, tokenTypes []TokenTypeInfo,
+	minDelegation math.Int, flexiblePeriodType int32, periods []Period, lockedTokenType int32, tokenTypes []TokenTypeInfo,
 ) Params {
 	return Params{
 		UnbondingTime:      unbondingTime,
@@ -87,6 +89,7 @@ func NewParams(
 		MinDelegation:      minDelegation,
 		FlexiblePeriodType: flexiblePeriodType,
 		Periods:            periods,
+		LockedTokenType:    lockedTokenType,
 		TokenTypes:         tokenTypes,
 	}
 }
@@ -103,6 +106,7 @@ func DefaultParams() Params {
 		DefaultMinDelegation,
 		DefaultFlexiblePeriodType,
 		DefaultPeriods,
+		DefaultLockedTokenType,
 		DefaultTokenTypes,
 	)
 }
@@ -161,6 +165,10 @@ func (p Params) Validate() error {
 		return err
 	}
 
+	if err := validateLockedTokenType(p.LockedTokenType); err != nil {
+		return err
+	}
+
 	if err := validateTokenTypes(p.TokenTypes); err != nil {
 		return err
 	}
@@ -296,6 +304,19 @@ func validatePeriods(i interface{}) error {
 	return nil
 }
 
+func validateLockedTokenType(i interface{}) error {
+	v, ok := i.(int32)
+	if !ok {
+		return fmt.Errorf("invalid parameter type: %T", i)
+	}
+
+	if v < 0 {
+		return fmt.Errorf("invalid locked token type: %d", v)
+	}
+
+	return nil
+}
+
 func validateTokenTypes(i interface{}) error {
 	tokenTypes, ok := i.([]TokenTypeInfo)
 	if !ok {