feat!: add memo to IBC transfers of ICS rewards (backport #2290)

.changelog/unreleased/features/2290-add-memo-to-ICS-rewards.md

@@ -0,0 +1,4 @@
+- `[x/consumer]` Populate the memo on the IBC transfer packets used to send ICS rewards.
+with the required consumer chain Id to identify the consumer to the provider.
+- `[x/provider]` Identify the source of ICS rewards from the IBC transfer packet memo.
+  ([\#2290](https://github.com/cosmos/interchain-security/pull/2290))

.changelog/unreleased/state-breaking/2290-add-memo-to-ICS-rewards.md

@@ -0,0 +1,4 @@
+- `[x/consumer]` Populate the memo on the IBC transfer packets used to send ICS rewards.
+with the required consumer chain Id to identify the consumer to the provider.
+- `[x/provider]` Identify the source of ICS rewards from the IBC transfer packet memo.
+  ([\#2290](https://github.com/cosmos/interchain-security/pull/2290))

UPGRADING.md

@@ -2,6 +2,28 @@
 
 This guide provides instructions for upgrading to specific versions of Replicated Security.
 
+## [v4.5.x](https://github.com/cosmos/interchain-security/releases/tag/v4.5.0)
+
+### Consumer
+
+Upgrading a consumer from v4.4.x to v4.5.x requires state migrations. The following migrators should be added to the upgrade handler of the consumer chain:
+
+
+```go
+// InitializeConsumerId sets the consumer Id parameter in the consumer module,
+// to the consumer id for which the consumer is registered on the provider chain.
+// The consumer id can be obtained in by querying the provider, e.g. by using the
+// QueryConsumerIdFromClientId query.
+func InitializeConsumerId(ctx sdk.Context, consumerKeeper consumerkeeper.Keeper) error {
+	params, err := consumerKeeper.GetConsumerParams(ctx)
+	if err != nil {
+		return err
+	}
+	params.ConsumerId = ConsumerId
+	return consumerKeeper.SetParams(ctx, params)
+}
+```
+
 ## [v4.4.x](https://github.com/cosmos/interchain-security/releases/tag/v4.4.0)
 
 ### Provider

proto/interchain_security/ccv/v1/shared_consumer.proto

@@ -76,6 +76,10 @@ message ConsumerParams {
     // 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 ];
+
+    // The consumer ID of this consumer chain. Used by the consumer module to send 
+    // ICS rewards. 
+    string consumer_id = 14;
 }
 
 // ConsumerGenesisState defines shared genesis information between provider and

tests/mbt/driver/setup.go

@@ -491,6 +491,7 @@ func createConsumerGenesis(modelParams ModelParams, providerChain *ibctesting.Te
 		[]string{},
 		[]string{},
 		ccvtypes.DefaultRetryDelayPeriod,
+		"",
 	)
 
 	return consumertypes.NewInitialGenesisState(consumerClientState, providerConsState, valUpdates, params)

x/ccv/consumer/keeper/distribution.go

@@ -117,6 +117,10 @@ func (k Keeper) SendRewardsToProvider(ctx sdk.Context) error {
 
 	sentCoins := sdk.NewCoins()
 	var allBalances sdk.Coins
+	rewardMemo, err := ccv.CreateTransferMemo(k.GetConsumerId(ctx), ctx.ChainID())
+	if err != nil {
+		return err
+	}
 	// iterate over all whitelisted reward denoms
 	for _, denom := range k.AllowedRewardDenoms(ctx) {
 		// get the balance of the denom in the toSendToProviderTokens address
@@ -133,7 +137,7 @@ func (k Keeper) SendRewardsToProvider(ctx sdk.Context) error {
 				Receiver:         providerAddr,                  // provider fee pool address to send to
 				TimeoutHeight:    timeoutHeight,                 // timeout height disabled
 				TimeoutTimestamp: timeoutTimestamp,
-				Memo:             "consumer chain rewards distribution",
+				Memo:             rewardMemo,
 			}
 
 			// validate MsgTransfer before calling Transfer()

x/ccv/consumer/keeper/params.go

@@ -25,6 +25,7 @@ func (k Keeper) GetConsumerParams(ctx sdk.Context) ccvtypes.ConsumerParams {
 		k.GetRewardDenoms(ctx),
 		k.GetProviderRewardDenoms(ctx),
 		k.GetRetryDelayPeriod(ctx),
+		k.GetConsumerId(ctx),
 	)
 }
 
@@ -136,3 +137,9 @@ func (k Keeper) GetRetryDelayPeriod(ctx sdk.Context) time.Duration {
 	k.paramStore.Get(ctx, ccvtypes.KeyRetryDelayPeriod, &period)
 	return period
 }
+
+func (k Keeper) GetConsumerId(ctx sdk.Context) string {
+	var cId string
+	k.paramStore.Get(ctx, ccvtypes.KeyConsumerId, &cId)
+	return cId
+}

x/ccv/consumer/keeper/params_test.go

@@ -31,14 +31,15 @@ func TestParams(t *testing.T) {
 		rewardDenoms,
 		provideRewardDenoms,
 		ccv.DefaultRetryDelayPeriod,
+		"0",
 	) // 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, []string{"untrn"}, []string{"uatom"}, 2*time.Hour)
+		7*24*time.Hour, 25*time.Hour, "0.5", 500, 24*21*time.Hour, []string{"untrn"}, []string{"uatom"}, 2*time.Hour, "1")
 	consumerKeeper.SetParams(ctx, newParams)
 	params = consumerKeeper.GetConsumerParams(ctx)
 	require.Equal(t, newParams, params)

x/ccv/consumer/types/genesis_test.go

@@ -233,6 +233,7 @@ func TestValidateInitialGenesisState(t *testing.T) {
 					[]string{},
 					[]string{},
 					ccv.DefaultRetryDelayPeriod,
+					"1",
 				)),
 			true,
 		},
@@ -252,6 +253,7 @@ func TestValidateInitialGenesisState(t *testing.T) {
 					[]string{},
 					[]string{},
 					ccv.DefaultRetryDelayPeriod,
+					"1",
 				)),
 			true,
 		},
@@ -457,6 +459,7 @@ func TestValidateRestartConsumerGenesisState(t *testing.T) {
 					[]string{},
 					[]string{},
 					ccv.DefaultRetryDelayPeriod,
+					"1",
 				)),
 			true,
 		},

