Overview

Namespaces

• IcpIndexDid
• IcpLedgerDid

Classes

AccountIdentifier

Defined in: packages/canisters/src/ledger/icp/account_identifier.ts:23

A 32-byte account identifier used to send and receive ICP tokens.

The ICP Ledger uses the concept of an AccountIdentifier to represent accounts. It’s a unique value derived from a principal (the identity controlling the account) and a subaccount. This design allows a single principal to control multiple accounts by using different subaccounts.

See

• https://internetcomputer.org/docs/references/ledger#_accounts
• https://internetcomputer.org/docs/defi/token-ledgers/setup/icp_ledger_setup
• https://internetcomputer.org/docs/references/ledger#_operations_transactions_blocks_transaction_ledger

Methods

toAccountIdentifierHash()

toAccountIdentifierHash(): object

Defined in: packages/canisters/src/ledger/icp/account_identifier.ts:127

Returns the raw bytes wrapped in an object under the hash key.

Returns

object

{ hash: Uint8Array } where hash is the raw 32-byte Uint8Array.

hash

hash: Uint8Array

toHex()

toHex(): string

Defined in: packages/canisters/src/ledger/icp/account_identifier.ts:100

Returns the ICP Ledger Account Identifier as a 64-character hexadecimal string. This is the format typically used to display the account identifier in a human-readable way.

Returns

string

Hex representation (64-character string).

toNumbers()

toNumbers(): number[]

Defined in: packages/canisters/src/ledger/icp/account_identifier.ts:118

Returns the account identifier as an array of numbers.

Returns

number[]

An array of byte values.

toUint8Array()

toUint8Array(): Uint8Array

Defined in: packages/canisters/src/ledger/icp/account_identifier.ts:109

Returns the raw 32-byte Uint8Array of the account identifier.

Returns

Uint8Array

The raw bytes of the account identifier.

fromHex()

static fromHex(hex): AccountIdentifier

Defined in: packages/canisters/src/ledger/icp/account_identifier.ts:34

Creates an AccountIdentifier object from a hexadecimal string (e.g. d3e13d4777e22367532053190b6c6ccf57444a61337e996242b1abfb52cf92c8). Validates the checksum in the process.

Parameters

hex

string

The 64-character hexadecimal representation of the account identifier.

Returns

AccountIdentifier

An instance of AccountIdentifier.

Throws

If the length is not 32 bytes or if the checksum is invalid.

fromPrincipal()

static fromPrincipal(__namedParameters): AccountIdentifier

Defined in: packages/canisters/src/ledger/icp/account_identifier.ts:68

Creates an AccountIdentifier object from a principal and optional subaccount.

When no subaccount is provided, a 32-byte array of zeros is used by default. You can use any arbitrary 32 bytes as a subaccount identifier to derive a distinct account identifier for the same principal.

Parameters

__namedParameters

principal

Principal

subAccount?

SubAccount = ...

Returns

AccountIdentifier

An instance of AccountIdentifier.

---

AllowanceChangedError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:57

Extends

• ApproveError

Constructors

Constructor

new AllowanceChangedError(currentAllowance): AllowanceChangedError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:58

Parameters

currentAllowance

bigint

Returns

AllowanceChangedError

Overrides

ApproveError.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

ApproveError.cause

currentAllowance

readonly currentAllowance: bigint

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:58

message

message: string

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

Inherited from

ApproveError.message

name

name: string

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

Inherited from

ApproveError.name

stack?

optional stack: string

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

Inherited from

ApproveError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

ApproveError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ApproveError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

ApproveError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

ApproveError.prepareStackTrace

---

ApproveError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:7

Extends

• IcrcError

Extended by

• GenericError
• TemporarilyUnavailableError
• DuplicateError
• AllowanceChangedError
• CreatedInFutureError
• TooOldError
• ExpiredError

Constructors

Constructor

new ApproveError(message?): ApproveError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

Returns

ApproveError

Inherited from

IcrcError.constructor

Constructor

new ApproveError(message?, options?): ApproveError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

options?

ErrorOptions

