Creating a Dynamic Client

​

Installation

npm install @dynamic-labs-sdk/client

​

Usage

import { createDynamicClient } from '@dynamic-labs-sdk/client';

const dynamicClient = createDynamicClient({
  environmentId: 'YOUR_ENVIRONMENT_ID',
  metadata: {
    name: 'YOUR_APP_NAME',
    universalLink: 'https://yourapp.com',
    iconUrl: 'YOUR_APP_ICON_URL',
  },
});

import { createDynamicClient } from '@dynamic-labs-sdk/client';

const dynamicClient = createDynamicClient({
  environmentId: 'YOUR_ENVIRONMENT_ID',
  metadata: {
    name: 'YOUR_APP_NAME',
    nativeLink: 'myapp://', // Must match the scheme registered in Info.plist / AndroidManifest.xml
    universalLink: 'https://yourapp.com', // Required for passkeys; same value as the window.location polyfill
    iconUrl: 'YOUR_APP_ICON_URL',
  },
});

​

Configuration Options

​

Basic Options

• environmentId (required): Your Dynamic environment ID
• autoInitialize (optional): Whether to automatically initialize the client (default: true)
• metadata (optional): Your app’s metadata
  • name: The name of your app
  • universalLink: The official domain/URL of your app (e.g., https://yourapp.com). Used for deep link redirects and as the domain in sign-in message signatures.
  • iconUrl: The URL of the icon of your app
  • nativeLink: Native deep link for your app (e.g., myapp://). Used for app-to-app communication on mobile devices.
• logLevel (optional): Logging level for the SDK

​

Advanced Options

​

Transformers

const dynamicClient = createDynamicClient({
  environmentId: 'YOUR_ENVIRONMENT_ID',
  transformers: {
    networksData: (networksData) =>
      networksData.map((network) => {
        // Override RPC URLs
        if (network.networkId === '1') {
          return {
            ...network,
            rpcUrls: {
              http: ['https://eth-mainnet.g.alchemy.com/v2/YOUR-KEY'],
            },
          };
        }
        return network;
      }),
  },
});

​

WaaS Options

const dynamicClient = createDynamicClient({
  environmentId: 'YOUR_ENVIRONMENT_ID',
  waas: {
    loadTimeoutMs: 5000,
    maxLoadRetries: 0,
  },
});

• loadTimeoutMs (optional, default 20000): Per-attempt timeout, in milliseconds, for loading the embedded wallet’s secure container. Must be a number between 1000 and 60000; values outside that range are rejected with an InvalidParamError at client creation.
• maxLoadRetries (optional, default 1): Extra load attempts (after the first) before the wallet gives up and embedded wallet operations reject with WaasLoadFailedError. Must be an integer between 0 and 10; values outside that range are rejected with an InvalidParamError at client creation.
• additionalTrustedOrigins (optional): Extra origins allowed when the WaaS iframe validates postMessage sources — for example, when your app is embedded in another trusted origin.