Skip to content

CanisterSettings

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

Canister settings.

Principal

optional computeAllocation: bigint

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

The compute allocation of the canister.


optional controllers: Principal[]

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

The controllers of the canister. Defaults to the sender, which defaults to the anonymous principal.


optional environmentVariables: EnvironmentVariable[]

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

Environment variables exposed to the canister.


optional freezingThreshold: bigint

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

The freezing threshold of the canister.


optional logVisibility: LogVisibility

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

The log visibility of the canister.


optional memoryAllocation: bigint

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

The memory allocation of the canister.


optional reservedCyclesLimit: bigint

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

The reserved cycles limit of the canister.


optional wasmMemoryLimit: bigint

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

The WASM memory limit of the canister in bytes.


optional wasmMemoryThreshold: bigint

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

The WASM memory threshold of the canister in bytes. The canister_on_low_wasm_memory function will be called when the canister’s remaining wasm memory is below this threshold.