Overview

Namespaces

Enumerations

IcrcMetadataResponseEntries

Defined in: packages/canisters/src/ledger/icrc/types/ledger.responses.ts:5

Enumeration Members

DECIMALS

DECIMALS: "icrc1:decimals"

Defined in: packages/canisters/src/ledger/icrc/types/ledger.responses.ts:8

FEE

FEE: "icrc1:fee"

Defined in: packages/canisters/src/ledger/icrc/types/ledger.responses.ts:9

LOGO

LOGO: "icrc1:logo"

Defined in: packages/canisters/src/ledger/icrc/types/ledger.responses.ts:10

NAME

NAME: "icrc1:name"

Defined in: packages/canisters/src/ledger/icrc/types/ledger.responses.ts:7

SYMBOL

SYMBOL: "icrc1:symbol"

Defined in: packages/canisters/src/ledger/icrc/types/ledger.responses.ts:6

Classes

ConsentMessageError

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

Extends

Error

Constructors

Constructor

new ConsentMessageError(message?): ConsentMessageError

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

Parameters

message?

string

Returns

ConsentMessageError

Inherited from

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

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

ConsentMessageUnavailableError

Defined in: packages/canisters/src/ledger/icrc/errors/ledger.errors.ts:24

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

Extends

Error

Constructors

Constructor

new GenericError(message, error_code): GenericError

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

Parameters

message

string

error_code

bigint

Returns

GenericError

Overrides

Error.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

Error.cause

error_code

readonly error_code: bigint

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

message

readonly message: string

Defined in: packages/canisters/src/ledger/icrc/errors/ledger.errors.ts:13

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

IcrcIndexCanister

Defined in: packages/canisters/src/ledger/icrc/index.canister.ts:21

Extends

IcrcCanister<_SERVICE>

Constructors

Constructor

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

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

Parameters

id

Principal

service

_SERVICE

certifiedService

_SERVICE

Returns

IcrcIndexCanister

Inherited from

IcrcCanister<IcrcIndexService>.constructor

Properties

caller()

protected caller: (__namedParameters) => _SERVICE

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

Parameters

__namedParameters

QueryParams

Returns

_SERVICE

Inherited from

IcrcCanister.caller

certifiedService

protected readonly certifiedService: _SERVICE

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

Inherited from

IcrcCanister.certifiedService

service

protected readonly service: _SERVICE

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

Inherited from

IcrcCanister.service

Accessors

canisterId

Get Signature

get canisterId(): Principal

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

Returns

Principal

Inherited from

IcrcCanister.canisterId

Methods

balance()

balance(params): Promise<bigint>

Defined in: packages/canisters/src/ledger/icrc/canister.ts:15

Returns the balance for a given account provided as owner and with optional subaccount.

Parameters

params

BalanceParams

The parameters to get the balance of an account.

Returns

Promise<bigint>

The balance of the given account.

Inherited from

IcrcCanister.balance

getTransactions()

getTransactions(params): Promise<GetTransactions>

Defined in: packages/canisters/src/ledger/icrc/index.canister.ts:47

Get the transactions of an account.

Parameters

params

GetIndexAccountTransactionsParams

The parameters to get the transactions of an account.

Returns

Promise<GetTransactions>

The list of transactions and further related information of the given account.

ledgerId()

ledgerId(params): Promise<Principal>

Defined in: packages/canisters/src/ledger/icrc/index.canister.ts:65

Returns the ledger canister ID related to the index canister.

Parameters

params

QueryParams

Returns

Promise<Principal>

listSubaccounts()

listSubaccounts(params): Promise<SubAccount[]>

Defined in: packages/canisters/src/ledger/icrc/index.canister.ts:85

Returns the list of subaccounts for a given owner.

Parameters

params

ListSubaccountsParams

The parameters to get the list of subaccounts.

Returns

Promise<SubAccount[]>

The list of subaccounts.

status()

status(params): Promise<Status>

Defined in: packages/canisters/src/ledger/icrc/index.canister.ts:76

Returns the status of the index canister.

Parameters

params

QueryParams

The parameters to get the status of the index canister.

Returns

Promise<Status>

The status of the index canister.

create()

