Enum GasEstimationError

#[non_exhaustive]
#[repr(u32)]
pub enum GasEstimationError {
    ExceedsLimitForPublishedPubdata {
        pubdata_published: u32,
        pubdata_limit: u32,
    },
    ExceedsBlockGasLimit {
        overhead: U64,
        gas_for_pubdata: U64,
        estimated_body_cost: U64,
    },
    TransactionHalt {
        inner: Box<Halt>,
    },
    TransactionRevert {
        inner: Box<Revert>,
        data: Vec<u8>,
    },
    TransactionAlwaysHalts {
        inner: Box<Halt>,
    },
    TransactionAlwaysReverts {
        inner: Box<Revert>,
        data: Vec<u8>,
    },
    GenericError {
        message: String,
    },
}

Domain: AnvilZKsync

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.

ExceedsLimitForPublishedPubdata

Summary

Transaction exceeds the limit for published pubdata.

Description

This error occurs when a transaction attempts to publish more pubdata than is allowed in a batch. Each transaction has a limit on how much pubdata it can publish to maintain network efficiency and prevent abuse.

Fields

pubdata_published: u32

pubdata_limit: u32

ExceedsBlockGasLimit

Summary

Transaction gas estimation exceeds the block gas limit.

Description

This error occurs when the total gas required for a transaction exceeds the maximum allowed for a block. The total gas is calculated by summing three components: the gas needed for publishing pubdata, the fixed overhead costs, and the estimated gas for the transaction body itself. When this sum overflows or exceeds the block limit, this error is thrown.

Fields

overhead: U64

gas_for_pubdata: U64

estimated_body_cost: U64

TransactionHalt

Summary

Transaction execution reverts and burns all gas while estimating required gas in anvil-zksync.

Description

This error occurs when anvil-zksync is trying to estimate gas required to run this transaction but the estimation fails because the transaction reverts and burns all gas.

Before estimating gas, anvil-zksync first runs the transaction with maximum gas possible. If the first run was successful, anvil-zksync proceeds with the estimation The estimation algorithm looks for a minimum gas value that makes the transaction succeed. This works if the transaction fails for all lower gas values and succeeds for all higher gas values. Some valid, but exotic transactions, resist estimation. Typically they depend on specific gas values, for example, they fail if gasleft() returned a value in a specific range.

Fields

inner: Box<Halt>

TransactionRevert

Summary

Transaction execution reverted while estimating required gas in anvil-zksync.

Description

This error occurs when anvil-zksync is trying to estimate gas required to run this transaction but the estimation fails because the transaction is reverted.

Before estimating gas, anvil-zksync first runs the transaction with maximum gas possible. If the first run was successful, anvil-zksync proceeds with the estimation The estimation algorithm looks for a minimum gas value that makes the transaction succeed. This works if the transaction fails for all lower gas values and succeeds for all higher gas values. Some valid, but exotic transactions, resist estimation. Typically they depend on specific gas values, for example, they revert if gasleft() returned a value in a specific range.

Fields

inner: Box<Revert>

data: Vec<u8>

TransactionAlwaysHalts

Summary

An attempt to run the transaction with maximum gas resulted in reverting the transaction and burning all gas.

Description

Before estimating gas, anvil-zksync first runs the transaction with maximum gas possible. This error occurs when this initial run results in a revert and burns all gas, suggesting that no amount of gas will make this transaction executable.

There might be valid, but exotic transactions that fail when run with maximum gas provided, but these are rare. Typically they depend on specific gas values. Usually, this error indicates either an unconditional revert or excessive gas consumption.

Fields

inner: Box<Halt>

TransactionAlwaysReverts

Summary

An attempt to run the transaction with maximum gas resulted in reverting the transaction and returning unspent gas.

Description

Before estimating gas, anvil-zksync first runs the transaction with maximum gas possible. This error occurs when this initial run results in a revert and returns unspent gas, suggesting that no amount of gas will make this transaction executable.

There might be valid, but exotic transactions that fail when run with maximum gas provided, but these are rare. Typically they depend on specific gas values. Usually, this error indicates either an unconditional revert or excessive gas consumption.

Fields

inner: Box<Revert>

data: Vec<u8>

GenericError

Fields

message: String

Trait Implementations

impl AsRef<str> for GasEstimation

fn as_ref(&self) -> &str

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

impl Clone for GasEstimation

fn clone(&self) -> GasEstimation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CustomErrorMessage for GasEstimation

fn get_message(&self) -> String

impl Debug for GasEstimation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GasEstimation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for GasEstimation

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

Formats the value using the given formatter.

impl Documented for GasEstimation

type Documentation = &'static ErrorDocumentation

fn get_documentation( &self, ) -> Result<Option<Self::Documentation>, DocumentationError>

impl Error for GasEstimation

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl<'_enum> From<&'_enum GasEstimation> for GasEstimationCode

fn from(val: &'_enum GasEstimation) -> GasEstimationCode

Converts to this type from the input type.

impl From<Error> for GasEstimation

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<GasEstimation> for AnvilZksync

fn from(val: GasEstimation) -> Self

Converts to this type from the input type.

impl From<GasEstimation> for GasEstimationCode

fn from(val: GasEstimation) -> GasEstimationCode

Converts to this type from the input type.

impl From<GasEstimation> for PackedError<ZksyncError>

fn from(value: GasEstimation) -> Self

Converts to this type from the input type.

impl From<GasEstimation> for SerializedError

fn from(value: GasEstimation) -> Self

Converts to this type from the input type.

impl From<GasEstimation> for ZksyncError

fn from(val: GasEstimation) -> Self

Converts to this type from the input type.

impl ICustomError<ZksyncError, ZksyncError> for GasEstimation

fn to_unified(&self) -> ZksyncError

impl NamedError for GasEstimation

fn get_error_name(&self) -> String

impl PartialEq for GasEstimation

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for GasEstimation

impl StructuralPartialEq for GasEstimation