Returns

ApproveError

Inherited from

IcrcError.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

IcrcError.cause

message

message: string

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

Inherited from

IcrcError.message

name

name: string

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

Inherited from

IcrcError.name

stack?

optional stack: string

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

Inherited from

IcrcError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

IcrcError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

IcrcError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

IcrcError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

IcrcError.prepareStackTrace

---

BadFeeError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:34

Extends

• IcrcError

Constructors

Constructor

new BadFeeError(expectedFee): BadFeeError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:35

Parameters

expectedFee

bigint

Returns

BadFeeError

Overrides

IcrcError.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

IcrcError.cause

expectedFee

readonly expectedFee: bigint

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:35

message

message: string

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

Inherited from

IcrcError.message

name

name: string

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

Inherited from

IcrcError.name

stack?

optional stack: string

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

Inherited from

IcrcError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

IcrcError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

IcrcError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

IcrcError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

IcrcError.prepareStackTrace

---

ConsentMessageError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:8

Extends

• IcrcError

Extended by

• InsufficientPaymentError
• UnsupportedCanisterCallError
• ConsentMessageUnavailableError

Constructors

Constructor

new ConsentMessageError(message?): ConsentMessageError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

Returns

ConsentMessageError

Inherited from

IcrcError.constructor

Constructor

new ConsentMessageError(message?, options?): ConsentMessageError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

options?

ErrorOptions

Returns

ConsentMessageError

Inherited from

IcrcError.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

IcrcError.cause

message

message: string

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

Inherited from

IcrcError.message

name

name: string

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

Inherited from

IcrcError.name

stack?

optional stack: string

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

Inherited from

IcrcError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

IcrcError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

IcrcError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

IcrcError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

IcrcError.prepareStackTrace

---

ConsentMessageUnavailableError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:74

Extends

• ConsentMessageError

Constructors

Constructor

new ConsentMessageUnavailableError(message?): ConsentMessageUnavailableError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

Returns

ConsentMessageUnavailableError

Inherited from

ConsentMessageError.constructor

Constructor

new ConsentMessageUnavailableError(message?, options?): ConsentMessageUnavailableError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

options?

ErrorOptions

Returns

ConsentMessageUnavailableError

Inherited from

ConsentMessageError.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

ConsentMessageError.cause

message

message: string

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

Inherited from

ConsentMessageError.message

name

name: string

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

Inherited from

ConsentMessageError.name

stack?

optional stack: string

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

Inherited from

ConsentMessageError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

ConsentMessageError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ConsentMessageError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

ConsentMessageError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

ConsentMessageError.prepareStackTrace

---

CreatedInFutureError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:63

Extends

• ApproveError

Constructors

Constructor

new CreatedInFutureError(message?): CreatedInFutureError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

Returns

CreatedInFutureError

Inherited from

ApproveError.constructor

Constructor

new CreatedInFutureError(message?, options?): CreatedInFutureError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

options?

ErrorOptions

Returns

CreatedInFutureError

Inherited from

ApproveError.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

ApproveError.cause

message

message: string

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

Inherited from

ApproveError.message

name

name: string

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

Inherited from

ApproveError.name

stack?

optional stack: string

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

Inherited from

ApproveError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

ApproveError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ApproveError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

ApproveError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

ApproveError.prepareStackTrace

---

DuplicateError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:51

Extends

• ApproveError

Constructors

Constructor

new DuplicateError(duplicateOf): DuplicateError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:52

Parameters

duplicateOf

bigint

Returns

DuplicateError

Overrides

ApproveError.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

ApproveError.cause

duplicateOf

readonly duplicateOf: bigint

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:52

message

message: string

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

Inherited from

ApproveError.message

name

name: string

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

Inherited from

ApproveError.name

stack?

optional stack: string

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

Inherited from

ApproveError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

ApproveError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ApproveError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

ApproveError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

ApproveError.prepareStackTrace

---

ExpiredError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:66

Extends

• ApproveError

Constructors

Constructor

new ExpiredError(ledgerTime): ExpiredError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:67

Parameters

