CanisterSettings
Defined in: packages/pic/src/pocket-ic-types.ts:755
Canister settings.
Extended by
Section titled “Extended by”Properties
Section titled “Properties”computeAllocation?
Section titled “computeAllocation?”
optionalcomputeAllocation:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:765
The compute allocation of the canister.
controllers?
Section titled “controllers?”
optionalcontrollers:Principal[]
Defined in: packages/pic/src/pocket-ic-types.ts:760
The controllers of the canister. Defaults to the sender, which defaults to the anonymous principal.
environmentVariables?
Section titled “environmentVariables?”
optionalenvironmentVariables:EnvironmentVariable[]
Defined in: packages/pic/src/pocket-ic-types.ts:824
Environment variables exposed to the canister.
freezingThreshold?
Section titled “freezingThreshold?”
optionalfreezingThreshold:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:775
The freezing threshold of the canister.
logMemoryLimit?
Section titled “logMemoryLimit?”
optionallogMemoryLimit:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:797
The log memory limit of the canister in bytes.
logVisibility?
Section titled “logVisibility?”
optionallogVisibility:LogVisibility
Defined in: packages/pic/src/pocket-ic-types.ts:792
Who can read the canister’s logs. Defaults to its controllers.
memoryAllocation?
Section titled “memoryAllocation?”
optionalmemoryAllocation:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:770
The memory allocation of the canister.
minimumIncomingCanisterCallCycles?
Section titled “minimumIncomingCanisterCallCycles?”
optionalminimumIncomingCanisterCallCycles:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:787
The minimum cycles that calls from other canisters must attach. Calls attaching fewer cycles are rejected and refunded. Ingress messages and calls from the canister itself are not affected.
reservedCyclesLimit?
Section titled “reservedCyclesLimit?”
optionalreservedCyclesLimit:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:780
The reserved cycles limit of the canister.
snapshotVisibility?
Section titled “snapshotVisibility?”
optionalsnapshotVisibility:SnapshotVisibility
Defined in: packages/pic/src/pocket-ic-types.ts:802
Who can list and read the canister’s snapshots. Defaults to its controllers.
statusVisibility?
Section titled “statusVisibility?”
optionalstatusVisibility:StatusVisibility
Defined in: packages/pic/src/pocket-ic-types.ts:808
Who can read the canister’s status. Defaults to its controllers. The canister itself can always read it.
wasmMemoryLimit?
Section titled “wasmMemoryLimit?”
optionalwasmMemoryLimit:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:813
The WASM memory limit of the canister in bytes.
wasmMemoryThreshold?
Section titled “wasmMemoryThreshold?”
optionalwasmMemoryThreshold:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:819
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.