UnreachableCodeError

Represents an error that occurs when unreachable code is executed. This error always indicates a bug in the Tevm VM.

Unreachable code errors can occur due to:

Defensive programming checks to ensure all cases in a switch or if statement are covered.

To handle this error take the following steps:

ensure you did not modify the tevm VM in any unsupported way.
Open an issue with a minimal reproducable example

Example

import { UnreachableCodeError } from '@tevm/errors'

const x: 'a' | 'b'  = 'a'

if (x === 'a') {
  console.log('A')
} else if (x === 'b') {
  console.log('B')
} else {
  throw new UnreachableCodeError(x, 'Unreachable code executed.')
}

Param

The value that should be of type never.

Param

A human-readable error message.

Param

Additional parameters for the BaseError.

Extends

InternalError

Constructors

new UnreachableCodeError()

new UnreachableCodeError(value, message?, args?): UnreachableCodeError

Constructs an UnreachableCodeError.

Parameters

• value: never

The value that should be of type never.

• message?: string= 'Unreachable code executed.'

Human-readable error message.

• args?: UnreachableCodeErrorParameters= {}

Additional parameters for the BaseError.

Returns

UnreachableCodeError

Overrides

InternalError.constructor

Source

packages/errors/src/defensive/UnreachableCodeError.js:59

Properties

_tag

_tag: string = 'InternalError'

Same as name, used internally.

Inherited from

InternalError._tag

Source

packages/errors/src/ethereum/InternalErrorError.js:70

cause

cause: any

Inherited from

InternalError.cause

Source

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

code

code: number

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

Inherited from

InternalError.code

Source

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

details

details: string

Inherited from

InternalError.details

Source

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

docsPath

docsPath: undefined | string

Path to the documentation for this error.

Inherited from

InternalError.docsPath

Source

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

message

message: string

Human-readable error message.

Inherited from

InternalError.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

InternalError.metaMessages

Source

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

name

name: string = 'InternalError'

The name of the error, used to discriminate errors.

Inherited from

InternalError.name

Source

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

shortMessage

shortMessage: string

Inherited from

InternalError.shortMessage

Source

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

stack?

optional stack: string

Inherited from

InternalError.stack

Source

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

version

version: string

Inherited from

InternalError.version

Source

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

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

InternalError.prepareStackTrace

Source

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

stackTraceLimit

static stackTraceLimit: number

Inherited from

InternalError.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

InternalError.walk

Source

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

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

InternalError.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

InternalError.captureStackTrace

Source

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