initAmplifySDK

All Amplify SDK functions require initialization before use. Call initAmplifySDK() once at application startup.

Import

import { initAmplifySDK } from "@paxoslabs/amplify-sdk";

Usage

await initAmplifySDK("pxl_your_api_key");

Parameters

Parameter	Type	Required	Description
`apiKey`	`string`	Yes	Your Paxos Labs API key (format: `pxl_...`)
`options`	`SDKInitOptions`	No	Configuration options for telemetry and logging

SDKInitOptions

interface SDKInitOptions {
  /** Allow for use of custom RPCs in viem client */
  rpcUrls?: Record<number, string>;

  /** Enable/disable PostHog telemetry (default: true) */
  telemetry?: boolean;

  /** Log level for SDK operations (default: LogLevel.ERROR) */
  logLevel?: LogLevel;

  /** Custom logger implementation */
  logger?: Logger;

  /** Target environment (default: "production") */
  environment?: Environment;
}

Option	Type	Default	Description
`rpcUrls`	`Record<number, string>`	Public RPCs	Allow custom RPCs to provide better UX and reliability. Chains without a custom RPC URL fall back to public RPCs.
`telemetry`	`boolean`	`true`	Enable PostHog error tracking
`logLevel`	`LogLevel`	`LogLevel.ERROR`	Minimum log level to output
`logger`	`Logger`	Built-in console logger	Custom logger implementation
`environment`	`Environment`	`"production"`	Target environment (`"production"` or `"staging"`)

Return Type

Promise<void>

Examples

Basic
Custom RPCs
With Options
Custom Logger

import { initAmplifySDK } from "@paxoslabs/amplify-sdk";

await initAmplifySDK("pxl_your_api_key");

import { initAmplifySDK } from "@paxoslabs/amplify-sdk";
import { mainnet, sepolia } from "viem/chains";

await initAmplifySDK("pxl_your_api_key", {
  rpcUrls: {
    [mainnet.id]: import.meta.env.VITE_APP_ETHEREUM_MAINNET_RPC,
    [sepolia.id]: import.meta.env.VITE_APP_ETHEREUM_SEPOLIA_RPC,
  },
});

import { initAmplifySDK, LogLevel } from "@paxoslabs/amplify-sdk";

await initAmplifySDK("pxl_your_api_key", {
  telemetry: false,
  logLevel: LogLevel.DEBUG,
});

import { initAmplifySDK, LogLevel } from "@paxoslabs/amplify-sdk";

await initAmplifySDK("pxl_your_api_key", {
  logLevel: LogLevel.DEBUG,
  logger: {
    debug: (msg, ctx) => console.debug(`[SDK] ${msg}`, ctx),
    info: (msg, ctx) => console.info(`[SDK] ${msg}`, ctx),
    warn: (msg, ctx) => console.warn(`[SDK] ${msg}`, ctx),
    error: (msg, ctx) => console.error(`[SDK] ${msg}`, ctx),
  },
});

Behavior

Validates API key — Checks key format and minimum length
Returns immediately — Initialization completes without blocking on network calls
Populates cache in background — Vaults and assets are fetched asynchronously after init returns. Use waitForCacheReady() if you need guaranteed fast operations before the first SDK call
Configures telemetry — Sets up PostHog if enabled (async, non-blocking)
Configures logging — Sets log level and optional custom logger
Idempotent — Multiple calls with same key are no-ops
Re-initialization — Different key clears cache and reconfigures

Error Handling

try {
  await initAmplifySDK("pxl_your_api_key");
} catch (error) {
  if (error instanceof APIError) {
    console.error(`Init failed: ${error.message}`);
  }
}

Error Message Pattern	Description	Resolution
`"API key cannot be empty"`	Empty or missing API key	Provide a valid `pxl_...` key
`"Invalid API key format"`	Key too short or malformed	Check key format

If you call other SDK functions (e.g., prepareDepositTxData, fetchSupportedAssets) before calling initAmplifySDK(), they will throw an SDK_NOT_INITIALIZED error. Always initialize the SDK first.

Logging Guide - Configure logging levels
Project Setup - SDK initialization patterns

Getting started

Origin - Branded Stablecoins

Amplify - Stablecoin Earn

Access - Borrow

USDG0

Import

Usage

Parameters

SDKInitOptions

Return Type

Examples

Behavior

Error Handling

​Import

​Usage

​Parameters

​SDKInitOptions

​Return Type

​Examples

​Behavior

​Error Handling

​Related

Import

Usage

Parameters

SDKInitOptions

Return Type

Examples

Behavior

Error Handling

Related