Interface: SetupCanisterOptions
Options for setting up a canister.
Extends
Properties
idlFactory
idlFactory:
InterfaceFactory
The interface factory to use for the Actor.
Source
wasm
wasm:
string
|ArrayBufferLike
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.
Source
arg?
optional
arg:ArrayBufferLike
Candid encoded argument to pass to the canister's init function. Defaults to an empty ArrayBuffer.
Source
sender?
optional
sender:Principal
The principal to setup the canister as. Defaults to the anonymous principal.
Overrides
Source
controllers?
optional
controllers:Principal
[]
The controllers of the canister. Defaults to the sender, which defaults to the anonymous principal.
Inherited from
CreateCanisterOptions
.controllers
Source
computeAllocation?
optional
computeAllocation:bigint
The compute allocation of the canister.
Inherited from
CreateCanisterOptions
.computeAllocation
Source
memoryAllocation?
optional
memoryAllocation:bigint
The memory allocation of the canister.
Inherited from
CreateCanisterOptions
.memoryAllocation
Source
freezingThreshold?
optional
freezingThreshold:bigint
The freezing threshold of the canister.
Inherited from
CreateCanisterOptions
.freezingThreshold
Source
reservedCyclesLimit?
optional
reservedCyclesLimit:bigint
The reserved cycles limit of the canister.
Inherited from
CreateCanisterOptions
.reservedCyclesLimit
Source
cycles?
optional
cycles:bigint
The amount of cycles to send to the canister. Defaults to 1_000_000_000_000_000_000n.
Inherited from
Source
targetSubnetId?
optional
targetSubnetId:Principal
The Id of the subnet to create the canister on.
Inherited from
CreateCanisterOptions
.targetSubnetId
Source
targetCanisterId?
optional
targetCanisterId:Principal
The Id of the canister to create. Can only be used on Bitcoin, Fiduciary, II, SNS and NNS subnets.
Inherited from
CreateCanisterOptions
.targetCanisterId