Skip to content

CkEthOrchestratorDid

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:311

canister_ids: ActorMethod<[Erc20Contract], [] | [ManagedCanisterIds]>

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:315

Managed canister IDs for a given ERC20 contract

get_canister_status: ActorMethod<[], CanisterStatusResponse>

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:319

Retrieve the status of the canister.

get_orchestrator_info: ActorMethod<[], OrchestratorInfo>

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:323

Return internal orchestrator parameters


Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:13

contract: Erc20Contract

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:14

ledger_init_arg: LedgerInitArg

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:15


Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:17

cycles: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:23

idle_cycles_burned_per_day: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:26

memory_metrics: MemoryMetrics

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:18

memory_size: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:20

module_hash: [] | [Uint8Array<ArrayBufferLike>]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:27

query_stats: QueryStats

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:25

ready_for_migration: boolean

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:21

reserved_cycles: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:28

settings: DefiniteCanisterSettings

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:24

status: CanisterStatusType

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:19

version: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:22


Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:34

cycles_for_archive_creation: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:46

Number of cycles when creating a new ICRC1 archive canister.

cycles_for_index_creation: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:50

Number of cycles when creating a new ICRC1 index canister.

cycles_for_ledger_creation: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:42

Number of cycles when creating a new ICRC1 ledger canister.

cycles_top_up_increment: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:38

Number of cycles to add to a canister managed by the orchestrator whose cycles balance is running low.


Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:52

compute_allocation: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:61

controllers: Principal[]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:56

environment_variables: environment_variable[]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:55

freezing_threshold: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:53

log_visibility: LogVisibility

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:58

memory_allocation: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:60

reserved_cycles_limit: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:57

wasm_memory_limit: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:59

wasm_memory_threshold: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:54


Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:307

name: string

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:309

value: string

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:308


Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:63

address: string

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:65

chain_id: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:64


Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:67

cycles_management: [] | [CyclesManagement]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:71

Controls the cycles management of the canisters managed by the orchestrator.

minter_id: [] | [Principal]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:80

Canister ID of the minter that will be notified when new ERC-20 tokens are added.

more_controller_ids: Principal[]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:76

All canisters that will be spawned off by the orchestrator will be controlled by the orchestrator and additionally by the following controllers.


Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:82

canister_id: Principal

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:83

installed_wasm_hash: string

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:84


Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:86

archives: [] | [Principal[]]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:102

List of archive canister ids

index: InstalledCanister

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:98

Index canister

ledger: InstalledCanister

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:94

Ledger canister

token_symbol: string

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:90

Token symbol on the ledger


Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:108

ICRC1 ledger initialization argument that will be used when the orchestrator spawns a new ledger canister. Other fields, such as archive_options, needed to initialize a new ledger will be set by the orchestrator.

decimals: number

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:109

token_logo: string

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:112

token_name: string

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:113

token_symbol: string

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:110

transfer_fee: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:111


Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:115

archive_compressed_wasm_hash: string

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:120

Hexadecimal encoding of the SHA2-256 archive compressed wasm hash, e.g., “e59ec306ef67d0ec2e8919e8f6366aff31c666346e238d07d52f616bef61ccab”.

index_compressed_wasm_hash: string

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:132

Hexadecimal encoding of the SHA2-256 index compressed wasm hash, e.g., “3a6d39b5e94cdef5203bca62720e75a28cd071ff434d22b9746403ac7ae59614”. This exact version will be used to spawn off a new index canister when an ERC-20 token is added.

ledger_compressed_wasm_hash: string

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:126

Hexadecimal encoding of the SHA2-256 ledger compressed wasm hash, e.g., “3148f7a9f1b0ee39262c8abe3b08813480cf78551eee5a60ab1cf38433b5d9b0”. This exact version will be used to spawn off a new ledger canister when an ERC-20 token is added.


Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:138

archives: Principal[]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:141

index: [] | [Principal]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:140

ledger: [] | [Principal]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:139


Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:158

archives: Principal[]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:174

List of archive canister ids

ckerc20_token_symbol: string

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:178

ckERC20 Token symbol

erc20_contract: Erc20Contract

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:162

Corresponding ERC20 contract

index: [] | [ManagedCanisterStatus]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:170

Status of the index canister

ledger: [] | [ManagedCanisterStatus]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:166

Status of the ledger canister


Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:180

archives: Principal[]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:196

List of archive canister ids

index: [] | [ManagedCanisterStatus]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:192

Status of the index canister

ledger: [] | [ManagedCanisterStatus]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:188

Status of the ledger canister

token_symbol: string

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:184

Token symbol


Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:198

canister_history_size: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:201

custom_sections_size: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:206

global_memory_size: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:205

snapshots_size: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:203

stable_memory_size: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:202