x/ccv/consumer/types/params_test.go

@@ -11,6 +11,8 @@ import (
 
 // Tests the validation of consumer params that happens at genesis
 func TestValidateParams(t *testing.T) {
+	consumerId := "13"
+
 	testCases := []struct {
 		name    string
 		params  ccvtypes.ConsumerParams
@@ -19,59 +21,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, []string{"untrn"}, []string{"uatom"}, 2*time.Hour), true,
+			ccvtypes.NewParams(true, 5, "", "", 1004, 1005, "0.5", 1000, 24*21*time.Hour, []string{"untrn"}, []string{"uatom"}, 2*time.Hour, consumerId), true,
 		},
 		{
 			"custom invalid params, block per dist transmission",
-			ccvtypes.NewParams(true, -5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, []string{"untrn"}, []string{"uatom"}, 2*time.Hour), false,
+			ccvtypes.NewParams(true, -5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, []string{"untrn"}, []string{"uatom"}, 2*time.Hour, consumerId), false,
 		},
 		{
 			"custom invalid params, dist transmission channel",
-			ccvtypes.NewParams(true, 5, "badchannel/", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, []string{"untrn"}, []string{"uatom"}, 2*time.Hour), false,
+			ccvtypes.NewParams(true, 5, "badchannel/", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, []string{"untrn"}, []string{"uatom"}, 2*time.Hour, consumerId), false,
 		},
 		{
 			"custom invalid params, ccv timeout",
-			ccvtypes.NewParams(true, 5, "", "", -5, 1005, "0.5", 1000, 24*21*time.Hour, []string{"untrn"}, []string{"uatom"}, 2*time.Hour), false,
+			ccvtypes.NewParams(true, 5, "", "", -5, 1005, "0.5", 1000, 24*21*time.Hour, []string{"untrn"}, []string{"uatom"}, 2*time.Hour, consumerId), false,
 		},
 		{
 			"custom invalid params, transfer timeout",
-			ccvtypes.NewParams(true, 5, "", "", 1004, -7, "0.5", 1000, 24*21*time.Hour, []string{"untrn"}, []string{"uatom"}, 2*time.Hour), false,
+			ccvtypes.NewParams(true, 5, "", "", 1004, -7, "0.5", 1000, 24*21*time.Hour, []string{"untrn"}, []string{"uatom"}, 2*time.Hour, consumerId), false,
 		},
 		{
 			"custom invalid params, consumer redist fraction is negative",
-			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "-0.5", 1000, 24*21*time.Hour, []string{"untrn"}, []string{"uatom"}, 2*time.Hour), false,
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "-0.5", 1000, 24*21*time.Hour, []string{"untrn"}, []string{"uatom"}, 2*time.Hour, consumerId), false,
 		},
 		{
 			"custom invalid params, consumer redist fraction is over 1",
-			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "1.2", 1000, 24*21*time.Hour, []string{"untrn"}, []string{"uatom"}, 2*time.Hour), false,
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "1.2", 1000, 24*21*time.Hour, []string{"untrn"}, []string{"uatom"}, 2*time.Hour, consumerId), false,
 		},
 		{
 			"custom invalid params, bad consumer redist fraction ",
-			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "notFrac", 1000, 24*21*time.Hour, []string{"untrn"}, []string{"uatom"}, 2*time.Hour), false,
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "notFrac", 1000, 24*21*time.Hour, []string{"untrn"}, []string{"uatom"}, 2*time.Hour, consumerId), false,
 		},
 		{
 			"custom invalid params, negative num historical entries",
-			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", -100, 24*21*time.Hour, []string{"untrn"}, []string{"uatom"}, 2*time.Hour), false,
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", -100, 24*21*time.Hour, []string{"untrn"}, []string{"uatom"}, 2*time.Hour, consumerId), false,
 		},
 		{
 			"custom invalid params, negative unbonding period",
-			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, -24*21*time.Hour, []string{"untrn"}, []string{"uatom"}, 2*time.Hour), false,
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, -24*21*time.Hour, []string{"untrn"}, []string{"uatom"}, 2*time.Hour, consumerId), false,
 		},
 		{
 			"custom invalid params, invalid reward denom",
-			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, []string{"u"}, []string{}, 2*time.Hour), false,
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, []string{"u"}, []string{}, 2*time.Hour, consumerId), false,
 		},
 		{
 			"custom invalid params, invalid provider reward denom",
-			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, []string{}, []string{"a"}, 2*time.Hour), false,
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, []string{}, []string{"a"}, 2*time.Hour, consumerId), false,
 		},
 		{
 			"custom invalid params, retry delay period is negative",
-			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, []string{}, []string{}, -2*time.Hour), false,
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, []string{}, []string{}, -2*time.Hour, consumerId), false,
 		},
 		{
 			"custom invalid params, retry delay period is zero",
-			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, []string{}, []string{}, 0), false,
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, []string{}, []string{}, 0, consumerId), false,
+		},
+		{
+			"custom invalid params, consumer ID is blank",
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, []string{}, []string{}, time.Hour, ""), false,
+		},
+		{
+			"custom invalid params, consumer ID is not a uint64",
+			ccvtypes.NewParams(true, 5, "", "", 5, 1005, "0.5", 1000, 24*21*time.Hour, []string{}, []string{}, time.Hour, "consumerId"), false,
 		},
 	}
 

