CkEthOrchestratorDid
Interfaces
Section titled “Interfaces”_SERVICE
Section titled “_SERVICE”Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:292
Properties
Section titled “Properties”canister_ids
Section titled “canister_ids”canister_ids:
ActorMethod<[Erc20Contract], [] | [ManagedCanisterIds]>
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:296
Managed canister IDs for a given ERC20 contract
get_canister_status
Section titled “get_canister_status”get_canister_status:
ActorMethod<[],CanisterStatusResponse>
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:300
Retrieve the status of the canister.
get_orchestrator_info
Section titled “get_orchestrator_info”get_orchestrator_info:
ActorMethod<[],OrchestratorInfo>
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:304
Return internal orchestrator parameters
AddErc20Arg
Section titled “AddErc20Arg”Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:13
Properties
Section titled “Properties”contract
Section titled “contract”contract:
Erc20Contract
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:14
ledger_init_arg
Section titled “ledger_init_arg”ledger_init_arg:
LedgerInitArg
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:15
CanisterStatusResponse
Section titled “CanisterStatusResponse”Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:17
Properties
Section titled “Properties”cycles
Section titled “cycles”cycles:
bigint
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:20
idle_cycles_burned_per_day
Section titled “idle_cycles_burned_per_day”idle_cycles_burned_per_day:
bigint
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:23
memory_size
Section titled “memory_size”memory_size:
bigint
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:19
module_hash
Section titled “module_hash”module_hash: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:24
query_stats
Section titled “query_stats”query_stats:
QueryStats
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:22
reserved_cycles
Section titled “reserved_cycles”reserved_cycles:
bigint
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:25
settings
Section titled “settings”settings:
DefiniteCanisterSettings
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:21
status
Section titled “status”status:
CanisterStatusType
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:18
CyclesManagement
Section titled “CyclesManagement”Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:31
Properties
Section titled “Properties”cycles_for_archive_creation
Section titled “cycles_for_archive_creation”cycles_for_archive_creation:
bigint
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:43
Number of cycles when creating a new ICRC1 archive canister.
cycles_for_index_creation
Section titled “cycles_for_index_creation”cycles_for_index_creation:
bigint
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:47
Number of cycles when creating a new ICRC1 index canister.
cycles_for_ledger_creation
Section titled “cycles_for_ledger_creation”cycles_for_ledger_creation:
bigint
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:39
Number of cycles when creating a new ICRC1 ledger canister.
cycles_top_up_increment
Section titled “cycles_top_up_increment”cycles_top_up_increment:
bigint
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:35
Number of cycles to add to a canister managed by the orchestrator whose cycles balance is running low.
DefiniteCanisterSettings
Section titled “DefiniteCanisterSettings”Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:49
Properties
Section titled “Properties”compute_allocation
Section titled “compute_allocation”compute_allocation:
bigint
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:56
controllers
Section titled “controllers”controllers:
Principal[]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:51
freezing_threshold
Section titled “freezing_threshold”freezing_threshold:
bigint
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:50
log_visibility
Section titled “log_visibility”log_visibility:
LogVisibility
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:53
memory_allocation
Section titled “memory_allocation”memory_allocation:
bigint
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:55
reserved_cycles_limit
Section titled “reserved_cycles_limit”reserved_cycles_limit:
bigint
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:52
wasm_memory_limit
Section titled “wasm_memory_limit”wasm_memory_limit:
bigint
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:54
Erc20Contract
Section titled “Erc20Contract”Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:58
Properties
Section titled “Properties”address
Section titled “address”address:
string
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:60
chain_id
Section titled “chain_id”chain_id:
bigint
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:59
InitArg
Section titled “InitArg”Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:62
Properties
Section titled “Properties”cycles_management
Section titled “cycles_management”cycles_management: [] | [
CyclesManagement]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:66
Controls the cycles management of the canisters managed by the orchestrator.
minter_id
Section titled “minter_id”minter_id: [] | [
Principal]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:75
Canister ID of the minter that will be notified when new ERC-20 tokens are added.
more_controller_ids
Section titled “more_controller_ids”more_controller_ids:
Principal[]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:71
All canisters that will be spawned off by the orchestrator will be controlled by the orchestrator and additionally by the following controllers.
InstalledCanister
Section titled “InstalledCanister”Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:77
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:78
installed_wasm_hash
Section titled “installed_wasm_hash”installed_wasm_hash:
string
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:79
InstalledLedgerSuite
Section titled “InstalledLedgerSuite”Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:81
Properties
Section titled “Properties”archives
Section titled “archives”archives: [] | [
Principal[]]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:97
List of archive canister ids
index:
InstalledCanister
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:93
Index canister
ledger
Section titled “ledger”ledger:
InstalledCanister
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:89
Ledger canister
token_symbol
Section titled “token_symbol”token_symbol:
string
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:85
Token symbol on the ledger
LedgerInitArg
Section titled “LedgerInitArg”Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:103
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.
Properties
Section titled “Properties”decimals
Section titled “decimals”decimals:
number
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:104
token_logo
Section titled “token_logo”token_logo:
string
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:107
token_name
Section titled “token_name”token_name:
string
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:108
token_symbol
Section titled “token_symbol”token_symbol:
string
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:105
transfer_fee
Section titled “transfer_fee”transfer_fee:
bigint
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:106
LedgerSuiteVersion
Section titled “LedgerSuiteVersion”Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:110
Properties
Section titled “Properties”archive_compressed_wasm_hash
Section titled “archive_compressed_wasm_hash”archive_compressed_wasm_hash:
string
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:115
Hexadecimal encoding of the SHA2-256 archive compressed wasm hash, e.g., “e59ec306ef67d0ec2e8919e8f6366aff31c666346e238d07d52f616bef61ccab”.
index_compressed_wasm_hash
Section titled “index_compressed_wasm_hash”index_compressed_wasm_hash:
string
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:127
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
Section titled “ledger_compressed_wasm_hash”ledger_compressed_wasm_hash:
string
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:121
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.
ManagedCanisterIds
Section titled “ManagedCanisterIds”Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:133
Properties
Section titled “Properties”archives
Section titled “archives”archives:
Principal[]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:136
index: [] | [
Principal]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:135
ledger
Section titled “ledger”ledger: [] | [
Principal]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:134
ManagedCanisters
Section titled “ManagedCanisters”Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:153
Properties
Section titled “Properties”archives
Section titled “archives”archives:
Principal[]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:169
List of archive canister ids
ckerc20_token_symbol
Section titled “ckerc20_token_symbol”ckerc20_token_symbol:
string
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:173
ckERC20 Token symbol
erc20_contract
Section titled “erc20_contract”erc20_contract:
Erc20Contract
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:157
Corresponding ERC20 contract
index: [] | [
ManagedCanisterStatus]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:165
Status of the index canister
ledger
Section titled “ledger”ledger: [] | [
ManagedCanisterStatus]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:161
Status of the ledger canister
ManagedLedgerSuite
Section titled “ManagedLedgerSuite”Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:175
Properties
Section titled “Properties”archives
Section titled “archives”archives:
Principal[]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:191
List of archive canister ids
index: [] | [
ManagedCanisterStatus]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:187
Status of the index canister
ledger
Section titled “ledger”ledger: [] | [
ManagedCanisterStatus]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:183
Status of the ledger canister
token_symbol
Section titled “token_symbol”token_symbol:
string
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:179
Token symbol
OrchestratorInfo
Section titled “OrchestratorInfo”Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:197
Properties
Section titled “Properties”cycles_management
Section titled “cycles_management”cycles_management:
CyclesManagement
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:201
Cycle management parameters.
ledger_suite_version
Section titled “ledger_suite_version”ledger_suite_version: [] | [
LedgerSuiteVersion]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:218
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
Section titled “managed_canisters”managed_canisters:
ManagedCanisters[]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:205
List of managed canisters data for each ERC20 contract.
managed_pre_existing_ledger_suites
Section titled “managed_pre_existing_ledger_suites”managed_pre_existing_ledger_suites: [] | [
ManagedLedgerSuite[]]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:210
List of managed ledger suites that were not initially installed by the orchestrator. Those ledger suites are NOT necessarily ckERC20 tokens.
minter_id
Section titled “minter_id”minter_id: [] | [
Principal]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:222
ckETH minter canister id.
more_controller_ids
Section titled “more_controller_ids”more_controller_ids:
Principal[]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:214
Additional controllers that new canisters will be spawned with.
QueryStats
Section titled “QueryStats”Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:224
Properties
Section titled “Properties”num_calls_total
Section titled “num_calls_total”num_calls_total:
bigint
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:227
num_instructions_total
Section titled “num_instructions_total”num_instructions_total:
bigint
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:226
request_payload_bytes_total
Section titled “request_payload_bytes_total”request_payload_bytes_total:
bigint
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:228
response_payload_bytes_total
Section titled “response_payload_bytes_total”response_payload_bytes_total:
bigint
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:225
UpdateCyclesManagement
Section titled “UpdateCyclesManagement”Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:230
Properties
Section titled “Properties”cycles_for_archive_creation
Section titled “cycles_for_archive_creation”cycles_for_archive_creation: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:244
Change the number of cycles when creating a new ICRC1 archive canister. Previously created canisters are not affected.
cycles_for_index_creation
Section titled “cycles_for_index_creation”cycles_for_index_creation: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:249
Change the number of cycles when creating a new ICRC1 index canister. Previously created canisters are not affected.
cycles_for_ledger_creation
Section titled “cycles_for_ledger_creation”cycles_for_ledger_creation: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:239
Change the number of cycles when creating a new ICRC1 ledger canister. Previously created canisters are not affected.
cycles_top_up_increment
Section titled “cycles_top_up_increment”cycles_top_up_increment: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:234
Change the number of cycles to add to a canister managed by the orchestrator whose cycles balance is running low.
UpgradeArg
Section titled “UpgradeArg”Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:251
Properties
Section titled “Properties”archive_compressed_wasm_hash
Section titled “archive_compressed_wasm_hash”archive_compressed_wasm_hash: [] | [
string]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:268
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
Section titled “cycles_management”cycles_management: [] | [
UpdateCyclesManagement]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:261
Update the cycles management of the canisters managed by the orchestrator.
git_commit_hash
Section titled “git_commit_hash”git_commit_hash: [] | [
string]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:276
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
Section titled “index_compressed_wasm_hash”index_compressed_wasm_hash: [] | [
string]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:290
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
Section titled “ledger_compressed_wasm_hash”ledger_compressed_wasm_hash: [] | [
string]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:283
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
Section titled “manage_ledger_suites”manage_ledger_suites: [] | [
InstalledLedgerSuite[]]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:257
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.
Type Aliases
Section titled “Type Aliases”CanisterStatusType
Section titled “CanisterStatusType”CanisterStatusType = {
stopped:null; } | {stopping:null; } | {running:null; }
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:27
LogVisibility
Section titled “LogVisibility”LogVisibility = {
controllers:null; } | {public:null; } | {allowed_viewers:Principal[]; }
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:129
ManagedCanisterStatus
Section titled “ManagedCanisterStatus”ManagedCanisterStatus = {
Created: {canister_id:Principal; }; } | {Installed: {canister_id:Principal;installed_wasm_hash:string; }; }
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:138
Type Declaration
Section titled “Type Declaration”{ Created: { canister_id: Principal; }; }
Created
Section titled “Created”Created:
object
Canister created with the given principal but wasm module is not yet installed.
Created.canister_id
Section titled “Created.canister_id”canister_id:
Principal
{ Installed: { canister_id: Principal; installed_wasm_hash: string; }; }
Installed
Section titled “Installed”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)
Installed.canister_id
Section titled “Installed.canister_id”canister_id:
Principal
Installed.installed_wasm_hash
Section titled “Installed.installed_wasm_hash”installed_wasm_hash:
string
OrchestratorArg
Section titled “OrchestratorArg”OrchestratorArg = {
UpgradeArg:UpgradeArg; } | {InitArg:InitArg; } | {AddErc20Arg:AddErc20Arg; }
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:193
Variables
Section titled “Variables”idlFactory
Section titled “idlFactory”
constidlFactory:IDL.InterfaceFactory
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:306
init()
Section titled “init()”
constinit: (args) =>IDL.Type[]
Defined in: packages/canisters/src/declarations/cketh/orchestrator.d.ts:307
Parameters
Section titled “Parameters”typeof IDL
Returns
Section titled “Returns”IDL.Type[]