v8.3.0
Highlights 🌟
We present here a summary of the most relevant changes, please see the v8.3.0 changelog for the full set of changes included in this release. Check out also the release announcement blog post for more information.
dependencies
core
- Up until now ibc-go assumed that its underlying consensus is Tendermint, but in this release we have added the
ConsensusHost
interface that defines methods to validate an IBC light clientClientState
andConsensusState
against the host chain's underlying consensus parameters. This enables chains whose underlying consensus is not Tendermint to still use ibc-go and be able to specify how the client state and consensus state of counterparties' light clients should be verified during the connection handshake. A custom implementation of theConsensusHost
interface can be set in the core IBC keeper using functionSetConsensusHost
. By default the consensus host will be set to the implementation for 07-tendermint. See issue #5315 and PR #6055 for more details.
core/02-client
- We have added the
VerifyMembershipProof
query service gRPC endpoint that queries an IBC light client for proof verification of a value at a given key path. This endpoint specifically enables light clients to query other light clients through gRPC, and streamlines the process of implementing conditional clients, particularly within the 08-wasm module. The method takes aQueryVerifyMembershipRequest
where the ID of the light client the verification parameters (proof, value, height, etc) are specified. See issue #5310 and PR #5821 for more details.
apps/transfer
- In v8.1.0 the field
allowed_packet_data
was added to theAllocation
type used for authz support of IBC transfers. This field was originally a list ofMsgTransfer
'smemo
packet data keys that were allowed (i.e. top level JSON object keys). After receiving some feedback (thanks to Yieldmos team), we have re-purposed this field to be a list of full memo strings. That means that this field contains a list of memo strings that that the granter allows the grantee to include in thememo
field ofMsgTransfer
, the grantee can then submitMsgTransfer
with one of the allowed memo strings. See the documentation for more information. - In
OnChanOpenTry
, when the counterparty version does not match the executing chain's own version, instead of returning an error, the current version is now returned. This allows the channel handshake to complete in situations where the handshake initiating chain has the fee middleware wired up, but the counterparty doesn't (then transfer channel will be created with a version that does not contain fee middleware information). Similar change has been applied toOnChanOpenTry
of the host submodule in 27-interchain-accounts. See PR #6253 for more details.
apps/27-interchain-accounts
Unordered channels
Support for unordered channels was introduced in v8.1.0, and with this release we have now also changed the default ordering of new ICA channels from ordered to unordered. This means that new ICA channels will be unordered by default. Ordering can be specified either by setting the field ordering
of MsgRegisterInterchainAccount
or using the newly introduced function RegisterInterchainAccountWithOrdering
(in case the legacy RegisterInterchainAccount
function is used by a custom auth module).
Queries
We have added the message MsgModuleQuerySafe
, which enables to perform queries on the host chain. This message contains a list of QueryRequest
s that will be routed to the query router when the message MsgModuleQuerySafe
is executed on the host chain. The MsgModuleQuerySafe
message can be included in the list of encoded sdk.Msg
s of InterchainPacketData
. The host chain will return on the acknowledgment the responses for all the queries (in the same order as the query requests in the Requests
field of the MsgModuleQuerySafe
).
Please note that only module safe queries can be executed (i.e. deterministic queries that are safe to be called from within the state machine). See the documentation for more details and the list of supported queries.
Please also note that it is mandatory to register the gRPC query router after the creation of the host submodule's keeper, otherwise nodes will not start. The WithQueryRouter
function should be used. Please check the sample integration code in the documentation for more details.
apps/29-fee
- We have fixed a bug where, upon channel closure, already refunded fees remained in state in the event of one or more of the packet fees attached to a packet not being refunded. See PR #6255 for more details. Many thanks to @sushiwushi for reporting this bug.
Contributors ❤️
Special thanks to all external contributors that pushed code for this release:
To learn more about ibc-go versioning, please read our RELEASES.md.
IMPORTANT: Please read the migration guides for any versions of ibc-go that you might be going through when upgrading to this version. For example: if you upgrade from the IBC module contained in the Cosmos SDK 0.42.0 to SDK v0.50.6 and ibc-go v8.3.0, please follow:
- The migration from SDK 0.41.x or 0.42.x to the IBC module in the ibc-go repository based on the SDK v0.44.x.
- The migration from ibc-go v1 to v2.
- The migration from ibc-go v2 to v3.
- The migration from ibc-go v3 to v4.
- The migration from ibc-go v4 to v5.
- The migration from ibc-go v5 to v6.
- The migration from ibc-go v6 to v7.
- The migration from ibc-go v7 to v7.1.
- The migration from ibc-go v7.2 to v7.3.
- The migration from ibc-go v7 to v8.
- The migration from ibc-go v8 to v8.1.