ledgerTime

bigint

Returns

ExpiredError

Overrides

ApproveError.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

ApproveError.cause

ledgerTime

readonly ledgerTime: bigint

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:67

message

message: string

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

Inherited from

ApproveError.message

name

name: string

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

Inherited from

ApproveError.name

stack?

optional stack: string

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

Inherited from

ApproveError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

ApproveError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ApproveError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

ApproveError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

ApproveError.prepareStackTrace

---

GenericError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:40

Extends

• ApproveError

Constructors

Constructor

new GenericError(message, error_code): GenericError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:41

Parameters

message

string

error_code

bigint

Returns

GenericError

Overrides

ApproveError.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

ApproveError.cause

error_code

readonly error_code: bigint

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:43

message

readonly message: string

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:42

Inherited from

ApproveError.message

name

name: string

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

Inherited from

ApproveError.name

stack?

optional stack: string

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

Inherited from

ApproveError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

ApproveError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ApproveError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

ApproveError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

ApproveError.prepareStackTrace

---

IcpIndexCanister

Defined in: packages/canisters/src/ledger/icp/index.canister.ts:19

Extends

• Canister<_SERVICE>

Constructors

Constructor

protected new IcpIndexCanister(id, service, certifiedService): IcpIndexCanister

Defined in: packages/utils/dist/services/canister.d.ts:7

Parameters

id

Principal

service

_SERVICE

certifiedService

_SERVICE

Returns

IcpIndexCanister

Inherited from

Canister<IcpIndexService>.constructor

Properties

caller()

protected caller: (__namedParameters) => _SERVICE

Defined in: packages/utils/dist/services/canister.d.ts:9

Parameters

__namedParameters

QueryParams

Returns

_SERVICE

Inherited from

Canister.caller

certifiedService

protected readonly certifiedService: _SERVICE

Defined in: packages/utils/dist/services/canister.d.ts:6

Inherited from

Canister.certifiedService

service

protected readonly service: _SERVICE

Defined in: packages/utils/dist/services/canister.d.ts:5

Inherited from

Canister.service

Accessors

canisterId

Get Signature

get canisterId(): Principal

Defined in: packages/utils/dist/services/canister.d.ts:8

Returns

Principal

Inherited from

Canister.canisterId

Methods

accountBalance()

accountBalance(params): Promise<bigint>

Defined in: packages/canisters/src/ledger/icp/index.canister.ts:45

Returns the balance of the specified account identifier.

Parameters

params

AccountBalanceParams

The parameters to get the balance of an account.

Returns

Promise<bigint>

The balance of the given account.

getTransactions()

getTransactions(params): Promise<GetAccountIdentifierTransactionsResponse>

Defined in: packages/canisters/src/ledger/icp/index.canister.ts:64

Returns the transactions and balance of an ICP account.

Parameters

params

GetTransactionsParams

The parameters to get the transactions.

Returns

Promise<GetAccountIdentifierTransactionsResponse>

The transactions, balance and the transaction id of the oldest transaction the account has.

Throws

IndexError

create()

static create(__namedParameters): IcpIndexCanister

Defined in: packages/canisters/src/ledger/icp/index.canister.ts:20

Parameters

__namedParameters

CanisterOptions<_SERVICE>

Returns

IcpIndexCanister

---

IcpLedgerCanister

Defined in: packages/canisters/src/ledger/icp/ledger.canister.ts:33

Extends

• Canister<_SERVICE>

Constructors

Constructor

protected new IcpLedgerCanister(id, service, certifiedService): IcpLedgerCanister

Defined in: packages/utils/dist/services/canister.d.ts:7

Parameters

id

Principal

service

_SERVICE

certifiedService

_SERVICE

Returns

IcpLedgerCanister

Inherited from

Canister<IcpLedgerService>.constructor

Properties

caller()

protected caller: (__namedParameters) => _SERVICE

Defined in: packages/utils/dist/services/canister.d.ts:9

Parameters

__namedParameters

QueryParams

Returns

_SERVICE

Inherited from

Canister.caller

certifiedService

