Overview

Given a canister ID as input, this method returns a vector of logs of that canister including its trap messages. The canister logs are not collected in canister methods running in non-replicated mode (NRQ, CQ, CRy, CRt, CC, and F modes, as defined in Overview of imports). The total size of all returned logs does not exceed 4KiB. If new logs are added resulting in exceeding the maximum total log size of 4KiB, the oldest logs will be removed. Logs persist across canister upgrades and they are deleted if the canister is reinstalled or uninstalled.

Parameters

canisterId

Principal

Returns

Promise<fetch_canister_logs_result>

installChunkedCode()

installChunkedCode(params): Promise<void>

Defined in: packages/canisters/src/ic-management/ic-management.canister.ts:221

Installs code that had previously been uploaded in chunks.

Parameters

params

InstallChunkedCodeParams

Returns

Promise<void>

Link

https://internetcomputer.org/docs/current/references/ic-interface-spec/#ic-install_chunked_code

installCode()

installCode(params): Promise<void>

Defined in: packages/canisters/src/ic-management/ic-management.canister.ts:131

Install code to a canister

Parameters

params

InstallCodeParams

Returns

Promise<void>

listCanisterSnapshots()

listCanisterSnapshots(params): Promise<list_canister_snapshots_result>

Defined in: packages/canisters/src/ic-management/ic-management.canister.ts:408

Lists the snapshots of a canister.

Parameters

params

Parameters for the listing operation.

canisterId

Principal

The ID of the canister for which snapshots will be listed.

Returns

Promise<list_canister_snapshots_result>

A promise that resolves with the list of snapshots.

Link

https://internetcomputer.org/docs/current/references/ic-interface-spec#ic-list_canister_snapshots

Throws

If the operation fails.

loadCanisterSnapshot()

loadCanisterSnapshot(params): Promise<void>

Defined in: packages/canisters/src/ic-management/ic-management.canister.ts:434

Loads a snapshot of a canister’s state.

Parameters

params

Required<OptionSnapshotParams> & object

Parameters for the snapshot loading operation.

Returns

Promise<void>

A promise that resolves when the snapshot is successfully loaded.

Link

https://internetcomputer.org/docs/current/references/ic-interface-spec#ic-load_canister_snapshot

Throws

If the snapshot loading operation fails.

provisionalCreateCanisterWithCycles()

provisionalCreateCanisterWithCycles(params): Promise<Principal>

Defined in: packages/canisters/src/ic-management/ic-management.canister.ts:328

Creates a canister. Only available on development instances.

Parameters

params

ProvisionalCreateCanisterWithCyclesParams = {}

Returns

Promise<Principal>

readCanisterSnapshotData()

readCanisterSnapshotData(params): Promise<read_canister_snapshot_data_response>

Defined in: packages/canisters/src/ic-management/ic-management.canister.ts:506

Reads snapshot data for a specific canister snapshot and kind.

Parameters

params

ReadCanisterSnapshotDataParams

Parameters for the data read operation.

Returns

Promise<read_canister_snapshot_data_response>

A promise that resolves with the snapshot data payload.

Link

https://internetcomputer.org/docs/current/references/ic-interface-spec#ic-read_canister_snapshot_data

Throws

If the data read operation fails.

readCanisterSnapshotMetadata()

readCanisterSnapshotMetadata(params): Promise<ReadCanisterSnapshotMetadataResponse>

Defined in: packages/canisters/src/ic-management/ic-management.canister.ts:480

Reads metadata for a specific canister snapshot.

Parameters

params

SnapshotParams

Parameters for the metadata read operation.

Returns

Promise<ReadCanisterSnapshotMetadataResponse>

A promise that resolves with the snapshot metadata.

Link

https://internetcomputer.org/docs/current/references/ic-interface-spec#ic-read_canister_snapshot_metadata

Throws

If the metadata read operation fails.

startCanister()

startCanister(canisterId): Promise<void>

Defined in: packages/canisters/src/ic-management/ic-management.canister.ts:270

Start a canister

Parameters

canisterId

Principal

Returns

Promise<void>

stopCanister()

stopCanister(canisterId): Promise<void>

Defined in: packages/canisters/src/ic-management/ic-management.canister.ts:282

Stop a canister

Parameters

canisterId

Principal

Returns

Promise<void>

storedChunks()

storedChunks(params): Promise<chunk_hash[]>

Defined in: packages/canisters/src/ic-management/ic-management.canister.ts:196

