Serialise error cause as well

Mrtenz · Mrtenz · commit fe5721ce11bc · 2025-06-24T16:57:08.000+02:00
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": "HfS8W51aqGb0BK1JDliL6ksC9mWUIH1GUORb4M4YYWM=",
+    "shasum": "ZeGOk81XzfozOV1K0AAOCycf35KFDewU1b7Ygx+UYq0=",
     "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": "bjHxGGXuopVEpD/hKK+P3fn4Ax/vlCEnNxNBu7qMnY4=",
+    "shasum": "XKnKqodXcZJA0hSvC6TNfZVhDzN6eZRHSctqpJazuF0=",
     "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": "GaiczDPNcZNNeZmTM1lD0Es16ol0Vc9dUnla9My0vMY=",
+    "shasum": "tTKHHOjlxd1H1xlL8/u06w5rtdwE+lAjy8huj0Xpmgc=",
     "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": "61htd1OxCgh7MrL7o8gU0/H+jSjFTdq6iYdYOt6O/lc=",
+    "shasum": "0mYu+HG0LF+zEXP0ofbO2XRnU9pEJKJ/OysJkUgXySk=",
     "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": "3DriGiLqSVIfeZ0Pmno4wIpddgP4FSW4YyMiTJ90nsU=",
+    "shasum": "jV7dwnFSo1LyRdbv0Fc2kVC/HUcQHKZCqZ+obYm/KwI=",
     "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": "coE2TjDqRVzcxwAQVMPyDAbqFg+7wyqxoqw73QwRUj4=",
+    "shasum": "5IyZ0i8xZ4OXBhTpF6XO6xVBSM7UtcBhguNiE5gpNEQ=",
     "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": "KSJ9SgPoU6o89qv3qwFZri1nv7ysxzGPgdBAPJTb8dU=",
+    "shasum": "XRvnPWZOPTeaNuNKbWdeSg89DanFVVxy1uXssjMTgBg=",
     "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": "ZCmChJFnAXnE/reNPQCY6XE8tCPzwnZiR96/8zbxXj8=",
+    "shasum": "6bOeXhVQofs25UbISkyigUCoRA10T7zaPP2ghzsQOIU=",
     "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": "CIThpcRTDoxbtSCxJX9zu/yk27gOdnESslvjQ+38OHw=",
+    "shasum": "i6t5+ahTZ1mHHpzwDxALp5ChS8rUoAU8vxO23TxuJoA=",
     "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": "r0k7CpEo3WCkhWrBlo12a1TOng+NPDwFnlCFaxLqA1w=",
+    "shasum": "R1nxGhPLmZf4xnkP5S5VfAGFMJt2gUSFupys6wy/1mc=",
     "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": "OhwhIt01d7K6C0xxURWShV35cQZN7ruR25MMzntIRQg=",
+    "shasum": "oRHKfsSlzhEOjSmkTzIR+D4oqNDrnFubmqgNTUg5HNM=",
     "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": "aMp60pJJHM9TN+2CysoRjREdZmAIP0YrNJEjk1YBAeA=",
+    "shasum": "4C5vzQlMDkBCc4TFatzgPQL4wpedASQr6D0bFWaYliM=",
     "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": "cOM8ZJe8trZHWqIcS3cpLHpeCSyzAwp0O4/FzOa4EBg=",
+    "shasum": "imanfMg8Sxu0lxXajFyoz2ZP0yiEC2PMlQ6XFE7qd+c=",
     "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": "zhytEGLjGozEwzs14OJManfGsrp+c57naE1UsMVmcEg=",
+    "shasum": "0FkGC2CLD9XcjEQPVzOSGIeELYNeScqCBCIZsC5Vuo0=",
     "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": "8CpEf7iVZRh7Lf3OWjuuHlP5UHvUckw7Z/tlhHxedTc=",
+    "shasum": "nWsLWABz+WKeumeIvRwVuQ5b85PaQtWNticwcprEegk=",
     "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": "ns6XW/tGsvyJkC4ZE1LLQSACTmA8VoblXxJHuzc2dxI=",
+    "shasum": "GGlNYy63xQB4PJESE8J1MKD3kx7E+IQAYTtGJTPNzKQ=",
     "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": "LZz10wnND4wF0cG3q+qux+PtSsSI5EzTms7KFfr5Xxg=",
+    "shasum": "/dZEkO3uJdDwChCX84v/2pI8vqmlpnHjLymVI+UysJI=",
     "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": "uVcApb2nDesejqTeixPxDsjZ+5uxAiC9a74eD1EhQi0=",
+    "shasum": "I08NYz0dUay2qHMl59yV3WxxhviFD5nEvUksl8jkolQ=",
     "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": "u+m8cv8KuZLOKQQIrxIWoTyxIB6GERUbrDkixdw4hAk=",
+    "shasum": "ASqoajn7XyEjPrCjZT4E3M4aSVTvpLcY90Sm63aCwNc=",
     "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": "z0u5KdZroSO+unOsboZCuKF5WjSUPWLePVKfjL0dUlM=",
+    "shasum": "ODMJEfnOONzwujZvZIqgTQ2HGn/TL0Ri8j5EgYyn6fw=",
     "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": "+HO9w8NWQNgPf7JKQ14fSocaYzMVA1ep6qyRu1nhOQ0=",
+    "shasum": "No4VRxU18XBt0a4y9pdsHhsMardJi5d4njYbBm1yW10=",
     "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": "gnBDDsEcMzymkzYqWR4cX7ck1nRv0p4RmRWPNTqsaJw=",
