Struct Transaction

pub struct Transaction<T = TxEnvelope> {
    pub inner: Recovered<T>,
    pub block_hash: Option<BlockHash>,
    pub block_number: Option<u64>,
    pub transaction_index: Option<u64>,
    pub effective_gas_price: Option<u128>,
}

Transaction object used in RPC.

This represents a transaction in RPC format (eth_getTransactionByHash) and contains the full transaction object and additional block metadata if the transaction has been mined.

Fields

inner: Recovered<T>

The inner transaction object

block_hash: Option<BlockHash>

Hash of block where transaction was included, None if pending

block_number: Option<u64>

Number of block where transaction was included, None if pending

transaction_index: Option<u64>

Transaction Index

effective_gas_price: Option<u128>

Deprecated effective gas price value.

Implementations

impl<T> Transaction<T>

pub fn into_inner(self) -> T

Consumes the type and returns the wrapped transaction.

pub fn into_recovered(self) -> Recovered<T>

Consumes the type and returns a Recovered transaction with the sender

pub const fn as_recovered(&self) -> Recovered<&T>

Returns a Recovered<&T> with the transaction and the sender.

pub fn convert<U>(self) -> Transaction<U>

where U: From<T>,

Converts the transaction type to the given alternative that is From<T>

pub fn try_convert<U>(self) -> Result<Transaction<U>, U::Error>

where U: TryFrom<T>,

Converts the transaction to the given alternative that is TryFrom<T>

Returns the transaction with the new transaction type if all conversions were successful.

pub fn map<Tx>(self, f: impl FnOnce(T) -> Tx) -> Transaction<Tx>

Applies the given closure to the inner transaction type.

pub fn try_map<Tx, E>( self, f: impl FnOnce(T) -> Result<Tx, E>, ) -> Result<Transaction<Tx>, E>

Applies the given fallible closure to the inner transactions.

impl<T> Transaction<T>

where T: TransactionTrait,

pub fn is_legacy_gas(&self) -> bool

Returns true if the transaction is a legacy or 2930 transaction.

impl<T> Transaction<T>

where T: TransactionTrait + Encodable2718,

pub fn info(&self) -> TransactionInfo

Returns the TransactionInfo for this transaction.

This contains various metadata about the transaction and block context if available.

impl<T> Transaction<T>

where T: Into<TransactionRequest>,

pub fn into_request(self) -> TransactionRequest

Converts Transaction into TransactionRequest.

During this conversion data for TransactionRequest::sidecar is not populated as it is not part of Transaction.

impl<Eip4844> Transaction<EthereumTxEnvelope<Eip4844>>

pub fn into_signed(self) -> Signed<EthereumTypedTransaction<Eip4844>>

where EthereumTypedTransaction<Eip4844>: From<Eip4844>,

Consumes the transaction and returns it as Signed with EthereumTypedTransaction as the transaction type.

pub fn into_signed_recovered( self, ) -> Recovered<Signed<EthereumTypedTransaction<Eip4844>>>

where EthereumTypedTransaction<Eip4844>: From<Eip4844>,

Consumes the transaction and returns it a Recovered signed EthereumTypedTransaction.

Trait Implementations

impl<T> AsRef<T> for Transaction<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone> Clone for Transaction<T>

fn clone(&self) -> Transaction<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Transaction<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Default for Transaction<T>

where T: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Transaction<T>

where T: TransactionTrait + Clone + Serialize + DeserializeOwned,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<&Transaction<T>> for TransactionInfo

where T: TransactionTrait + Encodable2718,

fn from(tx: &Transaction<T>) -> Self

Converts to this type from the input type.

impl<Eip4844> From<Transaction<EthereumTxEnvelope<Eip4844>>> for EthereumTxEnvelope<Eip4844>

fn from(tx: Transaction<Self>) -> Self

Converts to this type from the input type.

impl<Eip4844> From<Transaction<EthereumTxEnvelope<Eip4844>>> for Signed<EthereumTypedTransaction<Eip4844>>

where EthereumTypedTransaction<Eip4844>: From<Eip4844>,

fn from(tx: Transaction<EthereumTxEnvelope<Eip4844>>) -> Self

Converts to this type from the input type.

impl<Eip4844> From<Transaction<EthereumTypedTransaction<Eip4844>>> for EthereumTypedTransaction<Eip4844>

fn from(tx: Transaction<Self>) -> Self

Converts to this type from the input type.

impl<T> From<Transaction<T>> for Recovered<T>

fn from(tx: Transaction<T>) -> Self

Converts to this type from the input type.

impl From<Transaction> for TransactionRequest

fn from(tx: Transaction) -> Self

Converts to this type from the input type.

impl<T: PartialEq> PartialEq for Transaction<T>

