reth_primitives/transaction/variant.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
//! Helper enum functions for `Transaction`, `TransactionSigned` and
//! `TransactionSignedEcRecovered`
use crate::{
Transaction, TransactionSigned, TransactionSignedEcRecovered, TransactionSignedNoHash,
};
use alloy_primitives::{Address, B256};
use core::ops::Deref;
/// Represents various different transaction formats used in reth.
///
/// All variants are based on a the raw [Transaction] data and can contain additional information
/// extracted (expensive) from that transaction, like the hash and the signer.
#[derive(Debug, Clone, PartialEq, Eq, Hash, derive_more::From)]
pub enum TransactionSignedVariant {
/// A signed transaction without a hash.
SignedNoHash(TransactionSignedNoHash),
/// Contains the plain transaction data its signature and hash.
Signed(TransactionSigned),
/// Contains the plain transaction data its signature and hash and the successfully recovered
/// signer.
SignedEcRecovered(TransactionSignedEcRecovered),
}
impl TransactionSignedVariant {
/// Returns the raw transaction object
pub const fn as_raw(&self) -> &Transaction {
match self {
Self::SignedNoHash(tx) => &tx.transaction,
Self::Signed(tx) => &tx.transaction,
Self::SignedEcRecovered(tx) => &tx.signed_transaction.transaction,
}
}
/// Returns the hash of the transaction
pub fn hash(&self) -> B256 {
match self {
Self::SignedNoHash(tx) => tx.hash(),
Self::Signed(tx) => tx.hash(),
Self::SignedEcRecovered(tx) => tx.hash(),
}
}
/// Returns the signer of the transaction.
///
/// If the transaction is of not of [`TransactionSignedEcRecovered`] it will be recovered.
pub fn signer(&self) -> Option<Address> {
match self {
Self::SignedNoHash(tx) => tx.recover_signer(),
Self::Signed(tx) => tx.recover_signer(),
Self::SignedEcRecovered(tx) => Some(tx.signer),
}
}
/// Returns [`TransactionSigned`] type
/// else None
pub const fn as_signed(&self) -> Option<&TransactionSigned> {
match self {
Self::Signed(tx) => Some(tx),
_ => None,
}
}
/// Returns `TransactionSignedEcRecovered` type
/// else None
pub const fn as_signed_ec_recovered(&self) -> Option<&TransactionSignedEcRecovered> {
match self {
Self::SignedEcRecovered(tx) => Some(tx),
_ => None,
}
}
/// Returns true if the transaction is of [`TransactionSigned`] variant
pub const fn is_signed(&self) -> bool {
matches!(self, Self::Signed(_))
}
/// Returns true if the transaction is of [`TransactionSignedNoHash`] variant
pub const fn is_signed_no_hash(&self) -> bool {
matches!(self, Self::SignedNoHash(_))
}
/// Returns true if the transaction is of [`TransactionSignedEcRecovered`] variant
pub const fn is_signed_ec_recovered(&self) -> bool {
matches!(self, Self::SignedEcRecovered(_))
}
/// Consumes the [`TransactionSignedVariant`] and returns the consumed [Transaction]
pub fn into_raw(self) -> Transaction {
match self {
Self::SignedNoHash(tx) => tx.transaction,
Self::Signed(tx) => tx.transaction,
Self::SignedEcRecovered(tx) => tx.signed_transaction.transaction,
}
}
/// Consumes the [`TransactionSignedVariant`] and returns the consumed [`TransactionSigned`]
pub fn into_signed(self) -> TransactionSigned {
match self {
Self::SignedNoHash(tx) => tx.with_hash(),
Self::Signed(tx) => tx,
Self::SignedEcRecovered(tx) => tx.signed_transaction,
}
}
/// Consumes the [`TransactionSignedVariant`] and converts it into a
/// [`TransactionSignedEcRecovered`]
///
/// If the variants is not a [`TransactionSignedEcRecovered`] it will recover the sender.
///
/// Returns `None` if the transaction's signature is invalid
pub fn into_signed_ec_recovered(self) -> Option<TransactionSignedEcRecovered> {
self.try_into_signed_ec_recovered().ok()
}
/// Consumes the [`TransactionSignedVariant`] and converts it into a
/// [`TransactionSignedEcRecovered`]
///
/// If the variants is not a [`TransactionSignedEcRecovered`] it will recover the sender.
///
/// Returns an error if the transaction's signature is invalid.
pub fn try_into_signed_ec_recovered(
self,
) -> Result<TransactionSignedEcRecovered, TransactionSigned> {
match self {
Self::SignedEcRecovered(tx) => Ok(tx),
Self::Signed(tx) => tx.try_into_ecrecovered(),
Self::SignedNoHash(tx) => tx.with_hash().try_into_ecrecovered(),
}
}
}
impl AsRef<Transaction> for TransactionSignedVariant {
fn as_ref(&self) -> &Transaction {
self.as_raw()
}
}
impl Deref for TransactionSignedVariant {
type Target = Transaction;
fn deref(&self) -> &Self::Target {
self.as_raw()
}
}