Skip to content

IcrcLedgerDid

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:553

archives: ActorMethod<[], ArchiveInfo[]>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:554

get_blocks: ActorMethod<[GetBlocksArgs], GetBlocksResponse>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:555

get_data_certificate: ActorMethod<[], DataCertificate>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:556

get_transactions: ActorMethod<[GetTransactionsRequest], GetTransactionsResponse>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:557

icrc1_balance_of: ActorMethod<[Account], bigint>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:570

icrc1_decimals: ActorMethod<[], number>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:571

icrc1_fee: ActorMethod<[], bigint>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:572

icrc1_metadata: ActorMethod<[], [string, MetadataValue][]>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:573

icrc1_minting_account: ActorMethod<[], [] | [Account]>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:574

icrc1_name: ActorMethod<[], string>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:575

icrc1_supported_standards: ActorMethod<[], StandardRecord[]>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:576

icrc1_symbol: ActorMethod<[], string>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:577

icrc1_total_supply: ActorMethod<[], bigint>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:578

icrc1_transfer: ActorMethod<[TransferArg], TransferResult>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:579

icrc10_supported_standards: ActorMethod<[], object[]>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:566

icrc103_get_allowances: ActorMethod<[GetAllowancesArgs], icrc103_get_allowances_response>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:561

icrc106_get_index_principal: ActorMethod<[], GetIndexPrincipalResult>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:565

icrc2_allowance: ActorMethod<[AllowanceArgs], Allowance>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:584

icrc2_approve: ActorMethod<[ApproveArgs], ApproveResult>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:585

icrc2_transfer_from: ActorMethod<[TransferFromArgs], TransferFromResult>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:586

icrc21_canister_call_consent_message: ActorMethod<[icrc21_consent_message_request], icrc21_consent_message_response>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:580

icrc3_get_archives: ActorMethod<[GetArchivesArgs], GetArchivesResult>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:587

icrc3_get_blocks: ActorMethod<[GetBlocksArgs[]], GetBlocksResult>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:588

icrc3_get_tip_certificate: ActorMethod<[], [] | [ICRC3DataCertificate]>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:589

icrc3_supported_block_types: ActorMethod<[], object[]>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:590

is_ledger_ready: ActorMethod<[], boolean>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:594


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:13

owner: Principal

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:14

subaccount: [] | [Subaccount]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:15


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:17

allowance: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:18

expires_at: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:19


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:21

allowance: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:24

expires_at: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:25

from_account: Account

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:22

to_spender: Account

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:23


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:27

account: Account

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:28

spender: Account

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:29


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:31

amount: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:36

created_at_time: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:35

expected_allowance: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:37

expires_at: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:38

fee: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:32

from: Account

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:33

memo: [] | [Uint8Array<ArrayBufferLike>]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:34

spender: Account

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:39


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:41

amount: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:46

created_at_time: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:45

expected_allowance: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:47

expires_at: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:48

fee: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:42

from_subaccount: [] | [Uint8Array<ArrayBufferLike>]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:44

memo: [] | [Uint8Array<ArrayBufferLike>]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:43

spender: Account

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:49


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:64

block_range_end: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:65

block_range_start: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:67

canister_id: Principal

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:66


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:74

A prefix of the block range specified in the [GetBlocksArgs] request.

blocks: Value[]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:92

A prefix of the requested block range. The index of the first block is equal to [GetBlocksArgs.start].

Note that the number of blocks might be less than the requested [GetBlocksArgs.length] for various reasons, for example:

  1. The query might have hit the replica with an outdated state that doesn’t have the whole range yet.
  2. The requested range is too large to fit into a single reply.

NOTE: the list of blocks can be empty if:

  1. [GetBlocksArgs.length] was zero.
  2. [GetBlocksArgs.start] was larger than the last block known to the canister.

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:94

amount: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:99

created_at_time: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:98

fee: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:95

from: Account

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:96

memo: [] | [Uint8Array<ArrayBufferLike>]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:97

spender: [] | [Account]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:100


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:102

controller_id: [] | [Principal]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:110

cycles_for_archive_creation: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:108

max_message_size_bytes: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:107

max_transactions_per_response: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:104

more_controller_ids: [] | [Principal[]]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:106

node_max_memory_size_bytes: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:109

