Skip to content

Latest commit

 

History

History
109 lines (83 loc) · 10.6 KB

CHANGELOG.md

File metadata and controls

109 lines (83 loc) · 10.6 KB
Raw

Changelog

v1.0.0 - 2021-08-10

Bug Fixes

  • (07-tendermint) #241 Ensure tendermint client state latest height revision number matches chain id revision number.
  • (07-tendermint) #234 Use sentinel value for the consensus state root set during a client upgrade. This prevents genesis validation from failing.
  • (modules) #223 Use correct Prometheus format for metric labels.
  • (06-solomachine) #214 Disable defensive timestamp check in SendPacket for solo machine clients.
  • (07-tendermint) #210 Export all consensus metadata on genesis restarts for tendermint clients.
  • (core) #200 Fixes incorrect export of IBC identifier sequences. Previously, the next identifier sequence for clients/connections/channels was not set during genesis export. This resulted in the next identifiers being generated on the new chain to reuse old identifiers (the sequences began again from 0).
  • (02-client) #192 Fix IBC query ibc client header cli command. Support historical queries for query header/node-state commands.
  • (modules/light-clients/06-solomachine) #153 Fix solo machine proof height sequence mismatch bug.
  • (modules/light-clients/06-solomachine) #122 Fix solo machine merkle prefix casting bug.
  • (modules/light-clients/06-solomachine) #120 Fix solo machine handshake verification bug.

API Breaking

  • (04-channel) #220 Channel legacy handler functions were removed. Please use the MsgServer functions or directly call the channel keeper's handshake function.
  • (modules) #206 Expose relayer sdk.AccAddress on OnRecvPacket, OnAcknowledgementPacket, OnTimeoutPacket module callbacks to enable incentivization.
  • (02-client) #181 Remove 'InitialHeight' from UpdateClient Proposal. Only copy over latest consensus state from substitute client.
  • (06-solomachine) #169 Change FrozenSequence to boolean in solomachine ClientState. The solo machine proto package has been bumped from v1 to v2.
  • (module/core/02-client) #165 Remove GetFrozenHeight from the ClientState interface.
  • (modules) #166 Remove GetHeight from the misbehaviour interface. The consensus_height attribute has been removed from Misbehaviour events.
  • (modules) #162 Remove deprecated Handler types in core IBC and the ICS 20 transfer module.
  • (modules/core) #161 Remove Type(), Route(), GetSignBytes() from 02-client, 03-connection, and 04-channel messages.
  • (modules) #140 IsFrozen() client state interface changed to Status(). gRPC ClientStatus route added.
  • (modules/core) #109 Remove connection and channel handshake CLI commands.
  • (modules) #107 Modify OnRecvPacket callback to return an acknowledgement which indicates if it is successful or not. Callback state changes are discarded for unsuccessful acknowledgements only.
  • (modules) #108 All message constructors take the signer as a string to prevent upstream bugs. The String() function for an SDK Acc Address relies on external context.
  • (transfer) #275 Remove 'ChanCloseInit' function from transfer keeper. ICS20 does not close channels.

State Machine Breaking

  • (modules/light-clients/07-tendermint) #99 Enforce maximum chain-id length for tendermint client.
  • (modules/light-clients/07-tendermint) #141 Allow a new form of misbehaviour that proves counterparty chain breaks time monotonicity, automatically enforce monotonicity in UpdateClient and freeze client if monotonicity is broken.
  • (modules/light-clients/07-tendermint) #141 Freeze the client if there's a conflicting header submitted for an existing consensus state.
  • (modules/core/02-client) #8405 Refactor IBC client update governance proposals to use a substitute client to update a frozen or expired client.
  • (modules/core/02-client) #8673 IBC upgrade logic moved to 02-client and an IBC UpgradeProposal is added.
  • (modules/core/03-connection) #171 Introduces a new parameter MaxExpectedTimePerBlock to allow connections to calculate and enforce a block delay that is proportional to time delay set by connection.
  • (core) #268 Perform a no-op on redundant relay messages. Previous behaviour returned an error. Now no state change will occur and no error will be returned.

Improvements

  • (04-channel) #220 Channel handshake events are now emitted with the channel keeper.
  • (core/02-client) #205 Add in-place and genesis migrations from SDK v0.42.0 to ibc-go v1.0.0. Solo machine protobuf defintions are migrated from v1 to v2. All solo machine consensus states are pruned. All expired tendermint consensus states are pruned.
  • (modules/core) #184 Improve error messages. Uses unique error codes to indicate already relayed packets.
  • (07-tendermint) #182 Remove duplicate checks in upgrade logic.
  • (modules/core/04-channel) #7949 Standardized channel Acknowledgement moved to its own file. Codec registration redundancy removed.
  • (modules/core/04-channel) #144 Introduced a packet_data_hex attribute to emit the hex-encoded packet data in events. This allows for raw binary (proto-encoded message) to be sent over events and decoded correctly on relayer. Original packet_data is DEPRECATED. All relayers and IBC event consumers are encouraged to switch to packet_data_hex as soon as possible.
  • (core/04-channel) #197 Introduced a packet_ack_hex attribute to emit the hex-encoded acknowledgement in events. This allows for raw binary (proto-encoded message) to be sent over events and decoded correctly on relayer. Original packet_ack is DEPRECATED. All relayers and IBC event consumers are encouraged to switch to packet_ack_hex as soon as possible.
  • (modules/light-clients/07-tendermint) #125 Implement efficient iteration of consensus states and pruning of earliest expired consensus state on UpdateClient.
  • (modules/light-clients/07-tendermint) #141 Return early in case there's a duplicate update call to save Gas.
  • (modules/core/ante) #235 Introduces a new IBC Antedecorator that will reject transactions that only contain redundant packet messages (and accompany UpdateClient msgs). This will prevent relayers from wasting fees by submitting messages for packets that have already been processed by previous relayer(s). The Antedecorator is only applied on CheckTx and RecheckTx and is therefore optional for each node.

Features

  • #198 New CLI command query ibc-transfer escrow-address <port> <channel id> to get the escrow address for a channel; can be used to then query balance of escrowed tokens

Client Breaking Changes

  • (02-client/cli) #196 Rename node-state cli command to self-consensus-state.

IBC in the Cosmos SDK Repository

The IBC module was originally released in v0.40.0 of the SDK. Please see the Release Notes.

The IBC module is also contained in the releases for v0.41.x and v0.42.x. Please see the Release Notes for v0.41.x and v0.42.x.

The IBC module was removed in the commit hash da064e13d56add466548135739c5860a9f7ed842 on the SDK. The release for SDK v0.43.0 will be the first release without the IBC module.

Backports should be made to the release/v0.42.x branch on the SDK.