LedgerCanister

Defined in: packages/ledger-icp/src/ledger.canister.ts:35

Extends

Canister<LedgerService>

Constructors

Constructor

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

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

Parameters

id

Principal

service

_SERVICE

certifiedService

_SERVICE

Returns

LedgerCanister

Inherited from

Canister<LedgerService>.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/ledger-icp/src/ledger.canister.ts:64

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/ledger-icp/src/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/ledger-icp/src/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/ledger-icp/src/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/ledger-icp/src/ledger.canister.ts:83

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.