Enum EthereumTxEnvelope

pub enum EthereumTxEnvelope<Eip4844> {
    Legacy(Signed<TxLegacy>),
    Eip2930(Signed<TxEip2930>),
    Eip1559(Signed<TxEip1559>),
    Eip4844(Signed<Eip4844>),
    Eip7702(Signed<TxEip7702>),
}

The Ethereum EIP-2718 Transaction Envelope.

Note:

This enum distinguishes between tagged and untagged legacy transactions, as the in-protocol merkle tree may commit to EITHER 0-prefixed or raw. Therefore we must ensure that encoding returns the precise byte-array that was decoded, preserving the presence or absence of the TransactionType flag.

Variants

Legacy(Signed<TxLegacy>)

An untagged TxLegacy.

Eip2930(Signed<TxEip2930>)

A TxEip2930 tagged with type 1.

Eip1559(Signed<TxEip1559>)

A TxEip1559 tagged with type 2.

Eip4844(Signed<Eip4844>)

A TxEip4844 tagged with type 3. An EIP-4844 transaction has two network representations: 1 - The transaction itself, which is a regular RLP-encoded transaction and used to retrieve historical transactions..

2 - The transaction with a sidecar, which is the form used to send transactions to the network.

Eip7702(Signed<TxEip7702>)

A TxEip7702 tagged with type 4.

Implementations

impl<T: Encodable7594> EthereumTxEnvelope<TxEip4844Variant<T>>

pub fn try_into_pooled( self, ) -> Result<EthereumTxEnvelope<TxEip4844WithSidecar<T>>, ValueError<Self>>

Attempts to convert the envelope into the pooled variant.

Returns an error if the envelope’s variant is incompatible with the pooled format: crate::TxEip4844 without the sidecar.

impl EthereumTxEnvelope<TxEip4844>

pub fn try_into_pooled<T>( self, ) -> Result<EthereumTxEnvelope<TxEip4844WithSidecar<T>>, ValueError<Self>>

Attempts to convert the envelope into the pooled variant.

Returns an error if the envelope’s variant is incompatible with the pooled format: crate::TxEip4844 without the sidecar.

pub fn try_into_pooled_eip4844<T>( self, sidecar: T, ) -> Result<EthereumTxEnvelope<TxEip4844WithSidecar<T>>, ValueError<Self>>

Converts from an EIP-4844 transaction to a EthereumTxEnvelope<TxEip4844WithSidecar<T>> with the given sidecar.

Returns an Err containing the original EthereumTxEnvelope if the transaction is not an EIP-4844 variant.

impl<T> EthereumTxEnvelope<T>

pub fn new_unchecked( transaction: EthereumTypedTransaction<T>, signature: Signature, hash: B256, ) -> Self

where T: RlpEcdsaEncodableTx,

Creates a new signed transaction from the given transaction, signature and hash.

Caution: This assumes the given hash is the correct transaction hash.

pub fn new( transaction: EthereumTypedTransaction<T>, signature: Signature, hash: B256, ) -> Self

where T: RlpEcdsaEncodableTx,

👎Deprecated: Use new_unchecked() instead

Creates a new signed transaction from the given transaction, signature and hash.

Caution: This assumes the given hash is the correct transaction hash.

pub fn new_unhashed( transaction: EthereumTypedTransaction<T>, signature: Signature, ) -> Self

where T: RlpEcdsaEncodableTx + SignableTransaction<Signature>,

Creates a new signed transaction from the given typed transaction and signature without the hash.

Note: this only calculates the hash on the first EthereumTxEnvelope::hash call.

pub fn into_typed_transaction(self) -> EthereumTypedTransaction<T>

where T: RlpEcdsaEncodableTx,

Consumes the type, removes the signature and returns the transaction.

impl<Eip4844> EthereumTxEnvelope<Eip4844>

pub fn map_eip4844<U>( self, f: impl FnMut(Eip4844) -> U, ) -> EthereumTxEnvelope<U>

Converts the EIP-4844 variant of this transaction with the given closure.

This is intended to convert between the EIP-4844 variants, specifically for stripping away non consensus data (blob sidecar data).

