IcpIndexDid
Interfaces
Section titled “Interfaces”_SERVICE
Section titled “_SERVICE”Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:131
Properties
Section titled “Properties”get_account_identifier_balance
Section titled “get_account_identifier_balance”get_account_identifier_balance:
ActorMethod<[string],bigint>
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:132
get_account_identifier_transactions
Section titled “get_account_identifier_transactions”get_account_identifier_transactions:
ActorMethod<[GetAccountIdentifierTransactionsArgs],GetAccountIdentifierTransactionsResult>
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:133
get_account_transactions
Section titled “get_account_transactions”get_account_transactions:
ActorMethod<[GetAccountTransactionsArgs],GetAccountIdentifierTransactionsResult>
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:137
get_blocks
Section titled “get_blocks”get_blocks:
ActorMethod<[GetBlocksRequest],GetBlocksResponse>
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:141
http_request
Section titled “http_request”http_request:
ActorMethod<[HttpRequest],HttpResponse>
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:142
icrc1_balance_of
Section titled “icrc1_balance_of”icrc1_balance_of:
ActorMethod<[Account],bigint>
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:143
ledger_id
Section titled “ledger_id”ledger_id:
ActorMethod<[],Principal>
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:144
status
Section titled “status”status:
ActorMethod<[],Status>
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:145
Account
Section titled “Account”Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:13
Properties
Section titled “Properties”owner:
Principal
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:14
subaccount
Section titled “subaccount”subaccount: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:15
GetAccountIdentifierTransactionsArgs
Section titled “GetAccountIdentifierTransactionsArgs”Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:17
Properties
Section titled “Properties”account_identifier
Section titled “account_identifier”account_identifier:
string
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:20
max_results
Section titled “max_results”max_results:
bigint
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:18
start: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:19
GetAccountIdentifierTransactionsError
Section titled “GetAccountIdentifierTransactionsError”Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:22
Properties
Section titled “Properties”message
Section titled “message”message:
string
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:23
GetAccountIdentifierTransactionsResponse
Section titled “GetAccountIdentifierTransactionsResponse”Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:25
Properties
Section titled “Properties”balance
Section titled “balance”balance:
bigint
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:26
oldest_tx_id
Section titled “oldest_tx_id”oldest_tx_id: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:28
transactions
Section titled “transactions”transactions:
TransactionWithId[]
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:27
GetAccountTransactionsArgs
Section titled “GetAccountTransactionsArgs”Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:35
Properties
Section titled “Properties”account
Section titled “account”account:
Account
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:47
max_results
Section titled “max_results”max_results:
bigint
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:39
Maximum number of transactions to fetch.
start: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:46
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-icp/index.d.ts:49
Properties
Section titled “Properties”length
Section titled “length”length:
bigint
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:51
start:
bigint
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:50
GetBlocksResponse
Section titled “GetBlocksResponse”Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:53
Properties
Section titled “Properties”blocks
Section titled “blocks”blocks:
Uint8Array<ArrayBufferLike>[]
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:54
chain_length
Section titled “chain_length”chain_length:
bigint
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:55
HttpRequest
Section titled “HttpRequest”Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:57
Properties
Section titled “Properties”body:
Uint8Array
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:60
headers
Section titled “headers”headers: [
string,string][]
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:61
method
Section titled “method”method:
string
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:59
url:
string
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:58
HttpResponse
Section titled “HttpResponse”Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:63
Properties
Section titled “Properties”body:
Uint8Array
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:64
headers
Section titled “headers”headers: [
string,string][]
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:65
status_code
Section titled “status_code”status_code:
number
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:66
InitArg
Section titled “InitArg”Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:69
Properties
Section titled “Properties”ledger_id
Section titled “ledger_id”ledger_id:
Principal
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:70
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-icp/index.d.ts:76
The interval in seconds in which to retrieve blocks from the ledger. 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.
Status
Section titled “Status”Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:102
Properties
Section titled “Properties”num_blocks_synced
Section titled “num_blocks_synced”num_blocks_synced:
bigint
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:103
TimeStamp
Section titled “TimeStamp”Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:105
Properties
Section titled “Properties”timestamp_nanos
Section titled “timestamp_nanos”timestamp_nanos:
bigint
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:106
Tokens
Section titled “Tokens”Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:108
Properties
Section titled “Properties”e8s:
bigint
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:109
Transaction
Section titled “Transaction”Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:111
Properties
Section titled “Properties”created_at_time
Section titled “created_at_time”created_at_time: [] | [
TimeStamp]
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:116
icrc1_memo
Section titled “icrc1_memo”icrc1_memo: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:113
memo:
bigint
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:112
operation
Section titled “operation”operation:
Operation
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:114
timestamp
Section titled “timestamp”timestamp: [] | [
TimeStamp]
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:115
TransactionWithId
Section titled “TransactionWithId”Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:118
Properties
Section titled “Properties”id:
bigint
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:119
transaction
Section titled “transaction”transaction:
Transaction
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:120
UpgradeArg
Section titled “UpgradeArg”Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:122
Properties
Section titled “Properties”ledger_id
Section titled “ledger_id”ledger_id: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:123
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-icp/index.d.ts:129
The interval in seconds in which to retrieve blocks from the ledger. 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.
Type Aliases
Section titled “Type Aliases”GetAccountIdentifierTransactionsResult
Section titled “GetAccountIdentifierTransactionsResult”GetAccountIdentifierTransactionsResult = {
Ok:GetAccountIdentifierTransactionsResponse; } | {Err:GetAccountIdentifierTransactionsError; }
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:30
IndexArg
Section titled “IndexArg”IndexArg = {
Upgrade:UpgradeArg; } | {Init:InitArg; }
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:68
Operation
Section titled “Operation”Operation = {
Approve: {allowance:Tokens;expected_allowance: [] | [Tokens];expires_at: [] | [TimeStamp];fee:Tokens;from:string;spender:string; }; } | {Burn: {amount:Tokens;from:string;spender: [] | [string]; }; } | {Mint: {amount:Tokens;to:string; }; } | {Transfer: {amount:Tokens;fee:Tokens;from:string;spender: [] | [string];to:string; }; }
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:78
Variables
Section titled “Variables”idlFactory
Section titled “idlFactory”
constidlFactory:IDL.InterfaceFactory
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:147
init()
Section titled “init()”
constinit: (args) =>IDL.Type[]
Defined in: packages/canisters/src/declarations/ledger-icp/index.d.ts:148
Parameters
Section titled “Parameters”typeof IDL
Returns
Section titled “Returns”IDL.Type[]