feat: retry delay period as param (#1308)

* boilerplate

* fix test

* Update proposal_test.go

* apply new param to keeper code

* Update params_test.go

proto/interchain_security/ccv/v1/shared_consumer.proto

@@ -77,6 +77,10 @@ message Params {
     // Provider-originated reward denoms. These are denoms coming from the
     // provider which are allowed to be used as rewards. e.g. "uatom"
     repeated string provider_reward_denoms = 12;
+
+    // The period after which a consumer can retry sending a throttled packet.
+    google.protobuf.Duration retry_delay_period = 13
+        [ (gogoproto.nullable) = false, (gogoproto.stdduration) = true ];
 }
 
 // GenesisState defines the CCV consumer chain genesis state.

tests/difference/core/driver/setup.go

@@ -537,6 +537,7 @@ func (b *Builder) createConsumerGenesis(client *ibctmtypes.ClientState) *ccv.Gen
 		"0", // disable soft opt-out
 		[]string{},
 		[]string{},
+		ccv.DefaultRetryDelayPeriod,
 	)
 	return ccv.NewInitialGenesisState(client, providerConsState, valUpdates, params)
 }

x/ccv/consumer/keeper/params.go

@@ -25,6 +25,7 @@ func (k Keeper) GetConsumerParams(ctx sdk.Context) ccvtypes.Params {
 		k.GetSoftOptOutThreshold(ctx),
 		k.GetRewardDenoms(ctx),
 		k.GetProviderRewardDenoms(ctx),
+		k.GetRetryDelayPeriod(ctx),
 	)
 }
 
@@ -138,3 +139,9 @@ func (k Keeper) GetProviderRewardDenoms(ctx sdk.Context) []string {
 	k.paramStore.Get(ctx, ccvtypes.KeyProviderRewardDenoms, &denoms)
 	return denoms
 }
+
+func (k Keeper) GetRetryDelayPeriod(ctx sdk.Context) time.Duration {
+	var period time.Duration
+	k.paramStore.Get(ctx, ccvtypes.KeyRetryDelayPeriod, &period)
+	return period
+}

x/ccv/consumer/keeper/params_test.go

@@ -31,14 +31,15 @@ func TestParams(t *testing.T) {
 		ccv.DefaultSoftOptOutThreshold,
 		rewardDenoms,
 		provideRewardDenoms,
+		ccv.DefaultRetryDelayPeriod,
 	) // these are the default params, IBC suite independently sets enabled=true
 
 	params := consumerKeeper.GetConsumerParams(ctx)
 	require.Equal(t, expParams, params)
 
 	newParams := ccv.NewParams(false, 1000,
 		"channel-2", "cosmos19pe9pg5dv9k5fzgzmsrgnw9rl9asf7ddwhu7lm",
-		7*24*time.Hour, 25*time.Hour, "0.5", 500, 24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"})
+		7*24*time.Hour, 25*time.Hour, "0.5", 500, 24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"}, 2*time.Hour)
 	consumerKeeper.SetParams(ctx, newParams)
 	params = consumerKeeper.GetConsumerParams(ctx)
 	require.Equal(t, newParams, params)

x/ccv/consumer/keeper/throttle_retry.go

@@ -2,7 +2,6 @@ package keeper
 
 import (
 	"fmt"
-	"time"
 
 	sdktypes "github.com/cosmos/cosmos-sdk/types"
 
@@ -44,9 +43,6 @@ import (
 // This design is implemented below, and in relay.go under SendPackets() and OnAcknowledgementPacket().
 //
 
-// Retry delay period could be implemented as a param, but 1 hour is reasonable
-const RetryDelayPeriod = time.Hour
-
 // PacketSendingPermitted returns whether the consumer is allowed to send packets
 // from the pending packets queue.
 func (k Keeper) PacketSendingPermitted(ctx sdktypes.Context) bool {
@@ -60,7 +56,7 @@ func (k Keeper) PacketSendingPermitted(ctx sdktypes.Context) bool {
 		return false
 	}
 	// If retry delay period has elapsed, we can send again
-	return ctx.BlockTime().After(record.SendTime.Add(RetryDelayPeriod))
+	return ctx.BlockTime().After(record.SendTime.Add(k.GetRetryDelayPeriod(ctx)))
 }
 
 func (k Keeper) UpdateSlashRecordOnSend(ctx sdktypes.Context) {

x/ccv/consumer/keeper/throttle_retry_test.go

@@ -7,14 +7,16 @@ import (
 	"github.com/stretchr/testify/require"
 
 	testutil "github.com/cosmos/interchain-security/v3/testutil/keeper"
-	consumerkeeper "github.com/cosmos/interchain-security/v3/x/ccv/consumer/keeper"
 	consumertypes "github.com/cosmos/interchain-security/v3/x/ccv/consumer/types"
+	ccvtypes "github.com/cosmos/interchain-security/v3/x/ccv/types"
 )
 
 func TestPacketSendingPermitted(t *testing.T) {
 	consumerKeeper, ctx, ctrl, _ := testutil.GetConsumerKeeperAndCtx(t, testutil.NewInMemKeeperParams(t))
 	defer ctrl.Finish()
 
+	consumerKeeper.SetParams(ctx, ccvtypes.DefaultParams())
+
 	ctx = ctx.WithBlockTime(time.Now())
 
 	// No slash record exists, send is permitted
@@ -42,7 +44,8 @@ func TestPacketSendingPermitted(t *testing.T) {
 	require.False(t, consumerKeeper.PacketSendingPermitted(ctx))
 
 	// Elapse retry delay period
-	ctx = ctx.WithBlockTime(ctx.BlockTime().Add(2 * consumerkeeper.RetryDelayPeriod))
+	period := consumerKeeper.GetRetryDelayPeriod(ctx)
+	ctx = ctx.WithBlockTime(ctx.BlockTime().Add(2 * period))
 
 	// Now packet sending is permitted again
 	require.True(t, consumerKeeper.PacketSendingPermitted(ctx))

x/ccv/consumer/types/genesis_test.go

@@ -222,6 +222,7 @@ func TestValidateInitialGenesisState(t *testing.T) {
 					types.DefaultSoftOptOutThreshold,
 					[]string{},
 					[]string{},
+					types.DefaultRetryDelayPeriod,
 				)),
 			true,
 		},
@@ -241,6 +242,7 @@ func TestValidateInitialGenesisState(t *testing.T) {
 					types.DefaultSoftOptOutThreshold,
 					[]string{},
 					[]string{},
+					types.DefaultRetryDelayPeriod,
 				)),
 			true,
 		},
@@ -442,6 +444,7 @@ func TestValidateRestartGenesisState(t *testing.T) {
 					types.DefaultSoftOptOutThreshold,
 					[]string{},
 					[]string{},
+					types.DefaultRetryDelayPeriod,
 				)),
 			true,
 		},

