Interface IGasCounter

An abstraction over gas counter.

It can be optimized to use numbers instead of bigint in case of small gas.

interface IGasCounter {
    initialGas: Gas;
    get(): Gas;
    set(g: Gas): void;
    sub(g: Gas): boolean;
    used(): Gas;
}

Index

Properties

Methods

get set sub used

Properties

initialGas

initialGas: Gas

Set during initialization of GasCounter.

NOTE: Needed to calculate used() gas.

Methods

get

get(): Gas
Return remaining gas.

Returns Gas
- Defined in packages/core/pvm-interface/gas.ts:34

set

set(g: Gas): void
Overwrite remaining gas.

NOTE: Could cause used() gas calculation to be incorrect.
Parameters
- g: Gas
Returns void
See
Prefer sub method instead.
- Defined in packages/core/pvm-interface/gas.ts:44

sub

sub(g: Gas): boolean
Returns true if there was an underflow.
Parameters
- g: Gas
Returns boolean
- Defined in packages/core/pvm-interface/gas.ts:47

used

used(): Gas
Calculates used gas since creation of GasCounter.

The interface does not handle negative or more than initialGas values.

NOTE: We can use at most initialGas and as little as 0.

Returns Gas
- Defined in packages/core/pvm-interface/gas.ts:56