IcrcIndexDid
Interfaces
Section titled “Interfaces”_SERVICE
Section titled “_SERVICE”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:168
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:169
get_blocks
Section titled “get_blocks”get_blocks:
ActorMethod<[GetBlocksRequest],GetBlocksResponse>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:173
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:174
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:175
ledger_id
Section titled “ledger_id”ledger_id:
ActorMethod<[],Principal>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:176
list_subaccounts
Section titled “list_subaccounts”list_subaccounts:
ActorMethod<[ListSubaccountsArgs],SubAccount[]>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:177
status
Section titled “status”status:
ActorMethod<[],Status>
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:178
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
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:29
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:34
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:33
fee: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:30
from:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:31
memo: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:32
spender
Section titled “spender”spender: [] | [
Account]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:35
FeeCollector
Section titled “FeeCollector”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:37
Properties
Section titled “Properties”caller
Section titled “caller”caller: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:41
fee_collector
Section titled “fee_collector”fee_collector: [] | [
Account]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:40
mthd: [] | [
string]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:39
ts: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:38
FeeCollectorRanges
Section titled “FeeCollectorRanges”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:43
Properties
Section titled “Properties”ranges
Section titled “ranges”ranges: [
Account, [bigint,bigint][]][]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:44
GetAccountTransactionsArgs
Section titled “GetAccountTransactionsArgs”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:46
Properties
Section titled “Properties”account
Section titled “account”account:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:58
max_results
Section titled “max_results”max_results:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:50
Maximum number of transactions to fetch.
start: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:57
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:60
Properties
Section titled “Properties”length
Section titled “length”length:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:62
start:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:61
GetBlocksResponse
Section titled “GetBlocksResponse”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:64
Properties
Section titled “Properties”blocks
Section titled “blocks”blocks:
Value[]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:65
chain_length
Section titled “chain_length”chain_length:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:66
GetTransactions
Section titled “GetTransactions”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:68
Properties
Section titled “Properties”balance
Section titled “balance”balance:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:69
oldest_tx_id
Section titled “oldest_tx_id”oldest_tx_id: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:74
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:70
GetTransactionsErr
Section titled “GetTransactionsErr”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:76
Properties
Section titled “Properties”message
Section titled “message”message:
string
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:77
InitArg
Section titled “InitArg”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:83
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:84
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:100
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:99
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:91
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:102
Properties
Section titled “Properties”owner:
Principal
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:103
start: [] | [
SubAccount]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:104
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:107
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:112
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:111
fee: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:109
memo: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:110
to:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:108
Status
Section titled “Status”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:114
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:115
Transaction
Section titled “Transaction”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:119
Properties
Section titled “Properties”approve
Section titled “approve”approve: [] | [
Approve]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:123
burn: [] | [
Burn]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:120
fee_collector
Section titled “fee_collector”fee_collector: [] | [
FeeCollector]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:124
kind:
string
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:121
mint: [] | [
Mint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:122
timestamp
Section titled “timestamp”timestamp:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:125
transfer
Section titled “transfer”transfer: [] | [
Transfer]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:126
TransactionWithId
Section titled “TransactionWithId”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:128
Properties
Section titled “Properties”id:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:129
transaction
Section titled “transaction”transaction:
Transaction
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:130
Transfer
Section titled “Transfer”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:132
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:138
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:137
fee: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:134
from:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:135
memo: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:136
spender
Section titled “spender”spender: [] | [
Account]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:139
to:
Account
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:133
UpgradeArg
Section titled “UpgradeArg”Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:141
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:142
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:158
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:157
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:149
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:27
BlockIndex
Section titled “BlockIndex”BlockIndex =
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:28
GetTransactionsResult
Section titled “GetTransactionsResult”GetTransactionsResult = {
Ok:GetTransactions; } | {Err:GetTransactionsErr; }
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:79
IndexArg
Section titled “IndexArg”IndexArg = {
Upgrade:UpgradeArg; } | {Init:InitArg; }
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:82
Map = [
string,Value][]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:106
SubAccount
Section titled “SubAccount”SubAccount =
Uint8Array
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:117
Tokens
Section titled “Tokens”Tokens =
bigint
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:118
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:160
Variables
Section titled “Variables”idlFactory
Section titled “idlFactory”
constidlFactory:IDL.InterfaceFactory
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:180
init()
Section titled “init()”
constinit: (args) =>IDL.Type[]
Defined in: packages/canisters/src/declarations/ledger-icrc/icrc_index.d.ts:181
Parameters
Section titled “Parameters”typeof IDL
Returns
Section titled “Returns”IDL.Type[]