Struct TxEnv 

pub struct TxEnv {

    pub tx_type: u8,
    pub caller: Address,
    pub gas_limit: u64,
    pub gas_price: u128,
    pub kind: TxKind,
    pub value: Uint<256, 4>,
    pub data: Bytes,
    pub nonce: u64,
    pub chain_id: Option<u64>,
    pub access_list: AccessList,
    pub gas_priority_fee: Option<u128>,
    pub blob_hashes: Vec<FixedBytes<32>>,
    pub max_fee_per_blob_gas: u128,
    pub authorization_list: Vec<Either<SignedAuthorization, RecoveredAuthorization>>,
}

The Transaction Environment is a struct that contains all fields that can be found in all Ethereum transaction, including EIP-4844, EIP-7702, EIP-7873, etc. It implements the Transaction trait, which is used inside the EVM to execute a transaction.

TxEnvBuilder builder is recommended way to create a new TxEnv as it will automatically set the transaction type based on the fields set.

Fields

tx_type: u8

Transaction type

caller: Address

Caller aka Author aka transaction signer

gas_limit: u64

The gas limit of the transaction.

gas_price: u128

The gas price of the transaction.

For EIP-1559 transaction this represent max_gas_fee.

kind: TxKind

The destination of the transaction

value: Uint<256, 4>

The value sent to transact_to

data: Bytes

The data of the transaction

nonce: u64

The nonce of the transaction

chain_id: Option<u64>

The chain ID of the transaction

Incorporated as part of the Spurious Dragon upgrade via EIP-155.

access_list: AccessList

A list of addresses and storage keys that the transaction plans to access

Added in EIP-2930.

gas_priority_fee: Option<u128>

The priority fee per gas

Incorporated as part of the London upgrade via EIP-1559.

blob_hashes: Vec<FixedBytes<32>>

The list of blob versioned hashes

Per EIP there should be at least one blob present if max_fee_per_blob_gas is Some.

Incorporated as part of the Cancun upgrade via EIP-4844.

max_fee_per_blob_gas: u128

The max fee per blob gas

Incorporated as part of the Cancun upgrade via EIP-4844.

authorization_list: Vec<Either<SignedAuthorization, RecoveredAuthorization>>

List of authorizations

authorization_list contains the signature that authorizes this caller to place the code to signer account.

Set EOA account code for one transaction via EIP-7702.

Implementations

impl TxEnv

pub fn new_bench() -> TxEnv

Creates a new TxEnv with benchmark-specific values.

pub fn derive_tx_type(&mut self) -> Result<(), DeriveTxTypeError>

Derives tx type from transaction fields and sets it to tx_type. Returns error in case some fields were not set correctly.

pub fn set_signed_authorization(&mut self, auth: Vec<SignedAuthorization>)

Insert a list of signed authorizations into the authorization list.

pub fn set_recovered_authorization(&mut self, auth: Vec<RecoveredAuthorization>)

Insert a list of recovered authorizations into the authorization list.

impl TxEnv

pub fn builder() -> TxEnvBuilder

Create a new builder for constructing a TxEnv

pub fn builder_for_bench() -> TxEnvBuilder

Create a new builder for constructing a TxEnv with benchmark-specific values.

pub fn modify(self) -> TxEnvBuilder

Modify the TxEnv by using builder pattern.

Trait Implementations

impl Clone for TxEnv

fn clone(&self) -> TxEnv

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TxEnv

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

Formats the value using the given formatter.

impl Default for TxEnv

fn default() -> TxEnv

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TxEnv

fn deserialize<__D>( __deserializer: __D, ) -> Result<TxEnv, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Eip4844> FromRecoveredTx<EthereumTxEnvelope<Eip4844>> for TxEnv

where Eip4844: AsRef<TxEip4844>,

fn from_recovered_tx(tx: &EthereumTxEnvelope<Eip4844>, sender: Address) -> TxEnv

Builds a TxEnv from a transaction and a sender address.

impl FromRecoveredTx<OpTxEnvelope> for TxEnv

fn from_recovered_tx(tx: &OpTxEnvelope, caller: Address) -> TxEnv

Builds a TxEnv from a transaction and a sender address.

impl FromRecoveredTx<TxDeposit> for TxEnv

fn from_recovered_tx(tx: &TxDeposit, caller: Address) -> TxEnv

Builds a TxEnv from a transaction and a sender address.

impl FromRecoveredTx<TxEip1559> for TxEnv

fn from_recovered_tx(tx: &TxEip1559, caller: Address) -> TxEnv

Builds a TxEnv from a transaction and a sender address.

impl FromRecoveredTx<TxEip2930> for TxEnv

fn from_recovered_tx(tx: &TxEip2930, caller: Address) -> TxEnv

Builds a TxEnv from a transaction and a sender address.

impl FromRecoveredTx<TxEip4844> for TxEnv

fn from_recovered_tx(tx: &TxEip4844, caller: Address) -> TxEnv

Builds a TxEnv from a transaction and a sender address.

impl FromRecoveredTx<TxEip7702> for TxEnv

fn from_recovered_tx(tx: &TxEip7702, caller: Address) -> TxEnv

Builds a TxEnv from a transaction and a sender address.

impl FromRecoveredTx<TxLegacy> for TxEnv

fn from_recovered_tx(tx: &TxLegacy, caller: Address) -> TxEnv

Builds a TxEnv from a transaction and a sender address.

impl<Eip4844> FromTxWithEncoded<EthereumTxEnvelope<Eip4844>> for TxEnv

