@lelantos-org/sdk / index / InvalidArgumentError

Class: InvalidArgumentError

Defined in: @lelantos-org/sdk/dist/errors/config.d.ts:11

A caller passed an argument the SDK cannot act on. Distinct from WalletConfigError, which is about wiring rather than a call.

Extends

• WalletError<"INVALID_ARGUMENT">

Constructors

Constructor

new InvalidArgumentError(message, opts): InvalidArgumentError;

Defined in: @lelantos-org/sdk/dist/errors/config.d.ts:17

Parameters

Parameter	Type
message	string
opts	WalletErrorOptions & object

Returns

InvalidArgumentError

Overrides

WalletError.constructor

Properties

argument

readonly argument: string;

Defined in: @lelantos-org/sdk/dist/errors/config.d.ts:16

The argument at fault: an option name ("amount", "feeAsset"), a dotted path into one ("selection.maxInputs"), or a parameter name.

---

cause?

optional cause?: unknown;

Defined in: typescript/lib/lib.es2022.error.d.ts:26

Inherited from

WalletError.cause

---

code

readonly code: "INVALID_ARGUMENT";

Defined in: @lelantos-org/sdk/dist/errors/base.d.ts:39

Inherited from

WalletError.code

---

context

readonly context: ErrorContext;

Defined in: @lelantos-org/sdk/dist/errors/base.d.ts:46

Inherited from

WalletError.context

---

details?

readonly optional details?: Readonly<Record<string, string | number | boolean>>;

Defined in: @lelantos-org/sdk/dist/errors/base.d.ts:48

Extra diagnostic scalars for this failure, when any.

Inherited from

WalletError.details

---

message

message: string;

Defined in: typescript/lib/lib.es5.d.ts:1077

Inherited from

WalletError.message

---

name

name: string;

Defined in: typescript/lib/lib.es5.d.ts:1076

Inherited from

WalletError.name

---

retryable

readonly retryable: boolean;

Defined in: @lelantos-org/sdk/dist/errors/base.d.ts:45

Whether the same call, unchanged, may succeed later without user action: a timeout, a 5xx, notes held by an earlier spend. false means retrying as-is will fail the same way.

Inherited from

WalletError.retryable

---

stack?

optional stack?: string;

Defined in: typescript/lib/lib.es5.d.ts:1078

Inherited from

WalletError.stack

Methods

withContext()

withContext(extra): this;

Defined in: @lelantos-org/sdk/dist/errors/base.d.ts:53

Merge additional context in place and return this for rethrowing.

Parameters

Parameter	Type
extra	ErrorContext

Returns

this

Inherited from

WalletError.withContext