Skip to content
Tevm Docs
Blog

InvalidBalanceError

Represents an error that occurs when an account balance is invalid.

This error is typically encountered when setting or manipulating account balances with invalid values.

Example

import { InvalidBalanceError } from '@tevm/errors'
import { createMemoryClient } from '@tevm/memory-client'


const client = createMemoryClient()


try {
  await client.setAccount({
    address: '0x...',
    balance: -1000n, // Invalid negative balance
  })
} catch (error) {
  if (error instanceof InvalidBalanceError) {
    console.error('Invalid balance:', error.message)
    console.log('Documentation:', error.docsLink)
  }
}

Extends

Constructors

new InvalidBalanceError()

new InvalidBalanceError(message, args?): InvalidBalanceError

Constructs an InvalidBalanceError.

Parameters

• message: string

Human-readable error message.

• args?: InvalidBalanceErrorParameters = {}

Additional parameters for the InvalidBalanceError.

Returns

InvalidBalanceError

Overrides

InvalidParamsError.constructor

Defined in

packages/errors/src/input/InvalidBalanceError.js:49

Properties

_tag

_tag: string

Same as name, used internally.

Inherited from

InvalidParamsError._tag

Defined in

packages/errors/src/input/InvalidBalanceError.js:61

cause

cause: any

Inherited from

InvalidParamsError.cause

Defined in

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

code

code: number

Inherited from

InvalidParamsError.code

Defined in

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

details

details: string

Inherited from

InvalidParamsError.details

Defined in

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

docsPath

docsPath: undefined | string

Path to the documentation for this error.

Inherited from

InvalidParamsError.docsPath

Defined in

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

message

message: string

Human-readable error message.

Inherited from

InvalidParamsError.message

Defined in

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

metaMessages

metaMessages: undefined | string[]

Additional meta messages for more context.

Inherited from

InvalidParamsError.metaMessages

Defined in

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

name

name: string

The name of the error, used to discriminate errors.

Inherited from

InvalidParamsError.name

Defined in

packages/errors/src/input/InvalidBalanceError.js:60

shortMessage

shortMessage: string

Inherited from

InvalidParamsError.shortMessage

Defined in

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

stack?

optional stack: string

Inherited from

InvalidParamsError.stack

Defined in

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

version

version: string

Inherited from

InvalidParamsError.version

Defined in

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

code

static code: number = -32602

The error code for InvalidParamsError.

Inherited from

InvalidParamsError.code

Defined in

packages/errors/src/ethereum/InvalidParamsError.js:46

prepareStackTrace()?

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

Optional override for formatting stack traces

Parameters

• err: Error

• stackTraces: CallSite[]

Returns

any

See

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

Inherited from

InvalidParamsError.prepareStackTrace

Defined in

node_modules/.pnpm/@types+node@22.7.3/node_modules/@types/node/globals.d.ts:143

stackTraceLimit

static stackTraceLimit: number

Inherited from

InvalidParamsError.stackTraceLimit

Defined in

node_modules/.pnpm/@types+node@22.7.3/node_modules/@types/node/globals.d.ts:145

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

InvalidParamsError.walk

Defined in

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

InvalidParamsError.captureStackTrace

Defined in

node_modules/.pnpm/@types+node@22.7.3/node_modules/@types/node/globals.d.ts:136

captureStackTrace(targetObject, constructorOpt)

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

• targetObject: object

• constructorOpt?: Function

Returns

void

Inherited from

InvalidParamsError.captureStackTrace

Defined in

node_modules/.pnpm/bun-types@1.1.29/node_modules/bun-types/globals.d.ts:1630

captureStackTrace(targetObject, constructorOpt)

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

• targetObject: object

• constructorOpt?: Function

Returns

void

Inherited from

InvalidParamsError.captureStackTrace

Defined in

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