x/ccv/provider/keeper/proposal.go

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

x/ccv/provider/keeper/proposal_test.go

@@ -880,7 +880,8 @@ func TestMakeConsumerGenesis(t *testing.T) {
 			"soft_opt_out_threshold": "0",
 			"reward_denoms": [],
 			"provider_reward_denoms": [],
-			"retry_delay_period": 3600000000000
+			"retry_delay_period": 3600000000000,
+			"consumer_id": "0"
 		},
 		"new_chain": true,
 		"provider" : {

x/ccv/types/errors.go

@@ -22,4 +22,7 @@ var (
 	ErrDuplicateConsumerChain      = errorsmod.Register(ModuleName, 14, "consumer chain already exists")
 	ErrConsumerChainNotFound       = errorsmod.Register(ModuleName, 15, "consumer chain not found")
 	ErrInvalidDoubleVotingEvidence = errorsmod.Register(ModuleName, 16, "invalid consumer double voting evidence")
+	ErrStoreKeyNotFound            = errorsmod.Register(ModuleName, 17, "store key not found")
+	ErrStoreUnmarshal              = errorsmod.Register(ModuleName, 18, "cannot unmarshal value from store")
+	ErrInvalidConsumerId           = errorsmod.Register(ModuleName, 19, "invalid consumer id")
 )

x/ccv/types/params.go

@@ -54,6 +54,7 @@ var (
 	KeyRewardDenoms                      = []byte("RewardDenoms")
 	KeyProviderRewardDenoms              = []byte("ProviderRewardDenoms")
 	KeyRetryDelayPeriod                  = []byte("RetryDelayPeriod")
+	KeyConsumerId                        = []byte("ConsumerId")
 )
 
 // ParamKeyTable type declaration for parameters
@@ -68,6 +69,7 @@ func NewParams(enabled bool, blocksPerDistributionTransmission int64,
 	consumerRedistributionFraction string, historicalEntries int64,
 	consumerUnbondingPeriod time.Duration,
 	rewardDenoms, providerRewardDenoms []string, retryDelayPeriod time.Duration,
+	consumerId string,
 ) ConsumerParams {
 	return ConsumerParams{
 		Enabled:                           enabled,
@@ -84,6 +86,7 @@ func NewParams(enabled bool, blocksPerDistributionTransmission int64,
 		RewardDenoms:         rewardDenoms,
 		ProviderRewardDenoms: providerRewardDenoms,
 		RetryDelayPeriod:     retryDelayPeriod,
+		ConsumerId:           consumerId,
 	}
 }
 
@@ -104,6 +107,7 @@ func DefaultParams() ConsumerParams {
 		rewardDenoms,
 		provideRewardDenoms,
 		DefaultRetryDelayPeriod,
+		"0",
 	)
 }
 
@@ -145,6 +149,9 @@ func (p ConsumerParams) Validate() error {
 	if err := ValidateDuration(p.RetryDelayPeriod); err != nil {
 		return err
 	}
+	if err := ValidateConsumerId(p.ConsumerId); err != nil {
+		return err
+	}
 	return nil
 }
 
@@ -174,6 +181,8 @@ func (p *ConsumerParams) ParamSetPairs() paramtypes.ParamSetPairs {
 			p.ProviderRewardDenoms, ValidateDenoms),
 		paramtypes.NewParamSetPair(KeyRetryDelayPeriod,
 			p.RetryDelayPeriod, ValidateDuration),
+		paramtypes.NewParamSetPair(KeyConsumerId,
+			p.ConsumerId, ValidateConsumerId),
 	}
 }