CanisterStatusResult
Defined in: packages/pic/src/pocket-ic-types.ts:1273
The result of querying the status of a canister,
as returned by the management canister’s canister_status method.
Properties
Section titled “Properties”cycles
Section titled “cycles”cycles:
bigint
Defined in: packages/pic/src/pocket-ic-types.ts:1315
The current cycle balance of the canister.
idleCyclesBurnedPerDay
Section titled “idleCyclesBurnedPerDay”idleCyclesBurnedPerDay:
bigint
Defined in: packages/pic/src/pocket-ic-types.ts:1325
The amount of cycles burned per day when idle.
memoryMetrics
Section titled “memoryMetrics”memoryMetrics:
CanisterMemoryMetrics
Defined in: packages/pic/src/pocket-ic-types.ts:1310
The memory usage of the canister by kind, see CanisterMemoryMetrics.
memorySize
Section titled “memorySize”memorySize:
bigint
Defined in: packages/pic/src/pocket-ic-types.ts:1305
The total memory size of the canister in bytes.
moduleHash
Section titled “moduleHash”moduleHash:
Uint8Array<ArrayBufferLike> |null
Defined in: packages/pic/src/pocket-ic-types.ts:1300
The SHA-256 hash of the installed WASM module, if any.
queryStats
Section titled “queryStats”queryStats:
CanisterQueryStats
Defined in: packages/pic/src/pocket-ic-types.ts:1330
Query call statistics for the canister.
readyForMigration
Section titled “readyForMigration”readyForMigration:
boolean
Defined in: packages/pic/src/pocket-ic-types.ts:1283
Whether the canister’s queues are empty and its streams flushed. Only meaningful while the canister is stopped.
reservedCycles
Section titled “reservedCycles”reservedCycles:
bigint
Defined in: packages/pic/src/pocket-ic-types.ts:1320
The reserved cycles of the canister.
settings
Section titled “settings”settings:
DefiniteCanisterSettings
Defined in: packages/pic/src/pocket-ic-types.ts:1295
The settings of the canister, see DefiniteCanisterSettings.
status
Section titled “status”status:
CanisterStatus
Defined in: packages/pic/src/pocket-ic-types.ts:1277
The current status of the canister.
version
Section titled “version”version:
bigint
Defined in: packages/pic/src/pocket-ic-types.ts:1290
The canister version. It increases with every change to the canister’s code, settings, running status, cycles balance or memory, including every successful execution of an update method, callback, heartbeat or timer.