x/ccv/consumer/types/params_test.go

@@ -19,59 +19,67 @@ func TestValidateParams(t *testing.T) {
 		{"default params", ccvtypes.DefaultParams(), true},
 		{
 			"custom valid params",
-			ccvtypes.NewParams(true, 5, "", "", 1004, 1005, "0.5", 1000, 24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"}), true,
+			ccvtypes.NewParams(true, 5, "", "", 1004, 1005, "0.5", 1000, 24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"}, 2*time.Hour), true,
 		},
 		{
 			"custom invalid params, block per dist transmission",
-			ccvtypes.NewParams(true, -5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"}), false,
+			ccvtypes.NewParams(true, -5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"}, 2*time.Hour), false,
 		},
 		{
 			"custom invalid params, dist transmission channel",
-			ccvtypes.NewParams(true, 5, "badchannel/", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"}), false,
+			ccvtypes.NewParams(true, 5, "badchannel/", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"}, 2*time.Hour), false,
 		},
 		{
 			"custom invalid params, ccv timeout",
-			ccvtypes.NewParams(true, 5, "", "", -5, 1005, "0.5", 1000, 24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"}), false,
+			ccvtypes.NewParams(true, 5, "", "", -5, 1005, "0.5", 1000, 24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"}, 2*time.Hour), false,
 		},
 		{
 			"custom invalid params, transfer timeout",
-			ccvtypes.NewParams(true, 5, "", "", 1004, -7, "0.5", 1000, 24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"}), false,
+			ccvtypes.NewParams(true, 5, "", "", 1004, -7, "0.5", 1000, 24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"}, 2*time.Hour), false,
 		},
 		{
 			"custom invalid params, consumer redist fraction is negative",
-			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "-0.5", 1000, 24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"}), false,
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "-0.5", 1000, 24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"}, 2*time.Hour), false,
 		},
 		{
 			"custom invalid params, consumer redist fraction is over 1",
-			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "1.2", 1000, 24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"}), false,
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "1.2", 1000, 24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"}, 2*time.Hour), false,
 		},
 		{
 			"custom invalid params, bad consumer redist fraction ",
-			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "notFrac", 1000, 24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"}), false,
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "notFrac", 1000, 24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"}, 2*time.Hour), false,
 		},
 		{
 			"custom invalid params, negative num historical entries",
-			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", -100, 24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"}), false,
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", -100, 24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"}, 2*time.Hour), false,
 		},
 		{
 			"custom invalid params, negative unbonding period",
-			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, -24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"}), false,
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, -24*21*time.Hour, "0.05", []string{"untrn"}, []string{"uatom"}, 2*time.Hour), false,
 		},
 		{
 			"custom invalid params, invalid soft opt out threshold",
-			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, "-0.05", []string{"u"}, []string{}), false,
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, "-0.05", []string{"u"}, []string{}, 2*time.Hour), false,
 		},
 		{
 			"custom invalid params, invalid soft opt out threshold",
-			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, "0.5", []string{"u"}, []string{}), false,
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, "0.5", []string{"u"}, []string{}, 2*time.Hour), false,
 		},
 		{
 			"custom invalid params, invalid reward denom",
-			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, "0.05", []string{"u"}, []string{}), false,
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, "0.05", []string{"u"}, []string{}, 2*time.Hour), false,
 		},
 		{
 			"custom invalid params, invalid provider reward denom",
-			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, "0.05", []string{}, []string{"a"}), false,
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, "0.05", []string{}, []string{"a"}, 2*time.Hour), false,
+		},
+		{
+			"custom invalid params, retry delay period is negative",
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, "0.05", []string{}, []string{}, -2*time.Hour), false,
+		},
+		{
+			"custom invalid params, retry delay period is zero",
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, "0.05", []string{}, []string{}, 0), false,
 		},
 	}
 

