Enum ReceiptEnvelope

#[non_exhaustive]
pub enum ReceiptEnvelope<T = Log> {
    Legacy(ReceiptWithBloom<Receipt<T>>),
    Eip2930(ReceiptWithBloom<Receipt<T>>),
    Eip1559(ReceiptWithBloom<Receipt<T>>),
    Eip4844(ReceiptWithBloom<Receipt<T>>),
    Eip7702(ReceiptWithBloom<Receipt<T>>),
}

Receipt envelope, as defined in EIP-2718.

This enum distinguishes between tagged and untagged legacy receipts, 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.

Transaction receipt payloads are specified in their respective EIPs.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Legacy(ReceiptWithBloom<Receipt<T>>)

Receipt envelope with no type flag.

Eip2930(ReceiptWithBloom<Receipt<T>>)

Receipt envelope with type flag 1, containing a EIP-2930 receipt.

Eip1559(ReceiptWithBloom<Receipt<T>>)

Receipt envelope with type flag 2, containing a EIP-1559 receipt.

Eip4844(ReceiptWithBloom<Receipt<T>>)

Receipt envelope with type flag 2, containing a EIP-4844 receipt.

Eip7702(ReceiptWithBloom<Receipt<T>>)

Receipt envelope with type flag 4, containing a EIP-7702 receipt.

Implementations

impl<T> ReceiptEnvelope<T>

pub const fn tx_type(&self) -> TxType

Return the [TxType] of the inner receipt.

pub fn is_success(&self) -> bool

Return true if the transaction was successful.

pub fn status(&self) -> bool

Returns the success status of the receipt’s transaction.

pub fn cumulative_gas_used(&self) -> u128

Returns the cumulative gas used at this receipt.

pub fn logs(&self) -> &[T]

Return the receipt logs.

pub fn logs_bloom(&self) -> &Bloom

Return the receipt’s bloom.

pub const fn as_receipt_with_bloom( &self, ) -> Option<&ReceiptWithBloom<Receipt<T>>>

Return the inner receipt with bloom. Currently this is infallible, however, future receipt types may be added.

pub const fn as_receipt(&self) -> Option<&Receipt<T>>

Return the inner receipt. Currently this is infallible, however, future receipt types may be added.

impl ReceiptEnvelope

pub fn inner_length(&self) -> usize

Get the length of the inner receipt in the 2718 encoding.

pub fn rlp_payload_length(&self) -> usize

Calculate the length of the rlp payload of the network encoded receipt.

Trait Implementations

impl<'a, T> Arbitrary<'a> for ReceiptEnvelope<T>

where T: Arbitrary<'a>,

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<ReceiptEnvelope<T>, Error>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

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.

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.

impl AsRef<ReceiptEnvelope<Log>> for TransactionReceipt

fn as_ref(&self) -> &ReceiptEnvelope<Log>

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

impl<T> Clone for ReceiptEnvelope<T>

where T: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for ReceiptEnvelope<T>

where T: Debug,

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

Formats the value using the given formatter.

impl Decodable for ReceiptEnvelope

fn decode(buf: &mut &[u8]) -> Result<ReceiptEnvelope, Error>

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

impl Decodable2718 for ReceiptEnvelope

fn typed_decode( ty: u8, buf: &mut &[u8], ) -> Result<ReceiptEnvelope, Eip2718Error>

Decode the appropriate variant, based on the type flag.

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

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

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.

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, T> Deserialize<'de> for ReceiptEnvelope<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodable for ReceiptEnvelope

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 Encodable2718 for ReceiptEnvelope

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

Return the type flag (if any).

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 is_legacy(&self) -> bool

True if the envelope is the legacy variant.

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 trie_hash(&self) -> FixedBytes<32>

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 seal(self) -> Sealed<Self>

Seal the encodable, by encoding and hashing it.

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<T> PartialEq for ReceiptEnvelope<T>

where T: PartialEq,

fn eq(&self, other: &ReceiptEnvelope<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 ReceiptEnvelope<T>

where T: Serialize,

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<T> TxReceipt for ReceiptEnvelope<T>

where T: Clone + Debug + PartialEq + Eq + Send + Sync,

fn bloom(&self) -> Bloom

Return the receipt’s bloom.

fn cumulative_gas_used(&self) -> u128

Returns the cumulative gas used at this receipt.

fn logs(&self) -> &[T]

Return the receipt logs.

type Log = T

The associated log type.

fn status_or_post_state(&self) -> Eip658Value

Returns the status or post state of the transaction.

fn status(&self) -> bool

Returns true if the transaction was successful OR if the transaction is pre-EIP-658. Results for transactions before EIP-658 are not reliable.

fn bloom_cheap(&self) -> Option<Bloom>

Returns the bloom filter for the logs in the receipt, if it is cheap to compute.

fn with_bloom_ref(&self) -> ReceiptWithBloom<&Self>

Returns ReceiptWithBloom with the computed bloom filter [Self::bloom] and a reference to the receipt.

fn into_with_bloom(self) -> ReceiptWithBloom<Self>

Consumes the type and converts it into ReceiptWithBloom with the computed bloom filter [Self::bloom] and the receipt.

impl<T> Eq for ReceiptEnvelope<T>

where T: Eq,

impl<T> StructuralPartialEq for ReceiptEnvelope<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: 352 bytes

Size for each variant:

• Legacy: 336 bytes
• Eip2930: 336 bytes
• Eip1559: 336 bytes
• Eip4844: 336 bytes
• Eip7702: 336 bytes