CanisterStatusResult
Defined in: packages/pic/src/pocket-ic-types.ts:854
The result of querying the status of a canister.
This is a subset of the IC management canister canister_status response.
Some fields (e.g. snapshotVisibility, logMemoryLimit, memoryMetrics)
are not yet included because the PocketIC server does not return them.
Properties
Section titled “Properties”cycles
Section titled “cycles”cycles:
bigint
Defined in: packages/pic/src/pocket-ic-types.ts:888
The current cycle balance of the canister.
idleCyclesBurnedPerDay
Section titled “idleCyclesBurnedPerDay”idleCyclesBurnedPerDay:
bigint
Defined in: packages/pic/src/pocket-ic-types.ts:898
The amount of cycles burned per day when idle.
memorySize
Section titled “memorySize”memorySize:
bigint
Defined in: packages/pic/src/pocket-ic-types.ts:883
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:878
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:903
Query call statistics for the canister.
reservedCycles
Section titled “reservedCycles”reservedCycles:
bigint
Defined in: packages/pic/src/pocket-ic-types.ts:893
The reserved cycles of the canister.
settings
Section titled “settings”settings:
object
Defined in: packages/pic/src/pocket-ic-types.ts:863
The definite settings of the canister.
computeAllocation
Section titled “computeAllocation”computeAllocation:
bigint
controllers
Section titled “controllers”controllers:
Principal[]
environmentVariables
Section titled “environmentVariables”environmentVariables:
EnvironmentVariable[]
freezingThreshold
Section titled “freezingThreshold”freezingThreshold:
bigint
logVisibility
Section titled “logVisibility”logVisibility:
LogVisibility
memoryAllocation
Section titled “memoryAllocation”memoryAllocation:
bigint
reservedCyclesLimit
Section titled “reservedCyclesLimit”reservedCyclesLimit:
bigint
wasmMemoryLimit
Section titled “wasmMemoryLimit”wasmMemoryLimit:
bigint
wasmMemoryThreshold
Section titled “wasmMemoryThreshold”wasmMemoryThreshold:
bigint
status
Section titled “status”status:
CanisterStatus
Defined in: packages/pic/src/pocket-ic-types.ts:858
The current status of the canister.