fn eq(&self, other: &Transaction<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Serialize for Transaction<T>

where T: TransactionTrait + Clone + Serialize + DeserializeOwned,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: TransactionTrait> Transaction for Transaction<T>

fn chain_id(&self) -> Option<ChainId>

Get chain_id.

fn nonce(&self) -> u64

Get nonce.

fn gas_limit(&self) -> u64

Get gas_limit.

fn gas_price(&self) -> Option<u128>

Get gas_price.

fn max_fee_per_gas(&self) -> u128

For dynamic fee transactions returns the maximum fee per gas the caller is willing to pay.

fn max_priority_fee_per_gas(&self) -> Option<u128>

For dynamic fee transactions returns the Priority fee the caller is paying to the block author.

fn max_fee_per_blob_gas(&self) -> Option<u128>

Max fee per blob gas for EIP-4844 transaction.

fn priority_fee_or_price(&self) -> u128

Return the max priority fee per gas if the transaction is an dynamic fee transaction, and otherwise return the gas price.

fn effective_gas_price(&self, base_fee: Option<u64>) -> u128

Returns the effective gas price for the given base fee.

fn is_dynamic_fee(&self) -> bool

Returns true if the transaction supports dynamic fees.

fn kind(&self) -> TxKind

Returns the transaction kind.

fn is_create(&self) -> bool

Returns true if the transaction is a contract creation. We don’t provide a default implementation via kind as it copies the 21-byte TxKind for this simple check. A proper implementation shouldn’t allocate.

fn value(&self) -> U256

Get value.

fn input(&self) -> &Bytes

Get data.

fn access_list(&self) -> Option<&AccessList>

Returns the EIP-2930 access_list for the particular transaction type. Returns None for older transaction types.

fn blob_versioned_hashes(&self) -> Option<&[B256]>

Blob versioned hashes for eip4844 transaction. For previous transaction types this is None.

fn authorization_list(&self) -> Option<&[SignedAuthorization]>

Returns the SignedAuthorization list of the transaction.

fn effective_tip_per_gas(&self, base_fee: u64) -> Option<u128>

Returns the effective tip for this transaction.

fn to(&self) -> Option<Address>

Get the transaction’s address of the contract that will be called, or the address that will receive the transfer.

fn function_selector(&self) -> Option<&FixedBytes<4>>

Returns the first 4bytes of the calldata for a function call.

fn blob_count(&self) -> Option<u64>

Returns the number of blobs of this transaction.

fn blob_gas_used(&self) -> Option<u64>

Returns the total gas for all blobs in this transaction.

fn authorization_count(&self) -> Option<u64>

Returns the number of blobs of SignedAuthorization in this transactions

impl<T: TransactionTrait + Encodable2718> TransactionResponse for Transaction<T>

fn tx_hash(&self) -> B256

Hash of the transaction

fn block_hash(&self) -> Option<BlockHash>

Block hash

fn block_number(&self) -> Option<u64>

Block number

fn transaction_index(&self) -> Option<u64>

Transaction Index

fn from(&self) -> Address

Sender of the transaction

fn gas_price(&self) -> Option<u128>

Gas Price, this is the RPC format for max_fee_per_gas, pre-eip-1559.

fn max_fee_per_gas(&self) -> Option<u128>

Max BaseFeePerGas the user is willing to pay. For pre-eip-1559 transactions, the field label gas_price is used instead.

fn transaction_type(&self) -> Option<u8>

Transaction type format for RPC. This field is included since eip-2930.

impl<Eip4844> TryFrom<Transaction<EthereumTxEnvelope<Eip4844>>> for Signed<TxEip1559>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from( tx: Transaction<EthereumTxEnvelope<Eip4844>>, ) -> Result<Self, Self::Error>

Performs the conversion.

impl<Eip4844> TryFrom<Transaction<EthereumTxEnvelope<Eip4844>>> for Signed<TxEip2930>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from( tx: Transaction<EthereumTxEnvelope<Eip4844>>, ) -> Result<Self, Self::Error>

Performs the conversion.

impl<Eip4844> TryFrom<Transaction<EthereumTxEnvelope<Eip4844>>> for Signed<TxEip7702>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from( tx: Transaction<EthereumTxEnvelope<Eip4844>>, ) -> Result<Self, Self::Error>

Performs the conversion.

impl<Eip4844> TryFrom<Transaction<EthereumTxEnvelope<Eip4844>>> for Signed<TxLegacy>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from( tx: Transaction<EthereumTxEnvelope<Eip4844>>, ) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Transaction> for Signed<TxEip4844>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(tx: Transaction) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Transaction> for Signed<TxEip4844Variant>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(tx: Transaction) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Typed2718> Typed2718 for Transaction<T>

fn ty(&self) -> u8

Returns the EIP-2718 type flag.

fn is_type(&self, ty: u8) -> bool

Returns true if the type matches the given type.

fn is_legacy(&self) -> bool

Returns true if the type is a legacy transaction.

fn is_eip2930(&self) -> bool

Returns true if the type is an EIP-2930 transaction.

fn is_eip1559(&self) -> bool

Returns true if the type is an EIP-1559 transaction.

fn is_eip4844(&self) -> bool

Returns true if the type is an EIP-4844 transaction.

fn is_eip7702(&self) -> bool

Returns true if the type is an EIP-7702 transaction.

impl<T: Eq> Eq for Transaction<T>

impl<T> StructuralPartialEq for Transaction<T>