Adding a network

This function was introduced in SDK version 0.4.0.

Use addNetwork to add a network to a wallet provider. This function requests that the wallet provider add a network to its list of available networks.

Usage

import { addNetwork, NetworkAddingUnavailableError } from '@dynamic-labs-sdk/client';

const addNetworkToWallet = async () => {
  try {
    await addNetwork({ 
      walletAccount, 
      networkData: {
        blockExplorerUrls: ['https://polygonscan.com'],
        chain: 'EVM',
        displayName: 'Polygon',
        iconUrl: 'https://app.dynamic.xyz/assets/networks/polygon.svg',
        name: 'polygon',
        nativeCurrency: {
          decimals: 18,
          name: 'POL',
          symbol: 'POL'
        },
        networkId: '137',
        rpcUrls: {
          http: ['https://polygon-rpc.com']
        },
        testnet: false
      }
    });
  } catch (error) {
    if (error instanceof NetworkAddingUnavailableError) {
      console.error('This wallet does not support adding networks');
    }
  }
}

React

import { addNetwork, NetworkAddingUnavailableError } from '@dynamic-labs-sdk/client';
import { useGetWalletAccounts } from '@dynamic-labs-sdk/react-hooks';

function AddPolygonButton() {
  const { data: walletAccounts = [] } = useGetWalletAccounts();
  const walletAccount = walletAccounts[0];

  const handleAdd = async () => {
    if (!walletAccount) return;
    try {
      await addNetwork({
        walletAccount,
        networkData: {
          blockExplorerUrls: ['https://polygonscan.com'],
          chain: 'EVM',
          displayName: 'Polygon',
          iconUrl: 'https://app.dynamic.xyz/assets/networks/polygon.svg',
          name: 'polygon',
          nativeCurrency: { decimals: 18, name: 'POL', symbol: 'POL' },
          networkId: '137',
          rpcUrls: { http: ['https://polygon-rpc.com'] },
          testnet: false,
        },
      });
    } catch (error) {
      if (error instanceof NetworkAddingUnavailableError) {
        console.error('This wallet does not support adding networks');
      }
    }
  };

  return (
    <button onClick={handleAdd} disabled={!walletAccount}>
      Add Polygon
    </button>
  );
}

Parameters

• walletAccount - The wallet account to add the network for.
• networkData - The network configuration to add to the wallet, as a NetworkData object. Get an existing one from getNetworksData or build it yourself with blockExplorerUrls, chain, displayName, iconUrl, name, nativeCurrency, networkId, rpcUrls and testnet.
• client (optional) - The Dynamic client instance. Only required when using multiple Dynamic clients.

Error Handling

The addNetwork function can throw the following errors:

NetworkAddingUnavailableError

If the wallet provider does not support adding networks, the function will throw a NetworkAddingUnavailableError error. In this case, the user must manually add the network in their wallet.

Related functions

• Switching Active Network
• Getting Active Network
• Getting Networks Data