x/ccv/provider/keeper/proposal.go

@@ -299,6 +299,7 @@ func (k Keeper) MakeConsumerGenesis(
 		"0.05",
 		[]string{},
 		[]string{},
+		ccv.DefaultRetryDelayPeriod,
 	)
 
 	gen = *ccv.NewInitialGenesisState(

x/ccv/provider/keeper/proposal_test.go

@@ -813,7 +813,8 @@ func TestMakeConsumerGenesis(t *testing.T) {
 			"unbonding_period": 1728000000000000,
 			"soft_opt_out_threshold": "0.05",
 			"reward_denoms": [],
-			"provider_reward_denoms": []
+			"provider_reward_denoms": [],
+			"retry_delay_period": 3600000000000
 		},
 		"new_chain": true,
 		"provider_client_state": {

x/ccv/types/params.go

@@ -39,6 +39,9 @@ const (
 
 	// By default, the bottom 5% of the validator set can opt out of validating consumer chains
 	DefaultSoftOptOutThreshold = "0.05"
+
+	// Default retry delay period is 1 hour.
+	DefaultRetryDelayPeriod = time.Hour
 )
 
 // Reflection based keys for params subspace
@@ -54,6 +57,7 @@ var (
 	KeySoftOptOutThreshold               = []byte("SoftOptOutThreshold")
 	KeyRewardDenoms                      = []byte("RewardDenoms")
 	KeyProviderRewardDenoms              = []byte("ProviderRewardDenoms")
+	KeyRetryDelayPeriod                  = []byte("RetryDelayPeriod")
 )
 
 // ParamKeyTable type declaration for parameters
@@ -66,7 +70,8 @@ func NewParams(enabled bool, blocksPerDistributionTransmission int64,
 	distributionTransmissionChannel, providerFeePoolAddrStr string,
 	ccvTimeoutPeriod, transferTimeoutPeriod time.Duration,
 	consumerRedistributionFraction string, historicalEntries int64,
-	consumerUnbondingPeriod time.Duration, softOptOutThreshold string, rewardDenoms, providerRewardDenoms []string,
+	consumerUnbondingPeriod time.Duration, softOptOutThreshold string,
+	rewardDenoms, providerRewardDenoms []string, retryDelayPeriod time.Duration,
 ) Params {
 	return Params{
 		Enabled:                           enabled,
@@ -81,6 +86,7 @@ func NewParams(enabled bool, blocksPerDistributionTransmission int64,
 		SoftOptOutThreshold:               softOptOutThreshold,
 		RewardDenoms:                      rewardDenoms,
 		ProviderRewardDenoms:              providerRewardDenoms,
+		RetryDelayPeriod:                  retryDelayPeriod,
 	}
 }
 
@@ -101,6 +107,7 @@ func DefaultParams() Params {
 		DefaultSoftOptOutThreshold,
 		rewardDenoms,
 		provideRewardDenoms,
+		DefaultRetryDelayPeriod,
 	)
 }
 
@@ -142,6 +149,9 @@ func (p Params) Validate() error {
 	if err := ValidateDenoms(p.ProviderRewardDenoms); err != nil {
 		return err
 	}
+	if err := ValidateDuration(p.RetryDelayPeriod); err != nil {
+		return err
+	}
 	return nil
 }
 
@@ -171,6 +181,8 @@ func (p *Params) ParamSetPairs() paramtypes.ParamSetPairs {
 			p.RewardDenoms, ValidateDenoms),
 		paramtypes.NewParamSetPair(KeyProviderRewardDenoms,
 			p.ProviderRewardDenoms, ValidateDenoms),
+		paramtypes.NewParamSetPair(KeyRetryDelayPeriod,
+			p.RetryDelayPeriod, ValidateDuration),
 	}
 }