SetupCanisterOptions
Defined in: packages/pic/src/pocket-ic-types.ts:654
Options for setting up a canister.
Extends
Section titled “Extends”Properties
Section titled “Properties”
optionalarg:Uint8Array<ArrayBufferLike>
Defined in: packages/pic/src/pocket-ic-types.ts:671
Candid encoded argument to pass to the canister’s init function. Defaults to an empty Uint8Array.
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”CreateCanisterOptions.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”CreateCanisterOptions.controllers
cycles?
Section titled “cycles?”
optionalcycles:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:838
The amount of cycles to send to the canister. Defaults to 1_000_000_000_000_000_000n.
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”CreateCanisterOptions.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”CreateCanisterOptions.freezingThreshold
idlFactory
Section titled “idlFactory”idlFactory:
InterfaceFactory
Defined in: packages/pic/src/pocket-ic-types.ts:658
The interface factory to use for the Actor.
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”CreateCanisterOptions.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”CreateCanisterOptions.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”CreateCanisterOptions.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”CreateCanisterOptions.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”CreateCanisterOptions.reservedCyclesLimit
sender?
Section titled “sender?”
optionalsender:Principal
Defined in: packages/pic/src/pocket-ic-types.ts:677
The principal to setup the canister as. Defaults to the anonymous principal.
Overrides
Section titled “Overrides”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”CreateCanisterOptions.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”CreateCanisterOptions.statusVisibility
targetCanisterId?
Section titled “targetCanisterId?”
optionaltargetCanisterId:Principal
Defined in: packages/pic/src/pocket-ic-types.ts:855
The Id of the canister to create. Can only be used on Bitcoin, Fiduciary, II, SNS and NNS subnets.
Inherited from
Section titled “Inherited from”CreateCanisterOptions.targetCanisterId
targetSubnetId?
Section titled “targetSubnetId?”
optionaltargetSubnetId:Principal
Defined in: packages/pic/src/pocket-ic-types.ts:849
The Id of the subnet to create the canister on.
Inherited from
Section titled “Inherited from”CreateCanisterOptions.targetSubnetId
wasm:
string|Uint8Array<ArrayBufferLike>
Defined in: packages/pic/src/pocket-ic-types.ts:665
The WASM module to install to the canister.
If a string is passed, it is treated as a path to a file.
If an Uint8Array is passed, it is treated as the WASM module itself.
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”CreateCanisterOptions.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.