List the hashes of chunks in the chunk storage of a canister.

Parameters

params

StoredChunksParams

Returns

Promise<chunk_hash[]>

The list of hash of the stored chunks.

Link

https://internetcomputer.org/docs/current/references/ic-interface-spec/#ic-stored_chunks

takeCanisterSnapshot()

takeCanisterSnapshot(params): Promise<snapshot>

Defined in: packages/canisters/src/ic-management/ic-management.canister.ts:379

This method takes a snapshot of the specified canister. A snapshot consists of the wasm memory, stable memory, certified variables, wasm chunk store and wasm binary.

Parameters

params

OptionSnapshotParams & object

Parameters for the snapshot operation.

Returns

Promise<snapshot>

A promise that resolves with the snapshot details, including the snapshot ID, total size, and timestamp.

Link

https://internetcomputer.org/docs/current/references/ic-interface-spec#ic-take_canister_snapshot

Throws

If the snapshot operation fails.

uninstallCode()

uninstallCode(params): Promise<void>

Defined in: packages/canisters/src/ic-management/ic-management.canister.ts:252

Uninstall code from a canister

Parameters

params

UninstallCodeParams

Returns

Promise<void>

updateSettings()

updateSettings(params): Promise<void>

Defined in: packages/canisters/src/ic-management/ic-management.canister.ts:106

Update canister settings

Parameters

params

UpdateSettingsParams

Returns

Promise<void>

uploadCanisterSnapshotData()

uploadCanisterSnapshotData(params): Promise<void>

Defined in: packages/canisters/src/ic-management/ic-management.canister.ts:559

Uploads a chunk of snapshot data for a canister snapshot.

Parameters

params

UploadCanisterSnapshotDataParams

Parameters for the data upload operation.

Returns

Promise<void>

A promise that resolves when the data is successfully uploaded.

Link

https://internetcomputer.org/docs/current/references/ic-interface-spec#ic-upload_canister_snapshot_data

Throws

If the data upload operation fails.

uploadCanisterSnapshotMetadata()

uploadCanisterSnapshotMetadata(params): Promise<upload_canister_snapshot_metadata_response>

Defined in: packages/canisters/src/ic-management/ic-management.canister.ts:532

Uploads snapshot metadata for a canister.

Parameters

params

UploadCanisterSnapshotMetadataParams

Parameters for the metadata upload operation.

Returns

Promise<upload_canister_snapshot_metadata_response>

A promise that resolves with the upload response.

Link

https://internetcomputer.org/docs/current/references/ic-interface-spec#ic-upload_canister_snapshot_metadata

Throws

If the metadata upload operation fails.

uploadChunk()

uploadChunk(params): Promise<chunk_hash>

Defined in: packages/canisters/src/ic-management/ic-management.canister.ts:157

Upload chunks of Wasm modules that are too large to fit in a single message for installation purposes.

Parameters

params

UploadChunkParams

Returns

Promise<chunk_hash>

The hash of the stored chunk.

Link

https://internetcomputer.org/docs/current/references/ic-interface-spec/#ic-upload_chunk

create()

static create(options): IcManagementCanister

Defined in: packages/canisters/src/ic-management/ic-management.canister.ts:59

Parameters

Extends

Error

Constructors

Constructor

new UnsupportedLogVisibility(message?): UnsupportedLogVisibility

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

Returns

UnsupportedLogVisibility

Inherited from

Error.constructor

Constructor

new UnsupportedLogVisibility(message?, options?): UnsupportedLogVisibility

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

options?

ErrorOptions

Returns

UnsupportedLogVisibility

Inherited from

Error.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

Error.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

UnsupportedSnapshotVisibility

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:35

Extends

Error

Constructors

Constructor

new UnsupportedSnapshotVisibility(message?): UnsupportedSnapshotVisibility

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

Returns

UnsupportedSnapshotVisibility

Inherited from

Error.constructor

Constructor

new UnsupportedSnapshotVisibility(message?, options?): UnsupportedSnapshotVisibility

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

options?

ErrorOptions

Returns

UnsupportedSnapshotVisibility

Inherited from

Error.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

Error.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

Interfaces

CanisterSettings

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:21

Properties

computeAllocation?

optional computeAllocation: bigint

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:25

controllers?

optional controllers: string[]

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:22

environmentVariables?

optional environmentVariables: environment_variable[]

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:31

freezingThreshold?

optional freezingThreshold: bigint

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:23