wasm_binary_size: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:199

wasm_chunk_store_size: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:200

wasm_memory_size: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:204


Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:212

cycles_management: CyclesManagement

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:216

Cycle management parameters.

ledger_suite_version: [] | [LedgerSuiteVersion]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:233

Ledger suite version that will be used to spawn off a new ledger suite (ledger and index canisters) when an ERC-20 token is added.

managed_canisters: ManagedCanisters[]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:220

List of managed canisters data for each ERC20 contract.

managed_pre_existing_ledger_suites: [] | [ManagedLedgerSuite[]]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:225

List of managed ledger suites that were not initially installed by the orchestrator. Those ledger suites are NOT necessarily ckERC20 tokens.

minter_id: [] | [Principal]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:237

ckETH minter canister id.

more_controller_ids: Principal[]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:229

Additional controllers that new canisters will be spawned with.


Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:239

num_calls_total: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:242

num_instructions_total: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:241

request_payload_bytes_total: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:243

response_payload_bytes_total: bigint

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:240


Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:245

cycles_for_archive_creation: [] | [bigint]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:259

Change the number of cycles when creating a new ICRC1 archive canister. Previously created canisters are not affected.

cycles_for_index_creation: [] | [bigint]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:264

Change the number of cycles when creating a new ICRC1 index canister. Previously created canisters are not affected.

cycles_for_ledger_creation: [] | [bigint]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:254

Change the number of cycles when creating a new ICRC1 ledger canister. Previously created canisters are not affected.

cycles_top_up_increment: [] | [bigint]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:249

Change the number of cycles to add to a canister managed by the orchestrator whose cycles balance is running low.


Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:266

archive_compressed_wasm_hash: [] | [string]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:283

Hexadecimal encoding of the SHA2-256 archive compressed wasm hash, e.g., “b24812976b2cc64f12faf813cf592631f3062bfda837334f77ab807361d64e82”. This exact version will be used for upgrading all existing archive canisters managed by the orchestrator. Leaving this field empty will not upgrade the archive canisters.

cycles_management: [] | [UpdateCyclesManagement]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:276

Update the cycles management of the canisters managed by the orchestrator.

git_commit_hash: [] | [string]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:291

Hexadecimal encoding of the SHA-1 git commit hash used for this upgrade, e.g., “51d01d3936498d4010de54505d6433e9ad5cc62b”, corresponding to a git revision in the IC repository. If this field is present, the orchestrator will register all embedded wasms (ledger, index, and archive) in its stable memory, so that those exact wasms can be used to upgrade managed canisters as specified below.

index_compressed_wasm_hash: [] | [string]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:305

Hexadecimal encoding of the SHA2-256 index compressed wasm hash, e.g., “3a6d39b5e94cdef5203bca62720e75a28cd071ff434d22b9746403ac7ae59614”. This exact version will be used for upgrading all existing index canisters managed by the orchestrator. Leaving this field empty will not upgrade the index canisters.

ledger_compressed_wasm_hash: [] | [string]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:298

Hexadecimal encoding of the SHA2-256 ledger compressed wasm hash, e.g., “3148f7a9f1b0ee39262c8abe3b08813480cf78551eee5a60ab1cf38433b5d9b0”. This exact version will be used for upgrading all existing ledger canisters managed by the orchestrator. Leaving this field empty will not upgrade the ledger canisters.

manage_ledger_suites: [] | [InstalledLedgerSuite[]]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:272

Add already installed ledger suites to the canisters managed by the orchestrator. Those ledger suites are NOT necessarily ckERC20 tokens. This assumes that the orchestrator is a controller of all the canisters in the list.

CanisterStatusType = { stopped: null; } | { stopping: null; } | { running: null; }

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:30


LogVisibility = { controllers: null; } | { public: null; } | { allowed_viewers: Principal[]; }

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:134


ManagedCanisterStatus = { Created: { canister_id: Principal; }; } | { Installed: { canister_id: Principal; installed_wasm_hash: string; }; }

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:143

{ Created: { canister_id: Principal; }; }

Created: object

Canister created with the given principal but wasm module is not yet installed.

canister_id: Principal

{ Installed: { canister_id: Principal; installed_wasm_hash: string; }; }

Installed: object

Canister created and wasm module installed. The wasm_hash reflects the installed wasm module by the orchestrator but may differ from the one being currently deployed (if another controller did an upgrade)

canister_id: Principal

installed_wasm_hash: string


OrchestratorArg = { UpgradeArg: UpgradeArg; } | { InitArg: InitArg; } | { AddErc20Arg: AddErc20Arg; }

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:208

const idlFactory: IDL.InterfaceFactory

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:325


const init: (args) => IDL.Type[]

Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:326

typeof IDL

IDL.Type[]