Define trait TransactionEnvelope

alloy-rs · Jan 12, 2025 · da3f0ca · da3f0ca
1 parent 065c123
commit da3f0ca
Show file tree

Hide file tree

Showing 3 changed files with 125 additions and 73 deletions.
diff --git a/crates/consensus/src/lib.rs b/crates/consensus/src/lib.rs
@@ -36,8 +36,9 @@ pub mod transaction;
 #[cfg(feature = "kzg")]
 pub use transaction::BlobTransactionValidationError;
 pub use transaction::{
-    SignableTransaction, Transaction, TxEip1559, TxEip2930, TxEip4844, TxEip4844Variant,
-    TxEip4844WithSidecar, TxEip7702, TxEnvelope, TxLegacy, TxType, Typed2718, TypedTransaction,
+    SignableTransaction, Transaction, TransactionEnvelope, TxEip1559, TxEip2930, TxEip4844,
+    TxEip4844Variant, TxEip4844WithSidecar, TxEip7702, TxEnvelope, TxLegacy, TxType, Typed2718,
+    TypedTransaction,
 };
 
 pub use alloy_eips::eip4844::{

diff --git a/crates/consensus/src/transaction/envelope.rs b/crates/consensus/src/transaction/envelope.rs
@@ -15,6 +15,45 @@ use alloy_primitives::{
 use alloy_rlp::{Decodable, Encodable};
 use core::fmt;
 
+/// Transaction envelope.
+#[auto_impl::auto_impl(&, Arc)]
+pub trait TransactionEnvelope {
+    /// Returns the envelope ID, i.e. the transaction type.
+    ///
+    /// Equivalent to [`Transaction::ty`](crate::Transaction::ty).
+    fn id(&self) -> u8;
+
+    /// Returns `true` if the transaction is a legacy transaction.
+    fn is_legacy(&self) -> bool;
+
+    /// Returns `true` if the transaction is an EIP-2930 transaction.
+    fn is_eip2930(&self) -> bool;
+
+    /// Returns `true` if the transaction is an EIP-1559 transaction.
+    fn is_eip1559(&self) -> bool;
+
+    /// Returns `true` if the transaction is an EIP-4844 transaction.
+    fn is_eip4844(&self) -> bool;
+
+    /// Returns `true` if the transaction is an EIP-7702 transaction.
+    fn is_eip7702(&self) -> bool;
+
+    /// Returns ref to [`Signed<TxLegacy>`] if transaction is a legacy transaction.
+    fn as_legacy(&self) -> Option<&Signed<TxLegacy>>;
+
+    /// Returns ref to [`Signed<TxEip2930>`] if transaction is an EIP-2930 transaction.
+    fn as_eip2930(&self) -> Option<&Signed<TxEip2930>>;
+
+    /// Returns ref to [`Signed<TxEip1559>`] if transaction is an EIP-1559 transaction.
+    fn as_eip1559(&self) -> Option<&Signed<TxEip1559>>;
+
+    /// Returns ref to [`Signed<TxEip4844>`] if this is an EIP-4844 transaction.
+    fn as_eip4844(&self) -> Option<&Signed<TxEip4844Variant>>;
+
+    /// Returns ref to [`Signed<TxEip7702>`] if this is an EIP-7702 transaction.
+    fn as_eip7702(&self) -> Option<&Signed<TxEip7702>>;
+}
+
 /// Ethereum `TransactionType` flags as specified in EIPs [2718], [1559], [2930],
 /// [4844], and [7702].
 ///
@@ -224,36 +263,6 @@ impl From<Signed<TxEip7702>> for TxEnvelope {
 }
 
 impl TxEnvelope {
-    /// Returns true if the transaction is a legacy transaction.
-    #[inline]
-    pub const fn is_legacy(&self) -> bool {
-        matches!(self, Self::Legacy(_))
-    }
-
-    /// Returns true if the transaction is an EIP-2930 transaction.
-    #[inline]
-    pub const fn is_eip2930(&self) -> bool {
-        matches!(self, Self::Eip2930(_))
-    }
-
-    /// Returns true if the transaction is an EIP-1559 transaction.
-    #[inline]
-    pub const fn is_eip1559(&self) -> bool {
-        matches!(self, Self::Eip1559(_))
-    }
-
-    /// Returns true if the transaction is an EIP-4844 transaction.
-    #[inline]
-    pub const fn is_eip4844(&self) -> bool {
-        matches!(self, Self::Eip4844(_))
-    }
-
-    /// Returns true if the transaction is an EIP-7702 transaction.
-    #[inline]
-    pub const fn is_eip7702(&self) -> bool {
-        matches!(self, Self::Eip7702(_))
-    }
-
     /// Returns true if the transaction is replay protected.
     ///
     /// All non-legacy transactions are replay protected, as the chain id is
@@ -270,46 +279,6 @@ impl TxEnvelope {
         }
     }
 
-    /// Returns the [`TxLegacy`] variant if the transaction is a legacy transaction.
-    pub const fn as_legacy(&self) -> Option<&Signed<TxLegacy>> {
-        match self {
-            Self::Legacy(tx) => Some(tx),
-            _ => None,
-        }
-    }
-
-    /// Returns the [`TxEip2930`] variant if the transaction is an EIP-2930 transaction.
-    pub const fn as_eip2930(&self) -> Option<&Signed<TxEip2930>> {
-        match self {
-            Self::Eip2930(tx) => Some(tx),
-            _ => None,
-        }
-    }
-
-    /// Returns the [`TxEip1559`] variant if the transaction is an EIP-1559 transaction.
-    pub const fn as_eip1559(&self) -> Option<&Signed<TxEip1559>> {
-        match self {
-            Self::Eip1559(tx) => Some(tx),
-            _ => None,
-        }
-    }
-
-    /// Returns the [`TxEip4844Variant`] variant if the transaction is an EIP-4844 transaction.
-    pub const fn as_eip4844(&self) -> Option<&Signed<TxEip4844Variant>> {
-        match self {
-            Self::Eip4844(tx) => Some(tx),
-            _ => None,
-        }
-    }
-
-    /// Returns the [`TxEip7702`] variant if the transaction is an EIP-7702 transaction.
-    pub const fn as_eip7702(&self) -> Option<&Signed<TxEip7702>> {
-        match self {
-            Self::Eip7702(tx) => Some(tx),
-            _ => None,
-        }
-    }
-
     /// Recover the signer of the transaction.
     #[cfg(feature = "k256")]
     pub fn recover_signer(
@@ -382,6 +351,88 @@ impl TxEnvelope {
     }
 }
 
+impl TransactionEnvelope for TxEnvelope {
+    #[inline]
+    fn id(&self) -> u8 {
+        self.ty()
+    }
+
+    /// Returns true if the transaction is a legacy transaction.
+    #[inline]
+    fn is_legacy(&self) -> bool {
+        matches!(self, Self::Legacy(_))
+    }
+
+    /// Returns true if the transaction is an EIP-2930 transaction.
+    #[inline]
+    fn is_eip2930(&self) -> bool {
+        matches!(self, Self::Eip2930(_))
+    }
+
+    /// Returns true if the transaction is an EIP-1559 transaction.
+    #[inline]
+    fn is_eip1559(&self) -> bool {
+        matches!(self, Self::Eip1559(_))
+    }
+
+    /// Returns true if the transaction is an EIP-4844 transaction.
+    #[inline]
+    fn is_eip4844(&self) -> bool {
+        matches!(self, Self::Eip4844(_))
+    }
+
+    /// Returns true if the transaction is an EIP-7702 transaction.
+    #[inline]
+    fn is_eip7702(&self) -> bool {
+        matches!(self, Self::Eip7702(_))
+    }
+
+    /// Returns the [`TxLegacy`] variant if the transaction is a legacy transaction.
+    #[inline]
+    fn as_legacy(&self) -> Option<&Signed<TxLegacy>> {
+        match self {
+            Self::Legacy(tx) => Some(tx),
+            _ => None,
+        }
+    }
+
+    /// Returns the [`TxEip2930`] variant if the transaction is an EIP-2930 transaction.
+    #[inline]
+    fn as_eip2930(&self) -> Option<&Signed<TxEip2930>> {
+        match self {
+            Self::Eip2930(tx) => Some(tx),
+            _ => None,
+        }
+    }
+
+    /// Returns the [`TxEip1559`] variant if the transaction is an EIP-1559 transaction.
+    #[inline]
+    fn as_eip1559(&self) -> Option<&Signed<TxEip1559>> {
+        match self {
+            Self::Eip1559(tx) => Some(tx),
+            _ => None,
+        }
+    }
+
+    /// Returns the [`TxEip4844Variant`] variant if the transaction is an EIP-4844 transaction.
+    #[inline]
+    fn as_eip4844(&self) -> Option<&Signed<TxEip4844Variant>> {
+        match self {
+            Self::Eip4844(tx) => Some(tx),
+            _ => None,
+        }
+    }
+
+    /// Returns the [`TxEip7702`] variant if the transaction is an EIP-7702 transaction.
+    #[inline]
+    fn as_eip7702(&self) -> Option<&Signed<TxEip7702>> {
+        match self {
+            Self::Eip7702(tx) => Some(tx),
+            _ => None,
+        }
+    }
+}
+
 impl Encodable for TxEnvelope {
     fn encode(&self, out: &mut dyn alloy_rlp::BufMut) {
         self.network_encode(out)

diff --git a/crates/consensus/src/transaction/mod.rs b/crates/consensus/src/transaction/mod.rs
@@ -30,7 +30,7 @@ pub use eip4844::BlobTransactionValidationError;
 pub use eip4844::{TxEip4844, TxEip4844Variant, TxEip4844WithSidecar};
 
 mod envelope;
-pub use envelope::{TxEnvelope, TxType};
+pub use envelope::{TransactionEnvelope, TxEnvelope, TxType};
 
 mod legacy;
 pub use legacy::{from_eip155_value, to_eip155_value, TxLegacy};