num_blocks_to_archive: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:103

trigger_threshold: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:105


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:116

Certificate for the block at block_index.

certificate: [] | [Uint8Array<ArrayBufferLike>]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:117

hash_tree: Uint8Array

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:118


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:124

icrc2: boolean

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:125


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:127

caller: [] | [Principal]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:131

fee_collector: [] | [Account]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:130

mthd: [] | [string]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:129

ts: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:128


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:133

fields: [string, Icrc21Value][]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:134

intent: string

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:135


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:137

from_account: [] | [Account]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:140

prev_spender: [] | [Account]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:139

take: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:138


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:147

from: [] | [Principal]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:154

The last archive seen by the client. The Ledger will return archives coming after this one if set, otherwise it will return the first archives.


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:170

length: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:178

Max number of blocks to fetch.

start: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:174

The index of the first block to fetch.


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:183

The result of a “get_blocks” call.

archived_blocks: object[]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:212

Encoding of instructions for fetching archived blocks.

callback: [Principal, string]

Callback to fetch the archived blocks.

length: bigint

The number of blocks that can be fetched.

start: bigint

The index of the first archived block.

blocks: Value[]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:203

List of blocks that were available in the ledger when it processed the call.

The blocks form a contiguous range, with the first block having index [first_block_index] (see below), and the last block having index [first_block_index] + len(blocks) - 1.

The block range can be an arbitrary sub-range of the originally requested range.

certificate: [] | [Uint8Array<ArrayBufferLike>]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:188

System certificate for the hash of the latest block in the chain. Only present if get_blocks is called in a non-replicated query context.

chain_length: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:208

The total number of blocks in the chain. If the chain length is positive, the index of the last block is chain_len - 1.

first_index: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:193

The index of the first block in “blocks”. If the blocks vector is empty, the exact value of this field is not specified.


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:227

archived_blocks: object[]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:234

args: GetBlocksArgs[]

callback: [Principal, string]

blocks: object[]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:233

block: ICRC3Value

id: bigint

log_length: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:232

Total number of blocks in the block log


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:250

length: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:258

The number of transactions to fetch.

start: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:254

The index of the first tx to fetch.


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:260

archived_transactions: object[]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:287

Encoding of instructions for fetching archived transactions whose indices fall into the requested range.

For each entry e in [archived_transactions], [e.from, e.from + len) is a sub-range of the originally requested transaction range.

callback: [Principal, string]

The function you should call to fetch the archived transactions. The range of the transaction accessible using this function is given by [from] and [len] fields above.

length: bigint

The number of transactions you can fetch using the callback.

start: bigint

The index of the first archived transaction you can fetch using the [callback].

first_index: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:265

The index of the first transaction in [transactions]. If the transaction vector is empty, the exact value of this field is not specified.

log_length: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:269

The total number of transactions in the log.

transactions: Transaction[]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:279

List of transaction that were available in the ledger when it processed the call.

The transactions form a contiguous range, with the first transaction having index [first_index] (see below), and the last transaction having index [first_index] + len(transactions) - 1.

The transaction range can be an arbitrary sub-range of the originally requested range.


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:304

body: Uint8Array

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:307

headers: [string, string][]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:308

method: string

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:306

url: string

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:305


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:310

body: Uint8Array

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:311

headers: [string, string][]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:312

status_code: number

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:313


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:515

consent_message: icrc21_consent_message

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:517

metadata: icrc21_consent_message_metadata

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:516


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:524

language: string

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:526

utc_offset_minutes: [number] | []

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:525


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:528

arg: Uint8Array

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:529

method: string

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:530

user_preferences: icrc21_consent_message_spec

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:531


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:536

device_spec: [] | [{ GenericDisplay: null; } | { FieldsDisplay: null; }]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:538

metadata: icrc21_consent_message_metadata

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:537


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:550

description: string

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:551


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:315

certificate: Uint8Array

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:319

See https://internetcomputer.org/docs/current/references/ic-interface-spec#certification

hash_tree: Uint8Array

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:323

CBOR encoded hash_tree


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:346

The initialization parameters of the Ledger

archive_options: object

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:354

controller_id: Principal

cycles_for_archive_creation: [] | [bigint]

max_message_size_bytes: [] | [bigint]