static create(options): IcrcIndexCanister

Defined in: packages/canisters/src/ledger/icrc/index.canister.ts:22

Parameters

options

IcrcLedgerCanisterOptions<_SERVICE>

Returns

IcrcIndexCanister

IcrcLedgerCanister

Defined in: packages/canisters/src/ledger/icrc/ledger.canister.ts:36

Extends

IcrcCanister<_SERVICE>

Constructors

Constructor

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

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

Parameters

id

Principal

service

_SERVICE

certifiedService

_SERVICE

Returns

IcrcLedgerCanister

Inherited from

IcrcCanister<IcrcLedgerService>.constructor

Properties

caller()

protected caller: (__namedParameters) => _SERVICE

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

Parameters

__namedParameters

QueryParams

Returns

_SERVICE

Inherited from

IcrcCanister.caller

certifiedService

protected readonly certifiedService: _SERVICE

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

Inherited from

IcrcCanister.certifiedService

service

protected readonly service: _SERVICE

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

Inherited from

IcrcCanister.service

Accessors

canisterId

Get Signature

get canisterId(): Principal

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

Returns

Principal

Inherited from

IcrcCanister.canisterId

Methods

allowance()

allowance(params): Promise<Allowance>

Defined in: packages/canisters/src/ledger/icrc/ledger.canister.ts:147

Returns the token allowance that the spender account can transfer from the specified account, and the expiration time for that allowance, if any.

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

Parameters

params

AllowanceParams

The parameters to call the allowance.

Returns

Promise<Allowance>

The token allowance. If there is no active approval, the ledger MUST return { allowance = 0; expires_at = null }.

approve()

approve(params): Promise<bigint>

Defined in: packages/canisters/src/ledger/icrc/ledger.canister.ts:123

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

ApproveParams

The parameters to approve.

Returns

Promise<bigint>

Throws

If the approval fails.

balance()

balance(params): Promise<bigint>

Defined in: packages/canisters/src/ledger/icrc/canister.ts:15

Returns the balance for a given account provided as owner and with optional subaccount.

Parameters

params

BalanceParams

The parameters to get the balance of an account.

Returns

Promise<bigint>

The balance of the given account.

Inherited from

IcrcCanister.balance

consentMessage()

consentMessage(params): Promise<icrc21_consent_info>

Defined in: packages/canisters/src/ledger/icrc/ledger.canister.ts:165

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

Icrc21ConsentMessageParams

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.

getBlocks()

getBlocks(params): Promise<GetBlocksResult>

Defined in: packages/canisters/src/ledger/icrc/ledger.canister.ts:189

Fetches the blocks information from the ledger canister,

Parameters

params

GetBlocksParams

The parameters to get the blocks.

Returns

Promise<GetBlocksResult>

The list of blocks.

getIndexPrincipal()

getIndexPrincipal(params): Promise<Principal>

Defined in: packages/canisters/src/ledger/icrc/ledger.canister.ts:204

Returns the principal of the index canister for the ledger, if one was defined as such.

@link: https://github.com/dfinity/ICRC/blob/main/ICRCs/ICRC-106/ICRC-106.md

Parameters

params

QueryParams

Returns

Promise<Principal>

The principal of the index canister.

Throws

For any errors that occur while fetching the index principal.

Throws

If the index principal was not set for the ledger canister.

getMintingAccount()

getMintingAccount(params): Promise<Nullable<Account>>

Defined in: packages/canisters/src/ledger/icrc/ledger.canister.ts:247

Returns the minting account of the Ledger canister.

@link: https://github.com/dfinity/ICRC-1/blob/main/standards/ICRC-1/index.md#icrc1_minting_account

Parameters

params

QueryParams

Returns

Promise<Nullable<Account>>

The minting account as a Nullable object.

icrc10SupportedStandards()

icrc10SupportedStandards(params): Promise<object[]>

Defined in: packages/canisters/src/ledger/icrc/ledger.canister.ts:235

Returns the list of standards this ledger supports by using icrc10_supported_standards.

@link: https://github.com/dfinity/ICRC/blob/main/ICRCs/ICRC-10/ICRC-10.md#icrc10_supported_standards

Parameters

params

QueryParams