protected readonly certifiedService: _SERVICE

Defined in: packages/utils/dist/services/canister.d.ts:6

Inherited from

Canister.certifiedService

service

protected readonly service: _SERVICE

Defined in: packages/utils/dist/services/canister.d.ts:5

Inherited from

Canister.service

Accessors

canisterId

Get Signature

get canisterId(): Principal

Defined in: packages/utils/dist/services/canister.d.ts:8

Returns

Principal

Inherited from

Canister.canisterId

Methods

accountBalance()

accountBalance(params): Promise<bigint>

Defined in: packages/canisters/src/ledger/icp/ledger.canister.ts:62

Returns the balance of the specified account identifier.

If certified is true, the request is fetched as an update call, otherwise it is fetched using a query call.

Parameters

params

AccountBalanceParams

The parameters to get the balance of an account.

Returns

Promise<bigint>

The balance of the given account.

Throws

Error

icrc1Transfer()

icrc1Transfer(request): Promise<bigint>

Defined in: packages/canisters/src/ledger/icp/ledger.canister.ts:132

Transfer ICP from the caller to the destination Account. Returns the index of the block containing the tx if it was successful.

Parameters

request

Icrc1TransferRequest

Returns

Promise<bigint>

Throws

TransferError

icrc21ConsentMessage()

icrc21ConsentMessage(params): Promise<icrc21_consent_info>

Defined in: packages/canisters/src/ledger/icp/ledger.canister.ts:179

Fetches the consent message for a specified canister call, intended to provide a human-readable message that helps users make informed decisions.

@link: https://github.com/dfinity/wg-identity-authentication/blob/main/topics/ICRC-21/icrc_21_consent_msg.md

Parameters

params

Icrc21ConsentMessageRequest

The request parameters containing the method name, arguments, and consent preferences (e.g., language).

Returns

Promise<icrc21_consent_info>

• A promise that resolves to the consent message response, which includes the consent message in the specified language and other related information.

Throws

• This error is reserved for future use, in case payment extensions are introduced. For example, if consent messages, which are currently free, begin to require payments.

Throws

• If the specified canister call is not supported.

Throws

• If there is no consent message available.

Throws

• For any other generic errors.

icrc2Approve()

icrc2Approve(params): Promise<bigint>

Defined in: packages/canisters/src/ledger/icp/ledger.canister.ts:152

This method entitles the spender to transfer token amount on behalf of the caller from account { owner = caller; subaccount = from_subaccount }.

Reference: https://github.com/dfinity/ICRC-1/blob/main/standards/ICRC-2/index.md#icrc2_approve

Parameters

params

Icrc2ApproveRequest

The parameters to approve.

Returns

Promise<bigint>

The block index of the approved transaction.

Throws

If the approval fails.

metadata()

metadata(params): Promise<[string, Value][]>

Defined in: packages/canisters/src/ledger/icp/ledger.canister.ts:81

Fetches the ledger metadata.

Parameters

params

QueryParams

The parameters used to fetch the metadata, notably query or certified call.

Returns

Promise<[string, Value][]>

The metadata of the ICP ledger. A promise that resolves to an array of metadata entries, where each entry is a tuple consisting of a string and a value.

transactionFee()

transactionFee(params?): Promise<bigint>

Defined in: packages/canisters/src/ledger/icp/ledger.canister.ts:94

Returns the transaction fee of the ICP ledger canister.

Parameters

params?

QueryParams = ...

Optional query parameters for the request, defaulting to { certified: false } for backwards compatibility reason.

Returns

Promise<bigint>

A promise that resolves to the transaction fee as a bigint.

transfer()

transfer(request): Promise<bigint>

Defined in: packages/canisters/src/ledger/icp/ledger.canister.ts:112

Transfer ICP from the caller to the destination accountIdentifier. Returns the index of the block containing the tx if it was successful.

Parameters

request

TransferRequest

Returns

Promise<bigint>

Throws

TransferError

create()

static create(options): IcpLedgerCanister

Defined in: packages/canisters/src/ledger/icp/ledger.canister.ts:34

