Enum TxEnvelope

Source
pub enum TxEnvelope {
    Legacy(Signed<TxLegacy>),
    Eip2930(Signed<TxEip2930>),
    Eip1559(Signed<TxEip1559>),
    Eip4844(Signed<TxEip4844Variant>),
    Eip7702(Signed<TxEip7702>),
}
Expand description

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<TxEip4844Variant>)

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§

Source§

impl TxEnvelope

Source

pub const fn is_legacy(&self) -> bool

Returns true if the transaction is a legacy transaction.

Source

pub const fn is_eip2930(&self) -> bool

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

Source

pub const fn is_eip1559(&self) -> bool

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

Source

pub const fn is_eip4844(&self) -> bool

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

Source

pub const fn is_eip7702(&self) -> bool

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

Source

pub fn try_into_pooled(self) -> Result<PooledTransaction, 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: TxEip4844 without the sidecar.

Source

pub fn into_signed(self) -> Signed<TypedTransaction>

Consumes the type into a Signed

Source

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.

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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

Available on crate feature k256 only.

Recover the signer of the transaction.

Source

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

Available on crate feature k256 only.

Recover the signer of the transaction.

Source

pub fn signature_hash(&self) -> B256

Calculate the signing hash for the transaction.

Source

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

Return the reference to signature.

Source

pub fn tx_hash(&self) -> &B256

Return the hash of the inner Signed.

Source

pub const fn tx_type(&self) -> TxType

Return the TxType of the inner txn.

Source

pub fn eip2718_encoded_length(&self) -> usize

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

Trait Implementations§

Source§

impl<'arbitrary> Arbitrary<'arbitrary> for TxEnvelope

Source§

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data. Read more
Source§

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data. Read more
Source§

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself. Read more
Source§

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself. Read more
Source§

impl Clone for TxEnvelope

Source§

fn clone(&self) -> TxEnvelope

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TxEnvelope

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Decodable for TxEnvelope

Source§

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

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

impl Decodable2718 for TxEnvelope

Source§

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

Decode the appropriate variant, based on the type flag. Read more
Source§

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

Decode the default variant. Read more
Source§

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 that first byte is 0x7f or lower.
Source§

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

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. Read more
Source§

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. Read more
Source§

impl<'de> Deserialize<'de> for TxEnvelope

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Encodable for TxEnvelope

Source§

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

Encodes the type into the out buffer.
Source§

fn length(&self) -> usize

Returns the length of the encoding of this type in bytes. Read more
Source§

impl Encodable2718 for TxEnvelope

Source§

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.
Source§

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. Read more
Source§

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. Read more
Source§

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

Return the type flag (if any). Read more
Source§

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. Read more
Source§

fn seal(self) -> Sealed<Self>

Seal the encodable, by encoding and hashing it.
Source§

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.
Source§

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. Read more
Source§

impl From<PooledTransaction> for TxEnvelope

Source§

fn from(tx: PooledTransaction) -> Self

Converts to this type from the input type.
Source§

impl From<Signed<EthereumTypedTransaction<TxEip4844Variant>>> for TxEnvelope

Source§

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

Converts to this type from the input type.
Source§

impl From<Signed<TxEip1559>> for TxEnvelope

Source§

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

Converts to this type from the input type.
Source§

impl From<Signed<TxEip2930>> for TxEnvelope

Source§

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

Converts to this type from the input type.
Source§

impl From<Signed<TxEip4844>> for TxEnvelope

Source§

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

Converts to this type from the input type.
Source§

impl From<Signed<TxEip4844Variant>> for TxEnvelope

Source§

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

Converts to this type from the input type.
Source§

impl From<Signed<TxEip4844WithSidecar>> for TxEnvelope

Source§

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

Converts to this type from the input type.
Source§

impl From<Signed<TxEip7702>> for TxEnvelope

Source§

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

Converts to this type from the input type.
Source§

impl From<Signed<TxLegacy>> for TxEnvelope

Source§

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

Converts to this type from the input type.
Source§

impl From<TxEnvelope> for TypedTransaction

Source§

fn from(envelope: TxEnvelope) -> Self

Converts to this type from the input type.
Source§

impl From<TxEnvelope> for Signed<TypedTransaction>

Source§

fn from(value: TxEnvelope) -> Self

Converts to this type from the input type.
Source§

impl<T: From<TxEnvelope>> From<TxEnvelope> for WithOtherFields<T>

Available on crate feature serde only.
Source§

fn from(value: TxEnvelope) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for TxEnvelope

Source§

fn eq(&self, other: &TxEnvelope) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for TxEnvelope

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Transaction for TxEnvelope

Source§

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

Get chain_id.
Source§

fn nonce(&self) -> u64

Get nonce.
Source§

fn gas_limit(&self) -> u64

Get gas_limit.
Source§

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

Get gas_price.
Source§

fn max_fee_per_gas(&self) -> u128

Returns the EIP-1559 the maximum fee per gas the caller is willing to pay. Read more
Source§

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

Returns the EIP-1559 Priority fee the caller is paying to the block author. Read more
Source§

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

Max fee per blob gas for EIP-4844 transaction. Read more
Source§

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. Read more
Source§

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

Returns the effective gas price for the given base fee. Read more
Source§

fn is_dynamic_fee(&self) -> bool

Returns true if the transaction supports dynamic fees.
Source§

fn kind(&self) -> TxKind

Returns the transaction kind.
Source§

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.
Source§

fn value(&self) -> U256

Get value.
Source§

fn input(&self) -> &Bytes

Get data.
Source§

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

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

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

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

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

Returns the SignedAuthorization list of the transaction. Read more
Source§

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

Returns the effective tip for this transaction. Read more
Source§

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. Read more
Source§

fn function_selector(&self) -> Option<&Selector>

Returns the first 4bytes of the calldata for a function call. Read more
Source§

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

Returns the number of blobs of this transaction. Read more
Source§

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

Returns the total gas for all blobs in this transaction. Read more
Source§

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

Returns the number of blobs of SignedAuthorization in this transactions Read more
Source§

impl TryFrom<TxEnvelope> for PooledTransaction

Source§

type Error = ValueError<TxEnvelope>

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl Typed2718 for TxEnvelope

Source§

fn ty(&self) -> u8

Returns the EIP-2718 type flag.
Source§

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

Returns true if the type matches the given type.
Source§

fn is_legacy(&self) -> bool

Returns true if the type is a legacy transaction.
Source§

fn is_eip2930(&self) -> bool

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

fn is_eip1559(&self) -> bool

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

fn is_eip4844(&self) -> bool

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

fn is_eip7702(&self) -> bool

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

impl Eq for TxEnvelope

Source§

impl StructuralPartialEq for TxEnvelope

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> Eip2718Envelope for T

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

Size for each variant:

  • Legacy: 256 bytes
  • Eip2930: 272 bytes
  • Eip1559: 288 bytes
  • Eip4844: 400 bytes
  • Eip7702: 304 bytes