LiquidiumClientConfig

@liquidium/client

---

@liquidium/client / LiquidiumClientConfig

Interface: LiquidiumClientConfig

Defined in: external/liquidium-sdk/packages/client/src/core/types.ts:13

Runtime options for new LiquidiumClient(config).

Canister-backed reads and SDK HTTP features work with {} defaults. Set apiBaseUrl only when overriding the Liquidium production API root.

Properties

apiBaseUrl?

optional apiBaseUrl?: string

Defined in: external/liquidium-sdk/packages/client/src/core/types.ts:25

Base URL for the Liquidium SDK HTTP API root (e.g. https://app.example.com/api/sdk). Defaults to the Liquidium production API root. Endpoint versions are owned by this SDK package version.

---

canisterIds?

optional canisterIds?: Partial<CanisterIds>

Defined in: external/liquidium-sdk/packages/client/src/core/types.ts:29

Override individual canister principals for custom deployments.

---

environment?

optional environment?: "mainnet"

Defined in: external/liquidium-sdk/packages/client/src/core/types.ts:15

Preset canister IDs. Only mainnet is bundled.

---

evmPublicClient?

optional evmPublicClient?: EvmReadClient

Defined in: external/liquidium-sdk/packages/client/src/core/types.ts:39

Existing viem public client or compatible read client for EVM reads.

---

evmRpcHeaders?

optional evmRpcHeaders?: Record<string, string>

Defined in: external/liquidium-sdk/packages/client/src/core/types.ts:37

Optional headers for RPC providers that authenticate via HTTP headers.

---

evmRpcUrl?

optional evmRpcUrl?: string

Defined in: external/liquidium-sdk/packages/client/src/core/types.ts:35

Ethereum RPC URL used for public ERC-20 reads in EVM supply flows.

---

fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: external/liquidium-sdk/packages/client/src/core/types.ts:31

Custom fetch implementation for SDK API requests.

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

URL | RequestInfo

init?

RequestInit

Returns

Promise<Response>

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

string | URL | Request

init?

RequestInit

Returns

Promise<Response>

---

headers?

optional headers?: Record<string, string>

Defined in: external/liquidium-sdk/packages/client/src/core/types.ts:27

Extra headers sent with every SDK API request.

---

icHost?

optional icHost?: string

Defined in: external/liquidium-sdk/packages/client/src/core/types.ts:17

ICP replica host override (defaults follow @icp-sdk/core/agent).

---

identity?

optional identity?: Identity

Defined in: external/liquidium-sdk/packages/client/src/core/types.ts:19

Agent identity for signed canister calls.

---

timeoutMs?

optional timeoutMs?: number

Defined in: external/liquidium-sdk/packages/client/src/core/types.ts:33

Per-request timeout for SDK API calls in milliseconds.