ClientManagerParameters

Defined in: core/src/types/client.ts:10

Parameters for configuring a ClientManager instance.

Properties

queryClient

queryClient: QueryClient

Defined in: core/src/types/client.ts:14

The TanStack QueryClient used for caching and state management.

---

agentOptions?

optional agentOptions?: HttpAgentOptions

Defined in: core/src/types/client.ts:18

Optional configuration for the underlying HttpAgent.

---

allowEnvConfig?

optional allowEnvConfig?: boolean

Defined in: core/src/types/client.ts:37

Whether to trust the configuration carried by the ic_env cookie.

Three values are read from that cookie, and this flag governs all of them: the agent root key certificate verification is checked against, the Internet Identity provider, and the canister ID a reactor resolves by name when none is configured.

Defaults to true only when the agent host AND the page the code is running on are both unambiguously a local replica (loopback, localhost and its subdomains). Cookies are not origin-isolated — any sibling subdomain of the registrable domain can write ic_env — and it is the PAGE that decides who those siblings are, so a document on a real domain is not trusted even when it points its agent at a loopback replica. Anything else must opt in: set this when you run a custom testnet on a real domain and trust its ic_env. That includes Codespaces and Gitpod, whose workspaces share a parent domain with every other user’s.

---

allowEnvRootKey?

optional allowEnvRootKey?: boolean

Defined in: core/src/types/client.ts:47

Deprecated

Superseded by allowEnvConfig, which governs every value read from the ic_env cookie rather than the root key alone.

Still honoured, and still scoped to what it always granted: the root key. It deliberately does not extend to the Internet Identity provider or to a reactor’s canister ID — setting it for a custom testnet was not an agreement to take those from a cookie too. Use allowEnvConfig for that.