Skip to main content
Version: Next

Migrating from ibc-go v6 to v7

This document is intended to highlight significant changes which may require more information than presented in the CHANGELOG. Any changes that must be done by a user of ibc-go should be documented here.

There are four sections based on the four potential user groups of this document:

  • Chains
  • IBC Apps
  • Relayers
  • IBC Light Clients

Note: ibc-go supports golang semantic versioning and therefore all imports must be updated to bump the version number on major releases.

Chains​

Chains will perform automatic migrations to remove existing localhost clients and to migrate the solomachine to v3 of the protobuf definition.

An optional upgrade handler has been added to prune expired tendermint consensus states. It may be used during any upgrade (from v7 onwards). Add the following to the function call to the upgrade handler in app/app.go, to perform the optional state pruning.

import (
  // ...
  ibctmmigrations "github.com/cosmos/ibc-go/v7/modules/light-clients/07-tendermint/migrations"
)

// ...

app.UpgradeKeeper.SetUpgradeHandler(
  upgradeName,
  func(ctx sdk.Context, _ upgradetypes.Plan, _ module.VersionMap) (module.VersionMap, error) {
    // prune expired tendermint consensus states to save storage space
    _, err := ibctmmigrations.PruneExpiredConsensusStates(ctx, app.Codec, app.IBCKeeper.ClientKeeper)
    if err != nil {
      return nil, err
    }

    return app.mm.RunMigrations(ctx, app.configurator, fromVM)
  },
)

Checkout the logs to see how many consensus states are pruned.

Light client registration​

Chains must explicitly register the types of any light client modules it wishes to integrate.

Tendermint registration​

To register the tendermint client, modify the app.go file to include the tendermint AppModuleBasic:

import (
  // ...
+ ibctm "github.com/cosmos/ibc-go/v7/modules/light-clients/07-tendermint"
)

// ...

ModuleBasics = module.NewBasicManager(
  ...
  ibc.AppModuleBasic{},
+ ibctm.AppModuleBasic{},
  ...
)

It may be useful to reference the PR which added the AppModuleBasic for the tendermint client.

Solo machine registration​

To register the solo machine client, modify the app.go file to include the solo machine AppModuleBasic:

import (
  // ...
+ solomachine "github.com/cosmos/ibc-go/v7/modules/light-clients/06-solomachine"
)

// ...

ModuleBasics = module.NewBasicManager(
  ...
  ibc.AppModuleBasic{},
+ solomachine.AppModuleBasic{},
  ...
)

It may be useful to reference the PR which added the AppModuleBasic for the solo machine client.

Testing package API​

The SetChannelClosed utility method in testing/endpoint.go has been updated to SetChannelState, which will take a channeltypes.State argument so that the ChannelState can be set to any of the possible channel states.

IBC Apps​

  • No relevant changes were made in this release.

Relayers​

  • No relevant changes were made in this release.

IBC Light Clients​

ClientState interface changes​

The VerifyUpgradeAndUpdateState function has been modified. The client state and consensus state return values have been removed.

Light clients must handle all management of client and consensus states including the setting of updated client state and consensus state in the client store.

The Initialize method is now expected to set the initial client state, consensus state and any client-specific metadata in the provided store upon client creation.

The CheckHeaderAndUpdateState method has been split into 4 new methods:

  • VerifyClientMessage verifies a ClientMessage. A ClientMessage could be a Header, Misbehaviour, or batch update. Calls to CheckForMisbehaviour, UpdateState, and UpdateStateOnMisbehaviour will assume that the content of the ClientMessage has been verified and can be trusted. An error should be returned if the ClientMessage fails to verify.

  • CheckForMisbehaviour checks for evidence of a misbehaviour in Header or Misbehaviour types.

  • UpdateStateOnMisbehaviour performs appropriate state changes on a ClientState given that misbehaviour has been detected and verified.

  • UpdateState updates and stores as necessary any associated information for an IBC client, such as the ClientState and corresponding ConsensusState. An error is returned if ClientMessage is of type Misbehaviour. Upon successful update, a list containing the updated consensus state height is returned.

