Use flex-error for ics03_connection

informalsystems · Jun 8, 2021 · 8bd683e · 8bd683e
1 parent 3063f27
commit 8bd683e
Show file tree

Hide file tree

Showing 20 changed files with 573 additions and 477 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/modules/Cargo.toml b/modules/Cargo.toml
@@ -36,7 +36,7 @@ dyn-clonable = "0.9.0"
 regex = "1"
 subtle-encoding = "0.5"
 sha2 = { version = "0.9.3", optional = true }
-flex-error = "0.1.2"
+flex-error = "0.2.0"
 
 [dependencies.tendermint]
 version = "=0.19.0"

diff --git a/modules/src/ics02_client/error.rs b/modules/src/ics02_client/error.rs
@@ -8,185 +8,186 @@ use crate::Height;
 use std::num::TryFromIntError;
 use tendermint_proto::Error as TendermintError;
 
-use flex_error::{define_error, DetailOnly, DisplayError};
-
-define_error! { Error;
-
-    UnknownClientType
-        { client_type: String }
-        | e | { format_args!("unknown client type: {0}", e.client_type) },
-
-    ClientIdentifierConstructor
-        { client_type: ClientType, counter: u64 }
-        [ DisplayError<ValidationError> ]
-        | e | {
-            format_args!("Client identifier constructor failed for type {0} with counter {1}",
-                e.client_type, e.counter)
-        },
-
-    ClientAlreadyExists
-        { client_id: ClientId }
-        | e | { format_args!("client already exists: {0}", e.client_id) },
-
-    ClientNotFound
-        { client_id: ClientId }
-        | e | { format_args!("client not found: {0}", e.client_id) },
-
-    ClientFrozen
-        { client_id: ClientId }
-        | e | { format_args!("client is frozen: {0}", e.client_id) },
-
-    ConsensusStateNotFound
-        { client_id: ClientId, height: Height }
-        | e | {
-            format_args!("consensus state not found at: {0} at height {1}",
-                e.client_id, e.height)
-        },
-
-    ImplementationSpecific
-        | _ | { format_args!("implementation specific error") },
-
-    HeaderVerificationFailure
-        { reason: String }
-        | e | { format_args!("header verification failed with reason: {}", e.reason) },
-
-    UnknownClientStateType
-        { client_state_type: String }
-        | e | { format_args!("unknown client state type: {0}", e.client_state_type) },
-
-    EmptyClientStateResponse
-        | _ | { format_args!("the client state was not found") },
-
-    UnknownConsensusStateType
-        { consensus_state_type: String }
-        | e | {
-            format_args!("unknown client consensus state type: {0}",
-                e.consensus_state_type)
-        },
-
-    EmptyConsensusStateResponse
-        | _ | { format_args!("the client state was not found") },
-
-    UnknownHeaderType
-        { header_type: String }
-        | e | {
-            format_args!("unknown header type: {0}",
-                e.header_type)
-        },
-
-    UnknownMisbehaviourType
-        { misbehavior_type: String }
-        | e | {
-            format_args!("unknown misbehaviour type: {0}",
-                e.misbehavior_type)
-        },
-
-    InvalidRawClientId
-        { client_id: String }
-        [ DisplayError<ValidationError> ]
-        | e | {
-            format_args!("invalid raw client identifier {0}",
-                e.client_id)
-        },
-
-    DecodeRawClientState
-        [ DisplayError<TendermintError> ]
-        | _ | { format_args!("error decoding raw client state") },
-
-    MissingRawClientState
-        | _ | { format_args!("missing raw client state") },
-
-    InvalidRawConsensusState
-        [ DisplayError<TendermintError> ]
-        | _ | { format_args!("invalid raw client consensus state") },
-
-    MissingRawConsensusState
-        | _ | { format_args!("missing raw client consensus state") },
-
-    InvalidMsgUpdateClientId
-        [ DisplayError<ValidationError> ]
-        | _ | { format_args!("invalid client id in the update client message") },
-
-    MissingHeight
-        | _ | { format_args!("invalid raw client consensus state: the height field is missing") },
-
-    InvalidClientIdentifier
-        [ DisplayError<ValidationError> ]
-        | _ | { format_args!("invalid client identifier") },
-
-    InvalidRawHeader
-        [ DisplayError<TendermintError> ]
-        | _ | { format_args!("invalid raw header") },
-
-    MissingRawHeader
-        | _ | { format_args!("missing raw header") },
-
-    DecodeRawMisbehaviour
-        [ DisplayError<TendermintError> ]
-        | _ | { format_args!("invalid raw misbehaviour") },
-
-    InvalidRawMisbehaviour
-        [ DisplayError<ValidationError> ]
-        | _ | { format_args!("invalid raw misbehaviour") },
-
-    MissingRawMisbehaviour
-        | _ | { format_args!("missing raw misbehaviour") },
-
-    InvalidHeightResult
-        | _ | { format_args!("height cannot end up zero or negative") },
-
-    HeightConversion
-        { height: String }
-        [ DetailOnly<ParseIntError> ]
-        | e | {
-            format_args!("cannot convert into a `Height` type from string {0}",
-                e.height)
-        },
-
-    InvalidAddress
-        | _ | { format_args!("invalid address") },
-
-    InvalidUpgradeClientProof
-        [ DisplayError<Ics23Error> ]
-        | _ | { format_args!("invalid proof for the upgraded client state") },
-
-    InvalidUpgradeConsensusStateProof
-        [ DisplayError<Ics23Error> ]
-        | _ | { format_args!("invalid proof for the upgraded consensus state") },
-
-    InvalidPacketTimestamp
-        [ DisplayError<TryFromIntError> ]
-        | _ | { format_args!("invalid packet timeout timestamp value") },
-
-    ClientArgsTypeMismatch
-        { client_type: ClientType }
-        | e | {
-            format_args!("mismatch between client and arguments types, expected: {0:?}",
-                e.client_type)
-        },
-
-    RawClientAndConsensusStateTypesMismatch
-        {
-            state_type: ClientType,
-            consensus_type: ClientType,
-        }
-        | e | {
-            format_args!("mismatch in raw client consensus state {} with expected state {}",
-                e.state_type, e.consensus_type)
-        },
-
-    UpgradeVerificationFailure
-        { reason: String }
-        | e | { format_args!("upgrade verification failed with reason: {}", e.reason) },
-
-    LowUpgradeHeight
-        {
-            upgraded_height: Height,
-            client_height: Height,
-        }
-        | e | {
-            format_args!("upgraded client height {0} must be at greater than current client height {1}",
-                e.upgraded_height, e.client_height)
-        },
-
+use flex_error::{define_error, DetailOnly, DisplayOnly};
+
+define_error! {
+    #[derive(Debug, PartialEq, Eq)]
+    Error {
+        UnknownClientType
+            { client_type: String }
+            | e | { format_args!("unknown client type: {0}", e.client_type) },
+
+        ClientIdentifierConstructor
+            { client_type: ClientType, counter: u64 }
+            [ DisplayOnly<ValidationError> ]
+            | e | {
+                format_args!("Client identifier constructor failed for type {0} with counter {1}",
+                    e.client_type, e.counter)
+            },
+
+        ClientAlreadyExists
+            { client_id: ClientId }
+            | e | { format_args!("client already exists: {0}", e.client_id) },
+
+        ClientNotFound
+            { client_id: ClientId }
+            | e | { format_args!("client not found: {0}", e.client_id) },
+
+        ClientFrozen
+            { client_id: ClientId }
+            | e | { format_args!("client is frozen: {0}", e.client_id) },
+
+        ConsensusStateNotFound
+            { client_id: ClientId, height: Height }
+            | e | {
+                format_args!("consensus state not found at: {0} at height {1}",
+                    e.client_id, e.height)
+            },
+
+        ImplementationSpecific
+            | _ | { format_args!("implementation specific error") },
+
+        HeaderVerificationFailure
+            { reason: String }
+            | e | { format_args!("header verification failed with reason: {}", e.reason) },
+
+        UnknownClientStateType
+            { client_state_type: String }
+            | e | { format_args!("unknown client state type: {0}", e.client_state_type) },
+
+        EmptyClientStateResponse
+            | _ | { format_args!("the client state was not found") },
+
+        UnknownConsensusStateType
+            { consensus_state_type: String }
+            | e | {
+                format_args!("unknown client consensus state type: {0}",
+                    e.consensus_state_type)
+            },
+
+        EmptyConsensusStateResponse
+            | _ | { format_args!("the client state was not found") },
+
+        UnknownHeaderType
+            { header_type: String }
+            | e | {
+                format_args!("unknown header type: {0}",
+                    e.header_type)
+            },
+
+        UnknownMisbehaviourType
+            { misbehavior_type: String }
+            | e | {
+                format_args!("unknown misbehaviour type: {0}",
+                    e.misbehavior_type)
+            },
+
+        InvalidRawClientId
+            { client_id: String }
+            [ DisplayOnly<ValidationError> ]
+            | e | {
+                format_args!("invalid raw client identifier {0}",
+                    e.client_id)
+            },
+
+        DecodeRawClientState
+            [ DisplayOnly<TendermintError> ]
+            | _ | { format_args!("error decoding raw client state") },
+
+        MissingRawClientState
+            | _ | { format_args!("missing raw client state") },
+
+        InvalidRawConsensusState
+            [ DisplayOnly<TendermintError> ]
+            | _ | { format_args!("invalid raw client consensus state") },
+
+        MissingRawConsensusState
+            | _ | { format_args!("missing raw client consensus state") },
+
+        InvalidMsgUpdateClientId
+            [ DisplayOnly<ValidationError> ]
+            | _ | { format_args!("invalid client id in the update client message") },
+
+        MissingHeight
+            | _ | { format_args!("invalid raw client consensus state: the height field is missing") },
+
+        InvalidClientIdentifier
+            [ DisplayOnly<ValidationError> ]
+            | _ | { format_args!("invalid client identifier") },
+
+        InvalidRawHeader
+            [ DisplayOnly<TendermintError> ]
+            | _ | { format_args!("invalid raw header") },
+
+        MissingRawHeader
+            | _ | { format_args!("missing raw header") },
+
+        DecodeRawMisbehaviour
+            [ DisplayOnly<TendermintError> ]
+            | _ | { format_args!("invalid raw misbehaviour") },
+
+        InvalidRawMisbehaviour
+            [ DisplayOnly<ValidationError> ]
+            | _ | { format_args!("invalid raw misbehaviour") },
+
+        MissingRawMisbehaviour
+            | _ | { format_args!("missing raw misbehaviour") },
+
+        InvalidHeightResult
+            | _ | { format_args!("height cannot end up zero or negative") },
+
+        HeightConversion
+            { height: String }
+            [ DetailOnly<ParseIntError> ]
+            | e | {
+                format_args!("cannot convert into a `Height` type from string {0}",
+                    e.height)
+            },
+
+        InvalidAddress
+            | _ | { format_args!("invalid address") },
+
+        InvalidUpgradeClientProof
+            [ DisplayOnly<Ics23Error> ]
+            | _ | { format_args!("invalid proof for the upgraded client state") },
+
+        InvalidUpgradeConsensusStateProof
+            [ DisplayOnly<Ics23Error> ]
+            | _ | { format_args!("invalid proof for the upgraded consensus state") },
+
+        InvalidPacketTimestamp
+            [ DisplayOnly<TryFromIntError> ]
+            | _ | { format_args!("invalid packet timeout timestamp value") },
+
+        ClientArgsTypeMismatch
+            { client_type: ClientType }
+            | e | {
+                format_args!("mismatch between client and arguments types, expected: {0:?}",
+                    e.client_type)
+            },
+
+        RawClientAndConsensusStateTypesMismatch
+            {
+                state_type: ClientType,
+                consensus_type: ClientType,
+            }
+            | e | {
+                format_args!("mismatch in raw client consensus state {} with expected state {}",
+                    e.state_type, e.consensus_type)
+            },
+
+        UpgradeVerificationFailure
+            { reason: String }
+            | e | { format_args!("upgrade verification failed with reason: {}", e.reason) },
+
+        LowUpgradeHeight
+            {
+                upgraded_height: Height,
+                client_height: Height,
+            }
+            | e | {
+                format_args!("upgraded client height {0} must be at greater than current client height {1}",
+                    e.upgraded_height, e.client_height)
+            },
+    }
 }
diff --git a/modules/src/ics02_client/handler/upgrade_client.rs b/modules/src/ics02_client/handler/upgrade_client.rs
@@ -218,7 +218,7 @@ mod tests {
             }
             Err(err) => match err.detail {
                 error::ErrorDetail::LowUpgradeHeight(e) => {
-                    assert_eq!(e.upgraded_height, Height::zero());
+                    assert_eq!(e.upgraded_height, Height::new(0, 42));
                     assert_eq!(e.client_height, msg.client_state.latest_height());
                 }
                 _ => {