Merge pull request #1193 from input-output-hk/ensemble/798/errors-refactoring

Add common error: CodecError

Author: dlachaume

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-common"
-version = "0.2.98"
+version = "0.2.99"
 authors = { workspace = true }
 edition = { workspace = true }
 documentation = { workspace = true }

mithril-common/Cargo.toml

@@ -3,29 +3,55 @@ use crate::entities::{HexEncodedKey, HexEncodedKeySlice};
 use hex::{FromHex, ToHex};
 use serde::de::DeserializeOwned;
 use serde::Serialize;
+use thiserror::Error;
+
+/// Error raised when the encoding or decoding fails
+#[derive(Error, Debug)]
+#[error("Codec error: {msg}")]
+pub struct CodecError {
+    msg: String,
+    #[source]
+    source: anyhow::Error,
+}
+
+impl CodecError {
+    /// [CodecError] factory.
+    pub fn new(msg: &str, source: anyhow::Error) -> Self {
+        Self {
+            msg: msg.to_string(),
+            source,
+        }
+    }
+}
 
 /// Encode key to hex helper
-pub fn key_encode_hex<T>(from: T) -> Result<HexEncodedKey, String>
+pub fn key_encode_hex<T>(from: T) -> Result<HexEncodedKey, CodecError>
 where
     T: Serialize,
 {
     Ok(serde_json::to_string(&from)
-        .map_err(|e| format!("can't convert to hex: {e}"))?
+        .map_err(|e| CodecError::new("Key encode hex: can not convert to hex", e.into()))?
         .encode_hex::<String>())
 }
 
 /// Decode key from hex helper
-pub fn key_decode_hex<T>(from: HexEncodedKeySlice) -> Result<T, String>
+pub fn key_decode_hex<T>(from: HexEncodedKeySlice) -> Result<T, CodecError>
 where
     T: DeserializeOwned,
 {
     let from_vec = Vec::from_hex(from).map_err(|e| {
-        format!("Key decode hex: can not turn hexadecimal value into bytes, error: {e}")
+        CodecError::new(
+            "Key decode hex: can not turn hexadecimal value into bytes",
+            e.into(),
+        )
     })?;
     serde_json::from_slice(from_vec.as_slice()).map_err(|e| {
-        format!(
-            "Key decode hex: can not deserialize to type '{}' from binary JSON: error {e}",
-            std::any::type_name::<T>()
+        CodecError::new(
+            &format!(
+                "Key decode hex: can not deserialize to type '{}' from binary JSON",
+                std::any::type_name::<T>()
+            ),
+            e.into(),
         )
     })
 }

mithril-common/src/crypto_helper/codec.rs

@@ -1,4 +1,4 @@
-use anyhow::{anyhow, Context};
+use anyhow::Context;
 use serde::{de::DeserializeOwned, Deserialize, Serialize, Serializer};
 use std::any::type_name;
 use std::ops::Deref;
@@ -44,14 +44,12 @@ where
 
     /// Create an instance from a JSON hex representation
     pub fn from_json_hex(hex_string: &str) -> StdResult<Self> {
-        let key = key_decode_hex::<T>(hex_string)
-            .map_err(|e| anyhow!(e))
-            .with_context(|| {
-                format!(
-                    "Could not deserialize a ProtocolKey from JSON hex string. Inner key type: {}",
-                    type_name::<T>()
-                )
-            })?;
+        let key = key_decode_hex::<T>(hex_string).with_context(|| {
+            format!(
+                "Could not deserialize a ProtocolKey from JSON hex string. Inner key type: {}",
+                type_name::<T>()
+            )
+        })?;
 
         Ok(Self { key })
     }
@@ -63,14 +61,12 @@ where
 
     /// Create a JSON hash representation of the given key
     pub fn key_to_json_hex(key: &T) -> StdResult<String> {
-        key_encode_hex(key)
-            .map_err(|e| anyhow!(e))
-            .with_context(|| {
-                format!(
-                    "Could not serialize a ProtocolKey to JSON hex key string. Inner key type: {}",
-                    type_name::<T>()
-                )
-            })
+        key_encode_hex(key).with_context(|| {
+            format!(
+                "Could not serialize a ProtocolKey to JSON hex key string. Inner key type: {}",
+                type_name::<T>()
+            )
+        })
     }
 }
 

