Skip to main content

BlobTransactionSidecarVariant

Enum BlobTransactionSidecarVariant 

Source
pub enum BlobTransactionSidecarVariant {
    Eip4844(BlobTransactionSidecar),
    Eip7594(BlobTransactionSidecarEip7594),
}
Expand description

This represents a set of blobs, and its corresponding commitments and proofs. Proof type depends on the sidecar variant.

This type encodes and decodes the fields without an rlp header.

Variants§

§

Eip4844(BlobTransactionSidecar)

EIP-4844 style blob transaction sidecar.

§

Eip7594(BlobTransactionSidecarEip7594)

EIP-7594 style blob transaction sidecar with cell proofs.

Implementations§

Source§

impl BlobTransactionSidecarVariant

Source

pub const fn is_eip4844(&self) -> bool

Returns true if this is a BlobTransactionSidecarVariant::Eip4844.

Source

pub const fn is_eip7594(&self) -> bool

Returns true if this is a BlobTransactionSidecarVariant::Eip7594.

Source

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

Returns the EIP-4844 sidecar if it is Self::Eip4844.

Source

pub const fn as_eip7594(&self) -> Option<&BlobTransactionSidecarEip7594>

Returns the EIP-7594 sidecar if it is Self::Eip7594.

Source

pub fn into_eip4844(self) -> Option<BlobTransactionSidecar>

Converts into EIP-4844 sidecar if it is Self::Eip4844.

Source

pub fn into_eip7594(self) -> Option<BlobTransactionSidecarEip7594>

Converts the EIP-7594 sidecar if it is Self::Eip7594.

Source

