refactor(core): move error to separate module (#104)

Signed-off-by: Ozgur Akkurt <[email protected]>

Author: ozgrakkurt

tap_core/src/eip_712_signed_message.rs

@@ -4,11 +4,12 @@
 //! Module containing EIP712 message and signature
 //!
 
+use ethereum_types::Address;
 use ethers::{
     signers::{LocalWallet, Signer},
     types::Signature,
 };
-use ethers_core::types::{transaction::eip712, Address};
+use ethers_core::types::transaction::eip712;
 use serde::{Deserialize, Serialize};
 
 use crate::{Error, Result};

tap_core/src/error.rs

@@ -0,0 +1,44 @@
+// Copyright 2023-, Semiotic AI, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+//! Module containing Error type and Result typedef
+//!
+
+use crate::receipt_aggregate_voucher::ReceiptAggregateVoucher;
+use ethers::signers::WalletError;
+use ethers_core::{abi::Address, types::SignatureError};
+use std::result::Result as StdResult;
+use thiserror::Error as ThisError;
+
+#[derive(ThisError, Debug)]
+pub enum Error {
+    #[error("Aggregating receipt results in overflow")]
+    AggregateOverflow,
+    #[error("Failed to encode to EIP712 hash:\n{source_error_message}")]
+    EIP712EncodeError { source_error_message: String },
+    #[error(
+        "Unexpected check: {check_string}, only checks provided in initial checklist are valid"
+    )]
+    InvalidCheckError { check_string: String },
+    #[error("The requested action is invalid for current receipt state: {state}")]
+    InvalidStateForRequestedAction { state: String },
+    #[error("Failed to get current system time: {source_error_message} ")]
+    InvalidSystemTime { source_error_message: String },
+    #[error(transparent)]
+    WalletError(#[from] WalletError),
+    #[error(transparent)]
+    SignatureError(#[from] SignatureError),
+    #[error("Recovered gateway address invalid{address}")]
+    InvalidRecoveredSigner { address: Address },
+    #[error("Received RAV does not match expexted RAV")]
+    InvalidReceivedRAV {
+        received_rav: ReceiptAggregateVoucher,
+        expected_rav: ReceiptAggregateVoucher,
+    },
+    #[error("Error from adapter: {source_error_message}")]
+    AdapterError { source_error_message: String },
+    #[error("Failed to produce rav request, no valid receipts")]
+    NoValidReceiptsForRAVRequest,
+}
+
+pub type Result<T> = StdResult<T, Error>;

tap_core/src/lib.rs

@@ -8,49 +8,16 @@
 
 use std::time::{SystemTime, UNIX_EPOCH};
 
-use ethereum_types::Address;
-use ethers::{signers::WalletError, types::SignatureError};
-use receipt_aggregate_voucher::ReceiptAggregateVoucher;
 use thiserror::Error;
 
 pub mod adapters;
 pub mod eip_712_signed_message;
+mod error;
 pub mod receipt_aggregate_voucher;
 pub mod tap_manager;
 pub mod tap_receipt;
 
-#[derive(Error, Debug)]
-
-pub enum Error {
-    #[error("Aggregating receipt results in overflow")]
-    AggregateOverflow,
-    #[error("Failed to encode to EIP712 hash:\n{source_error_message}")]
-    EIP712EncodeError { source_error_message: String },
-    #[error(
-        "Unexpected check: {check_string}, only checks provided in initial checklist are valid"
-    )]
-    InvalidCheckError { check_string: String },
-    #[error("The requested action is invalid for current receipt state: {state}")]
-    InvalidStateForRequestedAction { state: String },
-    #[error("Failed to get current system time: {source_error_message} ")]
-    InvalidSystemTime { source_error_message: String },
-    #[error(transparent)]
-    WalletError(#[from] WalletError),
-    #[error(transparent)]
-    SignatureError(#[from] SignatureError),
-    #[error("Recovered gateway address invalid{address}")]
-    InvalidRecoveredSigner { address: Address },
-    #[error("Received RAV does not match expexted RAV")]
-    InvalidReceivedRAV {
-        received_rav: ReceiptAggregateVoucher,
-        expected_rav: ReceiptAggregateVoucher,
-    },
-    #[error("Error from adapter: {source_error_message}")]
-    AdapterError { source_error_message: String },
-    #[error("Failed to produce rav request, no valid receipts")]
-    NoValidReceiptsForRAVRequest,
-}
-type Result<T> = std::result::Result<T, Error>;
+pub use error::{Error, Result};
 
 pub(crate) fn get_current_timestamp_u64_ns() -> Result<u64> {
     Ok(SystemTime::now()