UpdateCanisterSettingsOptions
Defined in: packages/pic/src/pocket-ic-types.ts:1070
Options for updating the settings of a given canister.
Extends
Section titled “Extends”Partial<CanisterSettings>
Properties
Section titled “Properties”canisterId
Section titled “canisterId”canisterId:
Principal
Defined in: packages/pic/src/pocket-ic-types.ts:1074
The Principal of the canister to update the settings for.
computeAllocation?
Section titled “computeAllocation?”
optionalcomputeAllocation:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:765
The compute allocation of the canister.
Inherited from
Section titled “Inherited from”CanisterSettings.computeAllocation
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.
Inherited from
Section titled “Inherited from”environmentVariables?
Section titled “environmentVariables?”
optionalenvironmentVariables:EnvironmentVariable[]
Defined in: packages/pic/src/pocket-ic-types.ts:824
Environment variables exposed to the canister.
Inherited from
Section titled “Inherited from”CanisterSettings.environmentVariables
freezingThreshold?
Section titled “freezingThreshold?”
optionalfreezingThreshold:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:775
The freezing threshold of the canister.
Inherited from
Section titled “Inherited from”CanisterSettings.freezingThreshold
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.
Inherited from
Section titled “Inherited from”CanisterSettings.logMemoryLimit
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.
Inherited from
Section titled “Inherited from”CanisterSettings.logVisibility
memoryAllocation?
Section titled “memoryAllocation?”
optionalmemoryAllocation:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:770
The memory allocation of the canister.
Inherited from
Section titled “Inherited from”CanisterSettings.memoryAllocation
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.
Inherited from
Section titled “Inherited from”CanisterSettings.minimumIncomingCanisterCallCycles
reservedCyclesLimit?
Section titled “reservedCyclesLimit?”
optionalreservedCyclesLimit:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:780
The reserved cycles limit of the canister.
Inherited from
Section titled “Inherited from”CanisterSettings.reservedCyclesLimit
sender?
Section titled “sender?”
optionalsender:Principal
Defined in: packages/pic/src/pocket-ic-types.ts:1080
The Principal to send the request as. Defaults to the anonymous principal.
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.
Inherited from
Section titled “Inherited from”CanisterSettings.snapshotVisibility
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.
Inherited from
Section titled “Inherited from”CanisterSettings.statusVisibility
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.
Inherited from
Section titled “Inherited from”CanisterSettings.wasmMemoryLimit
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.