Add controller action

MetaMask · Jul 21, 2022 · a90587f · a90587f
1 parent eaa5c25
commit a90587f
Show file tree

Hide file tree

Showing 3 changed files with 59 additions and 3 deletions.
diff --git a/packages/controllers/jest.config.js b/packages/controllers/jest.config.js
@@ -9,9 +9,9 @@ module.exports = {
   coverageThreshold: {
     global: {
       branches: 72.31,
-      functions: 86.26,
-      lines: 85.2,
-      statements: 85.28,
+      functions: 86.32,
+      lines: 85.23,
+      statements: 85.31,
     },
   },
   globals: {

diff --git a/packages/controllers/src/snaps/SnapController.test.ts b/packages/controllers/src/snaps/SnapController.test.ts
@@ -96,6 +96,7 @@ const getSnapControllerMessenger = (
       'SnapController:add',
       'SnapController:get',
       'SnapController:handleRpcRequest',
+      'SnapController:handleTransactionInsightRequest',
       'SnapController:getSnapState',
       'SnapController:has',
       'SnapController:updateSnapState',
@@ -3363,6 +3364,47 @@ describe('SnapController', () => {
       });
     });
 
+    describe('SnapController:handleTransactionInsightRequest', () => {
+      it('handles a transaction insight request', async () => {
+        const messenger = getSnapControllerMessenger(undefined, false);
+        const fooSnapObject = getSnapObject({
+          initialPermissions: {},
+          permissionName: 'fooperm',
+          version: '0.0.1',
+          sourceCode: MOCK_SNAP_SOURCE_CODE,
+          id: 'npm:fooSnap',
+          manifest: getSnapManifest(),
+          enabled: true,
+          status: SnapStatus.running,
+        });
+
+        const snapController = getSnapController(
+          getSnapControllerOptions({
+            messenger,
+            state: {
+              snaps: {
+                'npm:fooSnap': fooSnapObject,
+              },
+            },
+          }),
+        );
+
+        const handleRequestSpy = jest
+          .spyOn(snapController, 'handleTransactionInsightRequest')
+          .mockResolvedValueOnce(true);
+
+        expect(
+          await messenger.call(
+            'SnapController:handleTransactionInsightRequest',
+            'npm:fooSnap',
+            'foo',
+            {},
+          ),
+        ).toStrictEqual(true);
+        expect(handleRequestSpy).toHaveBeenCalledTimes(1);
+      });
+    });
+
     describe('SnapController:getSnapState', () => {
       it(`gets the snap's state`, async () => {
         const messenger = getSnapControllerMessenger(undefined, false);

diff --git a/packages/controllers/src/snaps/SnapController.ts b/packages/controllers/src/snaps/SnapController.ts
@@ -269,6 +269,14 @@ export type HandleSnapRpcRequest = {
   handler: SnapController['handleRpcRequest'];
 };
 
+/**
+ * Handles sending an inbound transaction insight message to a snap and returns its result.
+ */
+export type HandleSnapTransactionInsightRequest = {
+  type: `${typeof controllerName}:handleTransactionInsightRequest`;
+  handler: SnapController['handleTransactionInsightRequest'];
+};
+
 /**
  * Gets the specified Snap's persisted state.
  */
@@ -315,6 +323,7 @@ export type SnapControllerActions =
   | GetSnap
   | GetSnapState
   | HandleSnapRpcRequest
+  | HandleSnapTransactionInsightRequest
   | HasSnap
   | UpdateBlockedSnaps
   | UpdateSnapState;
@@ -774,6 +783,11 @@ export class SnapController extends BaseController<
       (...args) => this.handleRpcRequest(...args),
     );
 
+    this.messagingSystem.registerActionHandler(
+      `${controllerName}:handleTransactionInsightRequest`,
+      (...args) => this.handleTransactionInsightRequest(...args),
+    );
+
     this.messagingSystem.registerActionHandler(
       `${controllerName}:has`,
       (...args) => this.has(...args),