Define HostError type

.changelog/unreleased/improvements/1320-define-host-error-type.md

@@ -0,0 +1,2 @@
+- Defined a new `HostError` type in ics24 to draw distinction between protocol errors and host errors
+ ([\1320](https://github.com/cosmos/ibc-rs/issues/1320))

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

@@ -1,3 +1,3 @@
-- Modify `validate_self_client` error type to return `ContextError` instead of
- `ConnectionError` 
- ([#482](https://github.com/cosmos/ibc-rs/issues/482))
+- Modify `validate_self_client` error type to return `HandlerError` instead of
+ `ConnectionError`
+ ([#482](https://github.com/cosmos/ibc-rs/issues/482))

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

@@ -1,2 +1,2 @@
-- Fix ContextError Display output
+- Fix HandlerError Display output
  ([#547](https://github.com/cosmos/ibc-rs/issues/547))

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

@@ -1,3 +1,3 @@
 - Allow hosts to handle overflow cases in `increase_*_counter` methods by
- returning `Result<(),ContextError>` type.
+ returning `Result<(),HandlerError>` type.
  ([#857](https://github.com/cosmos/ibc-rs/issues/857))

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

@@ -1,2 +1,2 @@
-- logger and event emitter methods return `Result<(), ContextError>` type.
+- logger and event emitter methods return `Result<(), HandlerError>` type.
  ([#859](https://github.com/cosmos/ibc-rs/issues/859))

CHANGELOG.md

@@ -641,9 +641,9 @@ There are no consensus-breaking changes.
 - Bump ibc-proto-rs to v0.34.0
  ([#790](https://github.com/cosmos/ibc-rs/issues/790))
 - Allow hosts to handle overflow cases in `increase_*_counter` methods by
- returning `Result<(),ContextError>` type.
+ returning `Result<(),HandlerError>` type.
  ([#857](https://github.com/cosmos/ibc-rs/issues/857))
-- logger and event emitter methods return `Result<(), ContextError>` type.
+- logger and event emitter methods return `Result<(), HandlerError>` type.
  ([#859](https://github.com/cosmos/ibc-rs/issues/859))
 - Bump `ibc-proto-rs` to v0.35.0 along with some other minor dependency updates
  ([#873](https://github.com/cosmos/ibc-rs/issues/873))
@@ -1042,7 +1042,7 @@ There are no consensus-breaking changes.
 
 ### IMPROVEMENT
 
-- Fix `ContextError` Display output
+- Fix `HandlerError` Display output
  ([#547](https://github.com/cosmos/ibc-rs/issues/547))
 
 ## v0.32.0
@@ -1099,7 +1099,7 @@ There are no consensus-breaking changes.
  ([#479](https://github.com/cosmos/ibc-rs/issues/479))
 - Remove Send + Sync supertraits on the Module trait
  ([#480](https://github.com/cosmos/ibc-rs/issues/480))
-- Modify `validate_self_client` error type to return `ContextError` instead of
+- Modify `validate_self_client` error type to return `HandlerError` instead of
  `ConnectionError`
  ([#482](https://github.com/cosmos/ibc-rs/issues/482))
 

docs/architecture/adr-006-upgrade-client-implementation.md

@@ -119,7 +119,7 @@ supported by `IBC-rs`:
  negotiated on connection handshake.
 10. (U) Changing parameters that are customizable by relayers like `TrustLevel`
  and `TrustingPeriod`, `max_clock_drift`
- 
+
 #### Upgrade Process Step-by-step
 
 An IBC-connected Tendermint chain will take the following steps to completely
@@ -250,7 +250,7 @@ previous section as mentioned:
 
 1. ```rust
  if old_client_state.is_frozen() {
- return Err(ContextError::ClientError(ClientError::ClientFrozen {
+ return Err(HandlerError::ClientError(ClientError::ClientFrozen {
  client_id,
  }));
  }

docs/architecture/adr-007-light-client-contexts.md

@@ -98,12 +98,12 @@ pub trait ClientExecutionContext: Sized {
  /// Called upon successful client creation and update
  fn store_client_state(
  ...
- ) -> Result<(), ContextError>;
+ ) -> Result<(), HandlerError>;
 
  /// Called upon successful client creation and update
  fn store_consensus_state(
  ...
- ) -> Result<(), ContextError>;
+ ) -> Result<(), HandlerError>;
 }
 ```
 
@@ -120,7 +120,7 @@ pub trait ValidationContext: Router {
  type ClientValidationContext;
  type ClientExecutionContext;
  /// Enum that can contain a `ConsensusState` object of any supported light client
- type AnyConsensusState: ConsensusState<EncodeError = ContextError>;
+ type AnyConsensusState: ConsensusState<EncodeError = HandlerError>;
  /// Enum that can contain a `ClientState` object of any supported light client
  type AnyClientState: ClientState<
  Self::AnyConsensusState,

docs/architecture/adr-010-enable-standalone-ics02-integration.md

@@ -129,26 +129,26 @@ pub trait ValidationContext {
  fn get_client_validation_context(&self) -> &Self::V;
 
  // This method will be removed and replaced by a `ClientStateDecoder` trait that will encapsulate the ability to decode a client state from an `Any`
-- fn decode_client_state(&self, client_state: Any) -> Result<Self::AnyClientState, ContextError>;
+- fn decode_client_state(&self, client_state: Any) -> Result<Self::AnyClientState, HandlerError>;
 
-- fn client_state(&self, client_id: &ClientId) -> Result<Self::AnyClientState, ContextError>;
+- fn client_state(&self, client_id: &ClientId) -> Result<Self::AnyClientState, HandlerError>;
 
 - fn consensus_state(
 - &self,
 - client_cons_state_path: &ClientConsensusStatePath,
-- ) -> Result<Self::AnyConsensusState, ContextError>;
+- ) -> Result<Self::AnyConsensusState, HandlerError>;
 
  fn host_consensus_state(
  &self,
  height: &Height,
-- ) -> Result<Self::AnyConsensusState, ContextError>;
-+ ) -> Result<Self::HostConsensusState, ContextError>;
+- ) -> Result<Self::AnyConsensusState, HandlerError>;
++ ) -> Result<Self::HostConsensusState, HandlerError>;
 
  fn validate_self_client(
  &self,
 - client_state_of_host_on_counterparty: Any,
 + client_state_of_host_on_counterparty: Self::HostClientState,
- ) -> Result<(), ContextError>;
+ ) -> Result<(), HandlerError>;
 
  ... // other methods
 }
@@ -200,18 +200,18 @@ pub trait ClientValidationContext: Sized {
 + type ClientStateRef: ClientStateValidation<Self>;
 + type ConsensusStateRef: ConsensusState;
 
-+ fn client_state(&self, client_id: &ClientId) -> Result<Self::ClientStateRef, ContextError>;
++ fn client_state(&self, client_id: &ClientId) -> Result<Self::ClientStateRef, HandlerError>;
 
 + fn consensus_state(
 + &self,
 + client_cons_state_path: &ClientConsensusStatePath,
-+ ) -> Result<Self::ConsensusStateRef, ContextError>;
++ ) -> Result<Self::ConsensusStateRef, HandlerError>;
 
  fn client_update_meta(
  &self,
  client_id: &ClientId,
  height: &Height,
- ) -> Result<(Timestamp, Height), ContextError>;
+ ) -> Result<(Timestamp, Height), HandlerError>;
 }
 
 pub trait ClientExecutionContext:
@@ -222,40 +222,40 @@ pub trait ClientExecutionContext:
 - type AnyConsensusState: ConsensusState;
 + type ClientStateMut: ClientStateExecution<Self>;
 
-+ fn client_state_mut(&self, client_id: &ClientId) -> Result<Self::ClientStateMut, ContextError> {
++ fn client_state_mut(&self, client_id: &ClientId) -> Result<Self::ClientStateMut, HandlerError> {
 + self.client_state(client_id)
 + }
 
  fn store_client_state(
  &mut self,
  client_state_path: ClientStatePath,
  client_state: Self::ClientStateMut,
- ) -> Result<(), ContextError>;
+ ) -> Result<(), HandlerError>;
 
  fn store_consensus_state(
  &mut self,
  consensus_state_path: ClientConsensusStatePath,
  consensus_state: Self::ConsensusStateRef,
- ) -> Result<(), ContextError>;
+ ) -> Result<(), HandlerError>;
 
  fn delete_consensus_state(
  &mut self,
  consensus_state_path: ClientConsensusStatePath,
- ) -> Result<(), ContextError>;
+ ) -> Result<(), HandlerError>;
 
  fn store_update_meta(
  &mut self,
  client_id: ClientId,
  height: Height,
  host_timestamp: Timestamp,
  host_height: Height,
- ) -> Result<(), ContextError>;
+ ) -> Result<(), HandlerError>;
 
  fn delete_update_meta(
  &mut self,
  client_id: ClientId,
  height: Height,
- ) -> Result<(), ContextError>;
+ ) -> Result<(), HandlerError>;
 }
 ```
 
@@ -306,28 +306,28 @@ pub trait ExtClientValidationContext:
 + type ConversionError: ToString;
 + type AnyConsensusState: TryInto<TmConsensusState, Error = Self::ConversionError>;
 
-+ fn host_timestamp(&self) -> Result<Timestamp, ContextError>;
++ fn host_timestamp(&self) -> Result<Timestamp, HandlerError>;
 
-+ fn host_height(&self) -> Result<Height, ContextError>;
++ fn host_height(&self) -> Result<Height, HostError>;
 
 - fn consensus_state(
 - &self,
 - client_cons_state_path: &ClientConsensusStatePath,
-- ) -> Result<Self::AnyConsensusState, ContextError>;
+- ) -> Result<Self::AnyConsensusState, HandlerError>;
 
-+ fn consensus_state_heights(&self, client_id: &ClientId) -> Result<Vec<Height>, ContextError>;
++ fn consensus_state_heights(&self, client_id: &ClientId) -> Result<Vec<Height>, HandlerError>;
 
  fn next_consensus_state(
  &self,
  client_id: &ClientId,
  height: &Height,
- ) -> Result<Option<Self::AnyConsensusState>, ContextError>;
+ ) -> Result<Option<Self::AnyConsensusState>, HandlerError>;
 
  fn prev_consensus_state(
  &self,
  client_id: &ClientId,
  height: &Height,
- ) -> Result<Option<Self::AnyConsensusState>, ContextError>;
+ ) -> Result<Option<Self::AnyConsensusState>, HandlerError>;
 }
 
 -impl<T> ExecutionContext for T where T: CommonContext + ClientExecutionContext {}

ibc-apps/ics20-transfer/src/context.rs

@@ -1,7 +1,7 @@
 //! Defines the main context traits and IBC module callbacks
 
-use ibc_app_transfer_types::error::TokenTransferError;
 use ibc_app_transfer_types::{Memo, PrefixedCoin, PrefixedDenom};
+use ibc_core::host::types::error::HostError;
 use ibc_core::host::types::identifiers::{ChannelId, PortId};
 use ibc_core::primitives::prelude::*;
 use ibc_core::primitives::Signer;
@@ -11,13 +11,13 @@ pub trait TokenTransferValidationContext {
  type AccountId: TryFrom<Signer>;
 
  /// get_port returns the portID for the transfer module.
- fn get_port(&self) -> Result<PortId, TokenTransferError>;
+ fn get_port(&self) -> Result<PortId, HostError>;
 
  /// Returns Ok() if the host chain supports sending coins.
- fn can_send_coins(&self) -> Result<(), TokenTransferError>;
+ fn can_send_coins(&self) -> Result<(), HostError>;
 
  /// Returns Ok() if the host chain supports receiving coins.
- fn can_receive_coins(&self) -> Result<(), TokenTransferError>;
+ fn can_receive_coins(&self) -> Result<(), HostError>;
 
  /// Validates that the tokens can be escrowed successfully.
  ///
@@ -30,7 +30,7 @@ pub trait TokenTransferValidationContext {
  channel_id: &ChannelId,
  coin: &PrefixedCoin,
  memo: &Memo,
- ) -> Result<(), TokenTransferError>;
+ ) -> Result<(), HostError>;
 
  /// Validates that the tokens can be unescrowed successfully.
  fn unescrow_coins_validate(
@@ -39,14 +39,14 @@ pub trait TokenTransferValidationContext {
  port_id: &PortId,
  channel_id: &ChannelId,
  coin: &PrefixedCoin,
- ) -> Result<(), TokenTransferError>;
+ ) -> Result<(), HostError>;
 
  /// Validates the receiver account and the coin input
  fn mint_coins_validate(
  &self,
  account: &Self::AccountId,
  coin: &PrefixedCoin,
- ) -> Result<(), TokenTransferError>;
+ ) -> Result<(), HostError>;
 
  /// Validates the sender account and the coin input before burning.
  ///
@@ -57,7 +57,7 @@ pub trait TokenTransferValidationContext {
  account: &Self::AccountId,
  coin: &PrefixedCoin,
  memo: &Memo,
- ) -> Result<(), TokenTransferError>;
+ ) -> Result<(), HostError>;
 
  /// Returns a hash of the prefixed denom.
  /// Implement only if the host chain supports hashed denominations.
@@ -79,7 +79,7 @@ pub trait TokenTransferExecutionContext: TokenTransferValidationContext {
  channel_id: &ChannelId,
  coin: &PrefixedCoin,
  memo: &Memo,
- ) -> Result<(), TokenTransferError>;
+ ) -> Result<(), HostError>;
 
  /// Executes the unescrow of the tokens in a user account.
  fn unescrow_coins_execute(
@@ -88,14 +88,14 @@ pub trait TokenTransferExecutionContext: TokenTransferValidationContext {
  port_id: &PortId,
  channel_id: &ChannelId,
  coin: &PrefixedCoin,
- ) -> Result<(), TokenTransferError>;
+ ) -> Result<(), HostError>;
 
  /// Executes minting of the tokens in a user account.
  fn mint_coins_execute(
  &mut self,
  account: &Self::AccountId,
  coin: &PrefixedCoin,
- ) -> Result<(), TokenTransferError>;
+ ) -> Result<(), HostError>;
 
  /// Executes burning of the tokens in a user account.
  ///
@@ -106,5 +106,5 @@ pub trait TokenTransferExecutionContext: TokenTransferValidationContext {
  account: &Self::AccountId,
  coin: &PrefixedCoin,
  memo: &Memo,
- ) -> Result<(), TokenTransferError>;
+ ) -> Result<(), HostError>;
 }