Struct GasCharger

pub struct GasCharger { /* private fields */ }

Tracks all gas operations for a single transaction. This is the main entry point for gas accounting. All the information about gas is stored in this object. The objective here is two-fold: 1- Isolate al version info into a single entry point. This file and the other gas related files are the only one that check for gas version. 2- Isolate all gas accounting into a single implementation. Gas objects are not passed around, and they are retrieved from this instance.

Implementations

impl GasCharger

pub fn new( tx_digest: TransactionDigest, gas_coins: Vec<ObjectRef>, gas_status: SuiGasStatus, protocol_config: &ProtocolConfig, ) -> Self

pub fn new_unmetered(tx_digest: TransactionDigest) -> Self

pub fn gas_coin(&self) -> Option<ObjectID>

pub fn gas_budget(&self) -> u64

pub fn unmetered_storage_rebate(&self) -> u64

pub fn no_charges(&self) -> bool

pub fn is_unmetered(&self) -> bool

pub fn move_gas_status(&self) -> &GasStatus

pub fn move_gas_status_mut(&mut self) -> &mut GasStatus

pub fn into_gas_status(self) -> SuiGasStatus

pub fn summary(&self) -> GasCostSummary

pub fn smash_gas(&mut self, temporary_store: &mut TemporaryStore<'_>)

pub fn track_storage_mutation( &mut self, object_id: ObjectID, new_size: usize, storage_rebate: u64, ) -> u64

pub fn reset_storage_cost_and_rebate(&mut self)

pub fn charge_publish_package( &mut self, size: usize, ) -> Result<(), ExecutionError>

pub fn charge_upgrade_package( &mut self, size: usize, ) -> Result<(), ExecutionError>

pub fn charge_input_objects( &mut self, temporary_store: &TemporaryStore<'_>, ) -> Result<(), ExecutionError>

pub fn charge_coin_transfers( &mut self, protocol_config: &ProtocolConfig, num_non_gas_coin_owners: u64, ) -> Result<(), ExecutionError>

pub fn reset(&mut self, temporary_store: &mut TemporaryStore<'_>)

Resets any mutations, deletions, and events recorded in the store, as well as any storage costs and rebates, then Re-runs gas smashing. Effects on store are now as if we were about to begin execution

pub fn charge_gas<T>( &mut self, temporary_store: &mut TemporaryStore<'_>, execution_result: &mut Result<T, ExecutionError>, ) -> GasCostSummary

Entry point for gas charging.

1. Compute tx storage gas costs and tx storage rebates, update storage_rebate field of mutated objects
2. Deduct computation gas costs and storage costs, credit storage rebates. The happy path of this function follows (1) + (2) and is fairly simple. Most of the complexity is in the unhappy paths:

• if execution aborted before calling this function, we have to dump all writes + re-smash gas, then charge for storage
• if we run out of gas while charging for storage, we have to dump all writes + re-smash gas, then charge for storage again

Trait Implementations

impl Debug for GasCharger

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

Formats the value using the given formatter.