Returns

Promise<object[]>

The list of standards.

icrc1SupportedStandards()

icrc1SupportedStandards(params): Promise<StandardRecord[]>

Defined in: packages/canisters/src/ledger/icrc/ledger.canister.ts:223

Returns the list of standards this ledger supports by using icrc1_supported_standards.

@link: https://github.com/dfinity/ICRC-1/blob/main/standards/ICRC-1/index.md#icrc1_supported_standards

Parameters

params

QueryParams

Returns

Promise<StandardRecord[]>

The list of standards.

metadata()

metadata(params): Promise<IcrcTokenMetadataResponse>

Defined in: packages/canisters/src/ledger/icrc/ledger.canister.ts:51

The token metadata (name, symbol, etc.).

Parameters

params

QueryParams

Returns

Promise<IcrcTokenMetadataResponse>

totalTokensSupply()

totalTokensSupply(params): Promise<bigint>

Defined in: packages/canisters/src/ledger/icrc/ledger.canister.ts:87

Returns the total supply of tokens.

Parameters

params

QueryParams

Returns

Promise<bigint>

transactionFee()

transactionFee(params): Promise<bigint>

Defined in: packages/canisters/src/ledger/icrc/ledger.canister.ts:59

The ledger transaction fees.

Parameters

params

QueryParams

Returns

Promise<bigint>

The ledger transaction fees in Tokens

transfer()

transfer(params): Promise<bigint>

Defined in: packages/canisters/src/ledger/icrc/ledger.canister.ts:69

Transfers tokens from the sender to the given account.

Parameters

params

TransferParams

The parameters to transfer tokens.

Returns

Promise<bigint>

Throws

If the transfer fails.

transferFrom()

transferFrom(params): Promise<bigint>

Defined in: packages/canisters/src/ledger/icrc/ledger.canister.ts:99

Transfers a token amount from the from account to the to account using the allowance of the spender’s account (SpenderAccount = { owner = caller; subaccount = spender_subaccount }). The ledger draws the fees from the from account.

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

Parameters

params

TransferFromParams

The parameters to transfer tokens from to.

Returns

Promise<bigint>

Throws

If the transfer from fails.

create()

static create(options): IcrcLedgerCanister

Defined in: packages/canisters/src/ledger/icrc/ledger.canister.ts:37

Parameters

options

IcrcLedgerCanisterOptions<_SERVICE>

Returns

IcrcLedgerCanister

IcrcNftLedgerCanister

Defined in: packages/canisters/src/ledger/icrc/nft-ledger.canister.ts:10

Extends

Canister<_SERVICE>

Constructors

Constructor

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

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

Parameters

id

Principal

service

_SERVICE

certifiedService

_SERVICE

Returns

IcrcNftLedgerCanister

Inherited from

Canister<IcrcNftLedgerService>.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

collectionMetadata()

collectionMetadata(params): Promise<IcrcTokenMetadataResponse>

Defined in: packages/canisters/src/ledger/icrc/nft-ledger.canister.ts:30

The collection metadata.

Parameters

params

QueryParams

The parameters to get the metadata of the collection.

Returns

Promise<IcrcTokenMetadataResponse>

The metadata as a list of metadata type and its value.

Link

https://github.com/dfinity/ICRC/blob/main/ICRCs/ICRC-7/ICRC-7.md#icrc7_collection_metadata

create()

static create(options): IcrcNftLedgerCanister

Defined in: packages/canisters/src/ledger/icrc/nft-ledger.canister.ts:11

Parameters

options

IcrcLedgerCanisterOptions<_SERVICE>

Returns

IcrcNftLedgerCanister

IcrcTransferError

Defined in: packages/canisters/src/ledger/icrc/errors/ledger.errors.ts:3

Extends

Error

Type Parameters

T

T

Constructors

Constructor

new IcrcTransferError<T>(__namedParameters): IcrcTransferError<T>

Defined in: packages/canisters/src/ledger/icrc/errors/ledger.errors.ts:5

Parameters

__namedParameters

errorType

T

msg?

string

Returns

IcrcTransferError<T>

Overrides

Error.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

Error.cause

errorType

errorType: T

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

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

IndexError

