OutOfGasError

Represents an error that occurs when a transaction runs out of gas during execution. This error is typically encountered when the gas provided for a transaction is insufficient to complete its execution.

Out of gas errors can occur due to:

Insufficient gas provided for complex transactions or loops.
Incorrect estimation of gas required for certain operations.
Contracts with high gas consumption in specific functions.
Non-deterministic gas usage in contracts.
If TEVM submitted the transaction using createTransaction: true and the account being used runs out of gas.

To debug an out of gas error:

Review Gas Estimates: Ensure that the gas estimate for your transaction is accurate and sufficient. If you provided explicit gas-related parameters, double-check their values.
Optimize Contract Code: Refactor your smart contract code to reduce gas consumption, especially in loops and complex operations. Remove potential non-deterministic behaviors.
Use TEVM Tracing: Utilize TEVM tracing to step through the transaction and inspect gas usage.
Estimate Gas Multiple Times: If using TEVM gas estimations, it might make sense to estimate gas many times and take the worst case to set gasPrice. Most nodes execute eth_estimateGas 10 times, while TEVM runs it only once.
Use Other Tools: Use other tools with gas profiling such as Foundry.

Example

try {
  // Some operation that can throw an OutOfGasError
} catch (error) {
  if (error instanceof OutOfGasError) {
    console.error(error.message);
    // Handle the out of gas error
  }
}

Param

A human-readable error message.

Param

Additional parameters for the BaseError.

Extends

GasLimitExceededError

Constructors

new OutOfGasError()

new OutOfGasError(message?, args?): OutOfGasError

Constructs an OutOfGasError.

Parameters

• message?: string= 'Out of gas error occurred.'

Human-readable error message.

• args?: OutOfGasErrorParameters= {}

Additional parameters for the BaseError.

Returns

OutOfGasError

Overrides

GasLimitExceededError.constructor

Source

packages/errors/src/ethereum/ethereumjs/OutOfGasError.js:64

Properties

_tag

_tag: string = 'GasLimitExceeded'

Same as name, used internally.

Inherited from

GasLimitExceededError._tag

Source

packages/errors/src/ethereum/GasLimitExceededError.js:76

cause

cause: any

Inherited from

GasLimitExceededError.cause

Source

packages/errors/src/ethereum/BaseError.js:110

code

code: number

Error code, analogous to the code in JSON RPC error.

Inherited from

GasLimitExceededError.code

Source

packages/errors/src/ethereum/BaseError.js:108

details

details: string

Inherited from

GasLimitExceededError.details

Source

packages/errors/src/ethereum/BaseError.js:87

docsPath

docsPath: undefined | string

Path to the documentation for this error.

Inherited from

GasLimitExceededError.docsPath

Source

packages/errors/src/ethereum/BaseError.js:92

message

message: string

Human-readable error message.

Inherited from

GasLimitExceededError.message

Source

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:1077

metaMessages

metaMessages: undefined | string[]

Additional meta messages for more context.

Inherited from

GasLimitExceededError.metaMessages

Source

packages/errors/src/ethereum/BaseError.js:96

name

name: string = 'GasLimitExceeded'

The name of the error, used to discriminate errors.

Inherited from

GasLimitExceededError.name

Source

packages/errors/src/ethereum/GasLimitExceededError.js:83

shortMessage

shortMessage: string

Inherited from

GasLimitExceededError.shortMessage

Source

packages/errors/src/ethereum/BaseError.js:100

stack?

optional stack: string

Inherited from

GasLimitExceededError.stack

Source

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:1078

version

version: string

Inherited from

GasLimitExceededError.version

Source

packages/errors/src/ethereum/BaseError.js:104

EVMErrorMessage

static EVMErrorMessage: EvmErrorMessage = EVMErrorMessage.OUT_OF_GAS

Source

packages/errors/src/ethereum/ethereumjs/OutOfGasError.js:57

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Parameters

• err: Error

• stackTraces: CallSite[]

Returns

any

Inherited from

GasLimitExceededError.prepareStackTrace

Source

node_modules/.pnpm/@types+node@20.14.2/node_modules/@types/node/globals.d.ts:28

stackTraceLimit

static stackTraceLimit: number

Inherited from

GasLimitExceededError.stackTraceLimit

Source

node_modules/.pnpm/@types+node@20.14.2/node_modules/@types/node/globals.d.ts:30

Methods

walk()

walk(fn?): unknown

Walks through the error chain.

Parameters

• fn?: Function

A function to execute on each error in the chain.

Returns

unknown

The first error that matches the function, or the original error.

Inherited from

GasLimitExceededError.walk

Source

packages/errors/src/ethereum/BaseError.js:133

captureStackTrace()

captureStackTrace(targetObject, constructorOpt)

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

• targetObject: object

• constructorOpt?: Function

Returns

void

Inherited from

GasLimitExceededError.captureStackTrace

Source

node_modules/.pnpm/@types+node@20.14.2/node_modules/@types/node/globals.d.ts:21

captureStackTrace(targetObject, constructorOpt)

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

• targetObject: object

• constructorOpt?: Function

Returns

void

Inherited from

GasLimitExceededError.captureStackTrace

Source

node_modules/.pnpm/bun-types@1.1.12/node_modules/bun-types/globals.d.ts:1613