AccountLockedError

Represents an error that occurs when an account is locked.

This error is typically encountered when an operation is attempted on an account that has been locked for security reasons. This might happen if the account has been temporarily disabled or if additional authentication is required.

Example

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

Param

A human-readable error message.

Param

Additional parameters for the BaseError.

Extends

• BaseError

Constructors

new AccountLockedError()

new AccountLockedError(message, args?): AccountLockedError

Constructs an AccountLockedError.

Parameters

• message: string

Human-readable error message.

• args?: AccountLockedErrorParameters= {}

Additional parameters for the BaseError.

Returns

AccountLockedError

Overrides

BaseError.constructor

Source

packages/errors/src/ethereum/AccountLockedError.js:50

Properties

_tag

_tag: "AccountLocked" = 'AccountLocked'

Same as name, used internally.

Overrides

BaseError._tag

Source

packages/errors/src/ethereum/AccountLockedError.js:72

---

cause

cause: any

Inherited from

BaseError.cause

Source

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

---

code

code: number

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

Inherited from

BaseError.code

Source

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

---

details

details: string

Inherited from

BaseError.details

Source

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

---

docsPath

docsPath: undefined | string

Path to the documentation for this error.

Inherited from

BaseError.docsPath

Source

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

---

message

message: string

Human-readable error message.

Inherited from

BaseError.message

Source

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

---

meta

meta: undefined | object

Optional object containing additional information about the error.

Source

packages/errors/src/ethereum/AccountLockedError.js:65

---

metaMessages

metaMessages: undefined | string[]

Additional meta messages for more context.

Inherited from

BaseError.metaMessages

Source

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

---

name

name: "AccountLocked" = 'AccountLocked'

The name of the error, used to discriminate errors.

Overrides

BaseError.name

Source

packages/errors/src/ethereum/AccountLockedError.js:78

---

shortMessage

shortMessage: string

Inherited from

BaseError.shortMessage

Source

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

---

stack?

optional stack: string

Inherited from

BaseError.stack

Source

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

---

version

version: string

Inherited from

BaseError.version

Source

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

---

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

Source

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

---

stackTraceLimit

static stackTraceLimit: number

Inherited from

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

BaseError.walk

Source

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

---

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

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

BaseError.captureStackTrace

Source

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