CreateCanisterOptions
Defined in: packages/pic/src/pocket-ic-types.ts:541
Options for creating a canister.
Extends
Section titled “Extends”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:496
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:491
The controllers of the canister. Defaults to the sender, which defaults to the anonymous principal.
Inherited from
Section titled “Inherited from”cycles?
Section titled “cycles?”
optionalcycles:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:546
The amount of cycles to send to the canister. Defaults to 1_000_000_000_000_000_000n.
environmentVariables?
Section titled “environmentVariables?”
optionalenvironmentVariables:EnvironmentVariable[]
Defined in: packages/pic/src/pocket-ic-types.ts:532
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:506
The freezing threshold of the canister.
Inherited from
Section titled “Inherited from”CanisterSettings.freezingThreshold
logVisibility?
Section titled “logVisibility?”
optionallogVisibility:LogVisibility
Defined in: packages/pic/src/pocket-ic-types.ts:516
The log visibility of the canister.
Inherited from
Section titled “Inherited from”CanisterSettings.logVisibility
memoryAllocation?
Section titled “memoryAllocation?”
optionalmemoryAllocation:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:501
The memory allocation of the canister.
Inherited from
Section titled “Inherited from”CanisterSettings.memoryAllocation
reservedCyclesLimit?
Section titled “reservedCyclesLimit?”
optionalreservedCyclesLimit:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:511
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:552
The principal to create the canister as. Defaults to the anonymous principal.
targetCanisterId?
Section titled “targetCanisterId?”
optionaltargetCanisterId:Principal
Defined in: packages/pic/src/pocket-ic-types.ts:563
The Id of the canister to create. Can only be used on Bitcoin, Fiduciary, II, SNS and NNS subnets.
targetSubnetId?
Section titled “targetSubnetId?”
optionaltargetSubnetId:Principal
Defined in: packages/pic/src/pocket-ic-types.ts:557
The Id of the subnet to create the canister on.
wasmMemoryLimit?
Section titled “wasmMemoryLimit?”
optionalwasmMemoryLimit:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:521
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: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.