pub fn try_map_eip4844<U, E>( self, f: impl FnOnce(Eip4844) -> Result<U, E>, ) -> Result<EthereumTxEnvelope<U>, E>

Converts the EIP-4844 variant of this transaction with the given closure, returning an error if the mapping fails.

pub const fn tx_type(&self) -> TxType

Return the TxType of the inner txn.

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

where EthereumTypedTransaction<Eip4844>: From<Eip4844>,

Consumes the type into a Signed

impl<Eip4844: RlpEcdsaEncodableTx> EthereumTxEnvelope<Eip4844>

pub const fn is_legacy(&self) -> bool

Returns true if the transaction is a legacy transaction.

pub const fn is_eip2930(&self) -> bool

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

pub const fn is_eip1559(&self) -> bool

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

pub const fn is_eip4844(&self) -> bool

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

pub const fn is_eip7702(&self) -> bool

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

pub const fn is_replay_protected(&self) -> bool

Returns true if the transaction is replay protected.

All non-legacy transactions are replay protected, as the chain id is included in the transaction body. Legacy transactions are considered replay protected if the v value is not 27 or 28, according to the rules of EIP-155.

pub const fn as_legacy(&self) -> Option<&Signed<TxLegacy>>

Returns the TxLegacy variant if the transaction is a legacy transaction.

pub const fn as_eip2930(&self) -> Option<&Signed<TxEip2930>>

Returns the TxEip2930 variant if the transaction is an EIP-2930 transaction.

pub const fn as_eip1559(&self) -> Option<&Signed<TxEip1559>>

Returns the TxEip1559 variant if the transaction is an EIP-1559 transaction.

pub const fn as_eip4844(&self) -> Option<&Signed<Eip4844>>

Returns the TxEip4844Variant variant if the transaction is an EIP-4844 transaction.

pub const fn as_eip7702(&self) -> Option<&Signed<TxEip7702>>

Returns the TxEip7702 variant if the transaction is an EIP-7702 transaction.

pub fn try_into_legacy(self) -> Result<Signed<TxLegacy>, ValueError<Self>>

Consumes the type and returns the TxLegacy variant if the transaction is a legacy transaction. Returns an error otherwise.

pub fn try_into_eip2930(self) -> Result<Signed<TxEip2930>, ValueError<Self>>

Consumes the type and returns the TxEip2930 variant if the transaction is an EIP-2930 transaction. Returns an error otherwise.

pub fn try_into_eip1559(self) -> Result<Signed<TxEip1559>, ValueError<Self>>

Consumes the type and returns the TxEip1559 variant if the transaction is an EIP-1559 transaction. Returns an error otherwise.

pub fn try_into_eip4844(self) -> Result<Signed<Eip4844>, ValueError<Self>>

Consumes the type and returns the TxEip4844 variant if the transaction is an EIP-4844 transaction. Returns an error otherwise.

pub fn try_into_eip7702(self) -> Result<Signed<TxEip7702>, ValueError<Self>>

Consumes the type and returns the TxEip7702 variant if the transaction is an EIP-7702 transaction. Returns an error otherwise.

pub fn signature_hash(&self) -> B256

where Eip4844: SignableTransaction<Signature>,

Calculate the signing hash for the transaction.

pub const fn signature(&self) -> &Signature

Return the reference to signature.

pub fn tx_hash(&self) -> &B256

Return the hash of the inner Signed.

pub fn hash(&self) -> &B256

Reference to transaction hash. Used to identify transaction.

pub fn eip2718_encoded_length(&self) -> usize

Return the length of the inner txn, including type byte length

impl<T: Encodable7594> EthereumTxEnvelope<TxEip4844WithSidecar<T>>

pub fn into_envelope(self) -> EthereumTxEnvelope<TxEip4844Variant<T>>

Converts the transaction into EthereumTxEnvelope<TxEip4844Variant<T>>.

Trait Implementations

impl<Eip4844: Clone> Clone for EthereumTxEnvelope<Eip4844>

fn clone(&self) -> EthereumTxEnvelope<Eip4844>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Eip4844: Debug> Debug for EthereumTxEnvelope<Eip4844>

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

