feat(rpc): Add more helpers for TraceResult (#815)

* Add more helpers for TraceResult * clean up * clean up * fix clippy * Update crates/rpc-types-trace/src/common.rs * update test --------- Co-authored-by: Matthias Seitz <[email protected]>
alloy-rs · Jun 3, 2024 · 91e8a0f · 91e8a0f
1 parent e8473cb
commit 91e8a0f
Showing 1 changed file with 74 additions and 0 deletions.
diff --git a/crates/rpc-types-trace/src/common.rs b/crates/rpc-types-trace/src/common.rs
@@ -33,4 +33,78 @@ impl<Ok, Err> TraceResult<Ok, Err> {
             Self::Error { tx_hash, .. } => tx_hash,
         }
     }
+
+    /// Returns a reference to the result if it is a success variant.
+    pub const fn success(&self) -> Option<&Ok> {
+        match self {
+            Self::Success { result, .. } => Some(result),
+            Self::Error { .. } => None,
+        }
+    }
+
+    /// Returns a reference to the error if it is an error variant.
+    pub const fn error(&self) -> Option<&Err> {
+        match self {
+            Self::Error { error, .. } => Some(error),
+            Self::Success { .. } => None,
+        }
+    }
+
+    /// Checks if the result is a success.
+    pub const fn is_success(&self) -> bool {
+        matches!(self, Self::Success { .. })
+    }
+
+    /// Checks if the result is an error.
+    pub const fn is_error(&self) -> bool {
+        matches!(self, Self::Error { .. })
+    }
+
+    /// Creates a new success trace result.
+    pub const fn new_success(result: Ok, tx_hash: Option<TxHash>) -> Self {
+        Self::Success { result, tx_hash }
+    }
+
+    /// Creates a new error trace result.
+    pub const fn new_error(error: Err, tx_hash: Option<TxHash>) -> Self {
+        Self::Error { error, tx_hash }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
+    struct OkResult {
+        message: String,
+    }
+
+    #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
+    struct ErrResult {
+        code: i32,
+    }
+
+    #[test]
+    fn test_trace_result_getters() {
+        let tx_hash = Some(TxHash::ZERO);
+
+        let success_result: TraceResult<OkResult, ErrResult> =
+            TraceResult::new_success(OkResult { message: "Success".to_string() }, tx_hash);
+
+        assert!(success_result.is_success());
+        assert!(!success_result.is_error());
+        assert_eq!(success_result.tx_hash(), tx_hash);
+        assert_eq!(success_result.success(), Some(&OkResult { message: "Success".to_string() }));
+        assert_eq!(success_result.error(), None);
+
+        let error_result: TraceResult<OkResult, ErrResult> =
+            TraceResult::new_error(ErrResult { code: 404 }, tx_hash);
+
+        assert!(!error_result.is_success());
+        assert!(error_result.is_error());
+        assert_eq!(error_result.tx_hash(), tx_hash);
+        assert_eq!(error_result.success(), None);
+        assert_eq!(error_result.error(), Some(&ErrResult { code: 404 }));
+    }
 }