IndexCanister
Defined in: packages/ledger-icp/src/index.canister.ts:19
Extends
Section titled “Extends”Canister<_SERVICE>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”
protectednew IndexCanister(id,service,certifiedService):IndexCanister
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”IndexCanister
Inherited from
Section titled “Inherited from”Canister<IndexService>.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”Canister.caller
certifiedService
Section titled “certifiedService”
protectedreadonlycertifiedService:_SERVICE
Defined in: packages/utils/dist/services/canister.d.ts:6
Inherited from
Section titled “Inherited from”Canister.certifiedService
service
Section titled “service”
protectedreadonlyservice:_SERVICE
Defined in: packages/utils/dist/services/canister.d.ts:5
Inherited from
Section titled “Inherited from”Canister.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”Canister.canisterId
Methods
Section titled “Methods”accountBalance()
Section titled “accountBalance()”accountBalance(
params):Promise<bigint>
Defined in: packages/ledger-icp/src/index.canister.ts:45
Returns the balance of the specified account identifier.
Parameters
Section titled “Parameters”params
Section titled “params”AccountBalanceParams
The parameters to get the balance of an account.
Returns
Section titled “Returns”Promise<bigint>
The balance of the given account.
getTransactions()
Section titled “getTransactions()”getTransactions(
params):Promise<GetAccountIdentifierTransactionsResponse>
Defined in: packages/ledger-icp/src/index.canister.ts:64
Returns the transactions and balance of an ICP account.
Parameters
Section titled “Parameters”params
Section titled “params”GetTransactionsParams
The parameters to get the transactions.
Returns
Section titled “Returns”Promise<GetAccountIdentifierTransactionsResponse>
The transactions, balance and the transaction id of the oldest transaction the account has.
Throws
Section titled “Throws”IndexError
create()
Section titled “create()”
staticcreate(__namedParameters):IndexCanister
Defined in: packages/ledger-icp/src/index.canister.ts:20
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”CanisterOptions<_SERVICE>
Returns
Section titled “Returns”IndexCanister