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, if additional authentication is required, or if the account’s private key is not available to the node.

The error code -32005 is a non-standard extension used by some Ethereum clients to indicate this specific condition.

Example

try {
  await client.sendTransaction({
    from: '0x1234567890123456789012345678901234567890',
    to: '0x0987654321098765432109876543210987654321',
    value: '0x1'
  })
} catch (error) {
  if (error instanceof AccountLockedError) {
    console.error('Account locked:', error.message);
    console.log('Unlock the account or use a different account for this transaction');
  }
}

Param

A human-readable error message.

Param

Additional parameters for the BaseError.

Extends

• BaseError

Constructors

new AccountLockedError()

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

Constructs an AccountLockedError.

Parameters

• message: string

Human-readable error message.

• args?: AccountLockedErrorParameters = {}

Additional parameters for the BaseError.

• tag?: string = 'AccountLocked'

The tag for the error.

Returns

AccountLockedError

Overrides

BaseError.constructor

Defined in

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

Properties

_tag

_tag: string

Same as name, used internally.

Inherited from

BaseError._tag

Defined in

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

---

cause

cause: any

Inherited from

BaseError.cause

Defined in

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

---

code

code: number

Inherited from

BaseError.code

Defined in

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

---

details

details: string

Inherited from

BaseError.details

Defined in

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

---

docsPath

docsPath: undefined | string

Path to the documentation for this error.

Inherited from

BaseError.docsPath

Defined in

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

---

message

message: string

Human-readable error message.

Inherited from

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

BaseError.metaMessages

Defined in

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

---

name

name: string

The name of the error, used to discriminate errors.

Inherited from

BaseError.name

Defined in

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

---

shortMessage

shortMessage: string

Inherited from

BaseError.shortMessage

Defined in

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

---

stack?

optional stack: string

Inherited from

BaseError.stack

Defined in

node_modules/.pnpm/typescript@5.6.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:108

---

code

static code: number = -32005

Error code (-32005), a non-standard extension for this specific error.

Defined in

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

---

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

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

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

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

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

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

BaseError.captureStackTrace

Defined in

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