feat: WalletConnect: error handling

trilitech · Jan 13, 2025 · 3c2c490 · 3c2c490
1 parent e17bef5
commit 3c2c490
Show file tree

Hide file tree

Showing 8 changed files with 273 additions and 67 deletions.
diff --git a/apps/web/src/components/Menu/ErrorLogsMenu/ErrorLogsMenu.tsx b/apps/web/src/components/Menu/ErrorLogsMenu/ErrorLogsMenu.tsx
@@ -1,6 +1,5 @@
 import { Box, Button, Divider, Flex, Heading, Link, Text, VStack } from "@chakra-ui/react";
 import { errorsActions, useAppDispatch, useAppSelector } from "@umami/state";
-import { handleTezError } from "@umami/utils";
 
 import { useColor } from "../../../styles/useColor";
 import { EmptyMessage } from "../../EmptyMessage";
@@ -61,8 +60,7 @@ export const ErrorLogsMenu = () => {
                     </Text>
                     {errorLog.technicalDetails && (
                       <Text marginTop="12px" color={color("700")} size="sm">
-                        {handleTezError({ name: "unknown", message: errorLog.technicalDetails }) ??
-                          ""}
+                        {JSON.stringify(errorLog.technicalDetails)}
                       </Text>
                     )}
                   </Flex>

diff --git a/apps/web/src/components/WalletConnect/WalletConnectProvider.tsx b/apps/web/src/components/WalletConnect/WalletConnectProvider.tsx
@@ -3,6 +3,7 @@ import type EventEmitter from "events";
 import { type NetworkType } from "@airgap/beacon-wallet";
 import { useToast } from "@chakra-ui/react";
 import { type WalletKitTypes } from "@reown/walletkit";
+import { TezosOperationError } from "@taquito/taquito";
 import { useDynamicModalContext } from "@umami/components";
 import {
   createWalletKit,
@@ -12,10 +13,10 @@ import {
   walletKit,
 } from "@umami/state";
 import { type Network } from "@umami/tezos";
-import { CustomError, WalletConnectError } from "@umami/utils";
+import { CustomError, WalletConnectError, type WcErrorKey, getWcErrorResponse } from "@umami/utils";
 import { formatJsonRpcError } from "@walletconnect/jsonrpc-utils";
 import { type SessionTypes } from "@walletconnect/types";
-import { type SdkErrorKey, getSdkError } from "@walletconnect/utils";
+import { getSdkError } from "@walletconnect/utils";
 import { type PropsWithChildren, useCallback, useEffect, useRef } from "react";
 
 import { SessionProposalModal } from "./SessionProposalModal";
@@ -94,7 +95,7 @@ export const WalletConnectProvider = ({ children }: PropsWithChildren) => {
       handleAsyncActionUnsafe(async () => {
         const activeSessions: Record<string, SessionTypes.Struct> = walletKit.getActiveSessions();
         if (!(event.topic in activeSessions)) {
-          throw new WalletConnectError("Session not found", "INVALID_EVENT", null);
+          throw new WalletConnectError("Session not found", "SESSION_NOT_FOUND", null);
         }
 
         const session = activeSessions[event.topic];
@@ -105,19 +106,20 @@ export const WalletConnectProvider = ({ children }: PropsWithChildren) => {
         await handleWcRequest(event, session);
       }).catch(async error => {
         const { id, topic } = event;
-        let sdkErrorKey: SdkErrorKey =
-          error instanceof WalletConnectError ? error.sdkError : "SESSION_SETTLEMENT_FAILED";
-        if (sdkErrorKey === "USER_REJECTED") {
-          console.info("WC request rejected", sdkErrorKey, event, error);
+        let wcErrorKey: WcErrorKey = "UNKNOWN_ERROR";
+
+        if (error instanceof WalletConnectError) {
+          wcErrorKey = error.wcError;
+        } else if (error instanceof TezosOperationError) {
+          wcErrorKey = "REJECTED_BY_CHAIN";
+        }
+        const response = formatJsonRpcError(id, getWcErrorResponse(error));
+        if (wcErrorKey === "USER_REJECTED") {
+          console.info("WC request rejected", wcErrorKey, event, error);
         } else {
-          if (error.message.includes("delegate.unchanged")) {
-            sdkErrorKey = "INVALID_EVENT";
-          }
-          console.warn("WC request failed", sdkErrorKey, event, error);
+          console.warn("WC request failed", wcErrorKey, event, error, response);
         }
         // dApp is waiting so we need to notify it
-        const sdkErrorMessage = getSdkError(sdkErrorKey).message;
-        const response = formatJsonRpcError(id, sdkErrorMessage);
         await walletKit.respondSessionRequest({ topic, response });
       }),
     [handleAsyncActionUnsafe, handleWcRequest, toast]

diff --git a/apps/web/src/components/WalletConnect/useHandleWcRequest.tsx b/apps/web/src/components/WalletConnect/useHandleWcRequest.tsx
@@ -14,10 +14,9 @@ import {
   useGetOwnedAccountSafe,
   walletKit,
 } from "@umami/state";
-import { WalletConnectError } from "@umami/utils";
+import { WC_ERRORS, WalletConnectError } from "@umami/utils";
 import { formatJsonRpcError, formatJsonRpcResult } from "@walletconnect/jsonrpc-utils";
 import { type SessionTypes, type SignClientTypes, type Verify } from "@walletconnect/types";
-import { type SdkErrorKey, getSdkError } from "@walletconnect/utils";
 
 import { SignPayloadRequestModal } from "../common/SignPayloadRequestModal";
 import { BatchSignPage } from "../SendFlow/common/BatchSignPage";
@@ -61,11 +60,18 @@ export const useHandleWcRequest = () => {
       let modal;
       let onClose;
 
+      const handleUserRejected = () => {
+        // dApp is waiting so we need to notify it
+        const response = formatJsonRpcError(id, WC_ERRORS.USER_REJECTED);
+        console.info("WC request rejected by user", event, response);
+        void walletKit.respondSessionRequest({ topic, response });
+      };
+
       switch (request.method) {
         case "tezos_getAccounts": {
           const wcPeers = walletKit.getActiveSessions();
           if (!(topic in wcPeers)) {
-            throw new WalletConnectError(`Unknown session ${topic}`, "UNAUTHORIZED_EVENT", null);
+            throw new WalletConnectError(`Unknown session ${topic}`, "SESSION_NOT_FOUND", null);
           }
           const session = wcPeers[topic];
           const accountPkh = session.namespaces.tezos.accounts[0].split(":")[2];
@@ -89,15 +95,20 @@ export const useHandleWcRequest = () => {
 
         case "tezos_sign": {
           if (!request.params.account) {
-            throw new WalletConnectError("Missing account in request", "INVALID_EVENT", session);
+            throw new WalletConnectError(
+              "Missing account in request",
+              "MISSING_ACCOUNT_IN_REQUEST",
+              session
+            );
           }
           const signer = getImplicitAccount(request.params.account);
           const network = findNetwork(chainId.split(":")[1]);
           if (!network) {
             throw new WalletConnectError(
               `Unsupported network ${chainId}`,
               "UNSUPPORTED_CHAINS",
-              session
+              session,
+              chainId
             );
           }
 
@@ -115,24 +126,24 @@ export const useHandleWcRequest = () => {
 
           modal = <SignPayloadRequestModal opts={signPayloadProps} />;
           onClose = () => {
-            const sdkErrorKey: SdkErrorKey = "USER_REJECTED";
-            console.info("WC request rejected by user", sdkErrorKey, event);
-            // dApp is waiting so we need to notify it
-            const response = formatJsonRpcError(id, getSdkError(sdkErrorKey).message);
-            void walletKit.respondSessionRequest({ topic, response });
+            handleUserRejected();
           };
           return openWith(modal, { onClose });
         }
 
         case "tezos_send": {
           if (!request.params.account) {
-            throw new WalletConnectError("Missing account in request", "INVALID_EVENT", session);
+            throw new WalletConnectError(
+              "Missing account in request",
+              "MISSING_ACCOUNT_IN_REQUEST",
+              session
+            );
           }
           const signer = getAccount(request.params.account);
           if (!signer) {
             throw new WalletConnectError(
               `Unknown account, no signer: ${request.params.account}`,
-              "UNAUTHORIZED_EVENT",
+              "INTERNAL_SIGNER_IS_MISSING",
               session
             );
           }
@@ -168,16 +179,17 @@ export const useHandleWcRequest = () => {
             modal = <BatchSignPage {...signProps} {...event.params.request.params} />;
           }
           onClose = () => {
-            throw new WalletConnectError("Rejected by user", "USER_REJECTED", session);
+            handleUserRejected();
           };
 
           return openWith(modal, { onClose });
         }
         default:
           throw new WalletConnectError(
             `Unsupported method ${request.method}`,
-            "WC_METHOD_UNSUPPORTED",
-            session
+            "METHOD_UNSUPPORTED",
+            session,
+            request.method
           );
       }
     });

diff --git a/packages/core/src/getPublicKeyAndCurve.ts b/packages/core/src/getPublicKeyAndCurve.ts
@@ -0,0 +1,53 @@
+import { type ManagerKeyResponse } from "@taquito/rpc";
+import { type ImplicitAccount } from "@umami/core";
+import { type Network, type RawPkh, makeToolkit } from "@umami/tezos";
+import { WalletConnectError } from "@umami/utils";
+import { type SessionTypes } from "@walletconnect/types";
+
+/**
+ * Fetches the public key and curve of a given tz1 address.
+ *
+ * @param address - tz1 address of the account
+ * @param signer - Implicit account
+ * @param network - network
+ * @param session - WalletConnect session
+ * @returns the public key if revelead
+ * Throws an error if the account is not revealed
+ */
+export const getPublicKeyAndCurve = async (
+  address: RawPkh,
+  signer: ImplicitAccount,
+  network: Network,
+  session?: SessionTypes.Struct | null
+): Promise<{ publicKey: string; curve: string }> => {
+  const tezosToolkit = await makeToolkit({
+    type: "fake",
+    signer: signer,
+    network,
+  });
+  const keyResponse: ManagerKeyResponse | null = await tezosToolkit.rpc.getManagerKey(address);
+  if (!keyResponse) {
+    throw new WalletConnectError(
+      `Signer address is not revealed on the ${network.name}. To reveal it, send any amount, e.g. 0.000001ꜩ, from that address to yourself. Wait several minutes and try again.`,
+      "SIGNER_ADDRESS_NOT_REVEALED",
+      session || null
+    );
+  }
+  const publicKey = typeof keyResponse === "string" ? keyResponse : keyResponse.key;
+  const curve = publicKey.startsWith("edpk")
+    ? "ed25519"
+    : publicKey.startsWith("sppk")
+      ? "secp256k1"
+      : publicKey.startsWith("p2pk")
+        ? "p-256"
+        : null;
+  if (!curve) {
+    throw new WalletConnectError(
+      `Unknown curve for the public key: ${publicKey}`,
+      "UNKNOWN_CURVE_FOR_PUBLIC_KEY",
+      session || null,
+      publicKey
+    );
+  }
+  return { publicKey, curve };
+};
diff --git a/packages/state/src/slices/errors.test.ts b/packages/state/src/slices/errors.test.ts
@@ -29,6 +29,7 @@ describe("Errors reducer", () => {
           description: `error ${i}`,
           stacktrace: "stacktrace",
           technicalDetails: "technicalDetails",
+          code: i,
         })
       );
     }

diff --git a/packages/test-utils/src/errorContext.ts b/packages/test-utils/src/errorContext.ts
@@ -2,12 +2,14 @@ export const errorContext1 = {
   timestamp: "2023-08-03T19:27:43.735Z",
   description: "error1",
   stacktrace: "stacktrace",
+  code: 100,
   technicalDetails: "technicalDetails",
 };
 
 export const errorContext2 = {
   timestamp: "2023-08-03T20:21:58.395Z",
   description: "error1",
   stacktrace: "stacktrace",
+  code: 200,
   technicalDetails: "technicalDetails",
 };