CreateCanisterOptions

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

Options for creating a canister.

Principal

Extends

• CanisterSettings

Extended by

• SetupCanisterOptions

Properties

computeAllocation?

optional computeAllocation: bigint

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

The compute allocation of the canister.

Inherited from

CanisterSettings.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

CanisterSettings.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.

---

freezingThreshold?

optional freezingThreshold: bigint

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

The freezing threshold of the canister.

Inherited from

CanisterSettings.freezingThreshold

---

memoryAllocation?

optional memoryAllocation: bigint

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

The memory allocation of the canister.

Inherited from

CanisterSettings.memoryAllocation

---

reservedCyclesLimit?

optional reservedCyclesLimit: bigint

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

The reserved cycles limit of the canister.

Inherited from

CanisterSettings.reservedCyclesLimit

---

sender?

optional sender: Principal

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

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

---

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.

---

targetSubnetId?

optional targetSubnetId: Principal

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

The Id of the subnet to create the canister on.