SetupCanisterOptions
Defined in: pocket-ic-types.ts:344
Options for setting up a canister.
Properties
Section titled “Properties”
optionalarg:ArrayBufferLike
Defined in: pocket-ic-types.ts:361
Candid encoded argument to pass to the canister’s init function. Defaults to an empty ArrayBuffer.
computeAllocation?
Section titled “computeAllocation?”
optionalcomputeAllocation:bigint
Defined in: pocket-ic-types.ts:405
The compute allocation of the canister.
Inherited from
Section titled “Inherited from”CreateCanisterOptions.computeAllocation
controllers?
Section titled “controllers?”
optionalcontrollers:Principal[]
Defined in: pocket-ic-types.ts:400
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: pocket-ic-types.ts:434
The amount of cycles to send to the canister. Defaults to 1_000_000_000_000_000_000n.
Inherited from
Section titled “Inherited from”freezingThreshold?
Section titled “freezingThreshold?”
optionalfreezingThreshold:bigint
Defined in: pocket-ic-types.ts:415
The freezing threshold of the canister.
Inherited from
Section titled “Inherited from”CreateCanisterOptions.freezingThreshold
idlFactory
Section titled “idlFactory”idlFactory:
InterfaceFactory
Defined in: pocket-ic-types.ts:348
The interface factory to use for the Actor.
memoryAllocation?
Section titled “memoryAllocation?”
optionalmemoryAllocation:bigint
Defined in: pocket-ic-types.ts:410
The memory allocation of the canister.
Inherited from
Section titled “Inherited from”CreateCanisterOptions.memoryAllocation
reservedCyclesLimit?
Section titled “reservedCyclesLimit?”
optionalreservedCyclesLimit:bigint
Defined in: pocket-ic-types.ts:420
The reserved cycles limit of the canister.
Inherited from
Section titled “Inherited from”CreateCanisterOptions.reservedCyclesLimit
sender?
Section titled “sender?”
optionalsender:Principal
Defined in: pocket-ic-types.ts:367
The principal to setup the canister as. Defaults to the anonymous principal.
Overrides
Section titled “Overrides”targetCanisterId?
Section titled “targetCanisterId?”
optionaltargetCanisterId:Principal
Defined in: pocket-ic-types.ts:451
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: pocket-ic-types.ts:445
The Id of the subnet to create the canister on.
Inherited from
Section titled “Inherited from”CreateCanisterOptions.targetSubnetId
wasm:
string|ArrayBufferLike
Defined in: pocket-ic-types.ts:355
The WASM module to install to the canister.
If a string is passed, it is treated as a path to a file.
If an ArrayBufferLike is passed, it is treated as the WASM module itself.