SetupCanisterOptions

Defined in: pocket-ic-types.ts:313

Options for setting up a canister.

• CreateCanisterOptions

Properties

arg?

optional arg: ArrayBufferLike

Defined in: pocket-ic-types.ts:330

Candid encoded argument to pass to the canister’s init function. Defaults to an empty ArrayBuffer.

---

computeAllocation?

optional computeAllocation: bigint

Defined in: pocket-ic-types.ts:374

The compute allocation of the canister.

Inherited from

CreateCanisterOptions.computeAllocation

---

controllers?

optional controllers: Principal[]

Defined in: pocket-ic-types.ts:369

The controllers of the canister. Defaults to the sender, which defaults to the anonymous principal.

Inherited from

CreateCanisterOptions.controllers

---

cycles?

optional cycles: bigint

Defined in: pocket-ic-types.ts:403

The amount of cycles to send to the canister. Defaults to 1_000_000_000_000_000_000n.

Inherited from

CreateCanisterOptions.cycles

---

freezingThreshold?

optional freezingThreshold: bigint

Defined in: pocket-ic-types.ts:384

The freezing threshold of the canister.

Inherited from

CreateCanisterOptions.freezingThreshold

---

idlFactory

idlFactory: InterfaceFactory

Defined in: pocket-ic-types.ts:317

The interface factory to use for the Actor.

---

memoryAllocation?

optional memoryAllocation: bigint

Defined in: pocket-ic-types.ts:379

The memory allocation of the canister.

Inherited from

CreateCanisterOptions.memoryAllocation

---

reservedCyclesLimit?

optional reservedCyclesLimit: bigint

Defined in: pocket-ic-types.ts:389

The reserved cycles limit of the canister.

Inherited from

CreateCanisterOptions.reservedCyclesLimit

---

sender?

optional sender: Principal

Defined in: pocket-ic-types.ts:336

The principal to setup the canister as. Defaults to the anonymous principal.

Overrides

CreateCanisterOptions.sender

---

targetCanisterId?

optional targetCanisterId: Principal

Defined in: pocket-ic-types.ts:420

The Id of the canister to create. Can only be used on Bitcoin, Fiduciary, II, SNS and NNS subnets.

Inherited from

CreateCanisterOptions.targetCanisterId

---

targetSubnetId?

optional targetSubnetId: Principal

Defined in: pocket-ic-types.ts:414

The Id of the subnet to create the canister on.

Inherited from

CreateCanisterOptions.targetSubnetId

---

wasm

wasm: string | ArrayBufferLike

Defined in: pocket-ic-types.ts:324

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.