feat: Add snap_trackError method for error tracking through Sentry (#3498)

Mrtenz · metamaskbot · web-flow · commit 278d64711f65 · 2025-06-25T08:17:59.000Z
This adds a new RPC method `snap_trackError`, which can be used to track
errors in Sentry. It accepts a `name`, `message`, and `stack`, which
should be turned into a proper `Error` class again on the client end
before sending it to Sentry with `Sentry.captureException`.

To make the API a bit easier to use, I've added a `getJsonError` helper
function which takes an error (string, `Error` class, or other value)
and turns it into the properties expected by `snap_trackError`:

```ts
import { getJsonError } from '@metamask/snaps-sdk';

try {
  // ...
} catch (error) {
  await snap.request({
    method: 'snap_trackError',
    params: {
      error: getJsonError(error),
    },
  });
}
```

---------

Co-authored-by: MetaMask Bot &lt;metamaskbot@users.noreply.github.com&gt;
diff --git a/packages/examples/packages/background-events/snap.manifest.json b/packages/examples/packages/background-events/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "wRIfHJ8IQh76ktT6bMPaQeL76aUSIfOfdusGJAvU8j0=",
+    "shasum": "ry7ytwwA6jLu2lyh37cu4GnxJGRWw9l4HtHqfk/YxKs=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/bip32/snap.manifest.json b/packages/examples/packages/bip32/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "kQsI1Pe5Ds8AQM+3sbKnBpqCHbhkSlgPeuErzig1BSU=",
+    "shasum": "IrZRKN11QSuHCvwhtjLMKYkeQzo3dQbcnEM3h5UxMHU=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/bip44/snap.manifest.json b/packages/examples/packages/bip44/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "ZpWq5pSZ2qjXZHc2awkpSbUbO10vuT8uyRcVy6xyqkg=",
+    "shasum": "fbvXCpHz9/c+J/oGwc6cfNlmo44+YzB5+KzQGjg3UrQ=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/client-status/snap.manifest.json b/packages/examples/packages/client-status/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "IGEfi7rQXI0Tu98aDyGbtUAeUIE0CMZonR0leSBUl8E=",
+    "shasum": "OH3tTkb7IP7btCwvcg/aPl8KzsXTNN74U0+7mDnDbvI=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/cronjob-duration/snap.manifest.json b/packages/examples/packages/cronjob-duration/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "vzzpBIX/vOKbSw6x8JXHzMMeBe8lpOhaZi0KSZk9uOY=",
+    "shasum": "ikxPXqPpsUrLhRdpG++xXZq+P6nUtjy63k2MNa3senk=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/cronjobs/snap.manifest.json b/packages/examples/packages/cronjobs/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "eTktdzvPzAr/fMl6sZALdcUL2LOW3YhiUwqi28na8js=",
+    "shasum": "OwBJvrucDv6ozRGjtbbQbxDxM47wa0PSvDyPXAbypv8=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/dialogs/snap.manifest.json b/packages/examples/packages/dialogs/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "peqfxtsGBNeHO3WooTYIJK4bnujccveEwEd/FfGnItE=",
+    "shasum": "o/O+FW4JxMxiKE0SG0WMTeztDEGRD9OYTl38kg0gDW4=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/ethereum-provider/snap.manifest.json b/packages/examples/packages/ethereum-provider/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "TVX02bG6spSFsyki6sdzEnH/mWydCmiCBikwbTzAtUU=",
+    "shasum": "1I4qm6Fj6W2wx+m5PhMqR9B+xZEvapmvEhRG+y8rrN8=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/ethers-js/snap.manifest.json b/packages/examples/packages/ethers-js/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "fo34896eh0i/mRyFqXftntOqS1VtBPsTrh7dMfrE9/A=",
+    "shasum": "8BYNSeBmkTFOGtfAoCr40kBtyWFuphUpx1Ysrc69wxM=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/file-upload/snap.manifest.json b/packages/examples/packages/file-upload/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "2iuAhDEJAimbHAlgESzJfXj209w2Nu53AINf9xLClHc=",
+    "shasum": "6e1fd7mgrhCixaloe7WHbq31QyA9F7L1TDAOiCqo8U8=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/get-entropy/snap.manifest.json b/packages/examples/packages/get-entropy/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "DSRbnw3+N0bDFXC98mp6CRZclf9xnv02YjzbjqGhW+A=",
+    "shasum": "TeMbJ5681N2cDXzaCh6HXJuy/Cky/3O5kKrigky0gVA=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/get-file/snap.manifest.json b/packages/examples/packages/get-file/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "H06WpypSmOTGdYvW2FlWgvSJQlfbrClA6MhZQm+hCcE=",
+    "shasum": "A97Ii0+tB1PKtVmeFcMQ4f4CJ7rKvrKQRXmDYSc0HKw=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/images/snap.manifest.json b/packages/examples/packages/images/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "iwc4kyH65BZAt2aoYie0NV8WPQOifwsE/2FM09m83Pw=",
+    "shasum": "rlsDGm7dkPQC5I5/pf5LWKL2tDYpHxPO0Xk1fDZjByM=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/interactive-ui/snap.manifest.json b/packages/examples/packages/interactive-ui/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "3kmmluAHE93ugjckhw3/G2s0p1w5HxzJEiR/U2WwPqQ=",
+    "shasum": "C4s/7pT8TurRFHtZsFKkewUmrcVl/oHEs3fthh+s32g=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/invoke-snap/packages/consumer-signer/snap.manifest.json b/packages/examples/packages/invoke-snap/packages/consumer-signer/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "BwQ6ntfFAHvq/hKlliEg97F8OE0ECPKnGh5Qxld9toM=",
+    "shasum": "sfi9zpuxLaGN+Wtjb/YNHkmzkEkfhK5mClhV83Vl598=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/invoke-snap/packages/core-signer/snap.manifest.json b/packages/examples/packages/invoke-snap/packages/core-signer/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "HJdfma/JNA9n42xcivbwCE6j5BJVNmTGsqx+rvTI9fs=",
+    "shasum": "LDkje53dEOlbE5p/+faAByNWNRcs45GqM0iwQUjeOWI=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/json-rpc/snap.manifest.json b/packages/examples/packages/json-rpc/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "PzbEeF/xlc60ix7Vn8wgUTC7yQYBzl5hA6xFhIBT6FE=",
+    "shasum": "LMWJyn/sBYyJ/T3SQkWuMEqSqzXs0cVK4vhLEHHbjxc=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/localization/snap.manifest.json b/packages/examples/packages/localization/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "1j6zkURMjaXhrGzAZgKsk1CD4NCIkPiM9DkDlcwPEO0=",
+    "shasum": "miUOTcr3HaIm+vWPvfr1mIg7tJvgnhOKxh5XMUj1+7I=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/manage-state/snap.manifest.json b/packages/examples/packages/manage-state/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "CnU94yCbx/U2dMUA65F3zbYhlE3gACevVU0m6QABsKY=",
+    "shasum": "VlXLednI2Olvz71X4CqanMhTLJuzJuGK6W06idNhRQk=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/network-access/snap.manifest.json b/packages/examples/packages/network-access/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "scw0xXWz40VXRIgwF/GbGaQRT47ydnDC/SJzT+sRKPU=",
+    "shasum": "InSbJNcvPggkSzQkDHEZ+VuIuQC7UpyJH05d8fGnLzw=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/notifications/snap.manifest.json b/packages/examples/packages/notifications/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "I4pWz+sebUIYt8Tq2/wgcppAYrihS8mAS+Qq08/Txtg=",
+    "shasum": "6PWp6pREX1oDwWVO8teg8Zpa7UW34vdMtUSbGuz25wU=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/preferences/snap.manifest.json b/packages/examples/packages/preferences/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "ZS5vkAxL/NRIfymK1gnNl9B6ezbvUx/8tNlUVW18noA=",
+    "shasum": "UNEeF7Es5+tmJfxINloQxcnrn0znlKd0fWvnPDH3hH4=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/preinstalled/snap.manifest.json b/packages/examples/packages/preinstalled/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "lHCFjLZG7ocZFA8VZOCbzMwfgVR90oqR+YjSvStoiT0=",
+    "shasum": "E+3HjLH4YURxmrRtZT3FnhXYll0tl5qUSvw8udM6XM0=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/preinstalled/src/index.tsx b/packages/examples/packages/preinstalled/src/index.tsx
@@ -1,4 +1,8 @@
-import { MethodNotFoundError, UserInputEventType } from '@metamask/snaps-sdk';
+import {
+  getJsonError,
+  MethodNotFoundError,
+  UserInputEventType,
+} from '@metamask/snaps-sdk';
 import type {
   OnRpcRequestHandler,
   OnSettingsPageHandler,
@@ -15,10 +19,11 @@ type SnapState = {
 
 /**
  * Handle incoming JSON-RPC requests from the dapp, sent through the
- * `wallet_invokeSnap` method. This handler handles two methods:
+ * `wallet_invokeSnap` method. This handler handles the following methods:
  *
  * - `showDialog` - Opens a dialog.
  * - `getSettings`: Get the settings state from the snap state.
+ * - `trackError`: Tracks an error and sends it to Sentry.
  *
  * @param params - The request parameters.
  * @param params.request - The JSON-RPC request object.
@@ -47,6 +52,18 @@ export const onRpcRequest: OnRpcRequestHandler = async ({ request }) => {
         },
       });
 
+    case 'trackError': {
+      const error = new Error('This is a test error.');
+      error.name = 'TestError';
+
+      return await snap.request({
+        method: 'snap_trackError',
+        params: {
+          error: getJsonError(error),
+        },
+      });
+    }
+
     default:
       throw new MethodNotFoundError({ method: request.method });
   }
diff --git a/packages/examples/packages/protocol/snap.manifest.json b/packages/examples/packages/protocol/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "X7lSaqw58WTaT2P/Ofq57qObR3TQV06yihd1e701u3k=",
+    "shasum": "+IW+fJ+V6Vtwtxe9sV0Ipox+ouiJxmK4m8T2N99Mgfo=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/rollup-plugin/snap.manifest.json b/packages/examples/packages/rollup-plugin/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "6OOqdjZEf4xrOS3UOt8nkJUupgrJUb6iWLbwg1gOwZ8=",
+    "shasum": "7/afLZEvkMGoScchNYQDU09lxprGxiw4ONjsmW/tXx8=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/wasm/snap.manifest.json b/packages/examples/packages/wasm/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "PwRz4Geot00DmXDKEItFv266knJTA6drmHMTAIKuWqY=",
+    "shasum": "8YM0V0NUiX1UF8+g96L/5rGmr1HpAvEevt0iz+zuodg=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/examples/packages/webpack-plugin/snap.manifest.json b/packages/examples/packages/webpack-plugin/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "FtPoUR6SLkCXDUaAMiTbYNcaOR0asuy9r54IXFFbCg4=",
+    "shasum": "lAf6BB/S5/GfX3SNy9MBrTCnDQqpNttzmfYlTIsVWI8=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/snaps-rpc-methods/jest.config.js b/packages/snaps-rpc-methods/jest.config.js
@@ -10,10 +10,10 @@ module.exports = deepmerge(baseConfig, {
   ],
   coverageThreshold: {
     global: {
-      branches: 95.07,
-      functions: 98.68,
-      lines: 98.84,
-      statements: 98.53,
+      branches: 95.16,
+      functions: 98.71,
+      lines: 98.87,
+      statements: 98.56,
     },
   },
 });
diff --git a/packages/snaps-rpc-methods/src/permitted/handlers.ts b/packages/snaps-rpc-methods/src/permitted/handlers.ts
@@ -22,6 +22,7 @@ import { resolveInterfaceHandler } from './resolveInterface';
 import { scheduleBackgroundEventHandler } from './scheduleBackgroundEvent';
 import { sendWebSocketMessageHandler } from './sendWebSocketMessage';
 import { setStateHandler } from './setState';
+import { trackErrorHandler } from './trackError';
 import { trackEventHandler } from './trackEvent';
 import { updateInterfaceHandler } from './updateInterface';
 
@@ -48,6 +49,7 @@ export const methodHandlers = {
   snap_cancelBackgroundEvent: cancelBackgroundEventHandler,
   snap_getBackgroundEvents: getBackgroundEventsHandler,
   snap_setState: setStateHandler,
+  snap_trackError: trackErrorHandler,
   snap_trackEvent: trackEventHandler,
   snap_openWebSocket: openWebSocketHandler,
   snap_closeWebSocket: closeWebSocketHandler,
diff --git a/packages/snaps-rpc-methods/src/permitted/index.ts b/packages/snaps-rpc-methods/src/permitted/index.ts
@@ -18,6 +18,8 @@ import type { ResolveInterfaceMethodHooks } from './resolveInterface';
 import type { ScheduleBackgroundEventMethodHooks } from './scheduleBackgroundEvent';
 import type { SendWebSocketMessageMethodHooks } from './sendWebSocketMessage';
 import type { SetStateHooks } from './setState';
+import type { TrackErrorMethodHooks } from './trackError';
+import type { TrackEventMethodHooks } from './trackEvent';
 import type { UpdateInterfaceMethodHooks } from './updateInterface';
 
 export type PermittedRpcMethodHooks = ClearStateHooks &
@@ -40,7 +42,9 @@ export type PermittedRpcMethodHooks = ClearStateHooks &
   OpenWebSocketMethodHooks &
   CloseWebSocketMethodHooks &
   SendWebSocketMessageMethodHooks &
-  GetWebSocketsMethodHooks;
+  GetWebSocketsMethodHooks &
+  TrackEventMethodHooks &
+  TrackErrorMethodHooks;
 
 export * from './handlers';
 export * from './middleware';
diff --git a/packages/snaps-rpc-methods/src/permitted/trackError.test.ts b/packages/snaps-rpc-methods/src/permitted/trackError.test.ts
diff --git a/packages/snaps-rpc-methods/src/permitted/trackError.ts b/packages/snaps-rpc-methods/src/permitted/trackError.ts
diff --git a/packages/snaps-sdk/src/errors.test.ts b/packages/snaps-sdk/src/errors.test.ts
diff --git a/packages/snaps-sdk/src/errors.ts b/packages/snaps-sdk/src/errors.ts
diff --git a/packages/snaps-sdk/src/internals/errors.test.ts b/packages/snaps-sdk/src/internals/errors.test.ts
diff --git a/packages/snaps-sdk/src/internals/errors.ts b/packages/snaps-sdk/src/internals/errors.ts
diff --git a/packages/snaps-sdk/src/types/methods/index.ts b/packages/snaps-sdk/src/types/methods/index.ts
diff --git a/packages/snaps-sdk/src/types/methods/methods.ts b/packages/snaps-sdk/src/types/methods/methods.ts
diff --git a/packages/snaps-sdk/src/types/methods/track-error.ts b/packages/snaps-sdk/src/types/methods/track-error.ts
diff --git a/packages/snaps-utils/src/errors.test.ts b/packages/snaps-utils/src/errors.test.ts
diff --git a/packages/snaps-utils/src/errors.ts b/packages/snaps-utils/src/errors.ts
diff --git a/packages/test-snaps/src/features/snaps/preinstalled/Preinstalled.tsx b/packages/test-snaps/src/features/snaps/preinstalled/Preinstalled.tsx