logVisibility?

optional logVisibility: LogVisibility

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:27

memoryAllocation?

optional memoryAllocation: bigint

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:24

reservedCyclesLimit?

optional reservedCyclesLimit: bigint

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:26

snapshotVisibility?

optional snapshotVisibility: SnapshotVisibility

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:28

wasmMemoryLimit?

optional wasmMemoryLimit: bigint

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:29

wasmMemoryThreshold?

optional wasmMemoryThreshold: bigint

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:30

CanisterStatusParams

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:150

Extends

QueryParams

Properties

canisterId

canisterId: Principal

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:151

certified?

optional certified: boolean

Defined in: packages/utils/dist/types/query.params.d.ts:6

Perform update calls (certified) or query calls (not certified).

Inherited from

QueryParams.certified

ClearChunkStoreParams

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:121

Properties

canisterId

canisterId: Principal

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:122

CreateCanisterParams

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:95

Properties

senderCanisterVersion?

optional senderCanisterVersion: bigint

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:97

settings?

optional settings: CanisterSettings

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:96

InstallChunkedCodeParams

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:129

Extends

Omit<InstallCodeParams, "canisterId" | "wasmModule">

Properties

arg

arg: Uint8Array

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:110

Inherited from

InstallCodeParams.arg

chunkHashesList

chunkHashesList: chunk_hash[]

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:133

mode

mode: canister_install_mode

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:107

Inherited from

InstallCodeParams.mode

senderCanisterVersion?

optional senderCanisterVersion: bigint

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:111

Inherited from

InstallCodeParams.senderCanisterVersion

storeCanisterId?

optional storeCanisterId: Principal

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:135

targetCanisterId

targetCanisterId: Principal

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:134

wasmModuleHash

wasmModuleHash: string | Uint8Array<ArrayBufferLike>

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:136

InstallCodeParams

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:106

Properties

arg

arg: Uint8Array

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:110

canisterId

canisterId: Principal

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:108

mode

mode: canister_install_mode

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:107

senderCanisterVersion?

optional senderCanisterVersion: bigint

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:111

wasmModule

wasmModule: Uint8Array

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:109

OptionSnapshotParams

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:9

Extended by

UploadCanisterSnapshotMetadataParams

Properties

canisterId

canisterId: Principal

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:10

snapshotId?

optional snapshotId: string | snapshot_id

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:11

ProvisionalCreateCanisterWithCyclesParams

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:144

Properties

amount?

optional amount: bigint

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:145

canisterId?

optional canisterId: Principal

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:147

settings?

optional settings: CanisterSettings

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:146

ReadCanisterSnapshotDataParams

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:46

Extends

SnapshotParams

Properties

canisterId

canisterId: Principal

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:10

Inherited from

OptionSnapshotParams.canisterId

kind

kind: CanisterSnapshotMetadataKind

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:47

snapshotId

snapshotId: string | snapshot_id

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:11

Inherited from

OptionSnapshotParams.snapshotId

ReadCanisterSnapshotMetadataParams

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:132

Extends

SnapshotParams

Properties

canisterId

canisterId: Principal

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:10

Inherited from

OptionSnapshotParams.canisterId

kind

kind: CanisterSnapshotMetadataKind

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:133

snapshotId

snapshotId: string | snapshot_id

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:11

Inherited from

OptionSnapshotParams.snapshotId

ReadCanisterSnapshotMetadataResponse

Defined in: packages/canisters/src/ic-management/types/snapshot.responses.ts:4

Properties

canisterVersion

canisterVersion: bigint

Defined in: packages/canisters/src/ic-management/types/snapshot.responses.ts:12

certifiedData

certifiedData: Uint8Array

Defined in: packages/canisters/src/ic-management/types/snapshot.responses.ts:14

globals

globals: ({ f32: number; } | { f64: number; } | { i32: number; } | { i64: bigint; } | { v128: bigint; })[]

Defined in: packages/canisters/src/ic-management/types/snapshot.responses.ts:5

globalTimer?

optional globalTimer: { active: bigint; } | { inactive: null; }

Defined in: packages/canisters/src/ic-management/types/snapshot.responses.ts:15

onLowWasmMemoryHookStatus?

optional onLowWasmMemoryHookStatus: { conditionNotSatisfied: null; } | { executed: null; } | { ready: null; }

Defined in: packages/canisters/src/ic-management/types/snapshot.responses.ts:16

source

