Struct GasTracker 

pub struct GasTracker { /* private fields */ }

Tracker for gas during execution.

This is used to track the gas during execution.

Implementations

impl GasTracker

pub const fn new(gas_limit: u64, remaining: u64, reservoir: u64) -> GasTracker

Creates a new GasTracker with the given remaining gas and reservoir.

pub const fn new_used_gas( gas_limit: u64, used_gas: u64, reservoir: u64, ) -> GasTracker

Creates a new GasTracker with the given used gas and reservoir.

pub const fn limit(&self) -> u64

Returns the gas limit.

pub const fn set_limit(&mut self, val: u64)

Sets the gas limit.

pub const fn remaining(&self) -> u64

Returns the remaining gas.

pub const fn set_remaining(&mut self, val: u64)

Sets the remaining gas.

pub const fn reservoir(&self) -> u64

Returns the reservoir gas.

pub const fn set_reservoir(&mut self, val: u64)

Sets the reservoir gas.

pub const fn state_gas_spent(&self) -> i64

Returns the state gas spent.

pub const fn set_state_gas_spent(&mut self, val: i64)

Sets the state gas spent.

pub const fn state_gas_spilled(&self) -> u64

Returns the state gas drawn from regular gas (remaining) because the reservoir was empty (EIP-8037’s state_gas_from_gas_left).

pub const fn set_state_gas_spilled(&mut self, val: u64)

Sets the spilled state gas.

pub const fn add_state_gas_spilled(&mut self, delta: u64)

Adds delta to the spilled state gas, saturating.

Used to merge a successful child frame’s spilled state gas into this (parent) frame so a later parent rollback can return it.

pub const fn refunded(&self) -> i64

Returns the refunded gas.

pub const fn set_refunded(&mut self, val: i64)

Sets the refunded gas.

pub const fn record_regular_cost(&mut self, cost: u64) -> bool

Records a regular gas cost.

Deducts from remaining. Returns false if insufficient gas.

pub const fn record_state_cost(&mut self, cost: u64) -> bool

Records a state gas cost (EIP-8037 reservoir model).

State gas charges deduct from the reservoir first. If the reservoir is exhausted, remaining charges spill into remaining (requiring remaining >= cost). Tracks state gas spent.

Returns false if total remaining gas is insufficient.

pub const fn rollback_state_gas(&mut self)

Rolls back this frame’s state-gas charges on revert or exceptional halt (EIP-8037).

The state gas charged within the frame is refilled in last-in-first-out order: the spilled portion is credited back to remaining (the pool charged last) and the rest restores the reservoir to its frame-start value. Concretely, remaining gains state_gas_spilled and the reservoir becomes reservoir + state_gas_spent - state_gas_spilled, which is exactly the reservoir the frame inherited. Both state-gas counters are then reset.

On revert the resulting remaining (including the refilled spill) is returned to the parent; on halt the caller additionally zeroes remaining so the spilled gas is consumed while the reservoir is left untouched.

pub const fn refill_reservoir(&mut self, amount: u64)

Refills the reservoir with state gas that is returned by 0→x→0 storage restoration (EIP-8037 issue #2).

Per the spec, when a storage slot is restored to its original zero value within the same transaction, the state gas charged for the initial 0→x transition is directly restored to the reservoir rather than routed through the capped refund counter.

state_gas_spent is decremented by the full amount and may become negative if the matching 0→x charge was made by a parent frame (so this frame’s state_gas_spilled is zero and the whole refill lands in the reservoir); the parent’s total is reconciled on frame return.

Because charges deduct from the reservoir first and from regular gas (remaining) last, the refill credits the pool charged last first: remaining is credited up to state_gas_spilled and any remainder tops up the reservoir.

pub const fn record_refund(&mut self, refund: i64)

Records a refund value.

pub const fn erase_cost(&mut self, returned: u64)

Erases a gas cost from remaining (returns gas from child frame).

pub const fn spend_all(&mut self)

Spends all remaining gas excluding the reservoir.

Trait Implementations

impl Clone for GasTracker

fn clone(&self) -> GasTracker

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for GasTracker

impl Debug for GasTracker

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

Formats the value using the given formatter.

impl Default for GasTracker

fn default() -> GasTracker

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GasTracker

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for GasTracker

impl Hash for GasTracker

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for GasTracker

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for GasTracker

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 StructuralPartialEq for GasTracker