IcrcLedgerDid
Interfaces
Section titled “Interfaces”_SERVICE
Section titled “_SERVICE”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:597
Properties
Section titled “Properties”archives
Section titled “archives”archives:
ActorMethod<[],ArchiveInfo[]>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:598
get_blocks
Section titled “get_blocks”get_blocks:
ActorMethod<[GetBlocksArgs],GetBlocksResponse>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:599
get_data_certificate
Section titled “get_data_certificate”get_data_certificate:
ActorMethod<[],DataCertificate>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:600
get_transactions
Section titled “get_transactions”get_transactions:
ActorMethod<[GetTransactionsRequest],GetTransactionsResponse>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:601
icrc1_balance_of
Section titled “icrc1_balance_of”icrc1_balance_of:
ActorMethod<[Account],bigint>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:616
icrc1_decimals
Section titled “icrc1_decimals”icrc1_decimals:
ActorMethod<[],number>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:617
icrc1_fee
Section titled “icrc1_fee”icrc1_fee:
ActorMethod<[],bigint>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:618
icrc1_metadata
Section titled “icrc1_metadata”icrc1_metadata:
ActorMethod<[], [string,MetadataValue][]>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:619
icrc1_minting_account
Section titled “icrc1_minting_account”icrc1_minting_account:
ActorMethod<[], [] | [Account]>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:620
icrc1_name
Section titled “icrc1_name”icrc1_name:
ActorMethod<[],string>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:621
icrc1_supported_standards
Section titled “icrc1_supported_standards”icrc1_supported_standards:
ActorMethod<[],StandardRecord[]>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:622
icrc1_symbol
Section titled “icrc1_symbol”icrc1_symbol:
ActorMethod<[],string>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:623
icrc1_total_supply
Section titled “icrc1_total_supply”icrc1_total_supply:
ActorMethod<[],bigint>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:624
icrc1_transfer
Section titled “icrc1_transfer”icrc1_transfer:
ActorMethod<[TransferArg],TransferResult>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:625
icrc10_supported_standards
Section titled “icrc10_supported_standards”icrc10_supported_standards:
ActorMethod<[],object[]>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:610
icrc103_get_allowances
Section titled “icrc103_get_allowances”icrc103_get_allowances:
ActorMethod<[GetAllowancesArgs],icrc103_get_allowances_response>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:605
icrc106_get_index_principal
Section titled “icrc106_get_index_principal”icrc106_get_index_principal:
ActorMethod<[],GetIndexPrincipalResult>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:609
icrc152_burn
Section titled “icrc152_burn”icrc152_burn:
ActorMethod<[Icrc152BurnArgs],Icrc152BurnResult>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:614
icrc152_mint
Section titled “icrc152_mint”icrc152_mint:
ActorMethod<[Icrc152MintArgs],Icrc152MintResult>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:615
icrc2_allowance
Section titled “icrc2_allowance”icrc2_allowance:
ActorMethod<[AllowanceArgs],Allowance>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:630
icrc2_approve
Section titled “icrc2_approve”icrc2_approve:
ActorMethod<[ApproveArgs],ApproveResult>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:631
icrc2_transfer_from
Section titled “icrc2_transfer_from”icrc2_transfer_from:
ActorMethod<[TransferFromArgs],TransferFromResult>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:632
icrc21_canister_call_consent_message
Section titled “icrc21_canister_call_consent_message”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:626
icrc3_get_archives
Section titled “icrc3_get_archives”icrc3_get_archives:
ActorMethod<[GetArchivesArgs],GetArchivesResult>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:633
icrc3_get_blocks
Section titled “icrc3_get_blocks”icrc3_get_blocks:
ActorMethod<[GetBlocksArgs[]],GetBlocksResult>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:634
icrc3_get_tip_certificate
Section titled “icrc3_get_tip_certificate”icrc3_get_tip_certificate:
ActorMethod<[], [] | [ICRC3DataCertificate]>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:635
icrc3_supported_block_types
Section titled “icrc3_supported_block_types”icrc3_supported_block_types:
ActorMethod<[],object[]>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:636
is_ledger_ready
Section titled “is_ledger_ready”is_ledger_ready:
ActorMethod<[],boolean>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:640
Account
Section titled “Account”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:13
Properties
Section titled “Properties”owner:
Principal
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:14
subaccount
Section titled “subaccount”subaccount: [] | [
Subaccount]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:15
Allowance
Section titled “Allowance”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:17
Properties
Section titled “Properties”allowance
Section titled “allowance”allowance:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:18
expires_at
Section titled “expires_at”expires_at: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:19
Allowance103
Section titled “Allowance103”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:21
Properties
Section titled “Properties”allowance
Section titled “allowance”allowance:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:24
expires_at
Section titled “expires_at”expires_at: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:25
from_account
Section titled “from_account”from_account:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:22
to_spender
Section titled “to_spender”to_spender:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:23
AllowanceArgs
Section titled “AllowanceArgs”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:27
Properties
Section titled “Properties”account
Section titled “account”account:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:28
spender
Section titled “spender”spender:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:29
Approve
Section titled “Approve”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:31
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:36
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:35
expected_allowance
Section titled “expected_allowance”expected_allowance: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:37
expires_at
Section titled “expires_at”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
Section titled “spender”spender:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:39
ApproveArgs
Section titled “ApproveArgs”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:41
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:46
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:45
expected_allowance
Section titled “expected_allowance”expected_allowance: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:47
expires_at
Section titled “expires_at”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
Section titled “from_subaccount”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
Section titled “spender”spender:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:49
ArchiveInfo
Section titled “ArchiveInfo”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:64
Properties
Section titled “Properties”block_range_end
Section titled “block_range_end”block_range_end:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:65
block_range_start
Section titled “block_range_start”block_range_start:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:67
canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:66
AuthorizedBurn
Section titled “AuthorizedBurn”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:69
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:74
caller
Section titled “caller”caller: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:72
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:73
from:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:70
mthd: [] | [
string]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:71
reason
Section titled “reason”reason: [] | [
string]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:75
AuthorizedMint
Section titled “AuthorizedMint”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:77
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:82
caller
Section titled “caller”caller: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:80
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:81
mthd: [] | [
string]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:79
reason
Section titled “reason”reason: [] | [
string]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:83
to:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:78
BlockRange
Section titled “BlockRange”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:90
A prefix of the block range specified in the [GetBlocksArgs] request.
Properties
Section titled “Properties”blocks
Section titled “blocks”blocks:
Value[]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:108
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:
- The query might have hit the replica with an outdated state that doesn’t have the whole range yet.
- The requested range is too large to fit into a single reply.
NOTE: the list of blocks can be empty if:
- [GetBlocksArgs.length] was zero.
- [GetBlocksArgs.start] was larger than the last block known to the canister.
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:110
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:115
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:114
fee: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:111
from:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:112
memo: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:113
spender
Section titled “spender”spender: [] | [
Account]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:116
ChangeArchiveOptions
Section titled “ChangeArchiveOptions”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:118
Properties
Section titled “Properties”controller_id
Section titled “controller_id”controller_id: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:126
cycles_for_archive_creation
Section titled “cycles_for_archive_creation”cycles_for_archive_creation: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:124
max_message_size_bytes
Section titled “max_message_size_bytes”max_message_size_bytes: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:123
max_transactions_per_response
Section titled “max_transactions_per_response”max_transactions_per_response: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:120
more_controller_ids
Section titled “more_controller_ids”more_controller_ids: [] | [
Principal[]]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:122
node_max_memory_size_bytes
Section titled “node_max_memory_size_bytes”node_max_memory_size_bytes: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:125
num_blocks_to_archive
Section titled “num_blocks_to_archive”num_blocks_to_archive: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:119
trigger_threshold
Section titled “trigger_threshold”trigger_threshold: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:121
DataCertificate
Section titled “DataCertificate”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:132
Certificate for the block at block_index.
Properties
Section titled “Properties”certificate
Section titled “certificate”certificate: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:133
hash_tree
Section titled “hash_tree”hash_tree:
Uint8Array
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:134
FeatureFlags
Section titled “FeatureFlags”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:140
Properties
Section titled “Properties”icrc152
Section titled “icrc152”icrc152:
boolean
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:141
icrc2:
boolean
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:142
FeeCollector
Section titled “FeeCollector”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:144
Properties
Section titled “Properties”caller
Section titled “caller”caller: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:148
fee_collector
Section titled “fee_collector”fee_collector: [] | [
Account]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:147
mthd: [] | [
string]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:146
ts: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:145
FieldsDisplay
Section titled “FieldsDisplay”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:150
Properties
Section titled “Properties”fields
Section titled “fields”fields: [
string,Icrc21Value][]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:151
intent
Section titled “intent”intent:
string
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:152
GetAllowancesArgs
Section titled “GetAllowancesArgs”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:154
Properties
Section titled “Properties”from_account
Section titled “from_account”from_account: [] | [
Account]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:157
prev_spender
Section titled “prev_spender”prev_spender: [] | [
Account]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:156
take: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:155
GetArchivesArgs
Section titled “GetArchivesArgs”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:164
Properties
Section titled “Properties”from: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:171
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.
GetBlocksArgs
Section titled “GetBlocksArgs”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:187
Properties
Section titled “Properties”length
Section titled “length”length:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:195
Max number of blocks to fetch.
start:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:191
The index of the first block to fetch.
GetBlocksResponse
Section titled “GetBlocksResponse”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:200
The result of a “get_blocks” call.
Properties
Section titled “Properties”archived_blocks
Section titled “archived_blocks”archived_blocks:
object[]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:229
Encoding of instructions for fetching archived blocks.
callback
Section titled “callback”callback: [
Principal,string]
Callback to fetch the archived blocks.
length
Section titled “length”length:
bigint
The number of blocks that can be fetched.
start:
bigint
The index of the first archived block.
blocks
Section titled “blocks”blocks:
Value[]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:220
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
Section titled “certificate”certificate: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:205
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
Section titled “chain_length”chain_length:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:225
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
Section titled “first_index”first_index:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:210
The index of the first block in “blocks”. If the blocks vector is empty, the exact value of this field is not specified.
GetBlocksResult
Section titled “GetBlocksResult”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:244
Properties
Section titled “Properties”archived_blocks
Section titled “archived_blocks”archived_blocks:
object[]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:251
args:
GetBlocksArgs[]
callback
Section titled “callback”callback: [
Principal,string]
blocks
Section titled “blocks”blocks:
object[]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:250
block:
ICRC3Value
id:
bigint
log_length
Section titled “log_length”log_length:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:249
Total number of blocks in the block log
GetTransactionsRequest
Section titled “GetTransactionsRequest”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:267
Properties
Section titled “Properties”length
Section titled “length”length:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:275
The number of transactions to fetch.
start:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:271
The index of the first tx to fetch.
GetTransactionsResponse
Section titled “GetTransactionsResponse”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:277
Properties
Section titled “Properties”archived_transactions
Section titled “archived_transactions”archived_transactions:
object[]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:304
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
Section titled “callback”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
Section titled “length”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
Section titled “first_index”first_index:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:282
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
Section titled “log_length”log_length:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:286
The total number of transactions in the log.
transactions
Section titled “transactions”transactions:
Transaction[]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:296
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.
HttpRequest
Section titled “HttpRequest”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:321
Properties
Section titled “Properties”body:
Uint8Array
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:324
headers
Section titled “headers”headers: [
string,string][]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:325
method
Section titled “method”method:
string
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:323
url:
string
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:322
HttpResponse
Section titled “HttpResponse”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:327
Properties
Section titled “Properties”body:
Uint8Array
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:328
headers
Section titled “headers”headers: [
string,string][]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:329
status_code
Section titled “status_code”status_code:
number
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:330
Icrc152BurnArgs
Section titled “Icrc152BurnArgs”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:349
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:352
created_at_time
Section titled “created_at_time”created_at_time:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:351
from:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:350
reason
Section titled “reason”reason: [] | [
string]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:353
Icrc152MintArgs
Section titled “Icrc152MintArgs”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:362
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:365
created_at_time
Section titled “created_at_time”created_at_time:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:364
reason
Section titled “reason”reason: [] | [
string]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:366
to:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:363
icrc21_consent_info
Section titled “icrc21_consent_info”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:559
Properties
Section titled “Properties”consent_message
Section titled “consent_message”consent_message:
icrc21_consent_message
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:561
metadata
Section titled “metadata”metadata:
icrc21_consent_message_metadata
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:560
icrc21_consent_message_metadata
Section titled “icrc21_consent_message_metadata”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:568
Properties
Section titled “Properties”language
Section titled “language”language:
string
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:570
utc_offset_minutes
Section titled “utc_offset_minutes”utc_offset_minutes: [
number] | []
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:569
icrc21_consent_message_request
Section titled “icrc21_consent_message_request”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:572
Properties
Section titled “Properties”arg:
Uint8Array
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:573
method
Section titled “method”method:
string
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:574
user_preferences
Section titled “user_preferences”user_preferences:
icrc21_consent_message_spec
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:575
icrc21_consent_message_spec
Section titled “icrc21_consent_message_spec”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:580
Properties
Section titled “Properties”device_spec
Section titled “device_spec”device_spec: [] | [{
GenericDisplay:null; } | {FieldsDisplay:null; }]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:582
metadata
Section titled “metadata”metadata:
icrc21_consent_message_metadata
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:581
icrc21_error_info
Section titled “icrc21_error_info”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:594
Properties
Section titled “Properties”description
Section titled “description”description:
string
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:595
ICRC3DataCertificate
Section titled “ICRC3DataCertificate”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:332
Properties
Section titled “Properties”certificate
Section titled “certificate”certificate:
Uint8Array
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:336
See https://internetcomputer.org/docs/current/references/ic-interface-spec#certification
hash_tree
Section titled “hash_tree”hash_tree:
Uint8Array
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:340
CBOR encoded hash_tree
InitArgs
Section titled “InitArgs”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:388
The initialization parameters of the Ledger
Properties
Section titled “Properties”archive_options
Section titled “archive_options”archive_options:
object
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:396
controller_id
Section titled “controller_id”controller_id:
Principal
cycles_for_archive_creation
Section titled “cycles_for_archive_creation”cycles_for_archive_creation: [] | [
bigint]
max_message_size_bytes
Section titled “max_message_size_bytes”max_message_size_bytes: [] | [
bigint]
max_transactions_per_response
Section titled “max_transactions_per_response”max_transactions_per_response: [] | [
bigint]
more_controller_ids
Section titled “more_controller_ids”more_controller_ids: [] | [
Principal[]]
node_max_memory_size_bytes
Section titled “node_max_memory_size_bytes”node_max_memory_size_bytes: [] | [
bigint]
num_blocks_to_archive
Section titled “num_blocks_to_archive”num_blocks_to_archive:
bigint
trigger_threshold
Section titled “trigger_threshold”trigger_threshold:
bigint
decimals
Section titled “decimals”decimals: [
number] | []
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:389
feature_flags
Section titled “feature_flags”feature_flags: [] | [
FeatureFlags]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:409
fee_collector_account
Section titled “fee_collector_account”fee_collector_account: [] | [
Account]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:395
index_principal
Section titled “index_principal”index_principal: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:407
initial_balances
Section titled “initial_balances”initial_balances: [
Account,bigint][]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:394
max_memo_length
Section titled “max_memo_length”max_memo_length: [
number] | []
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:406
metadata
Section titled “metadata”metadata: [
string,MetadataValue][]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:392
minting_account
Section titled “minting_account”minting_account:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:393
token_name
Section titled “token_name”token_name:
string
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:408
token_symbol
Section titled “token_symbol”token_symbol:
string
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:390
transfer_fee
Section titled “transfer_fee”transfer_fee:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:391
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:421
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:426
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:425
fee: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:423
memo: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:424
to:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:422
StandardRecord
Section titled “StandardRecord”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:439
Properties
Section titled “Properties”name:
string
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:441
url:
string
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:440
Transaction
Section titled “Transaction”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:449
Properties
Section titled “Properties”approve
Section titled “approve”approve: [] | [
Approve]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:453
authorized_burn
Section titled “authorized_burn”authorized_burn: [] | [
AuthorizedBurn]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:454
authorized_mint
Section titled “authorized_mint”authorized_mint: [] | [
AuthorizedMint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:455
burn: [] | [
Burn]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:450
fee_collector
Section titled “fee_collector”fee_collector: [] | [
FeeCollector]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:456
kind:
string
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:451
mint: [] | [
Mint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:452
timestamp
Section titled “timestamp”timestamp:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:457
transfer
Section titled “transfer”transfer: [] | [
Transfer]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:458
TransactionRange
Section titled “TransactionRange”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:463
A prefix of the transaction range specified in the [GetTransactionsRequest] request.
Properties
Section titled “Properties”transactions
Section titled “transactions”transactions:
Transaction[]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:481
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:
- The query might have hit the replica with an outdated state that doesn’t have the whole range yet.
- The requested range is too large to fit into a single reply.
NOTE: the list of transactions can be empty if:
- [GetTransactionsRequest.length] was zero.
- [GetTransactionsRequest.from] was larger than the last transaction known to the canister.
Transfer
Section titled “Transfer”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:483
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:489
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:488
fee: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:485
from:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:486
memo: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:487
spender
Section titled “spender”spender: [] | [
Account]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:490
to:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:484
TransferArg
Section titled “TransferArg”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:492
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:498
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:497
fee: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:494
from_subaccount
Section titled “from_subaccount”from_subaccount: [] | [
Subaccount]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:496
memo: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:495
to:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:493
TransferFromArgs
Section titled “TransferFromArgs”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:511
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:518
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:517
fee: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:513
from:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:515
memo: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:516
spender_subaccount
Section titled “spender_subaccount”spender_subaccount: [] | [
Subaccount]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:514
to:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:512
UpgradeArgs
Section titled “UpgradeArgs”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:537
Properties
Section titled “Properties”change_archive_options
Section titled “change_archive_options”change_archive_options: [] | [
ChangeArchiveOptions]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:538
change_fee_collector
Section titled “change_fee_collector”change_fee_collector: [] | [
ChangeFeeCollector]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:542
feature_flags
Section titled “feature_flags”feature_flags: [] | [
FeatureFlags]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:546
index_principal
Section titled “index_principal”index_principal: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:544
max_memo_length
Section titled “max_memo_length”max_memo_length: [
number] | []
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:543
metadata
Section titled “metadata”metadata: [] | [[
string,MetadataValue][]]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:541
token_name
Section titled “token_name”token_name: [] | [
string]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:545
token_symbol
Section titled “token_symbol”token_symbol: [] | [
string]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:539
transfer_fee
Section titled “transfer_fee”transfer_fee: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:540
Type Aliases
Section titled “Type Aliases”ApproveError
Section titled “ApproveError”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
Section titled “ApproveResult”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:85
BlockIndex
Section titled “BlockIndex”BlockIndex =
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:86
ChangeFeeCollector
Section titled “ChangeFeeCollector”ChangeFeeCollector = {
SetTo:Account; } | {Unset:null; }
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:128
Duration
Section titled “Duration”Duration =
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:139
Number of nanoseconds between two [Timestamp]s.
GetAllowancesError
Section titled “GetAllowancesError”GetAllowancesError = {
GenericError: {error_code:bigint;message:string; }; } | {AccessDenied: {reason:string; }; }
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:159
GetArchivesResult
Section titled “GetArchivesResult”GetArchivesResult =
object[]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:173
Type Declaration
Section titled “Type Declaration”canister_id
Section titled “canister_id”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
Section titled “GetIndexPrincipalError”GetIndexPrincipalError = {
GenericError: {description:string;error_code:bigint; }; } | {IndexPrincipalNotSet:null; }
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:256
Type Declaration
Section titled “Type Declaration”{ GenericError: { description: string; error_code: bigint; }; }
GenericError
Section titled “GenericError”GenericError:
object
Any error not covered by the above variants.
GenericError.description
Section titled “GenericError.description”description:
string
GenericError.error_code
Section titled “GenericError.error_code”error_code:
bigint
{ IndexPrincipalNotSet: null; }
IndexPrincipalNotSet
Section titled “IndexPrincipalNotSet”IndexPrincipalNotSet:
null
GetIndexPrincipalResult
Section titled “GetIndexPrincipalResult”GetIndexPrincipalResult = {
Ok:Principal; } | {Err:GetIndexPrincipalError; }
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:264
icrc103_get_allowances_response
Section titled “icrc103_get_allowances_response”icrc103_get_allowances_response = {
Ok:Allowance103[]; } | {Err:GetAllowancesError; }
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:556
Icrc152BurnError
Section titled “Icrc152BurnError”Icrc152BurnError = {
InvalidAccount:string; } | {GenericError: {error_code:bigint;message:string; }; } | {Duplicate: {duplicate_of:bigint; }; } | {InsufficientBalance: {balance:bigint; }; } | {Unauthorized:string; }
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:355
Icrc152BurnResult
Section titled “Icrc152BurnResult”Icrc152BurnResult = {
Ok:bigint; } | {Err:Icrc152BurnError; }
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:361
Icrc152MintError
Section titled “Icrc152MintError”Icrc152MintError = {
InvalidAccount:string; } | {GenericError: {error_code:bigint;message:string; }; } | {Duplicate: {duplicate_of:bigint; }; } | {Unauthorized:string; }
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:368
Icrc152MintResult
Section titled “Icrc152MintResult”Icrc152MintResult = {
Ok:bigint; } | {Err:Icrc152MintError; }
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:373
icrc21_consent_message
Section titled “icrc21_consent_message”icrc21_consent_message = {
FieldsDisplayMessage:FieldsDisplay; } | {GenericDisplayMessage:string; }
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:563
icrc21_consent_message_response
Section titled “icrc21_consent_message_response”icrc21_consent_message_response = {
Ok:icrc21_consent_info; } | {Err:icrc21_error; }
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:577
icrc21_error
Section titled “icrc21_error”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:584
Type Declaration
Section titled “Type Declaration”{ GenericError: { description: string; error_code: bigint; }; }
GenericError
Section titled “GenericError”GenericError:
object
Any error not covered by the above variants.
GenericError.description
Section titled “GenericError.description”description:
string
GenericError.error_code
Section titled “GenericError.error_code”error_code:
bigint
{ InsufficientPayment: icrc21_error_info; }
InsufficientPayment
Section titled “InsufficientPayment”InsufficientPayment:
icrc21_error_info
{ UnsupportedCanisterCall: icrc21_error_info; }
UnsupportedCanisterCall
Section titled “UnsupportedCanisterCall”UnsupportedCanisterCall:
icrc21_error_info
{ ConsentMessageUnavailable: icrc21_error_info; }
ConsentMessageUnavailable
Section titled “ConsentMessageUnavailable”ConsentMessageUnavailable:
icrc21_error_info
Icrc21Value
Section titled “Icrc21Value”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:374
ICRC3Value
Section titled “ICRC3Value”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:342
LedgerArg
Section titled “LedgerArg”LedgerArg = {
Upgrade: [] | [UpgradeArgs]; } | {Init:InitArgs; }
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:411
Map = [
string,Value][]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:412
MetadataValue
Section titled “MetadataValue”MetadataValue = {
Int:bigint; } | {Nat:bigint; } | {Blob:Uint8Array; } | {Text:string; }
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:416
The value returned from the [icrc1_metadata] endpoint.
QueryArchiveFn
Section titled “QueryArchiveFn”QueryArchiveFn =
ActorMethod<[GetTransactionsRequest],TransactionRange>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:431
A function for fetching archived transaction.
QueryBlockArchiveFn
Section titled “QueryBlockArchiveFn”QueryBlockArchiveFn =
ActorMethod<[GetBlocksArgs],BlockRange>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:438
A function for fetching archived blocks.
Subaccount
Section titled “Subaccount”Subaccount =
Uint8Array
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:443
Timestamp
Section titled “Timestamp”Timestamp =
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:447
Number of nanoseconds since the UNIX epoch in UTC timezone.
Tokens
Section titled “Tokens”Tokens =
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:448
TransferError
Section titled “TransferError”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:500
TransferFromError
Section titled “TransferFromError”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:520
TransferFromResult
Section titled “TransferFromResult”TransferFromResult = {
Ok:BlockIndex; } | {Err:TransferFromError; }
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:532
TransferResult
Section titled “TransferResult”TransferResult = {
Ok:BlockIndex; } | {Err:TransferError; }
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:535
TxIndex
Section titled “TxIndex”TxIndex =
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:536
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:548
Variables
Section titled “Variables”idlFactory
Section titled “idlFactory”
constidlFactory:IDL.InterfaceFactory
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:642
init()
Section titled “init()”
constinit: (args) =>IDL.Type[]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_ledger.d.ts:643
Parameters
Section titled “Parameters”typeof IDL
Returns
Section titled “Returns”IDL.Type[]