Defined in: packages/canisters/src/ledger/icrc/errors/index.errors.ts:1

Extends

Error

Constructors

Constructor

new IndexError(message?): IndexError

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

Parameters

message?

string

Returns

IndexError

Inherited from

Error.constructor

Constructor

new IndexError(message?, options?): IndexError

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

Parameters

message?

string

options?

ErrorOptions

Returns

IndexError

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

IndexPrincipalNotSetError

Defined in: packages/canisters/src/ledger/icrc/errors/ledger.errors.ts:59

Extends

Error

Constructors

Constructor

new IndexPrincipalNotSetError(message?): IndexPrincipalNotSetError

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

Parameters

message?

string

Returns

IndexPrincipalNotSetError

Inherited from

Error.constructor

Constructor

new IndexPrincipalNotSetError(message?, options?): IndexPrincipalNotSetError

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

Parameters

message?

string

options?

ErrorOptions

Returns

IndexPrincipalNotSetError

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

InsufficientPaymentError

Defined in: packages/canisters/src/ledger/icrc/errors/ledger.errors.ts:22

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

UnsupportedCanisterCallError

Defined in: packages/canisters/src/ledger/icrc/errors/ledger.errors.ts:23

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

Icrc21ConsentMessageMetadata

Defined in: packages/canisters/src/ledger/icrc/types/ledger.params.ts:80

Metadata for the consent message in ICRC-21 specification.

Param

The user’s local timezone offset in minutes from UTC. If absent, the default is UTC.

Param

BCP-47 language tag. See https://www.rfc-editor.org/rfc/bcp/bcp47.txt

Properties

language

language: string

Defined in: packages/canisters/src/ledger/icrc/types/ledger.params.ts:82

utcOffsetMinutes?

optional utcOffsetMinutes: number

Defined in: packages/canisters/src/ledger/icrc/types/ledger.params.ts:81

Icrc21ConsentMessageSpec

Defined in: packages/canisters/src/ledger/icrc/types/ledger.params.ts:103

Specification for the consent message, including metadata and device preferences.

Param

Metadata of the consent message.

Param

Information about the device responsible for presenting the consent message to the user.

Properties

deriveSpec?

optional deriveSpec: Icrc21ConsentMessageDeviceSpec

Defined in: packages/canisters/src/ledger/icrc/types/ledger.params.ts:105

metadata

metadata: Icrc21ConsentMessageMetadata

Defined in: packages/canisters/src/ledger/icrc/types/ledger.params.ts:104

IcrcAccount

Defined in: packages/canisters/src/ledger/icrc/types/ledger.responses.ts:18

Properties

owner

owner: Principal

Defined in: packages/canisters/src/ledger/icrc/types/ledger.responses.ts:19

subaccount?

optional subaccount: Subaccount

Defined in: packages/canisters/src/ledger/icrc/types/ledger.responses.ts:20

IcrcLedgerCanisterOptions

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

Extends

Omit<CanisterOptions<T>, "canisterId">

Type Parameters

T

T

Properties

agent?

optional agent: Agent

Defined in: packages/utils/dist/types/canister.options.d.ts:4

Inherited from

NnsGovernanceCanisterOptions.agent

canisterId

canisterId: Principal

Defined in: packages/canisters/src/ledger/icrc/types/canister.options.ts:9

certifiedServiceOverride?

optional certifiedServiceOverride: ActorSubclass<T>

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

Inherited from

Omit.certifiedServiceOverride

serviceOverride?

optional serviceOverride: ActorSubclass<T>

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

Inherited from

Omit.serviceOverride

IcrcTokenMetadata

Defined in: packages/canisters/src/ledger/icrc/types/ledger.responses.ts:23

Properties

decimals

decimals: number

Defined in: packages/canisters/src/ledger/icrc/types/ledger.responses.ts:27

fee

fee: bigint

Defined in: packages/canisters/src/ledger/icrc/types/ledger.responses.ts:26

icon?

optional icon: string

Defined in: packages/canisters/src/ledger/icrc/types/ledger.responses.ts:28

name

name: string

Defined in: packages/canisters/src/ledger/icrc/types/ledger.responses.ts:24

symbol

symbol: string

