thirdweb 5.30.0-nightly-991cb72bdb1b94fcf0f9a3de36b2ec8ee07ae5ec-20240619000538 → 5.30.0-nightly-fab5cd43bed972b0a3f70f0f39a790349672ba72-20240620192731

package/src/wallets/wallet-connect/{consumer → receiver}/index.ts

@@ -1,15 +1,23 @@
 import { SignClient } from "@walletconnect/sign-client";
+import type { Chain } from "../../../chains/types.js";
 import type { ThirdwebClient } from "../../../client/client.js";
 import type { Prettify } from "../../../utils/type-utils.js";
-import type { Wallet } from "../../../wallets/interfaces/wallet.js";
+import type { Wallet } from "../../interfaces/wallet.js";
 import { getDefaultAppMetadata } from "../../utils/defaultDappMetadata.js";
 import { DEFAULT_PROJECT_ID } from "../constants.js";
+import { handleSendRawTransactionRequest } from "./request-handlers/send-raw-transaction.js";
+import { handleSendTransactionRequest } from "./request-handlers/send-transaction.js";
+import { handleSignTransactionRequest } from "./request-handlers/sign-transaction.js";
+import { handleSignTypedDataRequest } from "./request-handlers/sign-typed-data.js";
+import { handleSignRequest } from "./request-handlers/sign.js";
+import { handleSwitchChain } from "./request-handlers/switch-chain.js";
 import {
   getSessions,
   initializeSessionStore,
   removeSession,
 } from "./session-store.js";
 import type {
+  WalletConnectAddEthereumChainRequestParams,
   WalletConnectClient,
   WalletConnectConfig,
   WalletConnectRequestHandlers,
@@ -31,6 +39,11 @@ export type CreateWalletConnectClientOptions = Prettify<
      */
     wallet: Wallet;
 
+    /**
+     * Any chains to enable for the wallet. Apps can request access to specific chains, but this list will always be available for use with the wallet.
+     */
+    chains?: Chain[];
+
     /**
      * Custom RPC handlers to override the defaults. Useful when creating a custom approval UI.
      */
@@ -45,6 +58,11 @@ export type CreateWalletConnectClientOptions = Prettify<
      * Callback triggered whenever a session is disconnected.
      */
     onDisconnect?: (session: WalletConnectSession) => void;
+
+    /**
+     * Callback for handling errors.
+     */
+    onError?: (error: Error) => void;
   }
 >;
 
@@ -58,11 +76,38 @@ export type CreateWalletConnectSessionOptions = {
    * The WalletConnect session URI retrieved from the application to connect with.
    */
   uri: string;
+};
 
