Enum OpReceiptEnvelope

#[non_exhaustive]
pub enum OpReceiptEnvelope<T = Log> {
    Legacy(ReceiptWithBloom<T>),
    Eip2930(ReceiptWithBloom<T>),
    Eip1559(ReceiptWithBloom<T>),
    Eip7702(ReceiptWithBloom<T>),
    Deposit(OpDepositReceiptWithBloom<T>),
}

Receipt envelope, as defined in EIP-2718, modified for OP Stack chains.

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

Receipt envelope with no type flag.

Eip2930(ReceiptWithBloom<T>)

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

Eip1559(ReceiptWithBloom<T>)

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

Eip7702(ReceiptWithBloom<T>)

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

Deposit(OpDepositReceiptWithBloom<T>)

Receipt envelope with type flag 126, containing a deposit receipt.

Implementations

impl OpReceiptEnvelope<Log>

pub fn from_parts<'a>( status: bool, cumulative_gas_used: u128, logs: impl IntoIterator<Item = &'a Log>, tx_type: OpTxType, deposit_nonce: Option<u64>, deposit_receipt_version: Option<u64>, ) -> Self

Creates a new OpReceiptEnvelope from the given parts.

impl<T> OpReceiptEnvelope<T>

pub const fn tx_type(&self) -> OpTxType

Return the OpTxType 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 const fn logs_bloom(&self) -> &Bloom

Return the receipt’s bloom.

pub fn deposit_nonce(&self) -> Option<u64>

Return the receipt’s deposit_nonce if it is a deposit receipt.

pub fn deposit_receipt_version(&self) -> Option<u64>

Return the receipt’s deposit version if it is a deposit receipt.

pub const fn as_deposit_receipt_with_bloom( &self, ) -> Option<&OpDepositReceiptWithBloom<T>>

Returns the deposit receipt if it is a deposit receipt.

pub const fn as_deposit_receipt(&self) -> Option<&OpDepositReceipt<T>>

Returns the deposit receipt if it is a deposit receipt.

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 OpReceiptEnvelope

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<T: Clone> Clone for OpReceiptEnvelope<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for OpReceiptEnvelope<T>

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

Formats the value using the given formatter.

impl Decodable for OpReceiptEnvelope

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

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

impl Decodable2718 for OpReceiptEnvelope

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 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 Encodable for OpReceiptEnvelope

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 OpReceiptEnvelope

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

fn eq(&self, other: &OpReceiptEnvelope<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> TxReceipt<T> for OpReceiptEnvelope<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.

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.

impl<T: Eq> Eq for OpReceiptEnvelope<T>

impl<T> StructuralPartialEq for OpReceiptEnvelope<T>