Enum MockTransaction

pub enum MockTransaction {
    Legacy {
        chain_id: Option<ChainId>,
        hash: B256,
        sender: Address,
        nonce: u64,
        gas_price: u128,
        gas_limit: u64,
        to: TxKind,
        value: U256,
        input: Bytes,
        size: usize,
        cost: U256,
    },
    Eip2930 {
        chain_id: ChainId,
        hash: B256,
        sender: Address,
        nonce: u64,
        to: TxKind,
        gas_limit: u64,
        input: Bytes,
        value: U256,
        gas_price: u128,
        access_list: AccessList,
        size: usize,
        cost: U256,
    },
    Eip1559 {

        chain_id: ChainId,
        hash: B256,
        sender: Address,
        nonce: u64,
        max_fee_per_gas: u128,
        max_priority_fee_per_gas: u128,
        gas_limit: u64,
        to: TxKind,
        value: U256,
        access_list: AccessList,
        input: Bytes,
        size: usize,
        cost: U256,
    
},
    Eip4844 {

        chain_id: ChainId,
        hash: B256,
        sender: Address,
        nonce: u64,
        max_fee_per_gas: u128,
        max_priority_fee_per_gas: u128,
        max_fee_per_blob_gas: u128,
        gas_limit: u64,
        to: Address,
        value: U256,
        access_list: AccessList,
        input: Bytes,
        sidecar: BlobTransactionSidecar,
        blob_versioned_hashes: Vec<B256>,
        size: usize,
        cost: U256,
    
},
    Eip7702 {

        chain_id: ChainId,
        hash: B256,
        sender: Address,
        nonce: u64,
        max_fee_per_gas: u128,
        max_priority_fee_per_gas: u128,
        gas_limit: u64,
        to: Address,
        value: U256,
        access_list: AccessList,
        authorization_list: Vec<SignedAuthorization>,
        input: Bytes,
        size: usize,
        cost: U256,
    
},
}

Available on crate feature test-utils only.

A Bare transaction type used for testing.

Variants

Legacy

Legacy transaction type.

Fields

chain_id: Option<ChainId>

The chain id of the transaction.

hash: B256

The hash of the transaction.

sender: Address

The sender’s address.

nonce: u64

The transaction nonce.

gas_price: u128

The gas price for the transaction.

gas_limit: u64

The gas limit for the transaction.

to: TxKind

The transaction’s destination.

value: U256

The value of the transaction.

input: Bytes

The transaction input data.

size: usize

The size of the transaction, returned in the implementation of PoolTransaction.

cost: U256

The cost of the transaction, returned in the implementation of PoolTransaction.

Eip2930

EIP-2930 transaction type.

Fields

chain_id: ChainId

The chain id of the transaction.

hash: B256

The hash of the transaction.

sender: Address

The sender’s address.

nonce: u64

The transaction nonce.

to: TxKind

The transaction’s destination.

gas_limit: u64

The gas limit for the transaction.

input: Bytes

The transaction input data.

value: U256

The value of the transaction.

gas_price: u128

The gas price for the transaction.

access_list: AccessList

The access list associated with the transaction.

size: usize

The size of the transaction, returned in the implementation of PoolTransaction.

cost: U256

The cost of the transaction, returned in the implementation of PoolTransaction.

Eip1559

EIP-1559 transaction type.

Fields

chain_id: ChainId

The chain id of the transaction.

hash: B256

The hash of the transaction.

sender: Address

The sender’s address.

nonce: u64

The transaction nonce.

max_fee_per_gas: u128

The maximum fee per gas for the transaction.

max_priority_fee_per_gas: u128

The maximum priority fee per gas for the transaction.

gas_limit: u64

The gas limit for the transaction.

to: TxKind

The transaction’s destination.

value: U256

The value of the transaction.

access_list: AccessList

The access list associated with the transaction.

input: Bytes

The transaction input data.

size: usize

The size of the transaction, returned in the implementation of PoolTransaction.

cost: U256

The cost of the transaction, returned in the implementation of PoolTransaction.

Eip4844

EIP-4844 transaction type.

Fields

chain_id: ChainId

The chain id of the transaction.

hash: B256

The hash of the transaction.

sender: Address

