CkEthOrchestratorCanister
Defined in: packages/canisters/src/cketh/orchestrator.canister.ts:15
Class representing the CkEth Orchestrator Canister, which manages the Ledger and Index canisters of ckERC20 tokens.
Extends
Section titled “Extends”Canister<_SERVICE>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”
protectednew CkEthOrchestratorCanister(id,service,certifiedService):CkEthOrchestratorCanister
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”CkEthOrchestratorCanister
Inherited from
Section titled “Inherited from”Canister<CkEthOrchestratorService>.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”getOrchestratorInfo()
Section titled “getOrchestratorInfo()”getOrchestratorInfo(
params?):Promise<OrchestratorInfo>
Defined in: packages/canisters/src/cketh/orchestrator.canister.ts:40
Retrieves orchestrator information, which contains the list of existing ckERC20 Ledger and Index canisters.
Parameters
Section titled “Parameters”params?
Section titled “params?”QueryParams = {}
The query parameters.
Returns
Section titled “Returns”Promise<OrchestratorInfo>
A promise that resolves to the orchestrator information.
create()
Section titled “create()”
staticcreate(options):CkEthOrchestratorCanister
Defined in: packages/canisters/src/cketh/orchestrator.canister.ts:21
Creates an instance of CkEthOrchestratorCanister.
Parameters
Section titled “Parameters”options
Section titled “options”CkEthOrchestratorCanisterOptions<_SERVICE>
Options for creating the canister.
Returns
Section titled “Returns”CkEthOrchestratorCanister
A new instance of CkEthOrchestratorCanister.