Parameters

options

IcpLedgerCanisterOptions = {}

Returns

IcpLedgerCanister

---

IcrcError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:4

Extends

• Error

Extended by

• TransferError
• ApproveError
• ConsentMessageError
• BadFeeError

Constructors

Constructor

new IcrcError(message?): IcrcError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

Returns

IcrcError

Inherited from

Error.constructor

Constructor

new IcrcError(message?, options?): IcrcError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

options?

ErrorOptions

Returns

IcrcError

Inherited from

Error.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

Error.cause

message

message: string

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

Inherited from

Error.message

name

name: string

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

Inherited from

Error.name

stack?

optional stack: string

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

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

Error.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace

---

InsufficientFundsError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:14

Extends

• TransferError

Constructors

Constructor

new InsufficientFundsError(balance): InsufficientFundsError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:15

Parameters

balance

bigint

Returns

InsufficientFundsError

Overrides

TransferError.constructor

Properties

balance

readonly balance: bigint

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:15

cause?

optional cause: unknown

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

Inherited from

TransferError.cause

message

message: string

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

Inherited from

TransferError.message

name

name: string

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

Inherited from

TransferError.name

stack?

optional stack: string

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

Inherited from

TransferError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

TransferError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

TransferError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

TransferError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

TransferError.prepareStackTrace

---

InsufficientPaymentError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:72

Extends

• ConsentMessageError

Constructors

Constructor

new InsufficientPaymentError(message?): InsufficientPaymentError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

Returns

InsufficientPaymentError

Inherited from

ConsentMessageError.constructor

Constructor

new InsufficientPaymentError(message?, options?): InsufficientPaymentError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

options?

ErrorOptions

Returns

InsufficientPaymentError

Inherited from

ConsentMessageError.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

ConsentMessageError.cause

message

message: string

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

Inherited from

ConsentMessageError.message

name

name: string

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

Inherited from

ConsentMessageError.name

stack?

optional stack: string

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

Inherited from

ConsentMessageError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

ConsentMessageError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ConsentMessageError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

ConsentMessageError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

ConsentMessageError.prepareStackTrace

---

InvalidAccountIDError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:12

Extends

• Error

Constructors

Constructor

new InvalidAccountIDError(message?): InvalidAccountIDError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

Returns

InvalidAccountIDError

Inherited from

Error.constructor

Constructor

new InvalidAccountIDError(message?, options?): InvalidAccountIDError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

options?

ErrorOptions

Returns

InvalidAccountIDError

Inherited from

Error.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

Error.cause

message

message: string

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

Inherited from

Error.message

name

name: string

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

Inherited from

Error.name

stack?

optional stack: string

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

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

Error.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace

---

InvalidSenderError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:10

Extends

• TransferError

Constructors

Constructor

new InvalidSenderError(message?): InvalidSenderError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

Returns

InvalidSenderError

Inherited from

TransferError.constructor

Constructor

new InvalidSenderError(message?, options?): InvalidSenderError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

options?

ErrorOptions

Returns

InvalidSenderError

Inherited from

TransferError.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

TransferError.cause

message

message: string

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

Inherited from

TransferError.message

name

name: string

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

Inherited from

TransferError.name

stack?

optional stack: string

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

Inherited from

TransferError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

TransferError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

TransferError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

TransferError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

TransferError.prepareStackTrace

---

SubAccount

Defined in: packages/canisters/src/ledger/icp/account_identifier.ts:140

A subaccount in the ICP ledger is a 32-byte identifier that allows a principal (user or canister) to control multiple independent accounts under the same principal.

See

https://internetcomputer.org/docs/references/ledger#_accounts

Methods

toUint8Array()

toUint8Array(): Uint8Array

Defined in: packages/canisters/src/ledger/icp/account_identifier.ts:218

Returns the raw 32-byte Uint8Array representing this subaccount.

Returns

Uint8Array

A 32-byte array.

fromBytes()

static fromBytes(bytes): SubAccount

Defined in: packages/canisters/src/ledger/icp/account_identifier.ts:150

