Skip to content

ForkError

Represents an error thrown when attempting to fetch a resource from a Forked transport. If the underlying JSON-RPC call has an error code, the error code will be proxied to the ForkError. Most tevm methods return these errors as values if throwOnFail is set to false and a forkUrl is provided

Example

try { // Some operation that can throw an ForkError } catch (error) { if (error instanceof ForkError) { console.error(error.message); // Handle the account locked error } }

To debug this error check to see if there might be a misconfiguration or rate limit of the fork transport.

If the issue is a rate limit consider using the rateLimit transport options to limit how many requests tevm are made.

import { rateLimit, http } from "@tevm/jsonrpc"
import { createMemoryClient } from "@tevm/memory-client"
const client = createMemoryClient({
fork: {
transport: rateLimit(
http('https://mainnet.optimism.io'), { browser: false, requestsPerSecond: 25 }
)
)
}}

Param

A human-readable error message.

Param

Additional parameters for the BaseError.

Extends

Constructors

new ForkError()

new ForkError(message, args, tag): ForkError

Constructs an ForkError.

Parameters

message: string

Human-readable error message.

args: ForkErrorParameters

Additional parameters for the BaseError.

tag: string = 'ForkError'

Returns

ForkError

Overrides

BaseError.constructor

Defined in

packages/errors/src/fork/ForkError.js:67

Properties

_tag

_tag: string

Same as name, used internally.

Inherited from

BaseError._tag

Defined in

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


cause

cause: any

Inherited from

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

BaseError.code

Defined in

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


details

details: string

Inherited from

BaseError.details

Defined in

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


docsPath

docsPath: undefined | string

Path to the documentation for this error.

Inherited from

BaseError.docsPath

Defined in

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


message

message: string

Human-readable error message.

Inherited from

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

BaseError.metaMessages

Defined in

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


name

name: string

The name of the error, used to discriminate errors.

Inherited from

BaseError.name

Defined in

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


shortMessage

shortMessage: string

Inherited from

BaseError.shortMessage

Defined in

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


stack?

optional stack: string

Inherited from

BaseError.stack

Defined in

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


version

version: string

Inherited from

BaseError.version

Defined in

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


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

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

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

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

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

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

BaseError.captureStackTrace

Defined in

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