Skip to content

Commit ede380f

Browse files
seanchen1991Farhad-Shabani
seanchen1991
and
Farhad-Shabani
authored
imp(ibc)!: refactor error handling throughout codebase (#1350)
* Clean up `ibc-apps` errors (#1318) * Clean up ics20-transfer error * Clean up NftTransfer error * Incorporate PR feedback * Remove redundant TODO comment * Simplify NftTransferError variant * Add TODO reminder * Clean up `ibc-core` and `ibc-clients` error types (#1317) * Clean up pass of ClientError type * Clean up pass of ics24 errors * Clean up pass of ics23 errors * Clean up pass of ics07 errors * Clean up ChannelError type * Clean up PacketError type * Better organize error variants * cargo nightly fmt * Update error variant in integration tests * Fix ics23 tests * Fix typo in doc comment * Update cw-check Cargo.lock * Clean up ics08 error * Cargo nightly fmt * Change single-field error variants to tuple structs * Propogate error variant changes * Propogate error variant changes * Clean up PacketError type * Clean up IdentifierError type * Clean up ics26 RouterError * Clean up ics03 ConnectionError * Fix error variant naming * Fix error variant naming * Remove redundant Other error variant * Clarify tendermint client error naming * Rename tendermint client Error to TendermintClientError * Rename wasm light client Error to WasmClientError * Rename ics25-handler Error to HandlerError * Remove unused HandlerError * Remove TendermintClientError::InvalidHeader error for more specific variant * Rename LightClientVerifierError variant to FailedToVerifyHeader * Rename ConsensusStateTimestampGteTrustingPeriod to InsufficientTrustingPeriod * Remove redundant ChannelError::FailedToParseSequence variant * Rename ChannelError::FailedChannelVerification to FailedProofVerification * Replace incorrect usages of FailedPacketVerification * Define From<CommitmentError> for ClientError impl * Add IdentifierError::FailedToParse variant * Replace InvalidPrefix error usage * Fix doc comment typo * Improve ChannelError variant names * Add PacketError::InvalidPathPrefix variant * Remove unnecessary PacketError variant * Add error variants used by basecoin * nit: remove unnecessary map_err in verify_(non_)membership * imp: define EmptyCommitmentRoot * nit: remove MissingHostHeight * fix: remove unnecessary map_err(PacketError::Channel) * Remove a TODO --------- Co-authored-by: Farhad Shabani <[email protected]> * Clean up `QueryError` and `RelayerError` types (#1321) * Clean up ibc-query QueryError type * Clean up ibc-testkit RelayerError * Clean up ibc-testkit RelayerError * Change wording of a doc comment * Remove RelayerError * Consolidate decoding-related errors into new `DecodingError` type (#1325) * Define DecodingError in ibc-primitives * Utilize DecodingError in ics721 * Start using DecodingError in ClientError * Define StatusError type * Wire up StatusError * Wiring up DecodingError * Add DecodingError to RouterError * Remove unused From impl * Change format of an import * Change format of an import * Change format of an import * Move DecodingError into ics24 * Cargo nightly fmt * Use DecodingError in more places * cargo fmt * cargo fmt * Update cw-check Cargo.lock * Add necessary wasm-client feature attribute * Move InvalidUri error variant back to NftTransferError * Regenerate cw hcheck cargo.lock * Add serde feature attribute * Remove ClientError::InvalidClientIdentifier error variant in favor of DecodingError::InvalidIdentifier * Add derive_more::From on NftTransferError * Stashing changes * Revert "Add derive_more::From on NftTransferError" This reverts commit 234ebee. * Remove RouterError::UnknownMessageTypeUrl * Add derive_more::From on TokenTransferError * Add derive_more to NftTransferError * Remove tendermint-proto dependency from ibc-primitives * Remove StatusError * Remove unnecessary ClientError::Decoding wrappings * Clean up TendermintClientError * Regenerate cw-check cargo.lock * taplo fmt * Apply PR feedback * Use ibc_proto::Error type instead of tendermint_proto::Error * Change FailedToParseType fields to make them more clear * Revert InvalidTrace and InvalidCoin TokenTransferError variants * Remove NftTransferError variants in favor of DecodingError::InvalidJson * cargo fmt * Regenerate cw-check cargo.lock * Separate out error variants that need to be moved to host-relevant errors * Consolidate TendermintClientError decoding errors * Consolidate Connection and Packet decoding errors * Remove WasmClientError * Consolidate Identifier variant naming * Remove HostError annotations in doc comments * Consolidate CommitmentError variants * Consolidate ConnectionError variants * Revert some CommitmentError variants * Change TryFrom<Any> for MsgEnvelope Error type to DecodingError * Remove ConnectionError::Identifier variant in favor of DecodingError::Identifier * Remove ChannelError::Identifier variant in favor of DecodingError::Identifier * Remove PacketError::Identifier variant in favor of DecodingError::Identifier * Revert TokenTransferError FailedToDeserializeAck and FailedToDeserializePacketData * Revert NftTransferError FailedToDeserializeAck and FailedToDeserializePacketData * Revert ics20 and ics721 on_recv_packet_execute impls * Remove additional Identifier error variants * Add TendermintClientError::InsufficientMisbehaviourHeaderHeight variant * Implement From<IdentifierError> for ClientError and ConnectionError * Incorporate PR feedback * Change TryFrom<RawConsensusState> for ConsensusState error to DecodingError * Remove RouterError::Decoding variant * Revert AcknowledgementStatus tests * Cargo fmt * Fix test_ack_de * Fix typo in doc comment * Fix test_ack_de * Fix test_ack_de * fix: revert nft721 on module errors * fix: remove Identifier variant from few more enums * fix: remove unused tendermint-proto dep * chore: update Cargo.lock --------- Co-authored-by: Farhad Shabani <[email protected]> * imp(ibc-apps): migrate to `DecodingError` in `TryFrom` conversions (#1335) * imp: migrate to DecodingError in TryFrom conversions, ibc-apps * imp: apply on TryFrom<RawPacketData> * fix: missing import * fix: apply review comments * imp: move away from From<Infallible> * Define `HostError` type (#1331) * Define DecodingError in ibc-primitives * Utilize DecodingError in ics721 * Start using DecodingError in ClientError * Define StatusError type * Wire up StatusError * Wiring up DecodingError * Add DecodingError to RouterError * Remove unused From impl * Change format of an import * Change format of an import * Change format of an import * Move DecodingError into ics24 * Cargo nightly fmt * Use DecodingError in more places * cargo fmt * cargo fmt * Update cw-check Cargo.lock * Add necessary wasm-client feature attribute * Move InvalidUri error variant back to NftTransferError * Regenerate cw hcheck cargo.lock * Add serde feature attribute * Remove ClientError::InvalidClientIdentifier error variant in favor of DecodingError::InvalidIdentifier * Add derive_more::From on NftTransferError * Stashing changes * Revert "Add derive_more::From on NftTransferError" This reverts commit ea9c83d. * Remove RouterError::UnknownMessageTypeUrl * Add derive_more::From on TokenTransferError * Add derive_more to NftTransferError * Remove tendermint-proto dependency from ibc-primitives * Remove StatusError * Remove unnecessary ClientError::Decoding wrappings * Clean up TendermintClientError * Regenerate cw-check cargo.lock * taplo fmt * Apply PR feedback * Use ibc_proto::Error type instead of tendermint_proto::Error * Change FailedToParseType fields to make them more clear * Revert InvalidTrace and InvalidCoin TokenTransferError variants * Remove NftTransferError variants in favor of DecodingError::InvalidJson * cargo fmt * Regenerate cw-check cargo.lock * Separate out error variants that need to be moved to host-relevant errors * Consolidate TendermintClientError decoding errors * Consolidate Connection and Packet decoding errors * Remove WasmClientError * Consolidate Identifier variant naming * Remove HostError annotations in doc comments * Consolidate CommitmentError variants * Consolidate ConnectionError variants * Revert some CommitmentError variants * Change TryFrom<Any> for MsgEnvelope Error type to DecodingError * Define HostError type * Rename ContextError to HandlerError * Change `pick_version` impl * Update ValidationContext trait methods to return HostError type * Rename HandlerError variants throughout the code base * Remove match arm that is no longer relevant * Change ClientValidationContext trait methods to return HostErrors * Change TokenTransferValidationContext and NftTransferValidationContext trait error types * Updating validation contexts to return HostError types * Map errors to HostError variants * Update ValidateSelfClientContext trait * Update Upgrade validation and execution contexts to return HostErrors * Fix merge conflicts * Fix merge conflicts * Revert execute_upgrade_client_proposal error type to UpgradeClientError * cargo fmt * Remove unused alloc::string::ToString * Import ibc_core::primitives::prelude into handler/mod.rs * cargo fmt * Attempt to fix failing testkit test * Remove RouterError::UnknownPort variant * Remove some uses of ClientError::Other variants * Fix recv_packet_validate_happy_path test * Fix conn_open_ack_no_connection test * cargo fmt * fix conn_open_ack_no_connection test without adding new HostError variant * fix test_create_client_try_from test * Remove unnecessary import * Fix test_create_client_try_from * cargo fmt * fix: remove now unneeded with_packet_receipt * fix: revert unintended ack status changes in ICS-20 * fix: revert unintended ack status changes in ICS-721 * fix: remove unintended tendermint-proto * fix: update Cargo.lock for cw-check * Fix lingering issues from merge conflicts * Fix lingering issues from merge conflicts * Remove From<Infallible> for ClientError impl * cargo fmt * Rename HostError InvalidData and MissingData variants * Define helper functions for HostError * Use newly-define HostError helpers * Remove HostError::AppModule variant * Prune some HostError variants * Consolidate some HostError variants * Remove HostError::NonexistentType variant * Remove HostError::UnexpectedState variant * Consolidate HostError::UnknownResource variant * cargo fmt * Remove unnecessary to_string calls * Revert `pick_version` method's documentation * Remove some more HostError variants * Remove From<DecodingError> for StatusValue impl * Fix AcknowledgementStatus tests * fix: revert errors in ICS721 callbacks * Change references to HandlerError in docs to refer to HostError where appropriate --------- Signed-off-by: Sean Chen <[email protected]> Co-authored-by: Farhad Shabani <[email protected]> * Consolidate `PacketError` and `ChannelError` (#1343) * Merge PacketError variants into ChannelError * cargo nightly fmt * Consolidate ChanelError verification variants * Convert ics04 try_from impls to use DecodingError * Add changelog entry * Incorporate some PR feedback * Remove ChannelError::MissingProof and MissingProofHeight error variants * Add `HostError` contexts to module-level error types (#1345) * Add ConnectionError::Host variant and clean up some other variants * Migrate some ics03 handlers to return HostErrors * Revert "Migrate some ics03 handlers to return HostErrors" This reverts commit f48a1a6. * Add HostError variant to ChannelError * Remove HandlerError::Host variant * Map client handler HostErrors to ClientError::Host * Revert "Map client handler HostErrors to ClientError::Host" This reverts commit 247be8a. * Change ics02-client handlers to return ClientError * Change ics03-connection handlers to return ConnectionError * Change ics04-channel handlers to return ChannelError * Make necessary changes in ics25 dispatch * imp: misc improvements and fixes * imp: use derive_more::From for ChannelError * fix: rename InvalidClientState under ConnectionError * nit: remove redundant import --------- Co-authored-by: Farhad Shabani <[email protected]> * Clean up generic String variants in error types (#1347) * Clean up most instances of ClientError::Other * Rename CommitmentError variants * Clean up some DecodingError calls * Incorporate some PR feedback * Incorporate more PR feedback * A bunch of DecodingError associated type changes * Eliminate a bunch of redundant map_err calls * cargo fmt * Fix ics23 spec tests * Fix a typo * Clean up some error messages * Consolidate MismatchedTypeUrl and MismatchedEventKind variants * Miscellaneous clean up * cargo fmt * Remove unused CommitmentError variants * Clean up errors to match ADR description * More clean up * Add changelog entry * fix: remove now unused HeightError * Clean up TimestampError --------- Co-authored-by: Farhad Shabani <[email protected]> * nitpicks * fix: remove ibc-core-connection-types dep under ICS-04 * fix: propogate errors in refund_packet_nft_execute * fix: revert few errors in ICS-20 module callbacks * imp: use if let for type_url matches * nit: minor improvements * fix: use RouterError in case of ModuleID not found * chore: add changelog * chore: add changelog for #1319 --------- Signed-off-by: Sean Chen <[email protected]> Co-authored-by: Farhad Shabani <[email protected]>
1 parent 8d36c68 commit ede380f

File tree

173 files changed

+2687
-3525
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

173 files changed

+2687
-3525
lines changed

‎.changelog/unreleased/breaking-changes/1311-migrate-cosmwasm-workspace

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎.changelog/unreleased/breaking-changes/1311-migrate-cosmwasm-workspace.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
- [cosmwasm] Migrate the `cosmwasm` workspace into its own separate repository
2+
located at [cosmwasm-ibc](https://github.com/informalsystems/cosmwasm-ibc).
3+
([\#1311](https://github.com/cosmos/ibc-rs/issues/1311))

‎.changelog/unreleased/breaking-changes/1319-consolidate-decoding-related-errors.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- [ibc] Consolidate decoding-related errors into new `DecodingError` type
2+
([\1319](https://github.com/cosmos/ibc-rs/issues/1319))

‎.changelog/unreleased/breaking-changes/1320-define-host-error-type.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
- [ibc-core] Define a new `HostError` type in ICS-24 to draw distinction between
2+
protocol errors and host errors. Additionally, rename `ContextError` to
3+
`HandlerError` to better reflect its use case.
4+
([\1320](https://github.com/cosmos/ibc-rs/issues/1320))

‎.changelog/unreleased/breaking-changes/1339-merge-packet-error-into-channel-error.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- [ibc-core-channel] Merge `PacketError` type into `ChannelError`
2+
([#1339](https://github.com/cosmos/ibc-rs/issues/1339))

‎.changelog/unreleased/breaking-changes/1346-remove-generic-string-error-variants.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
- [ibc] Clean up multi-purpose variants like the `Other` variant and reduce
2+
unnecessary `String` allocations in `*Error` enums.
3+
([\#1346](https://github.com/cosmos/ibc-rs/issues/1346))

‎.changelog/unreleased/breaking-changes/270-standardize-error-variants-to-be-less-specific.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
- [ibc] Standardize error variants across the codebase to make them less
2+
specific and more consistent.
3+
([\#270](https://github.com/cosmos/ibc-rs/issues/270))

‎.changelog/unreleased/breaking-changes/950-return-DecodingError-when-decoding-Any-to-MsgEnvelope.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- [ibc-core-handler] Return `DecodingError` for `MsgEnvelope` when trying to
2+
decode from `Any` ([\#950](https://github.com/cosmos/ibc-rs/issues/950))

‎.changelog/unreleased/improvements/1336-remove-faulty-receipt-check-during-recv-packet-validate.md renamed to ‎.changelog/unreleased/improvements/1338-remove-redundant-path-constructions-in-testkit.md

File renamed without changes.

‎.changelog/v0.31.0/breaking-changes/482-fix-validate-self-client-error-type.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
- Modify `validate_self_client` error type to return `ContextError` instead of
2-
`ConnectionError`
3-
([#482](https://github.com/cosmos/ibc-rs/issues/482))
1+
- Modify `validate_self_client` error type to return `HostError` instead of
2+
`ConnectionError`
3+
([#482](https://github.com/cosmos/ibc-rs/issues/482))

‎.changelog/v0.33.0/improvement/547-error-strings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
- Fix ContextError Display output
1+
- Fix HandlerError Display output
22
([#547](https://github.com/cosmos/ibc-rs/issues/547))

‎.changelog/v0.45.0/breaking-changes/857-use-result-for-safe-counters-increment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
- Allow hosts to handle overflow cases in `increase_*_counter` methods by
2-
returning `Result<(),ContextError>` type.
2+
returning `Result<(),HostError>` type.
33
([#857](https://github.com/cosmos/ibc-rs/issues/857))

‎.changelog/v0.45.0/breaking-changes/859-return-result-in-logger-event-emitter-methods.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
- logger and event emitter methods return `Result<(), ContextError>` type.
1+
- logger and event emitter methods return `Result<(), HostError>` type.
22
([#859](https://github.com/cosmos/ibc-rs/issues/859))

‎CHANGELOG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -641,9 +641,9 @@ There are no consensus-breaking changes.
641641
- Bump ibc-proto-rs to v0.34.0
642642
([#790](https://github.com/cosmos/ibc-rs/issues/790))
643643
- Allow hosts to handle overflow cases in `increase_*_counter` methods by
644-
returning `Result<(),ContextError>` type.
644+
returning `Result<(),HandlerError>` type.
645645
([#857](https://github.com/cosmos/ibc-rs/issues/857))
646-
- logger and event emitter methods return `Result<(), ContextError>` type.
646+
- logger and event emitter methods return `Result<(), HandlerError>` type.
647647
([#859](https://github.com/cosmos/ibc-rs/issues/859))
648648
- Bump `ibc-proto-rs` to v0.35.0 along with some other minor dependency updates
649649
([#873](https://github.com/cosmos/ibc-rs/issues/873))
@@ -1042,7 +1042,7 @@ There are no consensus-breaking changes.
10421042

10431043
### IMPROVEMENT
10441044

1045-
- Fix `ContextError` Display output
1045+
- Fix `HandlerError` Display output
10461046
([#547](https://github.com/cosmos/ibc-rs/issues/547))
10471047

10481048
## v0.32.0
@@ -1099,7 +1099,7 @@ There are no consensus-breaking changes.
10991099
([#479](https://github.com/cosmos/ibc-rs/issues/479))
11001100
- Remove Send + Sync supertraits on the Module trait
11011101
([#480](https://github.com/cosmos/ibc-rs/issues/480))
1102-
- Modify `validate_self_client` error type to return `ContextError` instead of
1102+
- Modify `validate_self_client` error type to return `HandlerError` instead of
11031103
`ConnectionError`
11041104
([#482](https://github.com/cosmos/ibc-rs/issues/482))
11051105

‎Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ ibc-client-wasm-types = { version = "0.54.0", path = "./ibc-clients/ics08-
105105
ibc-app-transfer-types = { version = "0.54.0", path = "./ibc-apps/ics20-transfer/types", default-features = false }
106106
ibc-app-nft-transfer-types = { version = "0.54.0", path = "./ibc-apps/ics721-nft-transfer/types", default-features = false }
107107

108-
ibc-proto = { version = "0.47.0", default-features = false }
108+
ibc-proto = { version = "0.47.1", default-features = false }
109109

110110
# cosmos dependencies
111111
tendermint = { version = "0.38.0", default-features = false }

‎ci/cw-check/Cargo.lock

Lines changed: 4 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)