Crate ic_management_canister_types 

ic-management-canister-types

Types for calling the IC management canister.

This module is a direct translation from its Candid interface description.

Correctness

This crate ensures type definition correctness through the candid_equality.rs test.

The test defines a dummy Canister covering all Management Canister entry points available for inter-canister calls.

It then asserts the equality of the dummy canister’s interface with the specified interface in ic.did.

The ic.did is sourced from the Internet Computer Interface Specification.

Some methods are excluded (commented out) as follows:

• Bitcoin API: These functionalities are planned to migrate from the Management Canister to the Bitcoin Canister.
• fetch_canister_logs: This method is only available for ingress messages (using an agent) and cannot be invoked in inter-canister calls.

Structs

Bip341

Bip341 variant of Schnorr Aux.

CanisterIdRecord

Canister ID Record

CanisterInfoArgs

Canister Info Args

CanisterInfoResult

Canister Info Result

CanisterLogRecord

Canister Log Record

CanisterMetadataArgs

Canister Metadata Args

CanisterMetadataResult

Canister Metadata Result

CanisterSettings

Canister Settings

CanisterStatusResult

Canister Status Result

Change

Change

ChunkHash

Chunk hash.

CodeDeploymentRecord

Code Deployment Record

ControllersChangeRecord

Controllers Change Record

CreateCanisterArgs

Create Canister Args

CreationRecord

Creation Record

DefiniteCanisterSettings

Definite Canister Settings

DeleteCanisterSnapshotArgs

Delete Canister Snapshot Args.

EcdsaKeyId

ECDSA Key ID.

EcdsaPublicKeyArgs

ECDSA Public Key Args.

EcdsaPublicKeyResult

ECDSA Public Key Result.

EnvironmentVariable

Environment Variable.

FetchCanisterLogsResult

Fetch Canister Logs Result.

FromCanisterRecord

From Canister Record

FromUserRecord

From User Record

HttpHeader

HTTP Header.

HttpRequestArgs

HTTP Request Args

HttpRequestResult

HTTP Request Result

InstallChunkedCodeArgs

Install Chunked Code Args

InstallCodeArgs

Install Code Args

LoadCanisterSnapshotArgs

Load Canister Snapshot Args.

LoadSnapshotRecord

Load Snapshot Record

MemoryMetrics

Memory Metrics

NodeMetrics

Node Metrics.

NodeMetricsHistoryArgs

Node Metrics History Args.

NodeMetricsHistoryRecord

Node Metrics History Record.

ProvisionalCreateCanisterWithCyclesArgs

Provisional Create Canister With Cycles Args.

ProvisionalTopUpCanisterArgs

Provisional Top Up Canister Args.

QueryStats

Query Stats

ReadCanisterSnapshotDataArgs

Read Canister Snapshot Data Args.

ReadCanisterSnapshotDataResult

Read Canister Snapshot Data Result.

ReadCanisterSnapshotMetadataArgs

Read Canister Snapshot Metadata Args.

ReadCanisterSnapshotMetadataResult

Read Canister Snapshot Metadata Result.

RenameCanisterRecord

Rename Canister Record

RenameToRecord

Rename To Record

SchnorrKeyId

Schnorr Key ID.

SchnorrPublicKeyArgs

Schnorr Public Key Args.

SchnorrPublicKeyResult

Schnorr Public Key Result.

SignWithEcdsaArgs

Sign With ECDSA Args.

SignWithEcdsaResult

Sign With ECDSA Result.

SignWithSchnorrArgs

Sign With Schnorr Args.

SignWithSchnorrResult

Sign With Schnorr Result.

Snapshot

Snapshot.

SubnetInfoArgs

Subnet Info Args.

SubnetInfoResult

Subnet Info Result.

TakeCanisterSnapshotArgs

Take Canister Snapshot Args.

TransformArgs

Transform Args.

TransformContext

Transform Context.

TransformFunc

Transform Function.

UninstallCodeArgs

Uninstall Code Args

UpdateSettingsArgs

Update Settings Args

UpgradeFlags

Upgrade Flags

UploadCanisterSnapshotDataArgs

Upload Canister Snapshot Data Args.

UploadCanisterSnapshotMetadataArgs

Upload Canister Snapshot Metadata Args.

UploadCanisterSnapshotMetadataResult

Upload Canister Snapshot Metadata Result.

UploadChunkArgs

Upload Chunk Args

VetKDDeriveKeyArgs

VetKD derive key request.

VetKDDeriveKeyResult

VetKD derive key reply.

VetKDKeyId

VetKDPublicKeyArgs

VetKD public key request.

VetKDPublicKeyResult

VetKD public key reply.

Enums

CanisterInstallMode

Canister Install Mode

CanisterStatusType

Canister Status Type

CanisterTimer

The status of a global timer.

ChangeDetails

Change Details

ChangeOrigin

Change Origin

CodeDeploymentMode

Code Deployment Mode

EcdsaCurve

ECDSA Curve.

HttpMethod

HTTP Method.

LogVisibility

Log Visibility.

OnLowWasmMemoryHookStatus

The status of a low wasm memory hook.

SchnorrAlgorithm

Schnorr Algorithm.

SchnorrAux

Schnorr Aux.

SnapshotDataKind

Snapshot data kind.

SnapshotDataOffset

Snapshot data offset.

SnapshotMetadataGlobal

An exported global variable.

SnapshotSource

The source of a snapshot.

VetKDCurve

The curve used for key derivation.

WasmMemoryPersistence

Wasm Memory Persistence

Type Aliases

CanisterId

Canister ID.

CanisterStatusArgs

Canister Status Args

ClearChunkStoreArgs

Clear Chunk Store Args

CreateCanisterResult

Create Canister Result

DeleteCanisterArgs

Delete Canister Args

DepositCyclesArgs

Deposit Cycles Args

FetchCanisterLogsArgs

Fetch Canister Logs Args.

ListCanisterSnapshotsArgs

List Canister Snapshots Args.

ListCanisterSnapshotsResult

List Canister Snapshots Result.

NodeMetricsHistoryResult

Node Metrics History Result.

ProvisionalCreateCanisterWithCyclesResult

Provisional Create Canister With Cycles Result.

RawRandResult

Raw Rand Result

SnapshotId

Snapshot ID.

StartCanisterArgs

Start Canister Args

StopCanisterArgs

Stop Canister Args

StoredChunksArgs

Stored Chunks Args

StoredChunksResult

Stored Chunks Result

TakeCanisterSnapshotResult

Take Canister Snapshot Result.

UploadChunkResult

Upload Chunk Result

WasmModule

WASM Module