Skip to content

OutOfRangeError

Represents an invalid bytecode/contract error that occurs when a value is out of the allowable range during EVM execution. This error is typically encountered when an operation results in a value that exceeds the allowed limits.

Value out of range errors can occur due to:

  • Arithmetic operations that result in overflow or underflow.
  • Incorrect handling of large numbers in the smart contract code.
  • Bugs in the smart contract code causing values to exceed their expected range.

To debug a value out of range error:

  1. Review Arithmetic Operations: Ensure that arithmetic operations in the contract are correctly handling large numbers and preventing overflow/underflow.
  2. Check Value Assignments: Verify that values assigned to variables are within the allowable range and properly validated.
  3. Use TEVM Tracing: Utilize TEVM tracing to step through the contract execution and identify where the value goes out of range.
  4. Inspect Contract Logic: Manually inspect the contract code to ensure that all value assignments and operations are within the expected limits.

Example

import { OutOfRangeError } from '@tevm/errors'
try {
// Some operation that can throw an OutOfRangeError
} catch (error) {
if (error instanceof OutOfRangeError) {
console.error(error.message);
// Handle the value out of range error
}
}

Param

A human-readable error message.

Param

Additional parameters for the BaseError.

Extends

Constructors

new OutOfRangeError()

new OutOfRangeError(message?, args?, tag?): OutOfRangeError

Constructs an OutOfRangeError. Represents an invalid bytecode/contract error that occurs when a value is out of the allowable range during EVM execution. This error is typically encountered when an operation results in a value that exceeds the allowed limits.

Value out of range errors can occur due to:

  • Arithmetic operations that result in overflow or underflow.
  • Incorrect handling of large numbers in the smart contract code.
  • Bugs in the smart contract code causing values to exceed their expected range.

To debug a value out of range error:

  1. Review Arithmetic Operations: Ensure that arithmetic operations in the contract are correctly handling large numbers and preventing overflow/underflow.
  2. Check Value Assignments: Verify that values assigned to variables are within the allowable range and properly validated.
  3. Use TEVM Tracing: Utilize TEVM tracing to step through the contract execution and identify where the value goes out of range.
  4. Inspect Contract Logic: Manually inspect the contract code to ensure that all value assignments and operations are within the expected limits.

Parameters

message?: string = 'Value out of range error occurred.'

Human-readable error message.

args?: OutOfRangeErrorParameters = {}

Additional parameters for the BaseError.

tag?: string = 'OutOfRangeError'

The tag for the error.

Returns

OutOfRangeError

Overrides

ExecutionError.constructor

Defined in

packages/errors/src/ethereum/ethereumjs/OutOfRangeError.js:76

Properties

_tag

_tag: string

Same as name, used internally.

Inherited from

ExecutionError._tag

Defined in

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


cause

cause: any

Inherited from

ExecutionError.cause

Defined in

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


code

code: number

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

Inherited from

ExecutionError.code

Defined in

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


details

details: string

Inherited from

ExecutionError.details

Defined in

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


docsPath

docsPath: undefined | string

Path to the documentation for this error.

Inherited from

ExecutionError.docsPath

Defined in

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


message

message: string

Human-readable error message.

Inherited from

ExecutionError.message

Defined in

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


metaMessages

metaMessages: undefined | string[]

Additional meta messages for more context.

Inherited from

ExecutionError.metaMessages

Defined in

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


name

name: string

The name of the error, used to discriminate errors.

Inherited from

ExecutionError.name

Defined in

node_modules/.pnpm/typescript@5.5.2/node_modules/typescript/lib/lib.es5.d.ts:1076


shortMessage

shortMessage: string

Inherited from

ExecutionError.shortMessage

Defined in

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


stack?

optional stack: string

Inherited from

ExecutionError.stack

Defined in

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


version

version: string

Inherited from

ExecutionError.version

Defined in

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


EVMErrorMessage

static EVMErrorMessage: EvmErrorMessage = EVMErrorMessage.OUT_OF_RANGE

Defined in

packages/errors/src/ethereum/ethereumjs/OutOfRangeError.js:55


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

ExecutionError.prepareStackTrace

Defined in

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


stackTraceLimit

static stackTraceLimit: number

Inherited from

ExecutionError.stackTraceLimit

Defined in

node_modules/.pnpm/@types+node@20.14.8/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

ExecutionError.walk

Defined in

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


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

ExecutionError.captureStackTrace

Defined in

node_modules/.pnpm/@types+node@20.14.8/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

ExecutionError.captureStackTrace

Defined in

node_modules/.pnpm/@types+node@22.1.0/node_modules/@types/node/globals.d.ts:22

captureStackTrace(targetObject, constructorOpt)

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

targetObject: object

constructorOpt?: Function

Returns

void

Inherited from

ExecutionError.captureStackTrace

Defined in

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

captureStackTrace(targetObject, constructorOpt)

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

targetObject: object

constructorOpt?: Function

Returns

void

Inherited from

ExecutionError.captureStackTrace

Defined in

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