Skip to content

CreateCanisterOptions

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

Options for creating a canister.

Principal

optional computeAllocation: bigint

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

The compute allocation of the canister.

CanisterSettings.computeAllocation


optional controllers: Principal[]

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

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

CanisterSettings.controllers


optional cycles: bigint

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

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


optional freezingThreshold: bigint

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

The freezing threshold of the canister.

CanisterSettings.freezingThreshold


optional memoryAllocation: bigint

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

The memory allocation of the canister.

CanisterSettings.memoryAllocation


optional reservedCyclesLimit: bigint

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

The reserved cycles limit of the canister.

CanisterSettings.reservedCyclesLimit


optional sender: Principal

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

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


optional targetCanisterId: Principal

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

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


optional targetSubnetId: Principal

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

The Id of the subnet to create the canister on.