IcrcIndexCanister
Defined in: packages/canisters/src/ledger/icrc/index.canister.ts:21
Extends
Section titled “Extends”IcrcCanister<_SERVICE>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”
protectednew IcrcIndexCanister(id,service,certifiedService):IcrcIndexCanister
Defined in: packages/utils/dist/services/canister.d.ts:7
Parameters
Section titled “Parameters”Principal
service
Section titled “service”certifiedService
Section titled “certifiedService”Returns
Section titled “Returns”IcrcIndexCanister
Inherited from
Section titled “Inherited from”IcrcCanister<IcrcIndexService>.constructor
Properties
Section titled “Properties”caller()
Section titled “caller()”
protectedcaller: (__namedParameters) =>_SERVICE
Defined in: packages/utils/dist/services/canister.d.ts:9
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”QueryParams
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”IcrcCanister.caller
certifiedService
Section titled “certifiedService”
protectedreadonlycertifiedService:_SERVICE
Defined in: packages/utils/dist/services/canister.d.ts:6
Inherited from
Section titled “Inherited from”IcrcCanister.certifiedService
service
Section titled “service”
protectedreadonlyservice:_SERVICE
Defined in: packages/utils/dist/services/canister.d.ts:5
Inherited from
Section titled “Inherited from”IcrcCanister.service
Accessors
Section titled “Accessors”canisterId
Section titled “canisterId”Get Signature
Section titled “Get Signature”get canisterId():
Principal
Defined in: packages/utils/dist/services/canister.d.ts:8
Returns
Section titled “Returns”Principal
Inherited from
Section titled “Inherited from”IcrcCanister.canisterId
Methods
Section titled “Methods”balance()
Section titled “balance()”balance(
params):Promise<bigint>
Defined in: packages/canisters/src/ledger/icrc/canister.ts:15
Returns the balance for a given account provided as owner and with optional subaccount.
Parameters
Section titled “Parameters”params
Section titled “params”The parameters to get the balance of an account.
Returns
Section titled “Returns”Promise<bigint>
The balance of the given account.
Inherited from
Section titled “Inherited from”IcrcCanister.balance
getTransactions()
Section titled “getTransactions()”getTransactions(
params):Promise<GetTransactions>
Defined in: packages/canisters/src/ledger/icrc/index.canister.ts:47
Get the transactions of an account.
Parameters
Section titled “Parameters”params
Section titled “params”GetIndexAccountTransactionsParams
The parameters to get the transactions of an account.
Returns
Section titled “Returns”Promise<GetTransactions>
The list of transactions and further related information of the given account.
ledgerId()
Section titled “ledgerId()”ledgerId(
params):Promise<Principal>
Defined in: packages/canisters/src/ledger/icrc/index.canister.ts:65
Returns the ledger canister ID related to the index canister.
Parameters
Section titled “Parameters”params
Section titled “params”QueryParams
Returns
Section titled “Returns”Promise<Principal>
listSubaccounts()
Section titled “listSubaccounts()”listSubaccounts(
params):Promise<SubAccount[]>
Defined in: packages/canisters/src/ledger/icrc/index.canister.ts:85
Returns the list of subaccounts for a given owner.
Parameters
Section titled “Parameters”params
Section titled “params”The parameters to get the list of subaccounts.
Returns
Section titled “Returns”Promise<SubAccount[]>
The list of subaccounts.
status()
Section titled “status()”status(
params):Promise<Status>
Defined in: packages/canisters/src/ledger/icrc/index.canister.ts:76
Returns the status of the index canister.
Parameters
Section titled “Parameters”params
Section titled “params”QueryParams
The parameters to get the status of the index canister.
Returns
Section titled “Returns”Promise<Status>
The status of the index canister.
create()
Section titled “create()”
staticcreate(options):IcrcIndexCanister
Defined in: packages/canisters/src/ledger/icrc/index.canister.ts:22
Parameters
Section titled “Parameters”options
Section titled “options”IcrcLedgerCanisterOptions<_SERVICE>
Returns
Section titled “Returns”IcrcIndexCanister