where Eip4844: AsRef<TxEip4844>,

fn from_encoded_tx( tx: &EthereumTxEnvelope<Eip4844>, caller: Address, encoded: Bytes, ) -> TxEnv

Builds a TxEnv from a transaction, its sender, and encoded transaction bytes.

impl FromTxWithEncoded<OpTxEnvelope> for TxEnv

fn from_encoded_tx(tx: &OpTxEnvelope, caller: Address, _encoded: Bytes) -> TxEnv

Builds a TxEnv from a transaction, its sender, and encoded transaction bytes.

impl FromTxWithEncoded<TxEip1559> for TxEnv

fn from_encoded_tx(tx: &TxEip1559, sender: Address, _encoded: Bytes) -> TxEnv

Builds a TxEnv from a transaction, its sender, and encoded transaction bytes.

impl FromTxWithEncoded<TxEip2930> for TxEnv

fn from_encoded_tx(tx: &TxEip2930, sender: Address, _encoded: Bytes) -> TxEnv

Builds a TxEnv from a transaction, its sender, and encoded transaction bytes.

impl FromTxWithEncoded<TxEip4844> for TxEnv

fn from_encoded_tx(tx: &TxEip4844, sender: Address, _encoded: Bytes) -> TxEnv

Builds a TxEnv from a transaction, its sender, and encoded transaction bytes.

impl FromTxWithEncoded<TxEip7702> for TxEnv

fn from_encoded_tx(tx: &TxEip7702, sender: Address, _encoded: Bytes) -> TxEnv

Builds a TxEnv from a transaction, its sender, and encoded transaction bytes.

impl FromTxWithEncoded<TxLegacy> for TxEnv

fn from_encoded_tx(tx: &TxLegacy, sender: Address, _encoded: Bytes) -> TxEnv

Builds a TxEnv from a transaction, its sender, and encoded transaction bytes.

impl IntoTxEnv<TxEnv> for TxEnv

fn into_tx_env(self) -> TxEnv

Converts self into TxEnv.

impl PartialEq for TxEnv

fn eq(&self, other: &TxEnv) -> 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 Serialize for TxEnv

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SystemCallTx for TxEnv

fn new_system_tx_with_caller( caller: Address, system_contract_address: Address, data: Bytes, ) -> TxEnv

Creates a new system transaction with a custom caller address.

fn new_system_tx(system_contract_address: Address, data: Bytes) -> Self

Creates new transaction for system call.

impl Transaction for TxEnv

type AccessListItem<'a> = &'a AccessListItem

EIP-2930 Access list item type.

type Authorization<'a> = &'a Either<SignedAuthorization, RecoveredAuthorization>

EIP-7702 Authorization type.

fn tx_type(&self) -> u8

Returns the transaction type.

fn kind(&self) -> TxKind

Transaction kind. It can be Call or Create.

fn caller(&self) -> Address

Caller aka Author aka transaction signer.

fn gas_limit(&self) -> u64

The maximum amount of gas the transaction can use.

fn gas_price(&self) -> u128

Gas price for the transaction. It is only applicable for Legacy and EIP-2930 transactions. For Eip1559 it is max_fee_per_gas.

fn value(&self) -> Uint<256, 4>

The value sent to the receiver of TxKind::Call.

fn nonce(&self) -> u64

The nonce of the transaction.

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

Chain Id is optional for legacy transactions.

fn access_list( &self, ) -> Option<impl Iterator<Item = <TxEnv as Transaction>::AccessListItem<'_>>>

Access list for the transaction.

fn max_fee_per_gas(&self) -> u128

Returns maximum fee that can be paid for the transaction.

fn max_fee_per_blob_gas(&self) -> u128

Max fee per data gas

fn authorization_list_len(&self) -> usize

Returns length of the authorization list.

fn authorization_list( &self, ) -> impl Iterator<Item = <TxEnv as Transaction>::Authorization<'_>>

List of authorizations, that contains the signature that authorizes this caller to place the code to signer account.

fn input(&self) -> &Bytes

Returns the input data of the transaction.

fn blob_versioned_hashes(&self) -> &[FixedBytes<32>]

Returns vector of fixed size hash(32 bytes)

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

Maximum priority fee per gas.

fn total_blob_gas(&self) -> u64

Total gas for all blobs. Max number of blocks is already checked so we dont need to check for overflow.

fn calc_max_data_fee(&self) -> Uint<256, 4>

Calculates the maximum [EIP-4844] data_fee of the transaction.

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

Returns effective gas price is gas price field for Legacy and Eip2930 transaction.

fn max_balance_spending(&self) -> Result<Uint<256, 4>, InvalidTransaction>

Returns the maximum balance that can be spent by the transaction.

fn ensure_enough_balance( &self, balance: Uint<256, 4>, ) -> Result<(), InvalidTransaction>

Checks if the caller has enough balance to cover the maximum balance spending of this transaction.

fn effective_balance_spending( &self, base_fee: u128, blob_price: u128, ) -> Result<Uint<256, 4>, InvalidTransaction>

Returns the effective balance that is going to be spent that depends on base_fee Multiplication for gas are done in u128 type (saturated) and value is added as U256 type.

fn gas_balance_spending( &self, base_fee: u128, blob_price: u128, ) -> Result<Uint<256, 4>, InvalidTransaction>

Returns the effective balance calculated with Self::effective_balance_spending but without the value.

impl Eq for TxEnv

impl StructuralPartialEq for TxEnv

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 288 bytes