Struct GasCharger 

pub struct GasCharger { /* private fields */ }

Encapsulates the gas metering state (SuiGasStatus) and the payment source metadata, whether it is from a smashed list (coin objects or address-balance withdrawals) or un-metered. In other words, this serves the point of interaction between the on-chain data (coins and address balances) and the gas meter.

Implementations

impl GasCharger

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

Pre-v15 input charging: sum all input sizes and charge storage_read once. Bit-for-bit identical to origin/main for replay determinism; goes away when execution_version > 4.

impl GasCharger

pub fn new( tx_digest: TransactionDigest, payment_kind: PaymentKind, gas_status: SuiGasStatus, temporary_store: &mut TemporaryStore<'_>, protocol_config: &ProtocolConfig, ) -> Self

pub fn new_unmetered( tx_digest: TransactionDigest, protocol_config: &ProtocolConfig, ) -> Self

pub fn override_gas_charge_location( &mut self, location: PaymentLocation, ) -> Result<(), ExecutionError>

pub fn gas_payment_amount(&self) -> Option<GasPayment>

Return the amount available at the given input payment location. For unmetered, this is None. For smashed gas payments, this is the payment location and the total amount smashed. This information feels a bit brittle but should be used only by PTB execution. This might also differ from the final charge location, if override_gas_charge_location is used.

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

The coin that receives the final gas charge, or None when gas is paid from an address balance (or there is no payment, e.g. unmetered/gasless).

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 set_computation_to_budget(&mut self)

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 track_storage_mutation( &mut self, object_id: ObjectID, new_size: usize, storage_rebate: u64, ) -> Option<u64>

pub fn reset_storage_cost_and_rebate(&mut self)

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

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

Charge storage_read for each input object (system packages excepted).

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<'_>)

Restore the store + gas state to the post-input shape: drop execution writes, clear storage cost/rebate, re-smash gas, and re-touch mutable inputs so their versions still bump on the err path.

pub fn round_computation<T, E: ExecutionErrorTrait>( &mut self, result: Result<T, E>, ) -> Result<T, E>

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

Meter storage: collect per-object storage cost/rebate and verify it fits the remaining budget. Payment is applied later, by charge. For gasless, the execution requirements must be validated before ensure_active_inputs_mutated populates written_objects.

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

Apply the final gas charge derived from the current SuiGasStatus, per payment kind (Unmetered / Gasless / Smash).

Trait Implementations

impl Debug for GasCharger

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

Formats the value using the given formatter.