Formats the value using the given formatter.

impl<Eip4844> Decodable for EthereumTxEnvelope<Eip4844>

where Signed<TxLegacy>: Decodable2718, Signed<TxEip2930>: Decodable2718, Signed<TxEip1559>: Decodable2718, Signed<Eip4844>: Decodable2718, Signed<TxEip7702>: Decodable2718,

fn decode(buf: &mut &[u8]) -> Result<Self>

Decodes the blob into the appropriate type. buf must be advanced past the decoded object.

impl<Eip4844> Decodable2718 for EthereumTxEnvelope<Eip4844>

where Signed<TxLegacy>: Decodable2718, Signed<TxEip2930>: Decodable2718, Signed<TxEip1559>: Decodable2718, Signed<Eip4844>: Decodable2718, Signed<TxEip7702>: Decodable2718,

fn typed_decode(ty: u8, buf: &mut &[u8]) -> Eip2718Result<Self>

Decode the appropriate variant, based on the type flag.

fn fallback_decode(buf: &mut &[u8]) -> Eip2718Result<Self>

Decode the default variant.

fn extract_type_byte(buf: &mut &[u8]) -> Option<u8>

Extract the type byte from the buffer, if any. The type byte is the first byte, provided that first byte is 0x7f or lower.

fn decode_2718(buf: &mut &[u8]) -> Result<Self, Eip2718Error>

Decode the transaction according to EIP-2718 rules. First a 1-byte type flag in the range 0x0-0x7f, then the body of the transaction.

fn decode_2718_exact(bytes: &[u8]) -> Result<Self, Eip2718Error>

Decode a transaction according to EIP-2718, ensuring no trailing bytes.

fn network_decode(buf: &mut &[u8]) -> Result<Self, Eip2718Error>

Decode an EIP-2718 transaction in the network format. The network format is used ONLY by the Ethereum p2p protocol. Do not call this method unless you are building a p2p protocol client.

impl<'de, Eip4844> Deserialize<'de> for EthereumTxEnvelope<Eip4844>

where EthereumTxEnvelope<Eip4844>: Clone, Signed<TxLegacy>: Serialize + DeserializeOwned, Signed<TxEip2930>: Serialize + DeserializeOwned, Signed<TxEip1559>: Serialize + DeserializeOwned, Signed<Eip4844>: Serialize + DeserializeOwned, Signed<TxEip7702>: Serialize + DeserializeOwned,

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<Eip4844> Encodable for EthereumTxEnvelope<Eip4844>

where Signed<TxLegacy>: Encodable2718, Signed<TxEip2930>: Encodable2718, Signed<TxEip1559>: Encodable2718, Signed<Eip4844>: Encodable2718, Signed<TxEip7702>: Encodable2718,

fn encode(&self, out: &mut dyn BufMut)

Encodes the type into the out buffer.

fn length(&self) -> usize

Returns the length of the encoding of this type in bytes.

impl<Eip4844> Encodable2718 for EthereumTxEnvelope<Eip4844>

where Signed<TxLegacy>: Encodable2718, Signed<TxEip2930>: Encodable2718, Signed<TxEip1559>: Encodable2718, Signed<Eip4844>: Encodable2718, Signed<TxEip7702>: Encodable2718,

fn encode_2718_len(&self) -> usize

The length of the 2718 encoded envelope. This is the length of the type flag + the length of the inner encoding.

fn encode_2718(&self, out: &mut dyn BufMut)

Encode the transaction according to EIP-2718 rules. First a 1-byte type flag in the range 0x0-0x7f, then the body of the transaction.

fn trie_hash(&self) -> B256

Compute the hash as committed to in the MPT trie. This hash is used ONLY by the Ethereum merkle-patricia trie and associated proofs. Do not call this method unless you are building a full or light client.

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

Return the type flag (if any).

fn encoded_2718(&self) -> Vec<u8>

Encode the transaction according to [EIP-2718] rules. First a 1-byte type flag in the range 0x0-0x7f, then the body of the transaction.

fn seal(self) -> Sealed<Self>

Seal the encodable, by encoding and hashing it.