source: { metadataUpload: unknown; } | { takenFromCanister: unknown; }

Defined in: packages/canisters/src/ic-management/types/snapshot.responses.ts:13

stableMemorySize

stableMemorySize: bigint

Defined in: packages/canisters/src/ic-management/types/snapshot.responses.ts:21

takenAtTimestamp

takenAtTimestamp: bigint

Defined in: packages/canisters/src/ic-management/types/snapshot.responses.ts:23

wasmChunkStore

wasmChunkStore: object[]

Defined in: packages/canisters/src/ic-management/types/snapshot.responses.ts:22

hash

hash: Uint8Array

wasmMemorySize

wasmMemorySize: bigint

Defined in: packages/canisters/src/ic-management/types/snapshot.responses.ts:24

wasmModuleSize

wasmModuleSize: bigint

Defined in: packages/canisters/src/ic-management/types/snapshot.responses.ts:20

StoredChunksParams

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:125

Properties

canisterId

canisterId: Principal

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:126

UninstallCodeParams

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:139

Properties

canisterId

canisterId: Principal

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:140

senderCanisterVersion?

optional senderCanisterVersion: bigint

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:141

UpdateSettingsParams

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:100

Properties

canisterId

canisterId: Principal

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:101

senderCanisterVersion?

optional senderCanisterVersion: bigint

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:102

settings

settings: CanisterSettings

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:103

UploadCanisterSnapshotDataParams

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:136

Extends

SnapshotParams

Properties

canisterId

canisterId: Principal

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:10

Inherited from

OptionSnapshotParams.canisterId

chunk

chunk: Uint8Array

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:137

kind

kind: UploadCanisterSnapshotDataKind

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:138

snapshotId

snapshotId: string | snapshot_id

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:11

Inherited from

OptionSnapshotParams.snapshotId

UploadCanisterSnapshotMetadataParams

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:83

Extends

OptionSnapshotParams

Properties

canisterId

canisterId: Principal

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:10

Inherited from

OptionSnapshotParams.canisterId

metadata

metadata: UploadCanisterSnapshotMetadataParam

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:84

snapshotId?

optional snapshotId: string | snapshot_id

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:11

Inherited from

OptionSnapshotParams.snapshotId

UploadChunkParams

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:114

Extends

Pick<upload_chunk_args, "chunk">

Properties

canisterId

canisterId: Principal

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:118

chunk

chunk: Uint8Array

Defined in: packages/canisters/src/declarations/ic-management/ic-management.d.ts:471

Inherited from

upload_chunk_args.chunk

Type Aliases

CanisterSnapshotMetadataKind

CanisterSnapshotMetadataKind = { wasmModule: { offset: bigint; size: bigint; }; } | { wasmMemory: { offset: bigint; size: bigint; }; } | { stableMemory: { offset: bigint; size: bigint; }; } | { wasmChunk: { hash: Uint8Array; }; }

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:40

CanisterStatusResponse

CanisterStatusResponse = ServiceResponse<_SERVICE, "canister_status">

Defined in: packages/canisters/src/ic-management/types/ic-management.responses.ts:4

FetchCanisterLogsResponse

FetchCanisterLogsResponse = ServiceResponse<_SERVICE, "fetch_canister_logs">

Defined in: packages/canisters/src/ic-management/types/ic-management.responses.ts:9

IcManagementCanisterOptions

IcManagementCanisterOptions = Pick<CanisterOptions<_SERVICE>, "agent" | "serviceOverride" | "certifiedServiceOverride">

Defined in: packages/canisters/src/ic-management/types/canister.options.ts:4

SnapshotIdText

SnapshotIdText = string

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:7

SnapshotParams

SnapshotParams = Required<OptionSnapshotParams>

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:14

SnapshotVisibility

SnapshotVisibility = { type: Controllers; } | { type: Public; } | { type: AllowedViewers; viewers: string[]; }

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:16

UploadCanisterSnapshotDataKind

UploadCanisterSnapshotDataKind = { wasmModule: { offset: bigint; }; } | { wasmMemory: { offset: bigint; }; } | { stableMemory: { offset: bigint; }; } | { wasmChunk: null; }

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:126

UploadCanisterSnapshotMetadataParam

UploadCanisterSnapshotMetadataParam = Pick<ReadCanisterSnapshotMetadataResponse, "globals" | "certifiedData" | "globalTimer" | "onLowWasmMemoryHookStatus" | "wasmModuleSize" | "stableMemorySize" | "wasmMemorySize">

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:72

