@tevm/voltaire / primitives/GasEstimate

primitives/GasEstimate

Type Aliases

GasEstimateType

GasEstimateType = bigint & object

Defined in: src/primitives/GasEstimate/GasEstimateType.ts:8 Branded GasEstimate type - estimated gas for transaction Returned by eth_estimateGas RPC method Should add buffer (20-30%) for actual transaction

Type Declaration

[brand]

readonly [brand]: "GasEstimate"

Variables

GasEstimate

const GasEstimate: object

Defined in: src/primitives/GasEstimate/index.ts:67

Type Declaration

compare()

compare: (value1, value2) => number

Parameters

value1

string | number | bigint

value2

string | number | bigint

Returns

number

equals()

equals: (value1, value2) => boolean

Parameters

value1

string | number | bigint

value2

string | number | bigint

Returns

boolean

from()

from: (value) => GasEstimateType

Create GasEstimate from number, bigint, or string

Parameters

value

Gas estimate value string | number | bigint

Returns

GasEstimateType Branded gas estimate

Throws

If value is negative

Example

const estimate = GasEstimate.from(51234n);
const fromRpc = GasEstimate.from(rpcEstimate);

toBigInt()

toBigInt: (value) => bigint

Parameters

value

string | number | bigint

Returns

bigint

toGasLimit()

toGasLimit: (estimate) => bigint

Parameters

estimate

string | number | bigint

Returns

bigint

toHex()

toHex: (value) => string

Parameters

value

string | number | bigint

Returns

string

toNumber()

toNumber: (value) => number

Parameters

value

string | number | bigint

Returns

number

withBuffer()

withBuffer: (estimate, percentageBuffer) => GasEstimateType

Parameters

estimate

string | number | bigint

percentageBuffer

number

Returns

GasEstimateType

Functions

_compare()

_compare(this, other): number

Defined in: src/primitives/GasEstimate/compare.js:15 Compare two GasEstimate values

Parameters

this

GasEstimateType

other

GasEstimateType Other gas estimate value

Returns

number -1 if this < other, 0 if equal, 1 if this > other

Example

const a = GasEstimate.from(21000n);
const b = GasEstimate.from(51234n);
GasEstimate._compare.call(a, b); // -1

_equals()

_equals(this, other): boolean

Defined in: src/primitives/GasEstimate/equals.js:15 Check if two GasEstimate values are equal

Parameters

this

GasEstimateType

other

GasEstimateType Other gas estimate value

Returns

boolean True if equal

Example

const a = GasEstimate.from(51234n);
const b = GasEstimate.from(51234n);
GasEstimate._equals.call(a, b); // true

_toBigInt()

_toBigInt(this): bigint

Defined in: src/primitives/GasEstimate/toBigInt.js:13 Convert GasEstimate to bigint (identity, for compatibility)

Parameters

this

GasEstimateType

Returns

bigint Gas estimate as bigint

Example

const estimate = GasEstimate.from(51234n);
GasEstimate.toBigInt(estimate); // 51234n

_toGasLimit()

_toGasLimit(this): bigint

Defined in: src/primitives/GasEstimate/toGasLimit.js:15 Convert GasEstimate to GasLimit type Typically used after adding buffer with withBuffer()

Parameters

this

GasEstimateType

Returns

bigint Gas limit value (unbranded bigint)

Example

const estimate = GasEstimate.from(100000n);
const withBuffer = GasEstimate._withBuffer.call(estimate, 20);
const gasLimit = GasEstimate._toGasLimit.call(withBuffer); // 120000n

_toHex()

_toHex(this): string

Defined in: src/primitives/GasEstimate/toHex.js:13 Convert GasEstimate to hex string

Parameters

this

GasEstimateType

Returns

string Gas estimate as hex string (0x prefixed)

Example

const estimate = GasEstimate.from(51234n);
GasEstimate.toHex(estimate); // "0xc822"

_toNumber()

_toNumber(this): number

Defined in: src/primitives/GasEstimate/toNumber.js:13 Convert GasEstimate to number

Parameters

this

GasEstimateType

Returns

number Gas estimate as number

Example

const estimate = GasEstimate.from(51234n);
GasEstimate.toNumber(estimate); // 51234

