Skip to content

DefiniteCanisterSettings

Defined in: packages/pic/src/pocket-ic-types.ts:1199

The settings of a canister, with every setting resolved to its current value, as returned by the management canister’s canister_status method.

Principal

computeAllocation: bigint

Defined in: packages/pic/src/pocket-ic-types.ts:1208

The compute allocation of the canister, as a percentage between 0 and 100.


controllers: Principal[]

Defined in: packages/pic/src/pocket-ic-types.ts:1203

The controllers of the canister.


environmentVariables: EnvironmentVariable[]

Defined in: packages/pic/src/pocket-ic-types.ts:1263

The environment variables exposed to the canister.


freezingThreshold: bigint

Defined in: packages/pic/src/pocket-ic-types.ts:1218

The freezing threshold of the canister in seconds.


logMemoryLimit: bigint

Defined in: packages/pic/src/pocket-ic-types.ts:1238

The log memory limit of the canister in bytes.


logVisibility: LogVisibility

Defined in: packages/pic/src/pocket-ic-types.ts:1233

Who can read the canister’s logs.


memoryAllocation: bigint

Defined in: packages/pic/src/pocket-ic-types.ts:1213

The memory allocation of the canister in bytes.


minimumIncomingCanisterCallCycles: bigint

Defined in: packages/pic/src/pocket-ic-types.ts:1228

The minimum cycles that calls from other canisters must attach.


reservedCyclesLimit: bigint

Defined in: packages/pic/src/pocket-ic-types.ts:1223

The upper limit on the canister’s reserved cycles.


snapshotVisibility: SnapshotVisibility

Defined in: packages/pic/src/pocket-ic-types.ts:1243

Who can list and read the canister’s snapshots.


statusVisibility: StatusVisibility

Defined in: packages/pic/src/pocket-ic-types.ts:1248

Who can read the canister’s status.


wasmMemoryLimit: bigint

Defined in: packages/pic/src/pocket-ic-types.ts:1253

The WASM memory limit of the canister in bytes, or 0 for no limit.


wasmMemoryThreshold: bigint

Defined in: packages/pic/src/pocket-ic-types.ts:1258

The WASM memory threshold of the canister in bytes.