Creates a SubAccount from a 32‑byte array.

Parameters

bytes

Uint8Array

A Uint8Array of exactly 32 bytes.

Returns

SubAccount

A SubAccount instance.

Throws

If the byte array length is not 32.

fromID()

static fromID(id): SubAccount

Defined in: packages/canisters/src/ledger/icp/account_identifier.ts:189

Generates a SubAccount from a non‑negative number.

The number is encoded into the last 8 bytes of the 32‑byte array. This is a common pattern when using numbered subaccounts like 0, 1, 2…

Parameters

id

number

A non-negative integer.

Returns

SubAccount

A SubAccount instance.

Throws

If the number is negative or exceeds Number.MAX_SAFE_INTEGER.

fromPrincipal()

static fromPrincipal(principal): SubAccount

Defined in: packages/canisters/src/ledger/icp/account_identifier.ts:166

Generates a SubAccount from a principal.

The principal is embedded into the beginning of a 32‑byte array.

Parameters

principal

Principal

A principal to encode into the subaccount.

Returns

SubAccount

A SubAccount instance.

---

TemporarilyUnavailableError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:49

Extends

• ApproveError

Constructors

Constructor

new TemporarilyUnavailableError(message?): TemporarilyUnavailableError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

Returns

TemporarilyUnavailableError

Inherited from

ApproveError.constructor

Constructor

new TemporarilyUnavailableError(message?, options?): TemporarilyUnavailableError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

options?

ErrorOptions

Returns

TemporarilyUnavailableError

Inherited from

ApproveError.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

ApproveError.cause

message

message: string

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

Inherited from

ApproveError.message

name

name: string

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

Inherited from

ApproveError.name

stack?

optional stack: string

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

Inherited from

ApproveError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

ApproveError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ApproveError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

ApproveError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

ApproveError.prepareStackTrace

---

TooOldError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:64

Extends

• ApproveError

Constructors

Constructor

new TooOldError(message?): TooOldError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

Returns

TooOldError

Inherited from

ApproveError.constructor

Constructor

new TooOldError(message?, options?): TooOldError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

options?

ErrorOptions

Returns

TooOldError

Inherited from

ApproveError.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

ApproveError.cause

message

message: string

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

Inherited from

ApproveError.message

name

name: string

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

Inherited from

ApproveError.name

stack?

optional stack: string

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

Inherited from

ApproveError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

ApproveError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ApproveError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

ApproveError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

ApproveError.prepareStackTrace

---

TransferError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:6

Extends

• IcrcError

Extended by

• InvalidSenderError
• InsufficientFundsError
• TxTooOldError
• TxCreatedInFutureError
• TxDuplicateError

Constructors

Constructor

new TransferError(message?): TransferError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

Returns

TransferError

Inherited from

IcrcError.constructor

Constructor

new TransferError(message?, options?): TransferError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

options?

ErrorOptions

Returns

TransferError

Inherited from

IcrcError.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

IcrcError.cause

message

message: string

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

Inherited from

IcrcError.message

name

name: string

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

Inherited from

IcrcError.name

stack?

optional stack: string

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

Inherited from

IcrcError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

IcrcError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

IcrcError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

IcrcError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

IcrcError.prepareStackTrace

---

TxCreatedInFutureError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:26

Extends

• TransferError

Constructors

Constructor

new TxCreatedInFutureError(message?): TxCreatedInFutureError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

Returns

TxCreatedInFutureError

Inherited from

TransferError.constructor

Constructor

new TxCreatedInFutureError(message?, options?): TxCreatedInFutureError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

options?

ErrorOptions

Returns

TxCreatedInFutureError

Inherited from

TransferError.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

TransferError.cause

message

message: string

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

Inherited from

TransferError.message

name

name: string

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

Inherited from

TransferError.name

stack?

optional stack: string

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

Inherited from

TransferError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

TransferError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

TransferError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

TransferError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

TransferError.prepareStackTrace

---

TxDuplicateError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:28

Extends

• TransferError

Constructors

Constructor

new TxDuplicateError(duplicateOf): TxDuplicateError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:29