_withBuffer()

_withBuffer(this, percentageBuffer): GasEstimateType

Defined in: src/primitives/GasEstimate/withBuffer.js:18 Add percentage buffer to gas estimate Recommended: 20-30% to account for variability

Parameters

this

GasEstimateType

percentageBuffer

number Padding percentage (e.g., 20 for 20%)

Returns

GasEstimateType Estimate with buffer

Example

const estimate = GasEstimate.from(100000n);
GasEstimate._withBuffer.call(estimate, 20); // 120000n (100000 + 20%)
GasEstimate._withBuffer.call(estimate, 30); // 130000n (100000 + 30%)

compare()

compare(value1, value2): number

Defined in: src/primitives/GasEstimate/index.ts:37

Parameters

value1

string | number | bigint

value2

string | number | bigint

Returns

number

equals()

equals(value1, value2): boolean

Defined in: src/primitives/GasEstimate/index.ts:30

Parameters

value1

string | number | bigint

value2

string | number | bigint

Returns

boolean

from()

from(value): GasEstimateType

Defined in: src/primitives/GasEstimate/from.js:16 Create GasEstimate from number, bigint, or string

Parameters

value

Gas estimate value string | number | bigint

Returns

GasEstimateType Branded gas estimate

Throws

If value is negative

Example

const estimate = GasEstimate.from(51234n);
const fromRpc = GasEstimate.from(rpcEstimate);

toBigInt()

toBigInt(value): bigint

Defined in: src/primitives/GasEstimate/index.ts:22

Parameters

value

string | number | bigint

Returns

bigint

toGasLimit()

toGasLimit(estimate): bigint

Defined in: src/primitives/GasEstimate/index.ts:51

Parameters

estimate

string | number | bigint

Returns

bigint

toHex()

toHex(value): string

Defined in: src/primitives/GasEstimate/index.ts:26

Parameters

value

string | number | bigint

Returns

string

toNumber()

toNumber(value): number

Defined in: src/primitives/GasEstimate/index.ts:18

Parameters

value

string | number | bigint

Returns

number

withBuffer()

withBuffer(estimate, percentageBuffer): GasEstimateType

Defined in: src/primitives/GasEstimate/index.ts:44

Parameters

estimate

string | number | bigint

percentageBuffer

number

Returns

GasEstimateType

Precompile primitives/GasRefund

​primitives/GasEstimate

​Type Aliases

​GasEstimateType

​Type Declaration

[brand]

​Variables

​GasEstimate

​Type Declaration

compare()

Parameters

value1

value2

Returns

equals()

Parameters

value1

value2

Returns

from()

Parameters

value

Returns

Throws

Example

toBigInt()

Parameters

value

Returns

toGasLimit()

Parameters

estimate

Returns

toHex()

Parameters

value

Returns

toNumber()

Parameters

value

Returns

withBuffer()

Parameters

estimate

percentageBuffer

Returns

​Functions

​_compare()

​Parameters

this

other

​Returns

​Example

​_equals()

​Parameters

this

other

​Returns

​Example

​_toBigInt()

​Parameters

this

​Returns

​Example

​_toGasLimit()

​Parameters

this

​Returns

​Example

​_toHex()

​Parameters

this

​Returns

​Example

​_toNumber()

​Parameters

this

​Returns

​Example

​_withBuffer()

​Parameters

primitives/GasEstimate

Type Aliases

GasEstimateType

Type Declaration

Variables

GasEstimate

Type Declaration

Functions

_compare()

Parameters

Returns

Example

_equals()

Parameters

Returns

Example

_toBigInt()

Parameters

Returns

Example

_toGasLimit()

Parameters

Returns

Example

_toHex()

Parameters

Returns

Example

_toNumber()

Parameters

Returns

Example

_withBuffer()

Parameters

Returns

Example

compare()

Parameters

Returns

equals()

Parameters

Returns

from()

Parameters

Returns

Throws

Example

toBigInt()

Parameters

Returns

toGasLimit()

Parameters

Returns

toHex()

Parameters

Returns

toNumber()

Parameters

Returns

withBuffer()

Parameters

Returns