The sender’s address.

nonce: u64

The transaction nonce.

max_fee_per_gas: u128

The maximum fee per gas for the transaction.

max_priority_fee_per_gas: u128

The maximum priority fee per gas for the transaction.

max_fee_per_blob_gas: u128

The maximum fee per blob gas for the transaction.

gas_limit: u64

The gas limit for the transaction.

to: Address

The transaction’s destination.

value: U256

The value of the transaction.

access_list: AccessList

The access list associated with the transaction.

input: Bytes

The transaction input data.

sidecar: BlobTransactionSidecar

The sidecar information for the transaction.

blob_versioned_hashes: Vec<B256>

The blob versioned hashes for the transaction.

size: usize

The size of the transaction, returned in the implementation of PoolTransaction.

cost: U256

The cost of the transaction, returned in the implementation of PoolTransaction.

Eip7702

EIP-7702 transaction type.

Fields

chain_id: ChainId

The chain id of the transaction.

hash: B256

The hash of the transaction.

sender: Address

The sender’s address.

nonce: u64

The transaction nonce.

max_fee_per_gas: u128

The maximum fee per gas for the transaction.

max_priority_fee_per_gas: u128

The maximum priority fee per gas for the transaction.

gas_limit: u64

The gas limit for the transaction.

to: Address

The transaction’s destination.

value: U256

The value of the transaction.

access_list: AccessList

The access list associated with the transaction.

authorization_list: Vec<SignedAuthorization>

The authorization list associated with the transaction.

input: Bytes

The transaction input data.

size: usize

The size of the transaction, returned in the implementation of PoolTransaction.

cost: U256

The cost of the transaction, returned in the implementation of PoolTransaction.

Implementations

impl MockTransaction

pub fn set_nonce(&mut self, nonce: u64) -> &mut Self

Sets the value of the specified field.

pub fn with_nonce(self, nonce: u64) -> Self

Sets the value of the specified field using a fluent interface.

pub const fn get_nonce(&self) -> &u64

Gets the value of the specified field.

pub fn set_hash(&mut self, hash: B256) -> &mut Self

Sets the value of the specified field.

pub fn with_hash(self, hash: B256) -> Self

Sets the value of the specified field using a fluent interface.

pub const fn get_hash(&self) -> &B256

Gets the value of the specified field.

pub fn set_sender(&mut self, sender: Address) -> &mut Self

Sets the value of the specified field.

pub fn with_sender(self, sender: Address) -> Self

Sets the value of the specified field using a fluent interface.

pub const fn get_sender(&self) -> &Address

Gets the value of the specified field.

pub fn set_gas_limit(&mut self, gas_limit: u64) -> &mut Self

Sets the value of the specified field.

pub fn with_gas_limit(self, gas_limit: u64) -> Self

Sets the value of the specified field using a fluent interface.

pub const fn get_gas_limit(&self) -> &u64

Gets the value of the specified field.

pub fn set_value(&mut self, value: U256) -> &mut Self

Sets the value of the specified field.

pub fn with_value(self, value: U256) -> Self

Sets the value of the specified field using a fluent interface.

pub const fn get_value(&self) -> &U256

Gets the value of the specified field.

pub fn set_input(&mut self, input: Bytes) -> &mut Self

Sets the value of the specified field.

pub fn with_input(self, input: Bytes) -> Self

Sets the value of the specified field using a fluent interface.

pub const fn get_input(&self) -> &Bytes

Gets the value of the specified field.

pub fn set_size(&mut self, size: usize) -> &mut Self

Sets the value of the specified field.

pub fn with_size(self, size: usize) -> Self

Sets the value of the specified field using a fluent interface.

pub const fn get_size(&self) -> &usize

Gets the value of the specified field.

pub fn legacy() -> Self

Returns a new legacy transaction with random address and hash and empty values

pub fn eip2930() -> Self

Returns a new EIP2930 transaction with random address and hash and empty values

pub fn eip1559() -> Self

Returns a new EIP1559 transaction with random address and hash and empty values

pub fn eip7702() -> Self

Returns a new EIP7702 transaction with random address and hash and empty values

pub fn eip4844() -> Self

Returns a new EIP4844 transaction with random address and hash and empty values