Parameters

duplicateOf

bigint

Returns

TxDuplicateError

Overrides

TransferError.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

TransferError.cause

duplicateOf

readonly duplicateOf: bigint

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:29

message

message: string

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

Inherited from

TransferError.message

name

name: string

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

Inherited from

TransferError.name

stack?

optional stack: string

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

Inherited from

TransferError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

TransferError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

TransferError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

TransferError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

TransferError.prepareStackTrace

---

TxTooOldError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:20

Extends

• TransferError

Constructors

Constructor

new TxTooOldError(allowed_window_secs?): TxTooOldError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:21

Parameters

allowed_window_secs?

number

Returns

TxTooOldError

Overrides

TransferError.constructor

Properties

allowed_window_secs?

readonly optional allowed_window_secs: number

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:21

cause?

optional cause: unknown

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

Inherited from

TransferError.cause

message

message: string

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

Inherited from

TransferError.message

name

name: string

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

Inherited from

TransferError.name

stack?

optional stack: string

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

Inherited from

TransferError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

TransferError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

TransferError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

TransferError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

TransferError.prepareStackTrace

---

UnsupportedCanisterCallError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:73

Extends

• ConsentMessageError

Constructors

Constructor

new UnsupportedCanisterCallError(message?): UnsupportedCanisterCallError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

Returns

UnsupportedCanisterCallError

Inherited from

ConsentMessageError.constructor

Constructor

new UnsupportedCanisterCallError(message?, options?): UnsupportedCanisterCallError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

options?

ErrorOptions

Returns

UnsupportedCanisterCallError

Inherited from

ConsentMessageError.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

ConsentMessageError.cause

message

message: string

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

Inherited from

ConsentMessageError.message

name

name: string

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

Inherited from

ConsentMessageError.name

stack?

optional stack: string

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

Inherited from

ConsentMessageError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

ConsentMessageError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ConsentMessageError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

ConsentMessageError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

ConsentMessageError.prepareStackTrace

Interfaces

Icrc1TransferRequest

Defined in: packages/canisters/src/ledger/icp/types/ledger_converters.ts:23

Properties

amount

amount: bigint

Defined in: packages/canisters/src/ledger/icp/types/ledger_converters.ts:25

createdAt?

optional createdAt: bigint

Defined in: packages/canisters/src/ledger/icp/types/ledger_converters.ts:32

fee?

optional fee: bigint

Defined in: packages/canisters/src/ledger/icp/types/ledger_converters.ts:27

fromSubAccount?

optional fromSubAccount: SubAccount

Defined in: packages/canisters/src/ledger/icp/types/ledger_converters.ts:28

icrc1Memo?

optional icrc1Memo: Uint8Array<ArrayBufferLike>

Defined in: packages/canisters/src/ledger/icp/types/ledger_converters.ts:26

to

to: Account

Defined in: packages/canisters/src/ledger/icp/types/ledger_converters.ts:24

---

TransferRequest

Defined in: packages/canisters/src/ledger/icp/types/ledger_converters.ts:5

Properties

amount

amount: bigint

Defined in: packages/canisters/src/ledger/icp/types/ledger_converters.ts:7

createdAt?

optional createdAt: bigint

Defined in: packages/canisters/src/ledger/icp/types/ledger_converters.ts:15

fee?

optional fee: bigint

Defined in: packages/canisters/src/ledger/icp/types/ledger_converters.ts:9

fromSubAccount?

optional fromSubAccount: number[]

Defined in: packages/canisters/src/ledger/icp/types/ledger_converters.ts:11

memo?

optional memo: bigint

Defined in: packages/canisters/src/ledger/icp/types/ledger_converters.ts:8

to

to: AccountIdentifier

Defined in: packages/canisters/src/ledger/icp/types/ledger_converters.ts:6

Type Aliases

AccountIdentifierHex

AccountIdentifierHex = string

Defined in: packages/canisters/src/ledger/icp/types/common.ts:1

---

BlockHeight

BlockHeight = bigint