The CheckMisbehaviourAndUpdateState function has been removed from ClientState interface. This functionality is now encapsulated by the usage of VerifyClientMessage, CheckForMisbehaviour, UpdateStateOnMisbehaviour.

The function GetTimestampAtHeight has been added to the ClientState interface. It should return the timestamp for a consensus state associated with the provided height.

Prior to ibc-go/v7 the ClientState interface defined a method for each data type which was being verified in the counterparty state store. The state verification functions for all IBC data types have been consolidated into two generic methods, VerifyMembership and VerifyNonMembership. Both are expected to be provided with a standardised key path, exported.Path, as defined in ICS 24 host requirements. Membership verification requires callers to provide the marshalled value []byte. Delay period values should be zero for non-packet processing verification. A zero proof height is now allowed by core IBC and may be passed into VerifyMembership and VerifyNonMembership. Light clients are responsible for returning an error if a zero proof height is invalid behaviour.

See below for an example of how ibc-go now performs channel state verification.

merklePath := commitmenttypes.NewMerklePath(host.ChannelPath(portID, channelID))
merklePath, err := commitmenttypes.ApplyPrefix(connection.GetCounterparty().GetPrefix(), merklePath)
if err != nil {
  return err
}

channelEnd, ok := channel.(channeltypes.Channel)
if !ok {
  return sdkerrors.Wrapf(sdkerrors.ErrInvalidType, "invalid channel type %T", channel)
}

bz, err := k.cdc.Marshal(&channelEnd)
if err != nil {
  return err
}

if err := clientState.VerifyMembership(
  ctx, clientStore, k.cdc, height,
  0, 0, // skip delay period checks for non-packet processing verification
  proof, merklePath, bz,
); err != nil {
  return sdkerrors.Wrapf(err, "failed channel state verification for client (%s)", clientID)
}

Header and Misbehaviour​

exported.Header and exported.Misbehaviour interface types have been merged and renamed to ClientMessage interface.

GetHeight function has been removed from exported.Header and thus is not included in the ClientMessage interface

ConsensusState​

The GetRoot function has been removed from consensus state interface since it was not used by core IBC.

Client keeper​

Keeper function CheckMisbehaviourAndUpdateState has been removed since function UpdateClient can now handle updating ClientState on ClientMessage type which can be any Misbehaviour implementations.

SDK message​

MsgSubmitMisbehaviour is deprecated since MsgUpdateClient can now submit a ClientMessage type which can be any Misbehaviour implementations.

The field header in MsgUpdateClient has been renamed to client_message.

Solomachine​

The 06-solomachine client implementation has been simplified in ibc-go/v7. In-place store migrations have been added to migrate solomachine clients from v2 to v3.

ClientState​

The ClientState protobuf message definition has been updated to remove the deprecated bool field allow_update_after_proposal.

message ClientState {
  option (gogoproto.goproto_getters) = false;

  uint64 sequence                  = 1;
  bool is_frozen                   = 2 [(gogoproto.moretags) = "yaml:\"is_frozen\""];
  ConsensusState consensus_state   = 3 [(gogoproto.moretags) = "yaml:\"consensus_state\""];
- bool allow_update_after_proposal = 4 [(gogoproto.moretags) = "yaml:\"allow_update_after_proposal\""];
}

Header and Misbehaviour​

The 06-solomachine protobuf message Header has been updated to remove the sequence field. This field was seen as redundant as the implementation can safely rely on the sequence value maintained within the ClientState.

message Header {
  option (gogoproto.goproto_getters) = false;
 
- uint64              sequence        = 1;
- uint64              timestamp       = 2;
- bytes               signature       = 3;
- google.protobuf.Any new_public_key  = 4 [(gogoproto.moretags) = "yaml:\"new_public_key\""];
- string              new_diversifier = 5 [(gogoproto.moretags) = "yaml:\"new_diversifier\""];
+ uint64              timestamp       = 1;
+ bytes               signature       = 2;
+ google.protobuf.Any new_public_key  = 3 [(gogoproto.moretags) = "yaml:\"new_public_key\""];
+ string              new_diversifier = 4 [(gogoproto.moretags) = "yaml:\"new_diversifier\""];
}