Defined in: packages/canisters/src/ledger/icrc/types/ledger.responses.ts:25

TransferParams

Defined in: packages/canisters/src/ledger/icrc/types/ledger.params.ts:27

Params to make a transfer in an ICRC-1 ledger

Param

The account to transfer tokens to.

Param

The Amount of tokens to transfer.

Param

The subaccount to transfer tokens to.

Param

Transfer memo.

Param

nanoseconds since unix epoc to trigger deduplication and avoid other issues See the link for more details on deduplication https://github.com/dfinity/ICRC-1/blob/main/standards/ICRC-1/index.md#transaction_deduplication

Param

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

Properties

amount

amount: bigint

Defined in: packages/canisters/src/ledger/icrc/types/ledger.params.ts:33

created_at_time?

optional created_at_time: bigint

Defined in: packages/canisters/src/ledger/icrc/types/ledger.params.ts:32

fee?

optional fee: bigint

Defined in: packages/canisters/src/ledger/icrc/types/ledger.params.ts:29

from_subaccount?

optional from_subaccount: Subaccount

Defined in: packages/canisters/src/ledger/icrc/types/ledger.params.ts:31

memo?

optional memo: Uint8Array<ArrayBufferLike>

Defined in: packages/canisters/src/ledger/icrc/types/ledger.params.ts:30

to

to: Account

Defined in: packages/canisters/src/ledger/icrc/types/ledger.params.ts:28

Type Aliases

AllowanceParams

AllowanceParams = AllowanceArgs & QueryParams

Defined in: packages/canisters/src/ledger/icrc/types/ledger.params.ts:73

Params to get the token allowance that the spender account can transfer from the specified account

ApproveParams

ApproveParams = Omit<TransferParams, "to"> & object

Defined in: packages/canisters/src/ledger/icrc/types/ledger.params.ts:64

Params for an icrc2_approve.

Type Declaration

expected_allowance?

optional expected_allowance: Tokens

expires_at?

optional expires_at: Timestamp

spender

spender: Account

Param

The account of the spender.

Param

The Amount of tokens to approve.

Param

The subaccount to transfer tokens from.

Param

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

BalanceParams

BalanceParams = IcrcAccount & QueryParams

Defined in: packages/canisters/src/ledger/icrc/types/ledger.params.ts:8

Params to get the balance of an ICRC-1 account.

GetBlocksParams

GetBlocksParams = QueryParams & object

Defined in: packages/canisters/src/ledger/icrc/types/ledger.params.ts:125

Parameters to get the canister blocks.

Type Declaration

args

args: GetBlocksArgs[]

GetIndexAccountTransactionsParams

GetIndexAccountTransactionsParams = object & QueryParams

Defined in: packages/canisters/src/ledger/icrc/types/index-ng.params.ts:5

Type Declaration

account

account: IcrcAccount

max_results

max_results: bigint

start?

optional start: BlockIndex

Icrc21ConsentMessageDeviceSpec

Icrc21ConsentMessageDeviceSpec = { GenericDisplay: null; } | { FieldsDisplay: null; }

Defined in: packages/canisters/src/ledger/icrc/types/ledger.params.ts:91

Device specification for displaying the consent message.

Param

A generic display able to handle large documents and do line wrapping and pagination / scrolling. Text must be Markdown formatted, no external resources (e.g. images) are allowed.

Param

A simple display able to handle multiple fields with a title and content.

Icrc21ConsentMessageParams

Icrc21ConsentMessageParams = Omit<icrc21_consent_message_request, "user_preferences"> & object

Defined in: packages/canisters/src/ledger/icrc/types/ledger.params.ts:115

Parameters for the consent message request.

Type Declaration

userPreferences

userPreferences: Icrc21ConsentMessageSpec

Param

Method name of the canister call.

Param

Argument of the canister call.

Param

User preferences with regards to the consent message presented to the end-user.

IcrcTokenMetadataResponse

IcrcTokenMetadataResponse = [string | IcrcMetadataResponseEntries, Value][]

Defined in: packages/canisters/src/ledger/icrc/types/ledger.responses.ts:13

ListSubaccountsParams