-  /**
-   * Callback triggered when the session is successfully created.
-   */
-  onConnect?: (session: WalletConnectSession) => void;
+let walletConnectClientCache = new WeakMap<
+  ThirdwebClient,
+  WalletConnectClient
+>();
+
+/*
+ * @internal
+ */
+export const clearWalletConnectClientCache = () => {
+  walletConnectClientCache = new WeakMap<ThirdwebClient, WalletConnectClient>();
+};
+
+/**
+ * Default request handlers for WalletConnect requests.
+ */
+export const DefaultWalletConnectRequestHandlers = {
+  personal_sign: handleSignRequest,
+  eth_sign: handleSignRequest,
+  eth_signTypedData: handleSignTypedDataRequest,
+  eth_signTypedData_v4: handleSignTypedDataRequest,
+  eth_signTransaction: handleSignTransactionRequest,
+  eth_sendTransaction: handleSendTransactionRequest,
+  eth_sendRawTransaction: handleSendRawTransactionRequest,
+  wallet_addEthereumChain: (_: {
+    wallet: Wallet;
+    params: WalletConnectAddEthereumChainRequestParams;
+  }) => {
+    throw new Error("Unsupported request method: wallet_addEthereumChain");
+  },
+  wallet_switchEthereumChain: handleSwitchChain,
 };
 
 /**
@@ -72,7 +117,7 @@ export type CreateWalletConnectSessionOptions = {
  * @returns The WalletConnect client. Use this client to connect to a WalletConnect URI with {@link createWalletConnectSession}.
  * @example
  * ```ts
- * import { createWalletConnectClient } from "thirdweb/wallets/wallet-connect";
+ * import { createWalletConnectClient } from "thirdweb/wallets";
  *
  * const client = await createWalletConnectClient({
  *   wallet: wallet,
@@ -81,13 +126,13 @@ export type CreateWalletConnectSessionOptions = {
  * ```
  * Pass custom handlers:
  * ```ts
- * import { createWalletConnectClient } from "thirdweb/wallets/wallet-connect";
+ * import { createWalletConnectClient } from "thirdweb/wallets";
  *
  * const client = await createWalletConnectClient({
  *   wallet: wallet,
  *   client: client,
  *   requestHandlers: {
- *     eth_signTransaction: ({ transaction }) => {
+ *     eth_signTransaction: ({ account, chainId, params }) => {
  *       // handle transaction signing
  *     },
  *   },
@@ -95,7 +140,7 @@ export type CreateWalletConnectSessionOptions = {
  * ```
  * Pass connect and disconnect callbacks:
  * ```ts
- * import { createWalletConnectClient } from "thirdweb/wallets/wallet-connect";
+ * import { createWalletConnectClient } from "thirdweb/wallets";
  *
  * const client = await createWalletConnectClient({
  *   wallet: wallet,
@@ -113,7 +158,11 @@ export type CreateWalletConnectSessionOptions = {
 export async function createWalletConnectClient(
   options: CreateWalletConnectClientOptions,
 ): Promise<WalletConnectClient> {
-  const { wallet, requestHandlers, onConnect, onDisconnect } = options;
+  const { wallet, requestHandlers, chains, onConnect, onDisconnect } = options;
+
+  if (walletConnectClientCache.has(options.client)) {
+    return walletConnectClientCache.get(options.client) as WalletConnectClient;
+  }
 
   initializeSessionStore({ clientId: options.client.clientId });
 
@@ -132,11 +181,18 @@ export async function createWalletConnectClient(
     "session_proposal",
     async (event: WalletConnectSessionProposalEvent) => {
       const { onSessionProposal } = await import("./session-proposal.js");
-      onSessionProposal({
+      await onSessionProposal({
         wallet,
         walletConnectClient,
         event,
+        chains,
         onConnect,
+      }).catch((error) => {
+        if (options.onError) {
+          options.onError(error as Error);
+        } else {
+          throw error;
+        }
       });
     },
   );
@@ -145,11 +201,17 @@ export async function createWalletConnectClient(
     "session_request",
     async (event: WalletConnectSessionRequestEvent) => {
       const { fulfillRequest } = await import("./session-request.js");
-      fulfillRequest({
+      await fulfillRequest({
         wallet,
         walletConnectClient,
         event,
         handlers: requestHandlers,
+      }).catch((error) => {
+        if (options.onError) {
+          options.onError(error as Error);
+        } else {
+          throw error;
+        }
       });
     },
   );
@@ -157,7 +219,7 @@ export async function createWalletConnectClient(
   walletConnectClient.on(
     "session_event",
     async (_event: WalletConnectSessionEvent) => {
-      // TODO
+      // TODO (accountsChanged, chainChanged)
     },
   );
 
@@ -174,6 +236,12 @@ export async function createWalletConnectClient(
       await disconnectWalletConnectSession({
         session: { topic: event.topic },
         walletConnectClient,
+      }).catch((error) => {
+        if (options.onError) {
+          options.onError(error as Error);
+        } else {
+          throw error;
+        }
       });
     },
   );
@@ -188,6 +256,8 @@ export async function createWalletConnectClient(
     return result;
   };
 
+  walletConnectClientCache.set(options.client, walletConnectClient);
+
   return walletConnectClient;
 }
 
@@ -196,7 +266,7 @@ export async function createWalletConnectClient(
  * @param options - The options to use to create the WalletConnect session.
  * @example
  * ```ts
- * import { createWalletConnectClient, createWalletConnectSession } from "thirdweb/wallets/wallet-connect";
+ * import { createWalletConnectClient, createWalletConnectSession } from "thirdweb/wallets";
  *
  * const client = await createWalletConnectClient({
  *   wallet: wallet,
@@ -223,7 +293,7 @@ export function createWalletConnectSession(
  * @returns All active WalletConnect sessions.
  * @example
  * ```ts
- * import { getActiveWalletConnectSessions } from "thirdweb/wallets/wallet-connect";
+ * import { getActiveWalletConnectSessions } from "thirdweb/wallets";
  *
  * const sessions = await getActiveWalletConnectSessions();
  * ```
@@ -240,10 +310,10 @@ export async function getActiveWalletConnectSessions(): Promise<
  * @param options - The options to use to disconnect the WalletConnect session.
  * @example
  * ```ts
- * import { disconnectWalletConnectSession } from "thirdweb/wallets/wallet-connect";
+ * import { disconnectWalletConnectSession } from "thirdweb/wallets";
  *
  * await disconnectWalletConnectSession({
- *   session: { topic: "..." },
+ *   session: mySession,
  *   walletConnectClient: wcClient,
  * });
  * ```
@@ -258,7 +328,7 @@ export async function disconnectWalletConnectSession(options: {
       topic: options.session.topic,
       reason: {
         code: 6000,
-        message: "Replaced by new session",
+        message: "Disconnected",
       },
     });
   } catch {

package/src/wallets/wallet-connect/{consumer/consumer.test.ts → receiver/receiver.test.ts}

@@ -5,6 +5,7 @@ import { TEST_IN_APP_WALLET_A } from "../../../../test/src/test-wallets.js";
 import { getDefaultAppMetadata } from "../../utils/defaultDappMetadata.js";
 import { DEFAULT_PROJECT_ID } from "../constants.js";
 import {
+  clearWalletConnectClientCache,
   createWalletConnectClient,
   createWalletConnectSession,
   disconnectWalletConnectSession,
@@ -64,6 +65,10 @@ beforeEach(() => {
 });
 
 describe("createWalletConnectClient", () => {
+  beforeEach(() => {
+    clearWalletConnectClientCache();
+  });
+
   it("creates a client with provided metadata", async () => {
     const client = await createWalletConnectClient({
       projectId: "test",
@@ -143,6 +148,40 @@ describe("createWalletConnectClient", () => {
     await listeners.session_delete?.({ topic: "test" });
     expect(onDisconnect).toHaveBeenCalledWith({ topic: "test" });
   });
+
+  describe("onError handling", () => {
+    it("triggers callback when session_proposal handler throws an error", async () => {
+      const onError = vi.fn();
+      onSessionProposal.mockRejectedValue(new Error("Proposal Error"));
+
+      await createWalletConnectClient({
+        client: TEST_CLIENT,
+        wallet: TEST_IN_APP_WALLET_A,
+        onError,
+      });
+
+      await listeners.session_proposal?.();
+
+      expect(onError).toHaveBeenCalledWith(expect.any(Error));
+      expect(onError).toHaveBeenCalledTimes(1);
+    });
+
+    it("triggers callback when session_request handler throws an error", async () => {
+      const onError = vi.fn();
+      fulfillRequest.mockRejectedValue(new Error("Request Error"));
+
+      await createWalletConnectClient({
+        client: TEST_CLIENT,
+        wallet: TEST_IN_APP_WALLET_A,
+        onError,
+      });
+
+      await listeners.session_request?.();
+
+      expect(onError).toHaveBeenCalledWith(expect.any(Error));
+      expect(onError).toHaveBeenCalledTimes(1);
+    });
+  });
 });
 
 describe("createWalletConnectSession", () => {

package/src/wallets/wallet-connect/{consumer → receiver}/request-handlers/send-raw-transaction.ts

@@ -18,7 +18,7 @@ export async function handleSendRawTransactionRequest(options: {
 
   if (!account.sendRawTransaction) {
     throw new Error(
-      "[WalletConnect] The current account does not support sending raw transactions",
+      "The current account does not support sending raw transactions",
     );
   }
 

package/src/wallets/wallet-connect/{consumer → receiver}/request-handlers/sign-transaction.ts

@@ -21,7 +21,7 @@ export async function handleSignTransactionRequest(options: {
 
   if (!account.signTransaction) {
     throw new Error(
-      "[WalletConnect] The current account does not support signing transactions",
+      "The current account does not support signing transactions",
     );
   }
 

package/src/wallets/wallet-connect/{consumer → receiver}/request-handlers/sign.ts

@@ -13,5 +13,5 @@ export async function handleSignRequest(options: {
   const { account, params } = options;
 
   validateAccountAddress(account, params[1]);
-  return account.signMessage({ message: params[0] });
+  return account.signMessage({ message: { raw: params[0] as Hex } });
 }

package/src/wallets/wallet-connect/receiver/request-handlers/switch-chain.ts

@@ -0,0 +1,21 @@
+import { defineChain } from "../../../../chains/utils.js";
+import { type Hex, hexToNumber } from "../../../../utils/encoding/hex.js";
+import type { Wallet } from "../../../interfaces/wallet.js";
+import type { WalletConnectSwitchEthereumChainRequestParams } from "../types.js";
+
+/**
+ * @internal
+ */
+export async function handleSwitchChain(options: {
+  wallet: Wallet;
+  params: WalletConnectSwitchEthereumChainRequestParams;
+}): Promise<Hex> {
+  const { wallet, params } = options;
+
+  if (wallet.getChain()?.id === hexToNumber(params[0].chainId)) {
+    return "0x1";
+  } else {
+    await wallet.switchChain(defineChain(hexToNumber(params[0].chainId)));
+    return "0x1";
+  }
+}

