StackUnderflowError

Represents a contract/bytecode error that occurs when there is a stack underflow during execution. This error is typically encountered when an operation requires more stack items than are present.

Stack underflow errors can occur due to:

• Incorrect management of stack operations (e.g., popping more items than available).
• Bugs in smart contract logic leading to unexpected stack behavior.
• Issues with function calls that manipulate the stack incorrectly.

To debug a stack underflow error:

1. Review Contract Logic: Ensure that your smart contract logic correctly handles stack operations, especially in loops and conditional branches.
2. Use TEVM Tracing: Utilize TEVM tracing to step through the transaction and inspect stack changes.
3. Use Other Tools: Use other tools with tracing such as Foundry.

• Ethereumjs Source: Refer to the source file where this error can occur.

Example

try {
  // Some operation that can throw a StackUnderflowError
} catch (error) {
  if (error instanceof StackUnderflowError) {
    console.error(error.message);
    // Handle the stack underflow error
  }
}

Param

A human-readable error message.

Param

Additional parameters for the BaseError.

Extends

• ExecutionError

Constructors

new StackUnderflowError()

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

Constructs a StackUnderflowError. This error is typically encountered when an operation requires more stack items than are present.

Stack underflow errors can occur due to:

• Incorrect management of stack operations (e.g., popping more items than available).
• Bugs in smart contract logic leading to unexpected stack behavior.
• Issues with function calls that manipulate the stack incorrectly.

To debug a stack underflow error:

1. Review Contract Logic: Ensure that your smart contract logic correctly handles stack operations, especially in loops and conditional branches.
2. Use TEVM Tracing: Utilize TEVM tracing to step through the transaction and inspect stack changes.
3. Use Other Tools: Use other tools with tracing such as Foundry.

• Ethereumjs Source: Refer to the source file where this error can occur.

Parameters

• message?: string = 'Stack underflow error occurred.'

Human-readable error message.

• args?: StackUnderflowErrorParameters = {}

Additional parameters for the BaseError.

• tag?: string = 'StackUnderflowError'

The tag for the error.

Returns

StackUnderflowError

Overrides

ExecutionError.constructor

Defined in

packages/errors/src/ethereum/ethereumjs/StackUnderflowError.js:74

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.4/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.4/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.4/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.STACK_UNDERFLOW

Defined in

packages/errors/src/ethereum/ethereumjs/StackUnderflowError.js:54

---

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.5.1/node_modules/@types/node/globals.d.ts:67

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.15/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/bun-types@1.1.22/node_modules/bun-types/globals.d.ts:1629

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