feat!: enable standalone consumers to reuse existing clients for ICS

.changelog/unreleased/api-breaking/2400-preccv.md

@@ -0,0 +1,12 @@
+- Enable existing (standalone) chains to use the existing client (and connection)
+  to the provider chain when becoming a consumer chain. This feature introduces 
+  the following API-breaking changes.
+  ([\#2400](https://github.com/cosmos/interchain-security/pull/2400))
+
+  - Add `connection_id` and `preCCV` to `ConsumerGenesisState`, the consumer 
+  genesis state created by the provider chain. If the `connection_id` is not empty,
+  `preCCV` is set to true and both `provider.client_state` and `provider.consensus_state`
+  are set to nil (as the consumer doesn't need to create a new provider client).
+  As a result, for older versions of consumers, the `connection_id` in 
+  `ConsumerInitializationParameters` must be empty and the resulting `ConsumerGenesisState`
+  needs to be adapted, i.e., both `connection_id` and `preCCV` need to be removed. 

.changelog/unreleased/features/2400-preccv.md

@@ -0,0 +1,13 @@
+- Enable existing (standalone) chains to use the existing client (and connection)
+  to the provider chain when becoming a consumer chain. This feature introduces 
+  the following changes.
+  ([\#2400](https://github.com/cosmos/interchain-security/pull/2400))
+
+  - Add `connection_id` to `ConsumerInitializationParameters`, the ID of 
+  the connection end _on the provider chain_ on top of which the CCV channel will 
+  be established. Consumer chain owners can set `connection_id` to a valid ID in 
+  order to reuse the underlying clients.
+  - Add `connection_id` to the consumer genesis state, the ID of the connection 
+  end _on the consumer chain_ on top of which the CCV channel will be established.
+  If `connection_id` is a valid ID, then the consumer chain will use the underlying 
+  client as the provider client and it will initiate the channel handshake.

.changelog/unreleased/state-breaking/2400-preccv.md

@@ -0,0 +1,3 @@
+- Enable existing (standalone) chains to use the existing client (and connection)
+  to the provider chain when becoming a consumer chain.
+  ([\#2400](https://github.com/cosmos/interchain-security/pull/2400))

Makefile

@@ -53,11 +53,17 @@ test-integration-cov:
 	go test ./tests/integration/... -timeout 30m -coverpkg=./... -coverprofile=integration-profile.out -covermode=atomic
 
 # run interchain tests
-# we can use PROVIDER_IMAGE_TAG and PROVIDER_IMAGE_NAME to run tests with a desired docker image,
-# including a locally built one that, for example, contains some of our changes that are not yet on the main branch.
-# if not provided, default value for PROVIDER_IMAGE_TAG is "latest" and for PROVIDER_IMAGE_NAME "ghcr.io/cosmos/interchain-security"
+# we can use PROVIDER_IMAGE_TAG, PROVIDER_IMAGE_NAME, SOUVEREIGN_IMAGE_TAG, and SOUVEREIGN_IMAGE_NAME to run tests with desired docker images,
+# including locally built ones that, for example, contain some of our changes that are not yet on the main branch.
+# if not provided, default value for PROVIDER_IMAGE_TAG and SOUVEREIGN_IMAGE_TAG is "latest" and for PROVIDER_IMAGE_NAME 
+# and SOUVEREIGN_IMAGE_NAME is "ghcr.io/cosmos/interchain-security"
 test-interchain:
-	cd tests/interchain && PROVIDER_IMAGE_NAME=$(PROVIDER_IMAGE_NAME) PROVIDER_IMAGE_TAG=$(PROVIDER_IMAGE_TAG) go test ./... -timeout 30m
+	cd tests/interchain && \
+	PROVIDER_IMAGE_NAME=$(PROVIDER_IMAGE_NAME) \
+	PROVIDER_IMAGE_TAG=$(PROVIDER_IMAGE_TAG) \
+	SOUVEREIGN_IMAGE_NAME=$(SOUVEREIGN_IMAGE_NAME) \
+	SOUVEREIGN_IMAGE_TAG=$(SOUVEREIGN_IMAGE_TAG) \
+	go test ./... -timeout 30m
 
 # run mbt tests
 test-mbt:

app/consumer-democracy/app.go

@@ -689,8 +689,6 @@ func New(
 
 			consumerGenesis := consumertypes.GenesisState{}
 			appCodec.MustUnmarshalJSON(appState[consumertypes.ModuleName], &consumerGenesis)
-
-			consumerGenesis.PreCCV = true
 			app.ConsumerKeeper.InitGenesis(sdkCtx, &consumerGenesis)
 
 			app.Logger().Info("start to run module migrations...")

docs/docs/build/modules/02-provider.md

@@ -1560,6 +1560,7 @@ init_params:
   spawn_time: "2024-09-26T06:55:14.616054Z"
   transfer_timeout_period: 3600s
   unbonding_period: 1209600s
+  connection_id: ""
 metadata:
     description: description of your chain and all other relevant information
     metadata: some metadata about your chain
@@ -1715,7 +1716,8 @@ where `update-consumer-msg.json` contains:
       "consumer_redistribution_fraction": "0.75",
       "blocks_per_distribution_transmission": "1500",
       "historical_entries": "1000",
-      "distribution_transmission_channel": ""
+      "distribution_transmission_channel": "",
+      "connection_id": ""
   },
   "power_shaping_parameters":{
       "top_N": 0,

proto/interchain_security/ccv/consumer/v1/genesis.proto

@@ -53,10 +53,15 @@ message GenesisState {
   // LastTransmissionBlockHeight nil on new chain, filled in on restart.
   LastTransmissionBlockHeight last_transmission_block_height = 12
       [ (gogoproto.nullable) = false ];
-  // flag indicating whether the consumer CCV module starts in pre-CCV state
+  // Flag indicating whether the consumer CCV module starts in pre-CCV state
   bool preCCV = 13;
   interchain_security.ccv.v1.ProviderInfo provider = 14
       [ (gogoproto.nullable) = false ];
+  // The ID of the connection end on the consumer chain on top of which the 
+  // CCV channel will be established. If connection_id == "", a new client of 
+  // the provider chain and a new connection on top of this client are created.
+  // The new client is initialized using provider.client_state and provider.consensus_state.
+  string connection_id = 15;
 }
 
 // HeightValsetUpdateID represents a mapping internal to the consumer CCV module

proto/interchain_security/ccv/provider/v1/provider.proto

@@ -94,7 +94,7 @@ message ConsumerAdditionProposal {
   // sub-protocol. If DistributionTransmissionChannel == "", a new transfer
   // channel is created on top of the same connection as the CCV channel.
   // Note that transfer_channel_id is the ID of the channel end on the consumer
-  // chain. it is most relevant for chains performing a sovereign to consumer
+  // chain. It is most relevant for chains performing a standalone to consumer
   // changeover in order to maintain the existing ibc transfer channel
   string distribution_transmission_channel = 14;
   // Corresponds to the percentage of validators that have to validate the chain under the Top N case.
@@ -466,9 +466,15 @@ message ConsumerInitializationParameters {
   // sub-protocol. If DistributionTransmissionChannel == "", a new transfer
   // channel is created on top of the same connection as the CCV channel.
   // Note that transfer_channel_id is the ID of the channel end on the consumer
-  // chain. it is most relevant for chains performing a sovereign to consumer
+  // chain. It is most relevant for chains performing a standalone to consumer
   // changeover in order to maintain the existing ibc transfer channel
   string distribution_transmission_channel = 11;
+  // The ID of the connection end on the provider chain on top of which the CCV 
+  // channel will be established. If connection_id == "", a new client of the 
+  // consumer chain and a new connection on top of this client are created. 
+  // Note that a standalone chain can transition to a consumer chain while 
+  // maintaining existing IBC channels to other chains by providing a valid connection_id.
+  string connection_id = 12;
 }
 
 // PowerShapingParameters contains parameters that shape the validator set that we send to the consumer chain

proto/interchain_security/ccv/v1/shared_consumer.proto

@@ -87,16 +87,27 @@ message ConsumerParams {
 message ConsumerGenesisState {
   ConsumerParams params = 1 [ (gogoproto.nullable) = false ];
   ProviderInfo provider = 2 [ (gogoproto.nullable) = false ];
-  // true for new chain, false for chain restart.
-  bool new_chain = 3; // TODO:Check if this is really needed
+  // True for new chain, false for chain restart.
+  // This is needed and always set to true; otherwise, new_chain in the consumer 
+  // genesis state will default to false
+  bool new_chain = 3;
+  // Flag indicating whether the consumer CCV module starts in pre-CCV state
+  bool preCCV = 4;
+  // The ID of the connection end on the consumer chain on top of which the 
+  // CCV channel will be established. If connection_id == "", a new client of 
+  // the provider chain and a new connection on top of this client are created.
+  // The new client is initialized using client_state and consensus_state.
+  string connection_id = 5;
 }
 
 // ProviderInfo defines all information a consumer needs from a provider
 // Shared data type between provider and consumer
 message ProviderInfo {
-  // ProviderClientState filled in on new chain, nil on restart.
+  // The client state for the provider client filled in on new chain, nil on restart.
+  // If connection_id != "", then client_state is ignored.
   ibc.lightclients.tendermint.v1.ClientState client_state = 1;
-  // ProviderConsensusState filled in on new chain, nil on restart.
+  // The consensus state for the provider client filled in on new chain, nil on restart.
+  // If connection_id != "", then consensus_state is ignored.
   ibc.lightclients.tendermint.v1.ConsensusState consensus_state = 2;
   // InitialValset filled in on new chain and on restart.
   repeated .tendermint.abci.ValidatorUpdate initial_val_set = 3

tests/interchain/chainsuite/chain.go

@@ -4,10 +4,13 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"io"
+	"net/http"
 	"path"
 	"strconv"
 	"strings"
 	"sync"
+	"time"
 
 	sdkmath "cosmossdk.io/math"
 	abci "github.com/cometbft/cometbft/abci/types"
@@ -16,6 +19,7 @@ import (
 	"github.com/strangelove-ventures/interchaintest/v8"
 	"github.com/strangelove-ventures/interchaintest/v8/chain/cosmos"
 	"github.com/strangelove-ventures/interchaintest/v8/ibc"
+	"github.com/tidwall/gjson"
 	"golang.org/x/sync/errgroup"
 )
 
@@ -48,8 +52,8 @@ func chainFromCosmosChain(cosmos *cosmos.CosmosChain, relayerWallet ibc.Wallet,
 	return c, nil
 }
 
-// CreateProviderChain creates a single new chain with the given version and returns the chain object.
-func CreateProviderChain(ctx context.Context, testName interchaintest.TestName, spec *interchaintest.ChainSpec) (*Chain, error) {
+// CreateChain creates a single new chain with the given version and returns the chain object.
+func CreateChain(ctx context.Context, testName interchaintest.TestName, spec *interchaintest.ChainSpec) (*Chain, error) {
 	cf := interchaintest.NewBuiltinChainFactory(
 		GetLogger(ctx),
 		[]*interchaintest.ChainSpec{spec},
@@ -155,6 +159,97 @@ func getValidatorWallets(ctx context.Context, chain *Chain) ([]ValidatorWallet,
 	return wallets, nil
 }
 
+// UpdateAndVerifyStakeChange updates the staking amount on the provider chain and verifies that the change is reflected on the consumer side
+func (p *Chain) UpdateAndVerifyStakeChange(ctx context.Context, consumer *Chain, relayer *Relayer, amount, valIdx int) error {
+
+	providerAddress := p.ValidatorWallets[valIdx]
+
+	providerHex, err := p.GetValidatorHexAddress(ctx, valIdx)
+	if err != nil {
+		return err
+	}
+	consumerHex, err := consumer.GetValidatorHexAddress(ctx, valIdx)
+	if err != nil {
+		return err
+	}
+
+	providerPowerBefore, err := p.GetValidatorPower(ctx, providerHex)
+	if err != nil {
+		return err
+	}
+
+	// increase the stake for the given validator
+	_, err = p.Validators[valIdx].ExecTx(ctx, providerAddress.Moniker,
+		"staking", "delegate",
+		providerAddress.ValoperAddress, fmt.Sprintf("%d%s", amount, p.Config().Denom),
+	)
+	if err != nil {
+		return err
+	}
+
+	// check that the validator power is updated on both, provider and consumer chains
+	tCtx, tCancel := context.WithTimeout(ctx, 5*time.Minute)
+	defer tCancel()
+	var retErr error
+	for tCtx.Err() == nil {
+		retErr = nil
+		providerPower, err := p.GetValidatorPower(ctx, providerHex)
+		if err != nil {
+			return err
+		}
+		consumerPower, err := consumer.GetValidatorPower(ctx, consumerHex)
+		if err != nil {
+			return err
+		}
+		if providerPowerBefore >= providerPower {
+			retErr = fmt.Errorf("provider power did not increase after delegation")
+		} else if providerPower != consumerPower {
+			retErr = fmt.Errorf("consumer power did not update after provider delegation")
+		}
+		if retErr == nil {
+			break
+		}
+		time.Sleep(CommitTimeout)
+	}
+	return retErr
+}
+
+func (p *Chain) GetValidatorHexAddress(ctx context.Context, valIdx int) (string, error) {
+	json, err := p.Validators[valIdx].ReadFile(ctx, "config/priv_validator_key.json")
+	if err != nil {
+		return "", err
+	}
+	return gjson.GetBytes(json, "address").String(), nil
+}
+
+func (c *Chain) GetValidatorPower(ctx context.Context, hexaddr string) (int64, error) {
+	var power int64
+	err := checkEndpoint(c.GetHostRPCAddress()+"/validators", func(b []byte) error {
+		power = gjson.GetBytes(b, fmt.Sprintf("result.validators.#(address==\"%s\").voting_power", hexaddr)).Int()
+		if power == 0 {
+			return fmt.Errorf("validator %s power not found; validators are: %s", hexaddr, string(b))
+		}
+		return nil
+	})
+	if err != nil {
+		return 0, err
+	}
+	return power, nil
+}
+
+func checkEndpoint(url string, f func([]byte) error) error {
+	resp, err := http.Get(url) //nolint:gosec
+	if err != nil {
+		return err
+	}
+	defer resp.Body.Close()
+	bts, err := io.ReadAll(resp.Body)
+	if err != nil {
+		return err
+	}
+	return f(bts)
+}
+
 func (c *Chain) WaitForProposalStatus(ctx context.Context, proposalID string, status govv1.ProposalStatus) error {
 	propID, err := strconv.ParseInt(proposalID, 10, 64)
 	if err != nil {
@@ -201,8 +296,8 @@ func (c *Chain) SubmitAndVoteForProposal(ctx context.Context, prop cosmos.TxProp
 }
 
 // builds proposal message, submits, votes and wait for proposal expected status
-func (c *Chain) ExecuteProposalMsg(ctx context.Context, proposalMsg cosmos.ProtoMessage, proposer string, chainName string, vote string, expectedStatus govv1.ProposalStatus, expedited bool) error {
-	proposal, err := c.BuildProposal([]cosmos.ProtoMessage{proposalMsg}, chainName, "summary", "", GovMinDepositString, proposer, false)
+func (c *Chain) ExecuteProposalMsg(ctx context.Context, proposalMsg cosmos.ProtoMessage, proposer string, title string, vote string, expectedStatus govv1.ProposalStatus, expedited bool) error {
+	proposal, err := c.BuildProposal([]cosmos.ProtoMessage{proposalMsg}, title, "summary", "", GovMinDepositString, proposer, false)
 	if err != nil {
 		return err
 	}
@@ -439,6 +534,24 @@ func (c *Chain) GetValidatorKey(ctx context.Context, validatorIndex int) (string
 	return address, nil
 }
 
+func (c *Chain) GetCcvConsumerParams(ctx context.Context) (ConsumerParamsResponse, error) {
+	queryRes, _, err := c.GetNode().ExecQuery(
+		ctx,
+		"ccvconsumer", "params",
+	)
+	if err != nil {
+		return ConsumerParamsResponse{}, err
+	}
+
+	var queryResponse ConsumerParamsResponse
+	err = json.Unmarshal([]byte(queryRes), &queryResponse)
+	if err != nil {
+		return ConsumerParamsResponse{}, err
+	}
+
+	return queryResponse, nil
+}
+
 func getEvtAttribute(events []abci.Event, evtType string, key string) (string, bool) {
 	for _, evt := range events {
 		if evt.GetType() == evtType {

tests/interchain/chainsuite/chain_spec_provider.go

@@ -1,15 +1,13 @@
 package chainsuite
 
 import (
-	"strconv"
-
 	"github.com/strangelove-ventures/interchaintest/v8/chain/cosmos"
 	"github.com/strangelove-ventures/interchaintest/v8/ibc"
 
 	"github.com/strangelove-ventures/interchaintest/v8"
 )
 
-func GetProviderSpec(validatorCount int) *interchaintest.ChainSpec {
+func GetProviderSpec(validatorCount int, modifiedGenesis []cosmos.GenesisKV) *interchaintest.ChainSpec {
 	fullNodes := FullNodeCount
 	validators := validatorCount
 
@@ -33,25 +31,8 @@ func GetProviderSpec(validatorCount int) *interchaintest.ChainSpec {
 				Repository: ProviderImageName(),
 				UIDGID:     "1025:1025",
 			}},
-			ModifyGenesis:        cosmos.ModifyGenesis(providerModifiedGenesis()),
+			ModifyGenesis:        cosmos.ModifyGenesis(modifiedGenesis),
 			ModifyGenesisAmounts: DefaultGenesisAmounts(Stake),
 		},
 	}
 }
-
-func providerModifiedGenesis() []cosmos.GenesisKV {
-	return []cosmos.GenesisKV{
-		cosmos.NewGenesisKV("app_state.staking.params.unbonding_time", ProviderUnbondingTime.String()),
-		cosmos.NewGenesisKV("app_state.gov.params.voting_period", GovVotingPeriod.String()),
-		cosmos.NewGenesisKV("app_state.gov.params.max_deposit_period", GovDepositPeriod.String()),
-		cosmos.NewGenesisKV("app_state.gov.params.min_deposit.0.denom", Stake),
-		cosmos.NewGenesisKV("app_state.gov.params.min_deposit.0.amount", strconv.Itoa(GovMinDepositAmount)),
-		cosmos.NewGenesisKV("app_state.slashing.params.signed_blocks_window", strconv.Itoa(ProviderSlashingWindow)),
-		cosmos.NewGenesisKV("app_state.slashing.params.downtime_jail_duration", DowntimeJailDuration.String()),
-		cosmos.NewGenesisKV("app_state.slashing.params.slash_fraction_double_sign", SlashFractionDoubleSign),
-		cosmos.NewGenesisKV("app_state.provider.params.slash_meter_replenish_period", ProviderReplenishPeriod),
-		cosmos.NewGenesisKV("app_state.provider.params.slash_meter_replenish_fraction", ProviderReplenishFraction),
-		cosmos.NewGenesisKV("app_state.provider.params.blocks_per_epoch", "1"),
-		cosmos.NewGenesisKV("app_state.staking.params.max_validators", "1"),
-	}
-}