pub fn eip4844_with_sidecar(sidecar: BlobTransactionSidecar) -> Self

Returns a new EIP4844 transaction with a provided sidecar

pub fn new_from_type(tx_type: TxType) -> Self

Creates a new transaction with the given [TxType].

See the default constructors for each of the transaction types:

• MockTransaction::legacy
• MockTransaction::eip2930
• MockTransaction::eip1559
• MockTransaction::eip4844

pub fn with_blob_fee(self, val: u128) -> Self

Sets the max fee per blob gas for EIP-4844 transactions,

pub fn set_blob_fee(&mut self, val: u128) -> &mut Self

Sets the max fee per blob gas for EIP-4844 transactions,

pub fn set_priority_fee(&mut self, val: u128) -> &mut Self

Sets the priority fee for dynamic fee transactions (EIP-1559 and EIP-4844)

pub fn with_priority_fee(self, val: u128) -> Self

Sets the priority fee for dynamic fee transactions (EIP-1559 and EIP-4844)

pub const fn get_priority_fee(&self) -> Option<u128>

Gets the priority fee for dynamic fee transactions (EIP-1559 and EIP-4844)

pub fn set_max_fee(&mut self, val: u128) -> &mut Self

Sets the max fee for dynamic fee transactions (EIP-1559 and EIP-4844)

pub fn with_max_fee(self, val: u128) -> Self

Sets the max fee for dynamic fee transactions (EIP-1559 and EIP-4844)

pub const fn get_max_fee(&self) -> Option<u128>

Gets the max fee for dynamic fee transactions (EIP-1559 and EIP-4844)

pub fn set_accesslist(&mut self, list: AccessList) -> &mut Self

Sets the access list for transactions supporting EIP-1559, EIP-4844, and EIP-2930.

pub fn set_gas_price(&mut self, val: u128) -> &mut Self

Sets the gas price for the transaction.

pub fn with_gas_price(self, val: u128) -> Self

Sets the gas price for the transaction.

pub const fn get_gas_price(&self) -> u128

Gets the gas price for the transaction.

pub fn prev(&self) -> Self

Returns a clone with a decreased nonce

pub fn next(&self) -> Self

Returns a clone with an increased nonce

pub fn skip(&self, skip: u64) -> Self

Returns a clone with an increased nonce

pub fn inc_nonce(self) -> Self

Returns a clone with incremented nonce

pub fn rng_hash(self) -> Self

Sets a new random hash

pub fn inc_price(&self) -> Self

Returns a new transaction with a higher gas price +1

pub fn inc_price_by(&self, value: u128) -> Self

Returns a new transaction with a higher gas price

pub fn decr_price(&self) -> Self

Returns a new transaction with a lower gas price -1

pub fn decr_price_by(&self, value: u128) -> Self

Returns a new transaction with a lower gas price

pub fn inc_value(&self) -> Self

Returns a new transaction with a higher value

pub fn inc_limit(&self) -> Self

Returns a new transaction with a higher gas limit

pub fn inc_blob_fee(&self) -> Self

Returns a new transaction with a higher blob fee +1

If it’s an EIP-4844 transaction.

pub fn inc_blob_fee_by(&self, value: u128) -> Self

Returns a new transaction with a higher blob fee

If it’s an EIP-4844 transaction.

pub fn decr_blob_fee(&self) -> Self

Returns a new transaction with a lower blob fee -1

If it’s an EIP-4844 transaction.

pub fn decr_blob_fee_by(&self, value: u128) -> Self

Returns a new transaction with a lower blob fee

If it’s an EIP-4844 transaction.

pub const fn tx_type(&self) -> u8

Returns the transaction type identifier associated with the current MockTransaction.

pub const fn is_legacy(&self) -> bool

Checks if the transaction is of the legacy type.

pub const fn is_eip1559(&self) -> bool

Checks if the transaction is of the EIP-1559 type.

pub const fn is_eip4844(&self) -> bool

Checks if the transaction is of the EIP-4844 type.

pub const fn is_eip2930(&self) -> bool

Checks if the transaction is of the EIP-2930 type.

pub const fn is_eip7702(&self) -> bool

Checks if the transaction is of the EIP-2930 type.

