Skip to content

API Reference


Type Alias: ICEConfig<U, R>

ICEConfig<U, R> = object

Defined in: types/types.ts:45

The core configuration object for an ICE environment.

Type Parameters

Type ParameterDefault type
U extends ICEUsersICEUsers
R extends ICERoles<U>ICERoles<U>

Properties

network

network: string

Defined in: types/types.ts:53

A logical name for the network (e.g. "local", "ic", "staging"). Used for caching and state isolation.


replica?

optional replica: Replica

Defined in: types/types.ts:57

The replica instance to connect to.


roles?

optional roles: R

Defined in: types/types.ts:66

A map of role names to user keys. Common roles: "deployer", "minter", "controller", "treasury".


users?

optional users: U

Defined in: types/types.ts:61

A map of named users/identities available in this environment.