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?
optionalarg:ArrayBufferLike
Candid encoded argument to pass to the canister's init function. Defaults to an empty ArrayBuffer.
Source
sender?
optionalsender:Principal
The principal to setup the canister as. Defaults to the anonymous principal.
Overrides
Source
controllers?
optionalcontrollers:Principal[]
The controllers of the canister. Defaults to the sender, which defaults to the anonymous principal.
Inherited from
CreateCanisterOptions.controllers
Source
computeAllocation?
optionalcomputeAllocation:bigint
The compute allocation of the canister.
Inherited from
CreateCanisterOptions.computeAllocation
Source
memoryAllocation?
optionalmemoryAllocation:bigint
The memory allocation of the canister.
Inherited from
CreateCanisterOptions.memoryAllocation
Source
freezingThreshold?
optionalfreezingThreshold:bigint
The freezing threshold of the canister.
Inherited from
CreateCanisterOptions.freezingThreshold
Source
reservedCyclesLimit?
optionalreservedCyclesLimit:bigint
The reserved cycles limit of the canister.
Inherited from
CreateCanisterOptions.reservedCyclesLimit
Source
cycles?
optionalcycles:bigint
The amount of cycles to send to the canister. Defaults to 1_000_000_000_000_000_000n.
Inherited from
Source
targetSubnetId?
optionaltargetSubnetId:Principal
The Id of the subnet to create the canister on.
Inherited from
CreateCanisterOptions.targetSubnetId
Source
targetCanisterId?
optionaltargetCanisterId:Principal
The Id of the canister to create. Can only be used on Bitcoin, Fiduciary, II, SNS and NNS subnets.
Inherited from
CreateCanisterOptions.targetCanisterId