fn into_encoded(self) -> WithEncoded<Self>

A convenience function that encodes the value in the 2718 format and wraps it in a WithEncoded wrapper.

fn network_len(&self) -> usize

The length of the 2718 encoded envelope in network format. This is the length of the header + the length of the type flag and inner encoding.

fn network_encode(&self, out: &mut dyn BufMut)

Encode in the network format. The network format is used ONLY by the Ethereum p2p protocol. Do not call this method unless you are building a p2p protocol client.

impl<Eip4844> From<(EthereumTypedTransaction<Eip4844>, Signature)> for EthereumTxEnvelope<Eip4844>

where Eip4844: RlpEcdsaEncodableTx + SignableTransaction<Signature>,

fn from(value: (EthereumTypedTransaction<Eip4844>, Signature)) -> Self

Converts to this type from the input type.

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

fn from(envelope: EthereumTxEnvelope<Eip4844>) -> Self

Converts to this type from the input type.

impl<Eip4844, Tx> From<EthereumTxEnvelope<Eip4844>> for Extended<EthereumTxEnvelope<Eip4844>, Tx>

fn from(value: EthereumTxEnvelope<Eip4844>) -> Self

Converts to this type from the input type.

impl<Eip4844: RlpEcdsaEncodableTx> From<EthereumTxEnvelope<Eip4844>> for Signed<EthereumTypedTransaction<Eip4844>>

where EthereumTypedTransaction<Eip4844>: From<Eip4844>,

fn from(value: EthereumTxEnvelope<Eip4844>) -> Self

Converts to this type from the input type.

impl<Eip4844, T> From<EthereumTxEnvelope<Eip4844>> for WithOtherFields<T>

where T: From<EthereumTxEnvelope<Eip4844>>,

fn from(value: EthereumTxEnvelope<Eip4844>) -> Self

Converts to this type from the input type.

impl<T> From<EthereumTxEnvelope<TxEip4844>> for EthereumTxEnvelope<TxEip4844Variant<T>>

fn from(value: EthereumTxEnvelope<TxEip4844>) -> Self

Converts to this type from the input type.

impl<T> From<EthereumTxEnvelope<TxEip4844Variant<T>>> for EthereumTxEnvelope<TxEip4844>

fn from(value: EthereumTxEnvelope<TxEip4844Variant<T>>) -> Self

Converts to this type from the input type.

impl<T> From<EthereumTxEnvelope<TxEip4844WithSidecar<T>>> for EthereumTxEnvelope<TxEip4844>

fn from(value: EthereumTxEnvelope<TxEip4844WithSidecar<T>>) -> Self

Converts to this type from the input type.

impl<T: Encodable7594> From<EthereumTxEnvelope<TxEip4844WithSidecar<T>>> for EthereumTxEnvelope<TxEip4844Variant<T>>

fn from(tx: EthereumTxEnvelope<TxEip4844WithSidecar<T>>) -> Self

Converts to this type from the input type.

impl<T, Eip4844> From<Signed<T>> for EthereumTxEnvelope<Eip4844>

where EthereumTypedTransaction<Eip4844>: From<T>, T: RlpEcdsaEncodableTx,

fn from(v: Signed<T>) -> Self

Converts to this type from the input type.

impl<Eip4844> Hash for EthereumTxEnvelope<Eip4844>

where Self: Encodable2718,

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Eip4844> IsTyped2718 for EthereumTxEnvelope<Eip4844>

fn is_type(type_id: u8) -> bool

Returns true if the given type ID corresponds to a supported typed transaction.

impl<Eip4844> PartialEq for EthereumTxEnvelope<Eip4844>

where Signed<TxLegacy>: PartialEq, Signed<TxEip2930>: PartialEq, Signed<TxEip1559>: PartialEq, Signed<Eip4844>: PartialEq, Signed<TxEip7702>: PartialEq,

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

where EthereumTxEnvelope<Eip4844>: Clone, Signed<TxLegacy>: Serialize + DeserializeOwned, Signed<TxEip2930>: Serialize + DeserializeOwned, Signed<TxEip1559>: Serialize + DeserializeOwned, Signed<Eip4844>: Serialize + DeserializeOwned, Signed<TxEip7702>: Serialize + DeserializeOwned,

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<Eip4844> SignerRecoverable for EthereumTxEnvelope<Eip4844>

