IcManagementDid
Interfaces
Section titled “Interfaces”_SERVICE
Section titled “_SERVICE”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:529
Properties
Section titled “Properties”bitcoin_get_balance
Section titled “bitcoin_get_balance”bitcoin_get_balance:
ActorMethod<[bitcoin_get_balance_args],bigint>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:533
bitcoin interface
bitcoin_get_block_headers
Section titled “bitcoin_get_block_headers”bitcoin_get_block_headers:
ActorMethod<[bitcoin_get_block_headers_args],bitcoin_get_block_headers_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:537
bitcoin_get_current_fee_percentiles
Section titled “bitcoin_get_current_fee_percentiles”bitcoin_get_current_fee_percentiles:
ActorMethod<[bitcoin_get_current_fee_percentiles_args],bitcoin_get_current_fee_percentiles_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:541
bitcoin_get_utxos
Section titled “bitcoin_get_utxos”bitcoin_get_utxos:
ActorMethod<[bitcoin_get_utxos_args],bitcoin_get_utxos_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:545
bitcoin_send_transaction
Section titled “bitcoin_send_transaction”bitcoin_send_transaction:
ActorMethod<[bitcoin_send_transaction_args],undefined>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:549
canister_info
Section titled “canister_info”canister_info:
ActorMethod<[canister_info_args],canister_info_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:556
Public canister data
canister_metadata
Section titled “canister_metadata”canister_metadata:
ActorMethod<[canister_metadata_args],canister_metadata_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:557
canister_metrics
Section titled “canister_metrics”canister_metrics:
ActorMethod<[canister_metrics_args],canister_metrics_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:564
Returns canister related metrics
canister_status
Section titled “canister_status”canister_status:
ActorMethod<[canister_status_args],canister_status_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:568
clear_chunk_store
Section titled “clear_chunk_store”clear_chunk_store:
ActorMethod<[clear_chunk_store_args],undefined>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:569
create_canister
Section titled “create_canister”create_canister:
ActorMethod<[create_canister_args],create_canister_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:570
delete_canister
Section titled “delete_canister”delete_canister:
ActorMethod<[delete_canister_args],undefined>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:571
delete_canister_snapshot
Section titled “delete_canister_snapshot”delete_canister_snapshot:
ActorMethod<[delete_canister_snapshot_args],undefined>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:572
deposit_cycles
Section titled “deposit_cycles”deposit_cycles:
ActorMethod<[deposit_cycles_args],undefined>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:576
ecdsa_public_key
Section titled “ecdsa_public_key”ecdsa_public_key:
ActorMethod<[ecdsa_public_key_args],ecdsa_public_key_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:580
Threshold ECDSA signature
fetch_canister_logs
Section titled “fetch_canister_logs”fetch_canister_logs:
ActorMethod<[fetch_canister_logs_args],fetch_canister_logs_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:587
canister logging
http_request
Section titled “http_request”http_request:
ActorMethod<[http_request_args],http_request_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:591
install_chunked_code
Section titled “install_chunked_code”install_chunked_code:
ActorMethod<[install_chunked_code_args],undefined>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:592
install_code
Section titled “install_code”install_code:
ActorMethod<[install_code_args],undefined>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:593
list_canister_snapshots
Section titled “list_canister_snapshots”list_canister_snapshots:
ActorMethod<[list_canister_snapshots_args],list_canister_snapshots_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:594
list_canisters
Section titled “list_canisters”list_canisters:
ActorMethod<[],list_canisters_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:601
subnet admin methods
load_canister_snapshot
Section titled “load_canister_snapshot”load_canister_snapshot:
ActorMethod<[load_canister_snapshot_args],undefined>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:602
node_metrics_history
Section titled “node_metrics_history”node_metrics_history:
ActorMethod<[node_metrics_history_args],node_metrics_history_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:606
metrics interface
provisional_create_canister_with_cycles
Section titled “provisional_create_canister_with_cycles”provisional_create_canister_with_cycles:
ActorMethod<[provisional_create_canister_with_cycles_args],provisional_create_canister_with_cycles_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:613
provisional interfaces for the pre-ledger world
provisional_top_up_canister
Section titled “provisional_top_up_canister”provisional_top_up_canister:
ActorMethod<[provisional_top_up_canister_args],undefined>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:617
raw_rand
Section titled “raw_rand”raw_rand:
ActorMethod<[],raw_rand_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:621
read_canister_snapshot_data
Section titled “read_canister_snapshot_data”read_canister_snapshot_data:
ActorMethod<[read_canister_snapshot_data_args],read_canister_snapshot_data_response>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:622
read_canister_snapshot_metadata
Section titled “read_canister_snapshot_metadata”read_canister_snapshot_metadata:
ActorMethod<[read_canister_snapshot_metadata_args],read_canister_snapshot_metadata_response>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:626
schnorr_public_key
Section titled “schnorr_public_key”schnorr_public_key:
ActorMethod<[schnorr_public_key_args],schnorr_public_key_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:633
Threshold Schnorr signature
sign_with_ecdsa
Section titled “sign_with_ecdsa”sign_with_ecdsa:
ActorMethod<[sign_with_ecdsa_args],sign_with_ecdsa_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:637
sign_with_schnorr
Section titled “sign_with_schnorr”sign_with_schnorr:
ActorMethod<[sign_with_schnorr_args],sign_with_schnorr_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:638
start_canister
Section titled “start_canister”start_canister:
ActorMethod<[start_canister_args],undefined>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:642
stop_canister
Section titled “stop_canister”stop_canister:
ActorMethod<[stop_canister_args],undefined>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:643
stored_chunks
Section titled “stored_chunks”stored_chunks:
ActorMethod<[stored_chunks_args],stored_chunks_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:644
subnet_info
Section titled “subnet_info”subnet_info:
ActorMethod<[subnet_info_args],subnet_info_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:648
subnet info
take_canister_snapshot
Section titled “take_canister_snapshot”take_canister_snapshot:
ActorMethod<[take_canister_snapshot_args],snapshot>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:652
Canister snapshots
uninstall_code
Section titled “uninstall_code”uninstall_code:
ActorMethod<[uninstall_code_args],undefined>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:656
update_settings
Section titled “update_settings”update_settings:
ActorMethod<[update_settings_args],undefined>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:657
upload_canister_snapshot_data
Section titled “upload_canister_snapshot_data”upload_canister_snapshot_data:
ActorMethod<[upload_canister_snapshot_data_args],undefined>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:658
upload_canister_snapshot_metadata
Section titled “upload_canister_snapshot_metadata”upload_canister_snapshot_metadata:
ActorMethod<[upload_canister_snapshot_metadata_args],upload_canister_snapshot_metadata_response>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:662
upload_chunk
Section titled “upload_chunk”upload_chunk:
ActorMethod<[upload_chunk_args],chunk_hash>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:666
vetkd_derive_key
Section titled “vetkd_derive_key”vetkd_derive_key:
ActorMethod<[vetkd_derive_key_args],vetkd_derive_key_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:667
vetkd_public_key
Section titled “vetkd_public_key”vetkd_public_key:
ActorMethod<[vetkd_public_key_args],vetkd_public_key_result>
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:674
Threshold key derivation
bitcoin_get_balance_args
Section titled “bitcoin_get_balance_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:17
Properties
Section titled “Properties”address
Section titled “address”address:
string
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:19
min_confirmations
Section titled “min_confirmations”min_confirmations: [
number] | []
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:20
network
Section titled “network”network:
bitcoin_network
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:18
bitcoin_get_block_headers_args
Section titled “bitcoin_get_block_headers_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:23
Properties
Section titled “Properties”end_height
Section titled “end_height”end_height: [
number] | []
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:25
network
Section titled “network”network:
bitcoin_network
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:26
start_height
Section titled “start_height”start_height:
number
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:24
bitcoin_get_block_headers_result
Section titled “bitcoin_get_block_headers_result”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:28
Properties
Section titled “Properties”block_headers
Section titled “block_headers”block_headers:
bitcoin_block_header[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:30
tip_height
Section titled “tip_height”tip_height:
number
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:29
bitcoin_get_current_fee_percentiles_args
Section titled “bitcoin_get_current_fee_percentiles_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:32
Properties
Section titled “Properties”network
Section titled “network”network:
bitcoin_network
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:33
bitcoin_get_utxos_args
Section titled “bitcoin_get_utxos_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:36
Properties
Section titled “Properties”address
Section titled “address”address:
string
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:39
filter
Section titled “filter”filter: [] | [{
page:Uint8Array; } | {min_confirmations:number; }]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:38
network
Section titled “network”network:
bitcoin_network
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:37
bitcoin_get_utxos_result
Section titled “bitcoin_get_utxos_result”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:41
Properties
Section titled “Properties”next_page
Section titled “next_page”next_page: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:42
tip_block_hash
Section titled “tip_block_hash”tip_block_hash:
bitcoin_block_hash
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:44
tip_height
Section titled “tip_height”tip_height:
number
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:43
utxos:
utxo[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:45
bitcoin_send_transaction_args
Section titled “bitcoin_send_transaction_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:48
Properties
Section titled “Properties”network
Section titled “network”network:
bitcoin_network
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:50
transaction
Section titled “transaction”transaction:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:49
canister_id_range
Section titled “canister_id_range”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:53
Properties
Section titled “Properties”end:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:54
start:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:55
canister_info_args
Section titled “canister_info_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:57
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:58
num_requested_changes
Section titled “num_requested_changes”num_requested_changes: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:59
canister_info_result
Section titled “canister_info_result”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:61
Properties
Section titled “Properties”controllers
Section titled “controllers”controllers:
Principal[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:62
module_hash
Section titled “module_hash”module_hash: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:63
recent_changes
Section titled “recent_changes”recent_changes:
change[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:64
total_num_changes
Section titled “total_num_changes”total_num_changes:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:65
canister_log_record
Section titled “canister_log_record”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:82
Properties
Section titled “Properties”content
Section titled “content”content:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:85
idx:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:83
timestamp_nanos
Section titled “timestamp_nanos”timestamp_nanos:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:84
canister_metadata_args
Section titled “canister_metadata_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:87
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:89
name:
string
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:88
canister_metadata_result
Section titled “canister_metadata_result”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:91
Properties
Section titled “Properties”value:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:92
canister_metrics_args
Section titled “canister_metrics_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:94
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:95
canister_metrics_result
Section titled “canister_metrics_result”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:97
Properties
Section titled “Properties”cycles_consumed
Section titled “cycles_consumed”cycles_consumed:
cycles_consumed
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:98
canister_settings
Section titled “canister_settings”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:100
Properties
Section titled “Properties”compute_allocation
Section titled “compute_allocation”compute_allocation: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:110
controllers
Section titled “controllers”controllers: [] | [
Principal[]]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:104
environment_variables
Section titled “environment_variables”environment_variables: [] | [
environment_variable[]]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:103
freezing_threshold
Section titled “freezing_threshold”freezing_threshold: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:101
log_visibility
Section titled “log_visibility”log_visibility: [] | [
log_visibility]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:106
memory_allocation
Section titled “memory_allocation”memory_allocation: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:109
reserved_cycles_limit
Section titled “reserved_cycles_limit”reserved_cycles_limit: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:105
snapshot_visibility
Section titled “snapshot_visibility”snapshot_visibility: [] | [
snapshot_visibility]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:107
wasm_memory_limit
Section titled “wasm_memory_limit”wasm_memory_limit: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:108
wasm_memory_threshold
Section titled “wasm_memory_threshold”wasm_memory_threshold: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:102
canister_status_args
Section titled “canister_status_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:112
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:113
canister_status_result
Section titled “canister_status_result”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:115
Properties
Section titled “Properties”cycles
Section titled “cycles”cycles:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:130
idle_cycles_burned_per_day
Section titled “idle_cycles_burned_per_day”idle_cycles_burned_per_day:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:138
memory_metrics
Section titled “memory_metrics”memory_metrics:
object
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:116
canister_history_size
Section titled “canister_history_size”canister_history_size:
bigint
custom_sections_size
Section titled “custom_sections_size”custom_sections_size:
bigint
global_memory_size
Section titled “global_memory_size”global_memory_size:
bigint
snapshots_size
Section titled “snapshots_size”snapshots_size:
bigint
stable_memory_size
Section titled “stable_memory_size”stable_memory_size:
bigint
wasm_binary_size
Section titled “wasm_binary_size”wasm_binary_size:
bigint
wasm_chunk_store_size
Section titled “wasm_chunk_store_size”wasm_chunk_store_size:
bigint
wasm_memory_size
Section titled “wasm_memory_size”wasm_memory_size:
bigint
memory_size
Section titled “memory_size”memory_size:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:127
module_hash
Section titled “module_hash”module_hash: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:139
query_stats
Section titled “query_stats”query_stats:
object
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:132
num_calls_total
Section titled “num_calls_total”num_calls_total:
bigint
num_instructions_total
Section titled “num_instructions_total”num_instructions_total:
bigint
request_payload_bytes_total
Section titled “request_payload_bytes_total”request_payload_bytes_total:
bigint
response_payload_bytes_total
Section titled “response_payload_bytes_total”response_payload_bytes_total:
bigint
ready_for_migration
Section titled “ready_for_migration”ready_for_migration:
boolean
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:128
reserved_cycles
Section titled “reserved_cycles”reserved_cycles:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:140
settings
Section titled “settings”settings:
definite_canister_settings
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:131
status
Section titled “status”status: {
stopped:null; } | {stopping:null; } | {running:null; }
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:126
version
Section titled “version”version:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:129
change
Section titled “change”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:142
Properties
Section titled “Properties”canister_version
Section titled “canister_version”canister_version:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:144
details
Section titled “details”details:
change_details
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:146
origin
Section titled “origin”origin:
change_origin
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:145
timestamp_nanos
Section titled “timestamp_nanos”timestamp_nanos:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:143
chunk_hash
Section titled “chunk_hash”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:192
Properties
Section titled “Properties”hash:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:193
clear_chunk_store_args
Section titled “clear_chunk_store_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:195
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:196
create_canister_args
Section titled “create_canister_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:198
Properties
Section titled “Properties”sender_canister_version
Section titled “sender_canister_version”sender_canister_version: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:200
settings
Section titled “settings”settings: [] | [
canister_settings]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:199
create_canister_result
Section titled “create_canister_result”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:202
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:203
cycles_consumed
Section titled “cycles_consumed”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:205
Properties
Section titled “Properties”burned_cycles
Section titled “burned_cycles”burned_cycles:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:208
canister_creation
Section titled “canister_creation”canister_creation:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:207
compute_allocation
Section titled “compute_allocation”compute_allocation:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:220
http_outcalls
Section titled “http_outcalls”http_outcalls:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:209
ingress_induction
Section titled “ingress_induction”ingress_induction:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:218
instructions
Section titled “instructions”instructions:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:210
memory
Section titled “memory”memory:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:206
request_and_response_transmission
Section titled “request_and_response_transmission”request_and_response_transmission:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:219
uninstall
Section titled “uninstall”uninstall:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:217
This metric applies to canisters that ran out of cycles. In particular, uninstalling code explicitly would not result in this metric being updated. In fact, others might be updated in that case, e.g. cycles for ingress induction if the uninstallation of the canister was requested via an ingress message.
definite_canister_settings
Section titled “definite_canister_settings”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:222
Properties
Section titled “Properties”compute_allocation
Section titled “compute_allocation”compute_allocation:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:232
controllers
Section titled “controllers”controllers:
Principal[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:226
environment_variables
Section titled “environment_variables”environment_variables:
environment_variable[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:225
freezing_threshold
Section titled “freezing_threshold”freezing_threshold:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:223
log_visibility
Section titled “log_visibility”log_visibility:
log_visibility
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:228
memory_allocation
Section titled “memory_allocation”memory_allocation:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:231
reserved_cycles_limit
Section titled “reserved_cycles_limit”reserved_cycles_limit:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:227
snapshot_visibility
Section titled “snapshot_visibility”snapshot_visibility:
snapshot_visibility
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:229
wasm_memory_limit
Section titled “wasm_memory_limit”wasm_memory_limit:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:230
wasm_memory_threshold
Section titled “wasm_memory_threshold”wasm_memory_threshold:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:224
delete_canister_args
Section titled “delete_canister_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:234
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:235
delete_canister_snapshot_args
Section titled “delete_canister_snapshot_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:237
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:238
snapshot_id
Section titled “snapshot_id”snapshot_id:
snapshot_id
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:239
deposit_cycles_args
Section titled “deposit_cycles_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:241
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:242
ecdsa_public_key_args
Section titled “ecdsa_public_key_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:245
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:247
derivation_path
Section titled “derivation_path”derivation_path:
Uint8Array<ArrayBufferLike>[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:248
key_id
Section titled “key_id”key_id:
object
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:246
curve:
ecdsa_curve
name:
string
ecdsa_public_key_result
Section titled “ecdsa_public_key_result”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:250
Properties
Section titled “Properties”chain_code
Section titled “chain_code”chain_code:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:252
public_key
Section titled “public_key”public_key:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:251
environment_variable
Section titled “environment_variable”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:254
Properties
Section titled “Properties”name:
string
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:256
value:
string
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:255
fetch_canister_logs_args
Section titled “fetch_canister_logs_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:258
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:259
fetch_canister_logs_result
Section titled “fetch_canister_logs_result”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:261
Properties
Section titled “Properties”canister_log_records
Section titled “canister_log_records”canister_log_records:
canister_log_record[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:262
http_header
Section titled “http_header”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:264
Properties
Section titled “Properties”name:
string
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:266
value:
string
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:265
http_request_args
Section titled “http_request_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:268
Properties
Section titled “Properties”body: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:277
headers
Section titled “headers”headers:
http_header[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:279
is_replicated
Section titled “is_replicated”is_replicated: [] | [
boolean]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:280
max_response_bytes
Section titled “max_response_bytes”max_response_bytes: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:276
method
Section titled “method”method: {
get:null; } | {put:null; } | {head:null; } | {post:null; } | {delete:null; }
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:270
transform
Section titled “transform”transform: [] | [{
context:Uint8Array;function: [Principal,string]; }]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:278
url:
string
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:269
http_request_result
Section titled “http_request_result”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:282
Properties
Section titled “Properties”body:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:284
headers
Section titled “headers”headers:
http_header[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:285
status
Section titled “status”status:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:283
install_chunked_code_args
Section titled “install_chunked_code_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:287
Properties
Section titled “Properties”arg:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:288
chunk_hashes_list
Section titled “chunk_hashes_list”chunk_hashes_list:
chunk_hash[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:291
mode:
canister_install_mode
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:290
sender_canister_version
Section titled “sender_canister_version”sender_canister_version: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:294
store_canister
Section titled “store_canister”store_canister: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:293
target_canister
Section titled “target_canister”target_canister:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:292
wasm_module_hash
Section titled “wasm_module_hash”wasm_module_hash:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:289
install_code_args
Section titled “install_code_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:296
Properties
Section titled “Properties”arg:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:297
canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:300
mode:
canister_install_mode
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:299
sender_canister_version
Section titled “sender_canister_version”sender_canister_version: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:301
wasm_module
Section titled “wasm_module”wasm_module:
wasm_module
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:298
list_canister_snapshots_args
Section titled “list_canister_snapshots_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:303
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:304
list_canisters_result
Section titled “list_canisters_result”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:307
Properties
Section titled “Properties”canisters
Section titled “canisters”canisters:
canister_id_range[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:308
load_canister_snapshot_args
Section titled “load_canister_snapshot_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:310
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:311
sender_canister_version
Section titled “sender_canister_version”sender_canister_version: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:312
snapshot_id
Section titled “snapshot_id”snapshot_id:
snapshot_id
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:313
node_metrics
Section titled “node_metrics”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:320
Properties
Section titled “Properties”node_id
Section titled “node_id”node_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:322
num_block_failures_total
Section titled “num_block_failures_total”num_block_failures_total:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:321
num_blocks_proposed_total
Section titled “num_blocks_proposed_total”num_blocks_proposed_total:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:323
node_metrics_history_args
Section titled “node_metrics_history_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:325
Properties
Section titled “Properties”start_at_timestamp_nanos
Section titled “start_at_timestamp_nanos”start_at_timestamp_nanos:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:326
subnet_id
Section titled “subnet_id”subnet_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:327
outpoint
Section titled “outpoint”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:333
Properties
Section titled “Properties”txid:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:334
vout:
number
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:335
provisional_create_canister_with_cycles_args
Section titled “provisional_create_canister_with_cycles_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:337
Properties
Section titled “Properties”amount
Section titled “amount”amount: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:340
sender_canister_version
Section titled “sender_canister_version”sender_canister_version: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:341
settings
Section titled “settings”settings: [] | [
canister_settings]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:338
specified_id
Section titled “specified_id”specified_id: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:339
provisional_create_canister_with_cycles_result
Section titled “provisional_create_canister_with_cycles_result”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:343
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:344
provisional_top_up_canister_args
Section titled “provisional_top_up_canister_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:346
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:348
canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:347
read_canister_snapshot_data_args
Section titled “read_canister_snapshot_data_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:351
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:357
kind: {
wasm_module: {offset:bigint;size:bigint; }; } | {wasm_memory: {offset:bigint;size:bigint; }; } | {stable_memory: {offset:bigint;size:bigint; }; } | {wasm_chunk: {hash:Uint8Array; }; }
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:352
snapshot_id
Section titled “snapshot_id”snapshot_id:
snapshot_id
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:358
read_canister_snapshot_data_response
Section titled “read_canister_snapshot_data_response”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:360
Properties
Section titled “Properties”chunk:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:361
read_canister_snapshot_metadata_args
Section titled “read_canister_snapshot_metadata_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:363
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:364
snapshot_id
Section titled “snapshot_id”snapshot_id:
snapshot_id
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:365
read_canister_snapshot_metadata_response
Section titled “read_canister_snapshot_metadata_response”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:367
Properties
Section titled “Properties”canister_version
Section titled “canister_version”canister_version:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:375
certified_data
Section titled “certified_data”certified_data:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:377
global_timer
Section titled “global_timer”global_timer: [] | [{
active:bigint; } | {inactive:null; }]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:378
globals
Section titled “globals”globals: ({
f32:number; } | {f64:number; } | {i32:number; } | {i64:bigint; } | {v128:bigint; })[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:368
on_low_wasm_memory_hook_status
Section titled “on_low_wasm_memory_hook_status”on_low_wasm_memory_hook_status: [] | [{
condition_not_satisfied:null; } | {executed:null; } | {ready:null; }]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:379
source
Section titled “source”source: {
metadata_upload:any; } | {taken_from_canister:any; }
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:376
stable_memory_size
Section titled “stable_memory_size”stable_memory_size:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:387
taken_at_timestamp
Section titled “taken_at_timestamp”taken_at_timestamp:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:389
wasm_chunk_store
Section titled “wasm_chunk_store”wasm_chunk_store:
object[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:388
hash:
Uint8Array
wasm_memory_size
Section titled “wasm_memory_size”wasm_memory_size:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:390
wasm_module_size
Section titled “wasm_module_size”wasm_module_size:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:386
schnorr_public_key_args
Section titled “schnorr_public_key_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:395
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:397
derivation_path
Section titled “derivation_path”derivation_path:
Uint8Array<ArrayBufferLike>[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:398
key_id
Section titled “key_id”key_id:
object
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:396
algorithm
Section titled “algorithm”algorithm:
schnorr_algorithm
name:
string
schnorr_public_key_result
Section titled “schnorr_public_key_result”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:400
Properties
Section titled “Properties”chain_code
Section titled “chain_code”chain_code:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:402
public_key
Section titled “public_key”public_key:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:401
sign_with_ecdsa_args
Section titled “sign_with_ecdsa_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:404
Properties
Section titled “Properties”derivation_path
Section titled “derivation_path”derivation_path:
Uint8Array<ArrayBufferLike>[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:406
key_id
Section titled “key_id”key_id:
object
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:405
curve:
ecdsa_curve
name:
string
message_hash
Section titled “message_hash”message_hash:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:407
sign_with_ecdsa_result
Section titled “sign_with_ecdsa_result”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:409
Properties
Section titled “Properties”signature
Section titled “signature”signature:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:410
sign_with_schnorr_args
Section titled “sign_with_schnorr_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:412
Properties
Section titled “Properties”aux: [] | [
schnorr_aux]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:413
derivation_path
Section titled “derivation_path”derivation_path:
Uint8Array<ArrayBufferLike>[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:415
key_id
Section titled “key_id”key_id:
object
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:414
algorithm
Section titled “algorithm”algorithm:
schnorr_algorithm
name:
string
message
Section titled “message”message:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:416
sign_with_schnorr_result
Section titled “sign_with_schnorr_result”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:418
Properties
Section titled “Properties”signature
Section titled “signature”signature:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:419
snapshot
Section titled “snapshot”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:421
Properties
Section titled “Properties”id:
snapshot_id
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:422
taken_at_timestamp
Section titled “taken_at_timestamp”taken_at_timestamp:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:424
total_size
Section titled “total_size”total_size:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:423
start_canister_args
Section titled “start_canister_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:431
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:432
stop_canister_args
Section titled “stop_canister_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:434
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:435
stored_chunks_args
Section titled “stored_chunks_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:437
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:438
subnet_info_args
Section titled “subnet_info_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:441
Properties
Section titled “Properties”subnet_id
Section titled “subnet_id”subnet_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:442
subnet_info_result
Section titled “subnet_info_result”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:444
Properties
Section titled “Properties”registry_version
Section titled “registry_version”registry_version:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:446
replica_version
Section titled “replica_version”replica_version:
string
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:445
take_canister_snapshot_args
Section titled “take_canister_snapshot_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:448
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:450
replace_snapshot
Section titled “replace_snapshot”replace_snapshot: [] | [
snapshot_id]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:449
sender_canister_version
Section titled “sender_canister_version”sender_canister_version: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:452
uninstall_code
Section titled “uninstall_code”uninstall_code: [] | [
boolean]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:451
uninstall_code_args
Section titled “uninstall_code_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:455
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:456
sender_canister_version
Section titled “sender_canister_version”sender_canister_version: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:457
update_settings_args
Section titled “update_settings_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:459
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:460
sender_canister_version
Section titled “sender_canister_version”sender_canister_version: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:462
settings
Section titled “settings”settings:
canister_settings
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:461
upload_canister_snapshot_data_args
Section titled “upload_canister_snapshot_data_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:464
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:471
chunk:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:465
kind: {
wasm_module: {offset:bigint; }; } | {wasm_memory: {offset:bigint; }; } | {stable_memory: {offset:bigint; }; } | {wasm_chunk:null; }
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:466
snapshot_id
Section titled “snapshot_id”snapshot_id:
snapshot_id
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:472
upload_canister_snapshot_metadata_args
Section titled “upload_canister_snapshot_metadata_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:474
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:493
certified_data
Section titled “certified_data”certified_data:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:483
global_timer
Section titled “global_timer”global_timer: [] | [{
active:bigint; } | {inactive:null; }]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:484
globals
Section titled “globals”globals: ({
f32:number; } | {f64:number; } | {i32:number; } | {i64:bigint; } | {v128:bigint; })[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:475
on_low_wasm_memory_hook_status
Section titled “on_low_wasm_memory_hook_status”on_low_wasm_memory_hook_status: [] | [{
condition_not_satisfied:null; } | {executed:null; } | {ready:null; }]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:485
replace_snapshot
Section titled “replace_snapshot”replace_snapshot: [] | [
snapshot_id]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:482
stable_memory_size
Section titled “stable_memory_size”stable_memory_size:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:494
wasm_memory_size
Section titled “wasm_memory_size”wasm_memory_size:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:495
wasm_module_size
Section titled “wasm_module_size”wasm_module_size:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:492
upload_canister_snapshot_metadata_response
Section titled “upload_canister_snapshot_metadata_response”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:497
Properties
Section titled “Properties”snapshot_id
Section titled “snapshot_id”snapshot_id:
snapshot_id
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:498
upload_chunk_args
Section titled “upload_chunk_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:500
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:502
chunk:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:501
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:505
Properties
Section titled “Properties”height
Section titled “height”height:
number
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:506
outpoint
Section titled “outpoint”outpoint:
outpoint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:508
value:
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:507
vetkd_derive_key_args
Section titled “vetkd_derive_key_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:511
Properties
Section titled “Properties”context
Section titled “context”context:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:512
input:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:514
key_id
Section titled “key_id”key_id:
object
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:513
curve:
vetkd_curve
name:
string
transport_public_key
Section titled “transport_public_key”transport_public_key:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:515
vetkd_derive_key_result
Section titled “vetkd_derive_key_result”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:517
Properties
Section titled “Properties”encrypted_key
Section titled “encrypted_key”encrypted_key:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:518
vetkd_public_key_args
Section titled “vetkd_public_key_args”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:520
Properties
Section titled “Properties”canister_id
Section titled “canister_id”canister_id: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:523
context
Section titled “context”context:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:521
key_id
Section titled “key_id”key_id:
object
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:522
curve:
vetkd_curve
name:
string
vetkd_public_key_result
Section titled “vetkd_public_key_result”Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:525
Properties
Section titled “Properties”public_key
Section titled “public_key”public_key:
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:526
Type Aliases
Section titled “Type Aliases”bitcoin_address
Section titled “bitcoin_address”bitcoin_address =
string
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:13
bitcoin_block_hash
Section titled “bitcoin_block_hash”bitcoin_block_hash =
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:14
bitcoin_block_header
Section titled “bitcoin_block_header”bitcoin_block_header =
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:15
bitcoin_block_height
Section titled “bitcoin_block_height”bitcoin_block_height =
number
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:16
bitcoin_get_balance_result
Section titled “bitcoin_get_balance_result”bitcoin_get_balance_result =
satoshi
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:22
bitcoin_get_current_fee_percentiles_result
Section titled “bitcoin_get_current_fee_percentiles_result”bitcoin_get_current_fee_percentiles_result =
BigUint64Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:35
bitcoin_network
Section titled “bitcoin_network”bitcoin_network = {
mainnet:null; } | {testnet:null; }
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:47
canister_id
Section titled “canister_id”canister_id =
Principal
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:52
canister_install_mode
Section titled “canister_install_mode”canister_install_mode = {
reinstall:null; } | {upgrade: [] | [{skip_pre_upgrade: [] | [boolean];wasm_memory_persistence: [] | [{keep:null; } | {replace:null; }]; }]; } | {install:null; }
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:67
change_details
Section titled “change_details”change_details = {
creation: {controllers:Principal[];environment_variables_hash: [] | [Uint8Array]; }; } | {code_deployment: {mode: {reinstall:null; } | {upgrade:null; } | {install:null; };module_hash:Uint8Array; }; } | {load_snapshot: {canister_version:bigint;from_canister_id: [] | [Principal];snapshot_id:snapshot_id;source: {metadata_upload:any; } | {taken_from_canister:any; };taken_at_timestamp:bigint; }; } | {rename_canister: {canister_id:canister_id;rename_to: {canister_id:canister_id;total_num_changes:bigint;version:bigint; };requested_by:Principal;total_num_changes:bigint; }; } | {controllers_change: {controllers:Principal[]; }; } | {code_uninstall:null; }
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:148
change_origin
Section titled “change_origin”change_origin = {
from_user: {user_id:Principal; }; } | {from_canister: {canister_id:canister_id;canister_version: [] | [bigint]; }; }
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:184
ecdsa_curve
Section titled “ecdsa_curve”ecdsa_curve =
object
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:244
Properties
Section titled “Properties”secp256k1
Section titled “secp256k1”secp256k1:
null
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:244
list_canister_snapshots_result
Section titled “list_canister_snapshots_result”list_canister_snapshots_result =
snapshot[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:306
log_visibility
Section titled “log_visibility”log_visibility = {
controllers:null; } | {public:null; } | {allowed_viewers:Principal[]; }
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:315
millisatoshi_per_byte
Section titled “millisatoshi_per_byte”millisatoshi_per_byte =
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:319
node_metrics_history_result
Section titled “node_metrics_history_result”node_metrics_history_result =
object[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:329
Type Declaration
Section titled “Type Declaration”node_metrics
Section titled “node_metrics”node_metrics:
node_metrics[]
timestamp_nanos
Section titled “timestamp_nanos”timestamp_nanos:
bigint
raw_rand_result
Section titled “raw_rand_result”raw_rand_result =
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:350
satoshi
Section titled “satoshi”satoshi =
bigint
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:392
schnorr_algorithm
Section titled “schnorr_algorithm”schnorr_algorithm = {
ed25519:null; } | {bip340secp256k1:null; }
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:393
schnorr_aux
Section titled “schnorr_aux”schnorr_aux =
object
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:394
Properties
Section titled “Properties”bip341
Section titled “bip341”bip341:
object
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:394
merkle_root_hash
Section titled “merkle_root_hash”merkle_root_hash:
Uint8Array
snapshot_id
Section titled “snapshot_id”snapshot_id =
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:426
snapshot_visibility
Section titled “snapshot_visibility”snapshot_visibility = {
controllers:null; } | {public:null; } | {allowed_viewers:Principal[]; }
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:427
stored_chunks_result
Section titled “stored_chunks_result”stored_chunks_result =
chunk_hash[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:440
take_canister_snapshot_result
Section titled “take_canister_snapshot_result”take_canister_snapshot_result =
snapshot
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:454
upload_chunk_result
Section titled “upload_chunk_result”upload_chunk_result =
chunk_hash
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:504
vetkd_curve
Section titled “vetkd_curve”vetkd_curve =
object
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:510
Properties
Section titled “Properties”bls12_381_g2
Section titled “bls12_381_g2”bls12_381_g2:
null
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:510
wasm_module
Section titled “wasm_module”wasm_module =
Uint8Array
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:528
Variables
Section titled “Variables”idlFactory
Section titled “idlFactory”
constidlFactory:IDL.InterfaceFactory
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:679
init()
Section titled “init()”
constinit: (args) =>IDL.Type[]
Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:680
Parameters
Section titled “Parameters”typeof IDL
Returns
Section titled “Returns”IDL.Type[]