Trait Implementations

impl Arbitrary for MockTransaction

Available on crate feature arbitrary only.

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<MockTransaction>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for MockTransaction

fn clone(&self) -> MockTransaction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MockTransaction

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

Formats the value using the given formatter.

impl EthPoolTransaction for MockTransaction

fn take_blob(&mut self) -> EthBlobTransactionSidecar

Extracts the blob sidecar from the transaction.

fn try_into_pooled_eip4844( self, sidecar: Arc<BlobTransactionSidecar>, ) -> Option<Recovered<Self::Pooled>>

A specialization for the EIP-4844 transaction type. Tries to reattach the blob sidecar to the transaction.

fn try_from_eip4844( tx: Recovered<Self::Consensus>, sidecar: BlobTransactionSidecar, ) -> Option<Self>

Tries to convert the Consensus type with a blob sidecar into the Pooled type.

fn validate_blob( &self, _blob: &BlobTransactionSidecar, _settings: &KzgSettings, ) -> Result<(), BlobTransactionValidationError>

Validates the blob sidecar of the transaction with the given settings.

impl From<MockTransaction> for Recovered<TransactionSigned>

fn from(tx: MockTransaction) -> Self

Converts to this type from the input type.

impl From<MockTransaction> for Transaction

fn from(mock: MockTransaction) -> Self

Converts to this type from the input type.

impl From<Recovered<EthereumTxEnvelope<TxEip4844WithSidecar>>> for MockTransaction

fn from(tx: Recovered<PooledTransaction>) -> Self

Converts to this type from the input type.

impl InMemorySize for MockTransaction

fn size(&self) -> usize

Returns a heuristic for the in-memory size of a struct.

impl PartialEq for MockTransaction

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

fn encoded_length(&self) -> usize

Returns the encoded length of the transaction.

type TryFromConsensusError = TransactionConversionError

Associated error type for the try_from_consensus method.

type Consensus = TransactionSigned

Associated type representing the raw consensus variant of the transaction.

type Pooled = EthereumTxEnvelope<TxEip4844WithSidecar>

Associated type representing the recovered pooled variant of the transaction.

fn into_consensus(self) -> Recovered<Self::Consensus>

Define a method to convert from the Self type to Consensus

fn from_pooled(pooled: Recovered<Self::Pooled>) -> Self

Define a method to convert from the Pooled type to Self

fn hash(&self) -> &TxHash

Hash of the transaction.

fn sender(&self) -> Address

The Sender of the transaction.

fn sender_ref(&self) -> &Address

Reference to the Sender of the transaction.

fn cost(&self) -> &U256

Returns the cost that this transaction is allowed to consume:

fn try_from_consensus( tx: Recovered<Self::Consensus>, ) -> Result<Self, Self::TryFromConsensusError>

Define a method to convert from the Consensus type to Self

fn clone_into_consensus(&self) -> Recovered<Self::Consensus>

Clone the transaction into a consensus variant.

fn try_into_pooled( self, ) -> Result<Recovered<Self::Pooled>, Self::TryFromConsensusError>

Tries to convert the Consensus type into the Pooled type.

fn pooled_into_consensus(tx: Self::Pooled) -> Self::Consensus

Converts the Pooled type into the Consensus type.

fn ensure_max_init_code_size( &self, max_init_code_size: usize, ) -> Result<(), InvalidPoolTransactionError>

Ensures that the transaction’s code size does not exceed the provided max_init_code_size.

impl Transaction for MockTransaction

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

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

Returns the EIP-1559 the maximum fee per gas the caller is willing to pay.

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

Returns the EIP-1559 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 EIP-1559 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 TryFrom<Recovered<EthereumTxEnvelope<TxEip4844Variant>>> for MockTransaction

type Error = TryFromRecoveredTransactionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Recovered<TransactionSigned>> for MockTransaction

type Error = TryFromRecoveredTransactionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Typed2718 for MockTransaction

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 Eq for MockTransaction

impl StructuralPartialEq for MockTransaction

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: 368 bytes

Size for each variant:

• Legacy: 240 bytes
• Eip2930: 256 bytes
• Eip1559: 272 bytes
• Eip4844: 368 bytes
• Eip7702: 288 bytes