where Eip4844: RlpEcdsaEncodableTx + SignableTransaction<Signature>,

fn recover_signer(&self) -> Result<Address, RecoveryError>

Recover signer from signature and hash.

fn recover_signer_unchecked(&self) -> Result<Address, RecoveryError>

Recover signer from signature and hash without ensuring that the signature has a low s value.

fn recover_unchecked_with_buf( &self, buf: &mut Vec<u8>, ) -> Result<Address, RecoveryError>

Same as SignerRecoverable::recover_signer_unchecked but receives a buffer to operate on for encoding. This is useful during batch recovery of historical transactions to avoid allocating a new buffer for each transaction.

fn try_into_recovered(self) -> Result<Recovered<Self>, RecoveryError>

where Self: Sized,

Recover the signer via SignerRecoverable::recover_signer and returns a Recovered<Self>

fn try_into_recovered_unchecked(self) -> Result<Recovered<Self>, RecoveryError>

where Self: Sized,

Recover the signer via SignerRecoverable::recover_signer_unchecked and returns a Recovered<&Self>

fn try_to_recovered_ref(&self) -> Result<Recovered<&Self>, RecoveryError>

Recover the signer via SignerRecoverable::recover_signer and returns a Recovered<&Self>

fn try_to_recovered_ref_unchecked( &self, ) -> Result<Recovered<&Self>, RecoveryError>

Recover the signer via SignerRecoverable::recover_signer_unchecked and returns a Recovered<&Self>

impl<Eip4844> Transaction for EthereumTxEnvelope<Eip4844>

where Self: Debug, Signed<TxLegacy>: Transaction, Signed<TxEip2930>: Transaction, Signed<TxEip1559>: Transaction, Signed<Eip4844>: Transaction, Signed<TxEip7702>: Transaction,

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

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 a 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<&Selector>

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<Eip4844> TransactionEnvelope for EthereumTxEnvelope<Eip4844>

where Self: Transaction,

type TxType = TxType

The enum of transaction types.

impl<T: Encodable7594> TryFrom<EthereumTxEnvelope<TxEip4844>> for EthereumTxEnvelope<TxEip4844WithSidecar<T>>

type Error = ValueError<EthereumTxEnvelope<TxEip4844>>

The type returned in the event of a conversion error.

fn try_from(value: EthereumTxEnvelope<TxEip4844>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Encodable7594> TryFrom<EthereumTxEnvelope<TxEip4844Variant<T>>> for EthereumTxEnvelope<TxEip4844WithSidecar<T>>

type Error = ValueError<EthereumTxEnvelope<TxEip4844Variant<T>>>

The type returned in the event of a conversion error.

fn try_from( value: EthereumTxEnvelope<TxEip4844Variant<T>>, ) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Encodable7594> TryFrom<Signed<TxEip4844Variant<T>>> for EthereumTxEnvelope<TxEip4844WithSidecar<T>>

type Error = ValueError<Signed<TxEip4844Variant<T>>>

The type returned in the event of a conversion error.

fn try_from(value: Signed<TxEip4844Variant<T>>) -> Result<Self, Self::Error>

Performs the conversion.

impl<Eip4844: RlpEcdsaEncodableTx> TxHashRef for EthereumTxEnvelope<Eip4844>

fn tx_hash(&self) -> &B256

Returns a reference to the transaction hash.

impl<Eip4844> Typed2718 for EthereumTxEnvelope<Eip4844>

where Signed<TxLegacy>: Typed2718, Signed<TxEip2930>: Typed2718, Signed<TxEip1559>: Typed2718, Signed<Eip4844>: Typed2718, Signed<TxEip7702>: Typed2718,

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<Eip4844> Eq for EthereumTxEnvelope<Eip4844>

where Signed<TxLegacy>: PartialEq, Signed<TxEip2930>: PartialEq, Signed<TxEip1559>: PartialEq, Signed<Eip4844>: PartialEq, Signed<TxEip7702>: PartialEq,