Defined in: packages/canisters/src/ledger/icp/types/common.ts:2

---

E8s

E8s = bigint

Defined in: packages/canisters/src/ledger/icp/types/common.ts:3

---

IcpLedgerCanisterOptions

IcpLedgerCanisterOptions = CanisterOptions<_SERVICE>

Defined in: packages/canisters/src/ledger/icp/types/ledger.options.ts:4

---

Icrc2ApproveRequest

Icrc2ApproveRequest = Omit<Icrc1TransferRequest, "to"> & object

Defined in: packages/canisters/src/ledger/icp/types/ledger_converters.ts:47

Params for an icrc2_approve.

Type Declaration

expected_allowance?

optional expected_allowance: Icrc1Tokens

expires_at?

optional expires_at: Icrc1Timestamp

spender

spender: Account

Param

The account of the spender.

Param

The amount of tokens to approve.

Param

The subaccount to transfer tokens from.

Param

Approve memo.

Param

nanoseconds since unix epoc to trigger deduplication and avoid other issues

Param

The fee of the transfer when it’s not the default fee.

Param

The optional allowance expected. If the expected_allowance field is set, the ledger MUST ensure that the current allowance for the spender from the caller’s account is equal to the given value and return the AllowanceChanged error otherwise.

Param

When the approval expires. If the field is set, it’s greater than the current ledger time.

Functions

checkAccountId()

checkAccountId(accountId): void

Defined in: packages/canisters/src/ledger/icp/utils/accounts.utils.ts:15

Checks account id check sum

Parameters

accountId

string

Returns

void

Throws

InvalidAccountIDError

---

isIcpAccountIdentifier()

isIcpAccountIdentifier(address): boolean

Defined in: packages/canisters/src/ledger/icp/utils/accounts.utils.ts:41

Checks if a given string (or undefined) is a valid ICP account identifier.

It uses the checkAccountId function to validate the checksum, but it does not throw an error.

Parameters

address

The putative ICP account identifier.

string | undefined

Returns

boolean

---

mapIcrc1TransferError()

mapIcrc1TransferError(rawTransferError): TransferError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:104

Parameters

rawTransferError

Icrc1TransferError

Returns

TransferError

---

mapIcrc21ConsentMessageError()

mapIcrc21ConsentMessageError(rawError): ConsentMessageError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:187

Parameters

rawError

icrc21_error

Returns

ConsentMessageError

---

mapIcrc2ApproveError()

mapIcrc2ApproveError(rawApproveError): ApproveError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:130

Parameters

rawApproveError

ApproveError

Returns

ApproveError

---

mapTransferError()

mapTransferError(rawTransferError): TransferError

Defined in: packages/canisters/src/ledger/icp/errors/ledger.errors.ts:76

Parameters

rawTransferError

TransferError

Returns

TransferError

---

toIcrc1TransferRawRequest()

toIcrc1TransferRawRequest(__namedParameters): TransferArg

Defined in: packages/canisters/src/ledger/icp/canisters/ledger/ledger.request.converts.ts:43

Parameters

__namedParameters

Icrc1TransferRequest

Returns

TransferArg

---

toIcrc21ConsentMessageRawRequest()

toIcrc21ConsentMessageRawRequest(__namedParameters): icrc21_consent_message_request

Defined in: packages/canisters/src/ledger/icp/canisters/ledger/ledger.request.converts.ts:79

Parameters

__namedParameters

Icrc21ConsentMessageRequest

Returns

icrc21_consent_message_request

---

toIcrc2ApproveRawRequest()

toIcrc2ApproveRawRequest(__namedParameters): ApproveArgs

Defined in: packages/canisters/src/ledger/icp/canisters/ledger/ledger.request.converts.ts:59

Parameters

__namedParameters

Icrc2ApproveRequest

Returns

ApproveArgs

---

toTransferRawRequest()

toTransferRawRequest(__namedParameters): TransferArgs

Defined in: packages/canisters/src/ledger/icp/canisters/ledger/ledger.request.converts.ts:17

Parameters

__namedParameters

TransferRequest

Returns

TransferArgs