+    "shasum": "A5uZ1kbQyC0+xWfTz4rE1TMKexi6jX0nLs+W6eFh4rY=",
     "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": "4v5zZEVDr3TNAeojfskCm+S0eXnEWriOIWDook4rU18=",
+    "shasum": "4d6rgW2HNdm61ukhh2c/v0epD9wFtijzmvcd2qJhFKQ=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
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": "6wqhUI9DdvjwZbc6CJ/CciNttk7NiDf1px83Hvishvo=",
+    "shasum": "/tyL0UAj8C/m+V84Mg/MatbgUiHQ8ozguqF3usBcfcs=",
     "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": "3s1s+6SeR9cU74vA8YIq+sVmniB5+t2Pygc8+rK1uVM=",
+    "shasum": "ML8tZErn9MkD/0HYpiaHZVBOp7WPjxXQUXlGl9MGW7M=",
     "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": "KpgZMcMvsLnq/tD0uNvHeHet6ZbghknYyosk8shUyT0=",
+    "shasum": "Bpfpq94Ou/K12Rreg43ew/IPgdq+cQIORTnRTRYfhQ0=",
     "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": "pSEJrqnZG87efQOrr+8Q8SZLMgwS9pqSQuoW5hcLxuM=",
+    "shasum": "VyFZXzG2zFde44i9ZqI/ikv+QA3NvRjKgi39LDbSV/I=",
     "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,9 +10,9 @@ module.exports = deepmerge(baseConfig, {
   ],
   coverageThreshold: {
     global: {
-      branches: 95.13,
-      functions: 98.7,
-      lines: 98.86,
+      branches: 95.16,
+      functions: 98.71,
+      lines: 98.87,
       statements: 98.56,
     },
   },
diff --git a/packages/snaps-rpc-methods/src/permitted/trackError.test.ts b/packages/snaps-rpc-methods/src/permitted/trackError.test.ts
@@ -51,6 +51,7 @@ describe('snap_trackError', () => {
             message: 'This is a test error.',
             stack:
               'Error: This is a test error\n    at Object.<anonymous> (test.js:1:1)',
+            cause: null,
           },
         },
       });
@@ -61,12 +62,79 @@ describe('snap_trackError', () => {
         result: 'test-id',
       });
 
+      expect(trackError.mock.calls[0][0]).toBeInstanceOf(Error);
+      expect(trackError).toHaveBeenCalledWith(
+        expect.objectContaining({
+          name: 'TestError',
+          message: 'This is a test error.',
+          stack:
+            'Error: This is a test error\n    at Object.<anonymous> (test.js:1:1)',
+        }),
+      );
+    });
+
+    it('tracks an error with a name, message, stack, and cause', async () => {
+      const { implementation } = trackErrorHandler;
+
+      const trackError = jest.fn().mockReturnValue('test-id');
+      const getSnap = jest.fn().mockReturnValue({ preinstalled: true });
+      const hooks = { trackError, getSnap };
+
+      const engine = new JsonRpcEngine();
+
+      engine.push((request, response, next, end) => {
+        const result = implementation(
+          request as JsonRpcRequest<TrackErrorParams>,
+          response as PendingJsonRpcResponse<TrackErrorResult>,
+          next,
+          end,
+          hooks,
+        );
+
+        result?.catch(end);
+      });
+
+      const response = await engine.handle({
+        jsonrpc: '2.0',
+        id: 1,
+        method: 'snap_trackError',
+        params: {
+          error: {
+            name: 'TestError',
+            message: 'This is a test error.',
+            stack:
+              'Error: This is a test error\n    at Object.<anonymous> (test.js:1:1)',
+            cause: {
+              name: 'TestCauseError',
+              message: 'This is a test cause error.',
+              stack:
+                'TestCauseError: This is a test cause error.\n    at Object.<anonymous> (cause.js:1:1)',
+              cause: null,
+            },
+          },
+        },
+      });
+
+      expect(response).toStrictEqual({
+        jsonrpc: '2.0',
+        id: 1,
+        result: 'test-id',
+      });
+
+      expect(trackError.mock.calls[0][0]).toBeInstanceOf(Error);
+      expect(trackError.mock.calls[0][0].cause).toBeInstanceOf(Error);
       expect(trackError).toHaveBeenCalledWith(
         expect.objectContaining({
           name: 'TestError',
           message: 'This is a test error.',
           stack:
             'Error: This is a test error\n    at Object.<anonymous> (test.js:1:1)',
+          cause: expect.objectContaining({
+            name: 'TestCauseError',
+            message: 'This is a test cause error.',
+            stack:
+              'TestCauseError: This is a test cause error.\n    at Object.<anonymous> (cause.js:1:1)',
+          }),
         }),
       );
     });
@@ -101,6 +169,7 @@ describe('snap_trackError', () => {
             name: 'TestError',
             message: 'This is a test error.',
             stack: null,
+            cause: null,
           },
         },
       });
@@ -111,6 +180,7 @@ describe('snap_trackError', () => {
         result: 'test-id',
       });
 
+      expect(trackError.mock.calls[0][0]).toBeInstanceOf(Error);
       expect(trackError).toHaveBeenCalledWith(
         expect.objectContaining({
           name: 'TestError',
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.ts b/packages/snaps-sdk/src/internals/errors.ts
diff --git a/packages/snaps-sdk/src/types/methods/track-error.ts b/packages/snaps-sdk/src/types/methods/track-error.ts