ListSubaccountsParams = object & Pick<IcrcAccount, "owner"> & QueryParams

Defined in: packages/canisters/src/ledger/icrc/types/index-ng.params.ts:11

Type Declaration

start?

optional start: Subaccount

TransferFromParams

TransferFromParams = Omit<TransferParams, "from_subaccount"> & object

Defined in: packages/canisters/src/ledger/icrc/types/ledger.params.ts:47

Params for an icrc2_transfer_from.

Type Declaration

from

from: Account

spender_subaccount?

optional spender_subaccount: Subaccount

Param

The account to transfer tokens to.

Param

The account to transfer tokens from.

Param

A spender subaccount.

Param

The Amount of tokens to transfer.

Param

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

Functions

decodeIcrcAccount()

decodeIcrcAccount(accountString): IcrcAccount

Defined in: packages/canisters/src/ledger/icrc/utils/ledger.utils.ts:67

Decodes a string into an Icrc-1 compatible account. Formatting Reference: https://github.com/dfinity/ICRC-1/blob/main/standards/ICRC-1/TextualEncoding.md

Parameters

accountString

string

string

Returns

IcrcAccount

IcrcAccount { owner: Principal, subaccount?: Uint8Array }

Throws

Error if the string is not a valid Icrc-1 account

decodePayment()

decodePayment(code): { amount?: number; identifier: string; token: string; } | undefined

Defined in: packages/canisters/src/ledger/icrc/utils/payment.utils.ts:26

👀 This feature is currently in draft. You can find more information about it at https://github.com/dfinity/ICRC/issues/22.

A naive implementation of a payment parser. Given a code, the function attempts to extract a token name, account identifier (textual representation), and an optional amount.

If the code doesn’t match the expected pattern, undefined is returned for simplicity. Similarly, if an optional amount is provided but it’s not a valid number, the parser will not throw an exception and returns undefined.

Please note that this function doesn’t perform any validity checks on the extracted information. It does not verify if the token is known or if the identifier is a valid address.

urn            = token ":" address [ "?" params]
token         = [ ckbtc / icp / chat / bitcoin / ethereum ... ]
address       = STRING
params        = param [ "&" params ]
param         = [ amountparam ]
amountparam   = "amount=" *digit [ "." *digit ]

Parameters

code

string

string

Returns

{ amount?: number; identifier: string; token: string; } | undefined

| undefined

encodeIcrcAccount()

encodeIcrcAccount(account): string

Defined in: packages/canisters/src/ledger/icrc/utils/ledger.utils.ts:27

Encodes an Icrc-1 account compatible into a string. Formatting Reference: https://github.com/dfinity/ICRC-1/blob/main/standards/ICRC-1/TextualEncoding.md

Parameters

account

IcrcAccount

{ owner: Principal, subaccount?: Uint8Array }

Returns

string

string

fromCandidAccount()

fromCandidAccount(-): IcrcAccount

Defined in: packages/canisters/src/ledger/icrc/converters/converters.ts:11

Converts a Candid Account object to an IcrcAccount, effectively transforming nullable properties into nullish ones.

Parameters

-

Account

The Candid Account object to convert.

Returns

IcrcAccount

The converted IcrcAccount object.

mapIcrc106GetIndexPrincipalError()

mapIcrc106GetIndexPrincipalError(err): GenericError | IndexPrincipalNotSetError

Defined in: packages/canisters/src/ledger/icrc/errors/ledger.errors.ts:61

Parameters

err

GetIndexPrincipalError

Returns

GenericError | IndexPrincipalNotSetError

mapIcrc21ConsentMessageError()

mapIcrc21ConsentMessageError(rawError): ConsentMessageError

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

Parameters

rawError

icrc21_error

Returns

ConsentMessageError

mapTokenMetadata()

mapTokenMetadata(response): IcrcTokenMetadata | undefined

Defined in: packages/canisters/src/ledger/icrc/utils/ledger.utils.ts:118

Maps the token metadata information from a ledger response into a structured record.

This utility processes an array of metadata key-value pairs provided by the ledger and extracts specific fields, such as symbol, name, fee, decimals, and logo. It then constructs a IcrcTokenMetadata record. If any required fields are missing, the function returns undefined.