Skip to main content

Configuration

Create the client with defaults for Liquidium mainnet:

import { LiquidiumClient } from "@liquidium/client";

const client = new LiquidiumClient();

Pass config when your app needs custom transports, headers, canister IDs, or EVM read support:

const client = new LiquidiumClient({
apiBaseUrl: "https://app.liquidium.fi/api/sdk",
headers: {
"x-client-name": "my-app",
},
evmRpcUrl: import.meta.env.VITE_EVM_RPC_URL,
});

Config Fields

FieldUse
environmentSelect bundled canister IDs. The SDK currently bundles mainnet.
icHostOverride the ICP replica host.
identitySend signed canister calls with a caller identity.
apiBaseUrlOverride the Liquidium SDK HTTP API root.
headersAdd headers to SDK HTTP API requests.
canisterIdsOverride individual canister principals for custom deployments.
fetchProvide a custom fetch implementation.
timeoutMsSet the SDK API request timeout in milliseconds.
evmRpcUrlCreate a viem public client for EVM reads.
evmRpcHeadersAdd headers to EVM RPC requests.
evmPublicClientUse an existing viem-compatible read client.

Set VITE_INFURA_API_KEY or VITE_EVM_RPC_URL when you run an example that needs Ethereum reads.