createWalletConnectClient

Defined in thirdweb/src/wallets/wallet-connect/receiver/index.ts#L158

Creates a new WalletConnect client for interacting with another application.

Example


import { createWalletConnectClient } from "thirdweb/wallets";
 
const client = await createWalletConnectClient({
  wallet: wallet,
  client: client,
});

Pass custom handlers:


import { createWalletConnectClient } from "thirdweb/wallets";
 
const client = await createWalletConnectClient({
  wallet: wallet,
  client: client,
  requestHandlers: {
    eth_signTransaction: ({ account, chainId, params }) => {
      // handle transaction signing
    },
  },
});

Pass connect and disconnect callbacks:


import { createWalletConnectClient } from "thirdweb/wallets";
 
const client = await createWalletConnectClient({
  wallet: wallet,
  client: client,
  onConnect: (session) => {
    console.log("Connected to WalletConnect", session);
  },
  onDisconnect: (session) => {
    console.log("Disconnected from WalletConnect", session);
  },
});


function createWalletConnectClient(options: {
  appMetadata?: AppMetadata;
  chains?: Array<{
    readonly blockExplorers?: Array<{
      apiUrl?: string;
      name: string;
      url: string;
    }>;
    readonly experimental?: { increaseZeroByteCount?: boolean };
    readonly faucets?: Array<string>;
    readonly icon?: Icon;
    readonly id: number;
    readonly name?: string;
    readonly nativeCurrency?: {
      decimals?: number;
      name?: string;
      symbol?: string;
    };
    readonly rpc: string;
    readonly testnet?: true;
  }>;
  client: ThirdwebClient;
  onConnect?: (session: WalletConnectSession) => void;
  onDisconnect?: (session: WalletConnectSession) => void;
  onError?: (error: Error) => void;
  projectId?: string;
  requestHandlers?: {
    eth_sendRawTransaction?: (_: {
      account: Account;
      chainId: number;
      params: WalletConnectRawTransactionRequestParams;
    }) => Promise<`0x${string}` | WalletConnectRequestError>;
    eth_sendTransaction?: (_: {
      account: Account;
      chainId: number;
      params: WalletConnectTransactionRequestParams;
    }) => Promise<`0x${string}` | WalletConnectRequestError>;
    eth_sign?: (_: {
      account: Account;
      params: WalletConnectSignRequestPrams;
    }) => Promise<`0x${string}` | WalletConnectRequestError>;
    eth_signTransaction?: (_: {
      account: Account;
      params: WalletConnectTransactionRequestParams;
    }) => Promise<`0x${string}` | WalletConnectRequestError>;
    eth_signTypedData?: (_: {
      account: Account;
      params: WalletConnectSignTypedDataRequestParams;
    }) => Promise<`0x${string}` | WalletConnectRequestError>;
    eth_signTypedData_v4?: (_: {
      account: Account;
      params: WalletConnectSignTypedDataRequestParams;
    }) => Promise<`0x${string}` | WalletConnectRequestError>;
    personal_sign?: (_: {
      account: Account;
      params: WalletConnectSignRequestPrams;
    }) => Promise<`0x${string}` | WalletConnectRequestError>;
    wallet_addEthereumChain?: (_: {
      params: WalletConnectAddEthereumChainRequestParams;
      wallet: Wallet;
    }) => Promise<`0x${string}`>;
    wallet_switchEthereumChain?: (_: {
      params: WalletConnectSwitchEthereumChainRequestParams;
      wallet: Wallet;
    }) => Promise<`0x${string}`>;
  };
  wallet: Wallet;
}): Promise<WalletConnectClient>;

Parameters

The options to use to create the WalletConnect client.

Type


let options: {
  appMetadata?: AppMetadata;
  chains?: Array<{
    readonly blockExplorers?: Array<{
      apiUrl?: string;
      name: string;
      url: string;
    }>;
    readonly experimental?: { increaseZeroByteCount?: boolean };
    readonly faucets?: Array<string>;
    readonly icon?: Icon;
    readonly id: number;
    readonly name?: string;
    readonly nativeCurrency?: {
      decimals?: number;
      name?: string;
      symbol?: string;
    };
    readonly rpc: string;
    readonly testnet?: true;
  }>;
  client: ThirdwebClient;
  onConnect?: (session: WalletConnectSession) => void;
  onDisconnect?: (session: WalletConnectSession) => void;
  onError?: (error: Error) => void;
  projectId?: string;
  requestHandlers?: {
    eth_sendRawTransaction?: (_: {
      account: Account;
      chainId: number;
      params: WalletConnectRawTransactionRequestParams;
    }) => Promise<`0x${string}` | WalletConnectRequestError>;
    eth_sendTransaction?: (_: {
      account: Account;
      chainId: number;
      params: WalletConnectTransactionRequestParams;
    }) => Promise<`0x${string}` | WalletConnectRequestError>;
    eth_sign?: (_: {
      account: Account;
      params: WalletConnectSignRequestPrams;
    }) => Promise<`0x${string}` | WalletConnectRequestError>;
    eth_signTransaction?: (_: {
      account: Account;
      params: WalletConnectTransactionRequestParams;
    }) => Promise<`0x${string}` | WalletConnectRequestError>;
    eth_signTypedData?: (_: {
      account: Account;
      params: WalletConnectSignTypedDataRequestParams;
    }) => Promise<`0x${string}` | WalletConnectRequestError>;
    eth_signTypedData_v4?: (_: {
      account: Account;
      params: WalletConnectSignTypedDataRequestParams;
    }) => Promise<`0x${string}` | WalletConnectRequestError>;
    personal_sign?: (_: {
      account: Account;
      params: WalletConnectSignRequestPrams;
    }) => Promise<`0x${string}` | WalletConnectRequestError>;
    wallet_addEthereumChain?: (_: {
      params: WalletConnectAddEthereumChainRequestParams;
      wallet: Wallet;
    }) => Promise<`0x${string}`>;
    wallet_switchEthereumChain?: (_: {
      params: WalletConnectSwitchEthereumChainRequestParams;
      wallet: Wallet;
    }) => Promise<`0x${string}`>;
  };
  wallet: Wallet;
};

Returns

The WalletConnect client. Use this client to connect to a WalletConnect URI with createWalletConnectSession.

createWalletConnectClient

Example

Signature

Parameters

options

Type

Returns

Return Type