max_transactions_per_response: [] | [bigint]

more_controller_ids: [] | [Principal[]]

node_max_memory_size_bytes: [] | [bigint]

num_blocks_to_archive: bigint

trigger_threshold: bigint

decimals: [number] | []

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:347

feature_flags: [] | [FeatureFlags]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:367

fee_collector_account: [] | [Account]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:353

index_principal: [] | [Principal]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:365

initial_balances: [Account, bigint][]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:352

max_memo_length: [number] | []

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:364

metadata: [string, MetadataValue][]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:350

minting_account: Account

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:351

token_name: string

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:366

token_symbol: string

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:348

transfer_fee: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:349


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:379

amount: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:384

created_at_time: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:383

fee: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:381

memo: [] | [Uint8Array<ArrayBufferLike>]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:382

to: Account

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:380


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:397

name: string

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:399

url: string

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:398


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:407

approve: [] | [Approve]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:411

burn: [] | [Burn]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:408

fee_collector: [] | [FeeCollector]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:412

kind: string

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:409

mint: [] | [Mint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:410

timestamp: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:413

transfer: [] | [Transfer]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:414


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:419

A prefix of the transaction range specified in the [GetTransactionsRequest] request.

transactions: Transaction[]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:437

A prefix of the requested transaction range. The index of the first transaction is equal to [GetTransactionsRequest.from].

Note that the number of transactions might be less than the requested [GetTransactionsRequest.length] for various reasons, for example:

  1. The query might have hit the replica with an outdated state that doesn’t have the whole range yet.
  2. The requested range is too large to fit into a single reply.

NOTE: the list of transactions can be empty if:

  1. [GetTransactionsRequest.length] was zero.
  2. [GetTransactionsRequest.from] was larger than the last transaction known to the canister.

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:439

amount: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:445

created_at_time: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:444

fee: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:441

from: Account

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:442

memo: [] | [Uint8Array<ArrayBufferLike>]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:443

spender: [] | [Account]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:446

to: Account

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:440


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:448

amount: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:454

created_at_time: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:453

fee: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:450

from_subaccount: [] | [Subaccount]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:452

memo: [] | [Uint8Array<ArrayBufferLike>]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:451

to: Account

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:449


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:467

amount: bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:474

created_at_time: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:473

fee: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:469

from: Account

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:471

memo: [] | [Uint8Array<ArrayBufferLike>]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:472

spender_subaccount: [] | [Subaccount]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:470

to: Account

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:468


Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:493

change_archive_options: [] | [ChangeArchiveOptions]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:494

change_fee_collector: [] | [ChangeFeeCollector]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:498

feature_flags: [] | [FeatureFlags]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:502

index_principal: [] | [Principal]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:500

max_memo_length: [number] | []

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:499

metadata: [] | [[string, MetadataValue][]]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:497

token_name: [] | [string]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:501

token_symbol: [] | [string]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:495

transfer_fee: [] | [bigint]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:496

ApproveError = { GenericError: { error_code: bigint; message: string; }; } | { TemporarilyUnavailable: null; } | { Duplicate: { duplicate_of: BlockIndex; }; } | { BadFee: { expected_fee: bigint; }; } | { AllowanceChanged: { current_allowance: bigint; }; } | { CreatedInFuture: { ledger_time: Timestamp; }; } | { TooOld: null; } | { Expired: { ledger_time: Timestamp; }; } | { InsufficientFunds: { balance: bigint; }; }

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:51


ApproveResult = { Ok: BlockIndex; } | { Err: ApproveError; }

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:63


Block = Value

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:69


BlockIndex = bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:70


ChangeFeeCollector = { SetTo: Account; } | { Unset: null; }

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:112


Duration = bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:123

Number of nanoseconds between two [Timestamp]s.


GetAllowancesError = { GenericError: { error_code: bigint; message: string; }; } | { AccessDenied: { reason: string; }; }

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:142


GetArchivesResult = object[]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:156

canister_id: Principal

The id of the archive

end: bigint

The last block in the archive

start: bigint

The first block in the archive


GetIndexPrincipalError = { GenericError: { description: string; error_code: bigint; }; } | { IndexPrincipalNotSet: null; }

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:239

{ GenericError: { description: string; error_code: bigint; }; }

GenericError: object

Any error not covered by the above variants.

description: string

error_code: bigint

{ IndexPrincipalNotSet: null; }

IndexPrincipalNotSet: null


GetIndexPrincipalResult = { Ok: Principal; } | { Err: GetIndexPrincipalError; }

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:247


icrc103_get_allowances_response = { Ok: Allowance103[]; } | { Err: GetAllowancesError; }

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:512


icrc21_consent_message = { FieldsDisplayMessage: FieldsDisplay; } | { GenericDisplayMessage: string; }

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:519


icrc21_consent_message_response = { Ok: icrc21_consent_info; } | { Err: icrc21_error; }

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:533


icrc21_error = { GenericError: { description: string; error_code: bigint; }; } | { InsufficientPayment: icrc21_error_info; } | { UnsupportedCanisterCall: icrc21_error_info; } | { ConsentMessageUnavailable: icrc21_error_info; }

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:540

{ GenericError: { description: string; error_code: bigint; }; }

GenericError: object

Any error not covered by the above variants.

description: string

error_code: bigint

{ InsufficientPayment: icrc21_error_info; }

InsufficientPayment: icrc21_error_info

{ UnsupportedCanisterCall: icrc21_error_info; }

UnsupportedCanisterCall: icrc21_error_info

{ ConsentMessageUnavailable: icrc21_error_info; }

ConsentMessageUnavailable: icrc21_error_info


Icrc21Value = { Text: { content: string; }; } | { TokenAmount: { amount: bigint; decimals: number; symbol: string; }; } | { TimestampSeconds: { amount: bigint; }; } | { DurationSeconds: { amount: bigint; }; }

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:332


ICRC3Value = { Int: bigint; } | { Map: [string, ICRC3Value][]; } | { Nat: bigint; } | { Blob: Uint8Array; } | { Text: string; } | { Array: ICRC3Value[]; }

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:325


LedgerArg = { Upgrade: [] | [UpgradeArgs]; } | { Init: InitArgs; }

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:369


Map = [string, Value][]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:370


MetadataValue = { Int: bigint; } | { Nat: bigint; } | { Blob: Uint8Array; } | { Text: string; }

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:374

The value returned from the [icrc1_metadata] endpoint.


QueryArchiveFn = ActorMethod<[GetTransactionsRequest], TransactionRange>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:389

A function for fetching archived transaction.


QueryBlockArchiveFn = ActorMethod<[GetBlocksArgs], BlockRange>

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:396

A function for fetching archived blocks.


Subaccount = Uint8Array

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:401


Timestamp = bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:405

Number of nanoseconds since the UNIX epoch in UTC timezone.


Tokens = bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:406


TransferError = { GenericError: { error_code: bigint; message: string; }; } | { TemporarilyUnavailable: null; } | { BadBurn: { min_burn_amount: Tokens; }; } | { Duplicate: { duplicate_of: BlockIndex; }; } | { BadFee: { expected_fee: Tokens; }; } | { CreatedInFuture: { ledger_time: Timestamp; }; } | { TooOld: null; } | { InsufficientFunds: { balance: Tokens; }; }

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:456


TransferFromError = { GenericError: { error_code: bigint; message: string; }; } | { TemporarilyUnavailable: null; } | { InsufficientAllowance: { allowance: Tokens; }; } | { BadBurn: { min_burn_amount: Tokens; }; } | { Duplicate: { duplicate_of: BlockIndex; }; } | { BadFee: { expected_fee: Tokens; }; } | { CreatedInFuture: { ledger_time: Timestamp; }; } | { TooOld: null; } | { InsufficientFunds: { balance: Tokens; }; }

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:476


TransferFromResult = { Ok: BlockIndex; } | { Err: TransferFromError; }

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:488


TransferResult = { Ok: BlockIndex; } | { Err: TransferError; }

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:491


TxIndex = bigint

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:492


Value = { Int: bigint; } | { Map: Map; } | { Nat: bigint; } | { Nat64: bigint; } | { Blob: Uint8Array; } | { Text: string; } | { Array: Value[]; }

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:504

const idlFactory: IDL.InterfaceFactory

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:596


const init: (args) => IDL.Type[]

Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:597

typeof IDL

IDL.Type[]