package/src/wallets/wallet-connect/{consumer → receiver}/session-proposal.test.ts

@@ -1,5 +1,6 @@
 import { beforeEach } from "node:test";
 import { afterAll, describe, expect, it, vi } from "vitest";
+import { ANVIL_CHAIN } from "../../../../test/src/chains.js";
 import {
   TEST_ACCOUNT_A,
   TEST_IN_APP_WALLET_A,
@@ -92,7 +93,7 @@ describe("session_proposal", () => {
     });
 
     await expect(promise).rejects.toThrow(
-      "[WalletConnect] No account connected to provided wallet",
+      "No account connected to provided wallet",
     );
   });
 
@@ -125,6 +126,39 @@ describe("session_proposal", () => {
     });
   });
 
+  it("should connect new session with custom chains", async () => {
+    await onSessionProposal({
+      walletConnectClient: signClientMock,
+      wallet: walletMock,
+      event: PROPOSAL_EVENT_MOCK,
+      chains: [ANVIL_CHAIN],
+    });
+
+    expect(signClientMock.approve).toHaveBeenCalledWith({
+      id: PROPOSAL_EVENT_MOCK.id,
+      namespaces: {
+        eip155: {
+          accounts: [
+            `eip155:1:${TEST_ACCOUNT_A.address}`,
+            `eip155:31337:${TEST_ACCOUNT_A.address}`,
+          ],
+          methods: [
+            ...(PROPOSAL_EVENT_MOCK.params.requiredNamespaces?.eip155
+              ?.methods ?? []),
+            ...(PROPOSAL_EVENT_MOCK.params.optionalNamespaces?.eip155
+              ?.methods ?? []),
+          ],
+          events: [
+            ...(PROPOSAL_EVENT_MOCK.params.requiredNamespaces?.eip155?.events ??
+              []),
+            ...(PROPOSAL_EVENT_MOCK.params.optionalNamespaces?.eip155?.events ??
+              []),
+          ],
+        },
+      },
+    });
+  });
+
   it("should disconnect existing session", async () => {
     vi.spyOn(SessionStore, "getSessions").mockResolvedValueOnce([
       {
@@ -151,27 +185,12 @@ describe("session_proposal", () => {
   });
 
   it("should throw if no eip155 namespace provided", async () => {
-    const proposal = {
-      ...PROPOSAL_EVENT_MOCK,
-      params: { ...PROPOSAL_EVENT_MOCK.params, requiredNamespaces: {} },
-    };
-
-    const promise = onSessionProposal({
-      walletConnectClient: signClientMock,
-      wallet: walletMock,
-      event: proposal,
-    });
-    await expect(promise).rejects.toThrow(
-      "[WalletConnect] No EIP155 namespace found in Wallet Connect session proposal",
-    );
-  });
-
-  it("should throw if no eip155 chains provided", async () => {
     const proposal = {
       ...PROPOSAL_EVENT_MOCK,
       params: {
         ...PROPOSAL_EVENT_MOCK.params,
-        requiredNamespaces: { eip155: { methods: [], events: [] } },
+        requiredNamespaces: {},
+        optionalNamespaces: {},
       },
     };
 
@@ -181,7 +200,7 @@ describe("session_proposal", () => {
       event: proposal,
     });
     await expect(promise).rejects.toThrow(
-      "[WalletConnect] No chains found in EIP155 Wallet Connect session proposal namespace",
+      "No EIP155 namespace found in Wallet Connect session proposal",
     );
   });
 

package/src/wallets/wallet-connect/{consumer → receiver}/session-proposal.ts

@@ -1,3 +1,4 @@
+import type { Chain } from "../../../chains/types.js";
 import type { Account, Wallet } from "../../interfaces/wallet.js";
 import { disconnectWalletConnectSession } from "./index.js";
 import { getSessions, saveSession } from "./session-store.js";
@@ -14,13 +15,14 @@ export async function onSessionProposal(options: {
   wallet: Wallet;
   walletConnectClient: WalletConnectClient;
   event: WalletConnectSessionProposalEvent;
+  chains?: Chain[];
   onConnect?: (session: WalletConnectSession) => void;
 }) {
-  const { wallet, walletConnectClient, event, onConnect } = options;
+  const { wallet, walletConnectClient, event, chains, onConnect } = options;
 
   const account = wallet.getAccount();
   if (!account) {
-    throw new Error("[WalletConnect] No account connected to provided wallet");
+    throw new Error("No account connected to provided wallet");
   }
 
   const origin = event.verifyContext?.verified?.origin;
@@ -31,6 +33,7 @@ export async function onSessionProposal(options: {
     account,
     walletConnectClient,
     sessionProposal: event,
+    chains,
   });
 
   await saveSession(session);
@@ -64,38 +67,43 @@ export async function acceptSessionProposal({
   account,
   walletConnectClient,
   sessionProposal,
+  chains,
 }: {
   account: Account;
   walletConnectClient: WalletConnectClient;
   sessionProposal: WalletConnectSessionProposalEvent;
+  chains?: Chain[];
 }): Promise<WalletConnectSession> {
-  if (!sessionProposal.params.requiredNamespaces.eip155) {
+  if (
+    !sessionProposal.params.requiredNamespaces?.eip155 &&
+    !sessionProposal.params.optionalNamespaces?.eip155
+  ) {
     throw new Error(
-      "[WalletConnect] No EIP155 namespace found in Wallet Connect session proposal",
-    );
-  }
-
-  if (!sessionProposal.params.requiredNamespaces.eip155.chains) {
-    throw new Error(
-      "[WalletConnect] No chains found in EIP155 Wallet Connect session proposal namespace",
+      "No EIP155 namespace found in Wallet Connect session proposal",
     );
   }
 
   const namespaces = {
     chains: [
-      ...sessionProposal.params.requiredNamespaces.eip155.chains.map(
-        (chain: string) => `${chain}:${account.address}`,
+      ...Array.from(
+        new Set([
+          ...(sessionProposal.params.requiredNamespaces?.eip155?.chains?.map(
+            (chain: string) => `${chain}:${account.address}`,
+          ) ?? []),
+          ...(sessionProposal.params.optionalNamespaces?.eip155?.chains?.map(
+            (chain: string) => `${chain}:${account.address}`,
+          ) ?? []),
+          ...(chains?.map((chain) => `eip155:${chain.id}:${account.address}`) ??
+            []),
+        ]),
       ),
-      ...(sessionProposal.params.optionalNamespaces?.eip155?.chains?.map(
-        (chain: string) => `${chain}:${account.address}`,
-      ) ?? []),
     ],
     methods: [
-      ...sessionProposal.params.requiredNamespaces.eip155.methods,
+      ...(sessionProposal.params.requiredNamespaces?.eip155?.methods ?? []),
       ...(sessionProposal.params.optionalNamespaces?.eip155?.methods ?? []),
     ],
     events: [
-      ...sessionProposal.params.requiredNamespaces.eip155.events,
+      ...(sessionProposal.params.requiredNamespaces?.eip155?.events ?? []),
       ...(sessionProposal.params.optionalNamespaces?.eip155?.events ?? []),
     ],
   };