IcrcIndexDid
Interfaces
Section titled “Interfaces”_SERVICE
Section titled “_SERVICE”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:186
Properties
Section titled “Properties”get_account_transactions
Section titled “get_account_transactions”get_account_transactions:
ActorMethod<[GetAccountTransactionsArgs],GetTransactionsResult>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:187
get_blocks
Section titled “get_blocks”get_blocks:
ActorMethod<[GetBlocksRequest],GetBlocksResponse>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:191
get_fee_collectors_ranges
Section titled “get_fee_collectors_ranges”get_fee_collectors_ranges:
ActorMethod<[],FeeCollectorRanges>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:192
icrc1_balance_of
Section titled “icrc1_balance_of”icrc1_balance_of:
ActorMethod<[Account],bigint>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:193
ledger_id
Section titled “ledger_id”ledger_id:
ActorMethod<[],Principal>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:194
list_subaccounts
Section titled “list_subaccounts”list_subaccounts:
ActorMethod<[ListSubaccountsArgs],SubAccount[]>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:195
status
Section titled “status”status:
ActorMethod<[],Status>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:196
Account
Section titled “Account”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:13
Properties
Section titled “Properties”owner:
Principal
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:14
subaccount
Section titled “subaccount”subaccount: [] | [
SubAccount]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:15
Approve
Section titled “Approve”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:17
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:22
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:21
expected_allowance
Section titled “expected_allowance”expected_allowance: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:23
expires_at
Section titled “expires_at”expires_at: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:24
fee: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:18
from:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:19
memo: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:20
spender
Section titled “spender”spender:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:25
AuthorizedBurn
Section titled “AuthorizedBurn”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:27
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:32
caller
Section titled “caller”caller: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:30
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:31
from:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:28
mthd: [] | [
string]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:29
reason
Section titled “reason”reason: [] | [
string]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:33
AuthorizedMint
Section titled “AuthorizedMint”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:35
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:40
caller
Section titled “caller”caller: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:38
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:39
mthd: [] | [
string]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:37
reason
Section titled “reason”reason: [] | [
string]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:41
to:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:36
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:45
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:50
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:49
fee: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:46
from:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:47
memo: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:48
spender
Section titled “spender”spender: [] | [
Account]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:51
FeeCollector
Section titled “FeeCollector”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:53
Properties
Section titled “Properties”caller
Section titled “caller”caller: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:57
fee_collector
Section titled “fee_collector”fee_collector: [] | [
Account]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:56
mthd: [] | [
string]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:55
ts: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:54
FeeCollectorRanges
Section titled “FeeCollectorRanges”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:59
Properties
Section titled “Properties”ranges
Section titled “ranges”ranges: [
Account, [bigint,bigint][]][]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:60
GetAccountTransactionsArgs
Section titled “GetAccountTransactionsArgs”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:62
Properties
Section titled “Properties”account
Section titled “account”account:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:74
max_results
Section titled “max_results”max_results:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:66
Maximum number of transactions to fetch.
start: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:73
The txid of the last transaction seen by the client. If None then the results will start from the most recent txid. If set then the results will start from the next most recent txid after start (start won’t be included).
GetBlocksRequest
Section titled “GetBlocksRequest”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:76
Properties
Section titled “Properties”length
Section titled “length”length:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:78
start:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:77
GetBlocksResponse
Section titled “GetBlocksResponse”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:80
Properties
Section titled “Properties”blocks
Section titled “blocks”blocks:
Value[]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:81
chain_length
Section titled “chain_length”chain_length:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:82
GetTransactions
Section titled “GetTransactions”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:84
Properties
Section titled “Properties”balance
Section titled “balance”balance:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:85
oldest_tx_id
Section titled “oldest_tx_id”oldest_tx_id: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:90
The txid of the oldest transaction the account has
transactions
Section titled “transactions”transactions:
TransactionWithId[]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:86
GetTransactionsErr
Section titled “GetTransactionsErr”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:92
Properties
Section titled “Properties”message
Section titled “message”message:
string
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:93
InitArg
Section titled “InitArg”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:99
Properties
Section titled “Properties”ledger_id
Section titled “ledger_id”ledger_id:
Principal
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:100
max_retrieve_blocks_from_ledger_interval_seconds
Section titled “max_retrieve_blocks_from_ledger_interval_seconds”max_retrieve_blocks_from_ledger_interval_seconds: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:116
min_retrieve_blocks_from_ledger_interval_seconds
Section titled “min_retrieve_blocks_from_ledger_interval_seconds”min_retrieve_blocks_from_ledger_interval_seconds: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:115
The minimum and maximum intervals in seconds in which to retrieve blocks from the ledger. When a request to the ledger returns an empty response, the interval is increased (up to the maximum). In case of a non-empty response, the interval is decreased (down to the minimum). A lower value makes the index more responsive in showing new blocks, but increases the consumption of cycles of both the index and ledger canisters. A higher values means that it takes longer for new blocks to show up in the index.
retrieve_blocks_from_ledger_interval_seconds
Section titled “retrieve_blocks_from_ledger_interval_seconds”retrieve_blocks_from_ledger_interval_seconds: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:107
The legacy parameter to set a fixed interval in seconds in which to retrieve blocks from the ledger.
If set, the index will set both min_retrieve_blocks_from_ledger_interval_seconds and
max_retrieve_blocks_from_ledger_interval_seconds to the value of retrieve_blocks_from_ledger_interval_seconds.
If either the min or max interval parameters are also set, the index will trap during initialization.
ListSubaccountsArgs
Section titled “ListSubaccountsArgs”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:118
Properties
Section titled “Properties”owner:
Principal
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:119
start: [] | [
SubAccount]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:120
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:123
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:128
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:127
fee: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:125
memo: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:126
to:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:124
Status
Section titled “Status”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:130
Properties
Section titled “Properties”num_blocks_synced
Section titled “num_blocks_synced”num_blocks_synced:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:131
Transaction
Section titled “Transaction”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:135
Properties
Section titled “Properties”approve
Section titled “approve”approve: [] | [
Approve]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:139
authorized_burn
Section titled “authorized_burn”authorized_burn: [] | [
AuthorizedBurn]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:140
authorized_mint
Section titled “authorized_mint”authorized_mint: [] | [
AuthorizedMint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:141
burn: [] | [
Burn]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:136
fee_collector
Section titled “fee_collector”fee_collector: [] | [
FeeCollector]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:142
kind:
string
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:137
mint: [] | [
Mint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:138
timestamp
Section titled “timestamp”timestamp:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:143
transfer
Section titled “transfer”transfer: [] | [
Transfer]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:144
TransactionWithId
Section titled “TransactionWithId”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:146
Properties
Section titled “Properties”id:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:147
transaction
Section titled “transaction”transaction:
Transaction
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:148
Transfer
Section titled “Transfer”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:150
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:156
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:155
fee: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:152
from:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:153
memo: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:154
spender
Section titled “spender”spender: [] | [
Account]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:157
to:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:151
UpgradeArg
Section titled “UpgradeArg”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:159
Properties
Section titled “Properties”ledger_id
Section titled “ledger_id”ledger_id: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:160
max_retrieve_blocks_from_ledger_interval_seconds
Section titled “max_retrieve_blocks_from_ledger_interval_seconds”max_retrieve_blocks_from_ledger_interval_seconds: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:176
min_retrieve_blocks_from_ledger_interval_seconds
Section titled “min_retrieve_blocks_from_ledger_interval_seconds”min_retrieve_blocks_from_ledger_interval_seconds: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:175
The minimum and maximum intervals in seconds in which to retrieve blocks from the ledger. When a request to the ledger returns an empty response, the interval is increased (up to the maximum). In case of a non-empty response, the interval is decreased (down to the minimum). A lower value makes the index more responsive in showing new blocks, but increases the consumption of cycles of both the index and ledger canisters. A higher values means that it takes longer for new blocks to show up in the index.
retrieve_blocks_from_ledger_interval_seconds
Section titled “retrieve_blocks_from_ledger_interval_seconds”retrieve_blocks_from_ledger_interval_seconds: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:167
The legacy parameter to set a fixed interval in seconds in which to retrieve blocks from the ledger.
If set, the index will set both min_retrieve_blocks_from_ledger_interval_seconds and
max_retrieve_blocks_from_ledger_interval_seconds to the value of retrieve_blocks_from_ledger_interval_seconds.
If either the min or max interval parameters are also set, the index will trap during post upgrade.
Type Aliases
Section titled “Type Aliases”Block =
Value
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:43
BlockIndex
Section titled “BlockIndex”BlockIndex =
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:44
GetTransactionsResult
Section titled “GetTransactionsResult”GetTransactionsResult = {
Ok:GetTransactions; } | {Err:GetTransactionsErr; }
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:95
IndexArg
Section titled “IndexArg”IndexArg = {
Upgrade:UpgradeArg; } | {Init:InitArg; }
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:98
Map = [
string,Value][]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:122
SubAccount
Section titled “SubAccount”SubAccount =
Uint8Array
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:133
Tokens
Section titled “Tokens”Tokens =
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:134
Value = {
Int:bigint; } | {Map:Map; } | {Nat:bigint; } | {Nat64:bigint; } | {Blob:Uint8Array; } | {Text:string; } | {Array:Value[]; }
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:178
Variables
Section titled “Variables”idlFactory
Section titled “idlFactory”
constidlFactory:IDL.InterfaceFactory
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:198
init()
Section titled “init()”
constinit: (args) =>IDL.Type[]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:199
Parameters
Section titled “Parameters”typeof IDL
Returns
Section titled “Returns”IDL.Type[]