Similarly, the Misbehaviour protobuf message has been updated to remove the client_id field.

message Misbehaviour {
  option (gogoproto.goproto_getters) = false;
  
- string           client_id         = 1 [(gogoproto.moretags) = "yaml:\"client_id\""];
- uint64           sequence          = 2;
- SignatureAndData signature_one     = 3 [(gogoproto.moretags) = "yaml:\"signature_one\""];
- SignatureAndData signature_two     = 4 [(gogoproto.moretags) = "yaml:\"signature_two\""];
+ uint64           sequence          = 1;
+ SignatureAndData signature_one     = 2 [(gogoproto.moretags) = "yaml:\"signature_one\""];
+ SignatureAndData signature_two     = 3 [(gogoproto.moretags) = "yaml:\"signature_two\""];
}

SignBytes​

Most notably, the SignBytes protobuf definition has been modified to replace the data_type field with a new field, path. The path field is defined as bytes and represents a serialized ICS-24 standardized key path under which the data is stored.

message SignBytes {
  option (gogoproto.goproto_getters) = false;

  uint64 sequence    = 1;
  uint64 timestamp   = 2;
  string diversifier = 3;
- DataType data_type = 4 [(gogoproto.moretags) = "yaml:\"data_type\""];
+ bytes path         = 4;
  bytes data         = 5;
}

The DataType enum and all associated data types have been removed, greatly reducing the number of message definitions and complexity in constructing the SignBytes message type. Likewise, solomachine implementations must now use the serialized path value when constructing SignatureAndData for signature verification of SignBytes data.

message SignatureAndData {
  option (gogoproto.goproto_getters) = false;
 
  bytes    signature = 1;
- DataType data_type = 2 [(gogoproto.moretags) = "yaml:\"data_type\""];
+ bytes    path      = 2;
  bytes    data      = 3;
  uint64   timestamp = 4;
}

For more information, please refer to ADR-007.

IBC module constants​

IBC module constants have been moved from the host package to the exported package. Any usages will need to be updated.

import (
  // ...
- host "github.com/cosmos/ibc-go/v7/modules/core/24-host"
+ ibcexported "github.com/cosmos/ibc-go/v7/modules/core/exported"
  // ...
)

- host.ModuleName
+ ibcexported.ModuleName

- host.StoreKey
+ ibcexported.StoreKey

- host.QuerierRoute
+ ibcexported.QuerierRoute

- host.RouterKey
+ ibcexported.RouterKey

Upgrading to Cosmos SDK 0.47​

The following should be considered as complementary to Cosmos SDK v0.47 UPGRADING.md.

Protobuf​

Protobuf code generation, linting and formatting have been updated to leverage the ghcr.io/cosmos/proto-builder:0.11.5 docker container. IBC protobuf definitions are now packaged and published to buf.build/cosmos/ibc via CI workflows. The third_party/proto directory has been removed in favour of dependency management using buf.build.

App modules​

Legacy APIs of the AppModule interface have been removed from ibc-go modules. For example, for

- // Route implements the AppModule interface
- func (am AppModule) Route() sdk.Route {
-   return sdk.Route{}
- }
-
- // QuerierRoute implements the AppModule interface
- func (AppModule) QuerierRoute() string {
-   return types.QuerierRoute
- }
-
- // LegacyQuerierHandler implements the AppModule interface
- func (am AppModule) LegacyQuerierHandler(*codec.LegacyAmino) sdk.Querier {
-   return nil
- }
-
- // ProposalContents doesn't return any content functions for governance proposals.
- func (AppModule) ProposalContents(_ module.SimulationState) []simtypes.WeightedProposalContent {
-   return nil
- }

Imports​

Imports for ics23 have been updated as the repository have been migrated from confio to cosmos.

import (
  // ...
- ics23 "github.com/confio/ics23/go"
+ ics23 "github.com/cosmos/ics23/go"
  // ...
)

Imports for gogoproto have been updated.

import (
  // ...
- "github.com/gogo/protobuf/proto"
+ "github.com/cosmos/gogoproto/proto"
  // ...
)