mithril-common/src/crypto_helper/types/protocol_key.rs

@@ -394,7 +394,9 @@ mod test {
         encoded_types: &[&str],
     ) {
         assert_decode_all(encoded_types, |encoded_type| {
-            key_decode_hex::<T>(encoded_type).map(|_| ())
+            key_decode_hex::<T>(encoded_type)
+                .map(|_| ())
+                .map_err(|e| format!("{e:?}"))
         })
     }
 

mithril-common/src/test_utils/fake_keys.rs

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-signer"
-version = "0.2.71"
+version = "0.2.72"
 description = "A Mithril Signer"
 authors = { workspace = true }
 edition = { workspace = true }

mithril-signer/Cargo.toml

@@ -8,7 +8,7 @@ use mithril_common::entities::{
     PartyId, ProtocolMessage, ProtocolParameters, SignerWithStake, SingleSignatures, Stake,
 };
 use mithril_common::protocol::SignerBuilder;
-use mithril_common::StdError;
+use mithril_common::{StdError, StdResult};
 
 #[cfg(test)]
 use mockall::automock;
@@ -46,14 +46,14 @@ pub trait SingleSigner: Sync + Send {
         protocol_message: &ProtocolMessage,
         signers_with_stake: &[SignerWithStake],
         protocol_initializer: &ProtocolInitializer,
-    ) -> Result<Option<SingleSignatures>, SingleSignerError>;
+    ) -> StdResult<Option<SingleSignatures>>;
 
     /// Compute aggregate verification key from stake distribution
     fn compute_aggregate_verification_key(
         &self,
         signers_with_stake: &[SignerWithStake],
         protocol_initializer: &ProtocolInitializer,
-    ) -> Result<Option<String>, SingleSignerError>;
+    ) -> StdResult<Option<String>>;
 
     /// Get party id
     fn get_party_id(&self) -> PartyId;
@@ -66,10 +66,6 @@ pub enum SingleSignerError {
     #[error("the protocol signer creation failed: `{0}`")]
     ProtocolSignerCreationFailure(String),
 
-    /// Encoding / Decoding error.
-    #[error("codec error: '{0:?}'")]
-    Codec(StdError),
-
     /// Signature Error
     #[error("Signature Error: {0:?}")]
     SignatureFailed(StdError),
@@ -97,7 +93,7 @@ impl SingleSigner for MithrilSingleSigner {
         protocol_message: &ProtocolMessage,
         signers_with_stake: &[SignerWithStake],
         protocol_initializer: &ProtocolInitializer,
-    ) -> Result<Option<SingleSignatures>, SingleSignerError> {
+    ) -> StdResult<Option<SingleSignatures>> {
         let builder = SignerBuilder::new(
             signers_with_stake,
             &protocol_initializer.get_protocol_parameters().into(),
@@ -131,7 +127,7 @@ impl SingleSigner for MithrilSingleSigner {
         &self,
         signers_with_stake: &[SignerWithStake],
         protocol_initializer: &ProtocolInitializer,
-    ) -> Result<Option<String>, SingleSignerError> {
+    ) -> StdResult<Option<String>> {
         let signer_builder = SignerBuilder::new(
             signers_with_stake,
             &protocol_initializer.get_protocol_parameters().into(),
@@ -140,8 +136,7 @@ impl SingleSigner for MithrilSingleSigner {
 
         let encoded_avk = signer_builder
             .compute_aggregate_verification_key()
-            .to_json_hex()
-            .map_err(SingleSignerError::Codec)?;
+            .to_json_hex()?;
 
         Ok(Some(encoded_avk))
     }