Ice.ts

Appearance

API Reference

Interface: CanisterSettings ​

Defined in: docs-entry.ts:121

Settings for creating or updating a canister. Used in CreateCanisterParams and canister configurations.

Example ​

typescript
const settings: CanisterSettings = {
  controllers: ["aaaaa-aa", "bbbbb-bb"],
  compute_allocation: 10n,
  memory_allocation: 1_000_000_000n,
  freezing_threshold: 2_592_000n, // 30 days
}

Properties ​

compute_allocation? ​

optional compute_allocation: bigint

Defined in: docs-entry.ts:129

Compute allocation percentage (0-100). Higher means more execution priority.

controllers? ​

optional controllers: string[]

Defined in: docs-entry.ts:123

Array of principal IDs that can control this canister.

cycles? ​

optional cycles: bigint

Defined in: docs-entry.ts:135

Initial cycles to add to the canister.

freezing_threshold? ​

optional freezing_threshold: bigint

Defined in: docs-entry.ts:125

Freezing threshold in seconds. Canister freezes if cycles drop below this.

memory_allocation? ​

optional memory_allocation: bigint

Defined in: docs-entry.ts:127

Memory allocation in bytes. Reserves memory for the canister.

reserved_cycles_limit? ​

optional reserved_cycles_limit: bigint

Defined in: docs-entry.ts:131

Maximum reserved cycles limit.

wasm_memory_limit? ​

optional wasm_memory_limit: bigint

Defined in: docs-entry.ts:133

Maximum Wasm memory limit in bytes.