chore: write changelog and summary

informalsystems · Sep 26, 2024 · 06d449c · 06d449c
1 parent e31fd3e
commit 06d449c
Show file tree

Hide file tree

Showing 13 changed files with 92 additions and 0 deletions.
diff --git a/...hanges/1311-migrate-cosmwasm-workspace.md → ...hanges/1311-migrate-cosmwasm-workspace.md b/...hanges/1311-migrate-cosmwasm-workspace.md → ...hanges/1311-migrate-cosmwasm-workspace.md
diff --git a/...19-consolidate-decoding-related-errors.md → ...19-consolidate-decoding-related-errors.md b/...19-consolidate-decoding-related-errors.md → ...19-consolidate-decoding-related-errors.md
diff --git a/...ng-changes/1320-define-host-error-type.md → ...ng-changes/1320-define-host-error-type.md b/...ng-changes/1320-define-host-error-type.md → ...ng-changes/1320-define-host-error-type.md
diff --git a/...-merge-packet-error-into-channel-error.md → ...-merge-packet-error-into-channel-error.md b/...-merge-packet-error-into-channel-error.md → ...-merge-packet-error-into-channel-error.md
diff --git a/...6-remove-generic-string-error-variants.md → ...6-remove-generic-string-error-variants.md b/...6-remove-generic-string-error-variants.md → ...6-remove-generic-string-error-variants.md
diff --git a/...sensusState-timestamp-to-return-Result.md → ...sensusState-timestamp-to-return-Result.md b/...sensusState-timestamp-to-return-Result.md → ...sensusState-timestamp-to-return-Result.md
diff --git a/...ize-error-variants-to-be-less-specific.md → ...ize-error-variants-to-be-less-specific.md b/...ize-error-variants-to-be-less-specific.md → ...ize-error-variants-to-be-less-specific.md
diff --git a/...Error-when-decoding-Any-to-MsgEnvelope.md → ...Error-when-decoding-Any-to-MsgEnvelope.md b/...Error-when-decoding-Any-to-MsgEnvelope.md → ...Error-when-decoding-Any-to-MsgEnvelope.md
diff --git a/...eipt-check-during-recv-packet-validate.md → ...eipt-check-during-recv-packet-validate.md b/...eipt-check-during-recv-packet-validate.md → ...eipt-check-during-recv-packet-validate.md
diff --git a/...mestamp-converstions-to-from-host-time.md → ...mestamp-converstions-to-from-host-time.md b/...mestamp-converstions-to-from-host-time.md → ...mestamp-converstions-to-from-host-time.md
diff --git a/...edundant-path-constructions-in-testkit.md → ...edundant-path-constructions-in-testkit.md b/...edundant-path-constructions-in-testkit.md → ...edundant-path-constructions-in-testkit.md
diff --git a/.changelog/v0.55.0/summary.md b/.changelog/v0.55.0/summary.md
@@ -0,0 +1,24 @@
+This release brings major improvements to error handling in `ibc-rs`, giving
+hosting environments better control over errors and make the process of
+debugging easier for the developers. A key enhancement is the clearer
+distinction between host-sourced errors and those propagated by `ibc-rs`,
+effectively separating host-level from protocol-level errors. Therefore, a
+noticeable update is the renaming of the previous `ContextError` to
+`HandlerError`, which now exclusively manages errors from IBC handlers. In
+parallel, a new `HostError` has been introduced to handle errors originating
+from hosts, particularly those from validation and execution contexts.
+Additionally, error definitions within `ibc-rs` have been unified, reducing the
+granularity of error variants. For more details, please refer to
+[ADR-011](./docs/architecture/adr-11-refactor-errors.md).
+
+In addition, this release also brings various fixes and enhancements. Notably,
+helper traits with default implementations have been added to simplify the
+conversion between host time types and `Timestamp`. Consequently, the
+`ibc-primitives` crate has been fully decoupled from the `tendermint`
+dependency.
+
+It’s also worth noting that the `cosmwasm` workspace has been relocated to its
+own repository, now available under
+[cosmwasm-ibc](https://github.com/informalsystems/cosmwasm-ibc).
+
+There are no consensus-breaking changes in this release.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,73 @@
 # CHANGELOG
 
+## v0.55.0
+
+*September 26, 2024*
+
+This release brings major improvements to error handling in `ibc-rs`, giving
+hosting environments better control over errors and make the process of
+debugging easier for the developers. A key enhancement is the clearer
+distinction between host-sourced errors and those propagated by `ibc-rs`,
+effectively separating host-level from protocol-level errors. Therefore, a
+noticeable update is the renaming of the previous `ContextError` to
+`HandlerError`, which now exclusively manages errors from IBC handlers. In
+parallel, a new `HostError` has been introduced to handle errors originating
+from hosts, particularly those from validation and execution contexts.
+Additionally, error definitions within `ibc-rs` have been unified, reducing the
+granularity of error variants. For more details, please refer to
+[ADR-011](./docs/architecture/adr-11-refactor-errors.md).
+
+In addition, this release also brings various fixes and enhancements. Notably,
+helper traits with default implementations have been added to simplify the
+conversion between host time types and `Timestamp`. Consequently, the
+`ibc-primitives` crate has been fully decoupled from the `tendermint`
+dependency.
+
+It’s also worth noting that the `cosmwasm` workspace has been relocated to its
+own repository, now available under
+[cosmwasm-ibc](https://github.com/informalsystems/cosmwasm-ibc).
+
+There are no consensus-breaking changes in this release.
+
+### BREAKING CHANGES
+
+- [ibc] Standardize error variants across the codebase to make them less
+  specific and more consistent.
+  ([\#270](https://github.com/cosmos/ibc-rs/issues/270))
+- [ibc-core-handler] Return `DecodingError` for `MsgEnvelope` when trying to
+  decode from `Any` ([\#950](https://github.com/cosmos/ibc-rs/issues/950))
+- [cosmwasm] Migrate the `cosmwasm` workspace into its own separate repository
+  located at [cosmwasm-ibc](https://github.com/informalsystems/cosmwasm-ibc).
+  ([\#1311](https://github.com/cosmos/ibc-rs/issues/1311))
+- [ibc] Consolidate decoding-related errors into new `DecodingError` type
+  ([\1319](https://github.com/cosmos/ibc-rs/issues/1319))
+- [ibc-core] Define a new `HostError` type in ICS-24 to draw distinction between
+  protocol errors and host errors. Additionally, rename `ContextError` to
+  `HandlerError` to better reflect its use case.
+  ([\1320](https://github.com/cosmos/ibc-rs/issues/1320))
+- [ibc-core-channel] Merge `PacketError` type into `ChannelError`
+  ([#1339](https://github.com/cosmos/ibc-rs/issues/1339))
+- [ibc] Clean up multi-purpose variants like the `Other` variant and reduce
+  unnecessary `String` allocations in `*Error` enums.
+  ([\#1346](https://github.com/cosmos/ibc-rs/issues/1346))
+- [ibc-core-client] Update ICS-02 `ConsensusState::timestamp()` to return
+  `Result<Timestamp, ClientError>`
+  ([\#1352](https://github.com/cosmos/ibc-rs/issues/1352))
+
+### BUG FIXES
+
+- [ibc-core] Remove faulty receipt check during `recv_packet_validate`
+  ([#1336](https://github.com/cosmos/ibc-rs/issues/1336)).
+
+### IMPROVEMENTS
+
+- [ibc-primitives] Define utility traits for converting between `Timestamp` and
+  host-specific time types.
+  ([#1323](https://github.com/cosmos/ibc-rs/pull/1323)).
+- [ibc-testkit] Remove redundant path constructions in the implementation of
+  `ValidationContext` for `MockIbcStore`
+  ([#1338](https://github.com/cosmos/ibc-rs/pull/1338)).
+
 ## v0.54.0
 
 *August 12, 2024*