pub fn blobs(&self) -> &[FixedBytes<alloy_eips::::eip4844::Blob::{constant#0}>]

Get a reference to the blobs

Source

pub fn into_blobs( self, ) -> Vec<FixedBytes<alloy_eips::::eip4844::Blob::{constant#0}>>

Consume self and return the blobs

Source

pub const fn size(&self) -> usize

Calculates a size heuristic for the in-memory size of the BlobTransactionSidecarVariant.

Source

pub fn try_convert_into_eip7594( self, ) -> Result<BlobTransactionSidecarVariant, Error>

Available on crate feature kzg only.

Attempts to convert this sidecar into the EIP-7594 format using default KZG settings.

This method converts an EIP-4844 sidecar to EIP-7594 by computing cell KZG proofs from the blob data. If the sidecar is already in EIP-7594 format, it returns itself unchanged.

The conversion requires computing CELLS_PER_EXT_BLOB cell proofs for each blob using the KZG trusted setup. The default KZG settings are loaded from the environment.

§Returns
  • Ok(Self) - The sidecar in EIP-7594 format (either converted or unchanged)
  • Err(c_kzg::Error) - If KZG proof computation fails
§Examples
// Convert an EIP-4844 sidecar to EIP-7594 format
let eip7594_sidecar = sidecar.try_convert_into_eip7594()?;

// Verify it's now in EIP-7594 format
assert!(eip7594_sidecar.is_eip7594());
Source

pub fn try_convert_into_eip7594_with_settings( self, settings: &KZGSettings, ) -> Result<BlobTransactionSidecarVariant, Error>

Available on crate feature kzg only.

Attempts to convert this sidecar into the EIP-7594 format using custom KZG settings.

This method converts an EIP-4844 sidecar to EIP-7594 by computing cell KZG proofs from the blob data using the provided KZG settings. If the sidecar is already in EIP-7594 format, it returns itself unchanged.

The conversion requires computing CELLS_PER_EXT_BLOB cell proofs for each blob using the provided KZG trusted setup parameters.

Use this method when you need to specify custom KZG settings rather than using the defaults. For most use cases, try_convert_into_eip7594 is sufficient.

§Arguments
  • settings - The KZG settings to use for computing cell proofs
§Returns
  • Ok(Self) - The sidecar in EIP-7594 format (either converted or unchanged)
  • Err(c_kzg::Error) - If KZG proof computation fails
§Examples
// Load custom KZG settings
let kzg_settings = EnvKzgSettings::Default.get();

// Convert using custom settings
let eip7594_sidecar = sidecar.try_convert_into_eip7594_with_settings(kzg_settings)?;

// Verify it's now in EIP-7594 format
assert!(eip7594_sidecar.is_eip7594());
Source

pub fn try_into_eip7594(self) -> Result<BlobTransactionSidecarEip7594, Error>

Available on crate feature kzg only.

Consumes this sidecar and returns a BlobTransactionSidecarEip7594 using default KZG settings.

This method converts an EIP-4844 sidecar to EIP-7594 by computing cell KZG proofs from the blob data. If the sidecar is already in EIP-7594 format, it extracts and returns the inner BlobTransactionSidecarEip7594.

Unlike try_convert_into_eip7594, this method returns the concrete BlobTransactionSidecarEip7594 type rather than the enum variant.

The conversion requires computing CELLS_PER_EXT_BLOB cell proofs for each blob using the KZG trusted setup. The default KZG settings are loaded from the environment.

§Returns
  • Ok(BlobTransactionSidecarEip7594) - The sidecar in EIP-7594 format
  • Err(c_kzg::Error) - If KZG proof computation fails
§Examples
// Convert and extract the EIP-7594 sidecar
let eip7594_sidecar = sidecar.try_into_eip7594()?;

// Now we have the concrete BlobTransactionSidecarEip7594 type
assert_eq!(eip7594_sidecar.blobs.len(), eip7594_sidecar.commitments.len());
Source

pub fn try_into_eip7594_with_settings( self, settings: &KZGSettings, ) -> Result<BlobTransactionSidecarEip7594, Error>

Available on crate feature kzg only.

Consumes this sidecar and returns a BlobTransactionSidecarEip7594 using custom KZG settings.

This method converts an EIP-4844 sidecar to EIP-7594 by computing cell KZG proofs from the blob data using the provided KZG settings. If the sidecar is already in EIP-7594 format, it extracts and returns the inner BlobTransactionSidecarEip7594.

Unlike try_convert_into_eip7594_with_settings, this method returns the concrete BlobTransactionSidecarEip7594 type rather than the enum variant.

The conversion requires computing CELLS_PER_EXT_BLOB cell proofs for each blob using the provided KZG trusted setup parameters.

Use this method when you need to specify custom KZG settings rather than using the defaults. For most use cases, try_into_eip7594 is sufficient.

§Arguments
  • settings - The KZG settings to use for computing cell proofs
§Returns
  • Ok(BlobTransactionSidecarEip7594) - The sidecar in EIP-7594 format
  • Err(c_kzg::Error) - If KZG proof computation fails
§Examples
// Load custom KZG settings
let kzg_settings = EnvKzgSettings::Default.get();

// Convert and extract using custom settings
let eip7594_sidecar = sidecar.try_into_eip7594_with_settings(kzg_settings)?;

// Now we have the concrete BlobTransactionSidecarEip7594 type
assert_eq!(eip7594_sidecar.blobs.len(), eip7594_sidecar.commitments.len());
Source

pub fn validate( &self, blob_versioned_hashes: &[FixedBytes<32>], proof_settings: &KZGSettings, ) -> Result<(), BlobTransactionValidationError>

Available on crate feature kzg only.

Verifies that the sidecar is valid. See relevant methods for each variant for more info.

Source

pub fn commitments(&self) -> &[FixedBytes<48>]

Returns the commitments of the sidecar.

Source

pub fn versioned_hashes(&self) -> VersionedHashIter<'_>

Returns an iterator over the versioned hashes of the commitments.

Source

pub fn versioned_hash_index(&self, hash: &FixedBytes<32>) -> Option<usize>

Returns the index of the versioned hash in the commitments vector.

Source

pub fn blob_by_versioned_hash( &self, hash: &FixedBytes<32>, ) -> Option<&FixedBytes<alloy_eips::::eip4844::Blob::{constant#0}>>

Returns the blob corresponding to the versioned hash, if it exists.

Trait Implementations§

Source§

impl<'arbitrary> Arbitrary<'arbitrary> for BlobTransactionSidecarVariant

Source§

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

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

fn arbitrary_take_rest( u: Unstructured<'arbitrary>, ) -> Result<BlobTransactionSidecarVariant, Error>

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 BlobTransactionSidecarVariant

Source§

fn clone(&self) -> BlobTransactionSidecarVariant

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BlobTransactionSidecarVariant

Source§

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

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

impl Decodable for BlobTransactionSidecarVariant

Source§

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

Decodes the inner BlobTransactionSidecar fields from RLP bytes, without a RLP header.

Source§

impl Decodable7594 for BlobTransactionSidecarVariant

Source§

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

Decode the sidecar according to EIP-7594 rules. First a 1-byte wrapper version (if any), then the body of the sidecar. Read more
Source§

impl Default for BlobTransactionSidecarVariant

Source§

fn default() -> BlobTransactionSidecarVariant

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for BlobTransactionSidecarVariant

Available on crate feature serde only.
Source§

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

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

impl Encodable for BlobTransactionSidecarVariant

Source§

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

Encodes the BlobTransactionSidecar fields as RLP bytes, without a RLP header.

Source§

fn length(&self) -> usize

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

impl Encodable7594 for BlobTransactionSidecarVariant

Source§

fn encode_7594_len(&self) -> usize

The length of the 7594 encoded envelope. This is the length of the wrapper version + the length of the inner encoding.
Source§

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

Encode the sidecar according to EIP-7594 rules. First a 1-byte wrapper version (if any), then the body of the sidecar. Read more
Source§

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

Encode the sidecar according to [EIP-7594] rules. First a 1-byte wrapper version (if any), then the body of the sidecar. Read more
Source§

impl Eq for BlobTransactionSidecarVariant

Source§

impl From<BlobTransactionSidecar> for BlobTransactionSidecarVariant

Source§

fn from(value: BlobTransactionSidecar) -> BlobTransactionSidecarVariant

Converts to this type from the input type.
Source§

impl From<BlobTransactionSidecarEip7594> for BlobTransactionSidecarVariant

Source§

fn from(value: BlobTransactionSidecarEip7594) -> BlobTransactionSidecarVariant

Converts to this type from the input type.
Source§

impl<'a> From<BlobTransactionSidecarVariant<'a>> for BlobTransactionSidecarVariant

Source§

fn from( value: BlobTransactionSidecarVariant<'a>, ) -> BlobTransactionSidecarVariant

Converts to this type from the input type.
Source§

impl Hash for BlobTransactionSidecarVariant

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for BlobTransactionSidecarVariant

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for BlobTransactionSidecarVariant

Source§

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

impl StructuralPartialEq for BlobTransactionSidecarVariant

Source§

impl TryFrom<BlobTransactionSidecarVariant> for BlobTransactionSidecarEip7594

Available on crate feature kzg only.
Source§

type Error = Error

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

fn try_from( value: BlobTransactionSidecarVariant, ) -> Result<BlobTransactionSidecarEip7594, <BlobTransactionSidecarEip7594 as TryFrom<BlobTransactionSidecarVariant>>::Error>

Performs the conversion.
Source§

impl TxEip4844Sidecar for BlobTransactionSidecarVariant

Source§

fn validate( &self, blob_versioned_hashes: &[B256], proof_settings: &KzgSettings, ) -> Result<(), BlobTransactionValidationError>

Available on crate feature kzg only.
Verifies that the versioned hashes are valid for this sidecar’s blob data, commitments, and proofs.
Source§

fn size(&self) -> usize

Calculate a size heuristic for the in-memory size of the sidecar.

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, dest: *mut u8)

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

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

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

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

Size for each variant:

  • Eip4844: 72 bytes
  • Eip7594: 72 bytes