Functions

decodeSnapshotId()

decodeSnapshotId(snapshotId): snapshot_id

Defined in: packages/canisters/src/ic-management/utils/ic-management.utils.ts:29

Decodes a hex string representation of a snapshot ID back into its original format.

A snapshot ID is a tuple (CanisterId, u64), where:

CanisterId is a unique identifier for a canister.
u64 is a subnet-local number (incremented for each new snapshot).

Parameters

snapshotId

string

The hex string representation of the snapshot ID.

Returns

snapshot_id

The decoded snapshot ID as a Uint8Array.

encodeSnapshotId()

encodeSnapshotId(snapshotId): string

Defined in: packages/canisters/src/ic-management/utils/ic-management.utils.ts:15

Encodes a snapshot ID into a hex string representation.

A snapshot ID is a tuple (CanisterId, u64), where:

CanisterId is a unique identifier for a canister.
u64 is a subnet-local number (incremented for each new snapshot).

Parameters

snapshotId

snapshot_id

The snapshot ID to encode, represented as a Uint8Array or an array of numbers.

Returns

string

The hex string representation of the snapshot ID.

fromReadCanisterSnapshotMetadataResponse()

fromReadCanisterSnapshotMetadataResponse(__namedParameters): ReadCanisterSnapshotMetadataResponse

Defined in: packages/canisters/src/ic-management/types/snapshot.responses.ts:27

Parameters

__namedParameters

read_canister_snapshot_metadata_response

Returns

ReadCanisterSnapshotMetadataResponse

mapSnapshotId()

mapSnapshotId(snapshotId): snapshot_id

Defined in: packages/canisters/src/ic-management/utils/ic-management.utils.ts:42

Maps a snapshot ID to the appropriate format for the IC interface.

Parameters

snapshotId

The snapshot ID to map. It can either be a string (SnapshotIdText) or a Uint8Array | number[] (snapshot_id). If a string is provided, it is decoded into a Uint8Array using decodeSnapshotId.

string | snapshot_id

Returns

snapshot_id

The mapped snapshot ID.

toCanisterSettings()

toCanisterSettings(__namedParameters): canister_settings

Defined in: packages/canisters/src/ic-management/types/ic-management.params.ts:37

Parameters

__namedParameters

CanisterSettings = {}

Returns

canister_settings

toCanisterSnapshotMetadataKind()

toCanisterSnapshotMetadataKind(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/ic-management/types/snapshot.params.ts:50

Parameters

kind

CanisterSnapshotMetadataKind

Returns

{ wasm_module: { offset: bigint; size: bigint; }; } | { wasm_memory: { offset: bigint; size: bigint; }; } | { stable_memory: { offset: bigint; size: bigint; }; } | { wasm_chunk: { hash: Uint8Array; }; }

toReplaceSnapshotArgs()

toReplaceSnapshotArgs(__namedParameters): Pick<take_canister_snapshot_args, "canister_id" | "replace_snapshot">

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:27

Parameters

__namedParameters

OptionSnapshotParams

Returns

Pick<take_canister_snapshot_args, "canister_id" | "replace_snapshot">

toSnapshotArgs()

toSnapshotArgs(__namedParameters): object

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:16

Parameters

__namedParameters

SnapshotParams

Returns

object

canister_id

canister_id: Principal

snapshot_id

snapshot_id: snapshot_id

toUploadCanisterSnapshotDataKind()

toUploadCanisterSnapshotDataKind(kind): { wasm_module: { offset: bigint; }; } | { wasm_memory: { offset: bigint; }; } | { stable_memory: { offset: bigint; }; } | { wasm_chunk: null; }

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:141

Parameters

kind

UploadCanisterSnapshotDataKind

Returns

{ wasm_module: { offset: bigint; }; } | { wasm_memory: { offset: bigint; }; } | { stable_memory: { offset: bigint; }; } | { wasm_chunk: null; }

toUploadCanisterSnapshotMetadata()

toUploadCanisterSnapshotMetadata(__namedParameters): Omit<upload_canister_snapshot_metadata_args, "canister_id" | "replace_snapshot">

Defined in: packages/canisters/src/ic-management/types/snapshot.params.ts:87

Parameters

__namedParameters

UploadCanisterSnapshotMetadataParam

Returns

Omit<upload_canister_snapshot_metadata_args, "canister_id" | "replace_snapshot">