@metamask/profile-sync-controller 2.0.0 → 3.0.0

package/dist/controllers/user-storage/__fixtures__/mockMessenger.cjs

@@ -0,0 +1,171 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mockUserStorageMessenger = exports.createCustomUserStorageMessenger = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const _1 = require("./index.cjs");
+const typedMockFn = (_type) => jest.fn();
+/**
+ * creates a custom user storage messenger, in case tests need different permissions
+ * @param props - overrides
+ * @param props.overrideEvents - override events
+ * @returns base messenger, and messenger. You can pass this into the mocks below to mock messenger calls
+ */
+function createCustomUserStorageMessenger(props) {
+    const baseMessenger = new base_controller_1.ControllerMessenger();
+    const messenger = baseMessenger.getRestricted({
+        name: 'UserStorageController',
+        allowedActions: [
+            'KeyringController:getState',
+            'KeyringController:addNewAccount',
+            'SnapController:handleRequest',
+            'AuthenticationController:getBearerToken',
+            'AuthenticationController:getSessionProfile',
+            'AuthenticationController:isSignedIn',
+            'AuthenticationController:performSignOut',
+            'AuthenticationController:performSignIn',
+            'NotificationServicesController:disableNotificationServices',
+            'NotificationServicesController:selectIsNotificationServicesEnabled',
+            'AccountsController:listAccounts',
+            'AccountsController:updateAccountMetadata',
+            'NetworkController:getState',
+            'NetworkController:addNetwork',
+            'NetworkController:updateNetwork',
+            'NetworkController:removeNetwork',
+        ],
+        allowedEvents: props?.overrideEvents ?? [
+            'KeyringController:lock',
+            'KeyringController:unlock',
+            'AccountsController:accountAdded',
+            'AccountsController:accountRenamed',
+            'NetworkController:networkRemoved',
+        ],
+    });
+    return {
+        baseMessenger,
+        messenger,
+    };
+}
+exports.createCustomUserStorageMessenger = createCustomUserStorageMessenger;
+/**
+ * Jest Mock Utility to generate a mock User Storage Messenger
+ * @param overrideMessengers - override messengers if need to modify the underlying permissions
+ * @returns series of mocks to actions that can be called
+ */
+function mockUserStorageMessenger(overrideMessengers) {
+    const { baseMessenger, messenger } = overrideMessengers ?? createCustomUserStorageMessenger();
+    const mockSnapGetPublicKey = jest.fn().mockResolvedValue('MOCK_PUBLIC_KEY');
+    const mockSnapSignMessage = jest
+        .fn()
+        .mockResolvedValue(_1.MOCK_STORAGE_KEY_SIGNATURE);
+    const mockAuthGetBearerToken = typedMockFn('AuthenticationController:getBearerToken').mockResolvedValue('MOCK_BEARER_TOKEN');
+    const mockAuthGetSessionProfile = typedMockFn('AuthenticationController:getSessionProfile').mockResolvedValue({
+        identifierId: '',
+        profileId: 'MOCK_PROFILE_ID',
+    });
+    const mockAuthPerformSignIn = typedMockFn('AuthenticationController:performSignIn').mockResolvedValue('New Access Token');
+    const mockAuthIsSignedIn = typedMockFn('AuthenticationController:isSignedIn').mockReturnValue(true);
+    const mockAuthPerformSignOut = typedMockFn('AuthenticationController:performSignOut');
+    const mockNotificationServicesIsEnabled = typedMockFn('NotificationServicesController:selectIsNotificationServicesEnabled').mockReturnValue(true);
+    const mockNotificationServicesDisableNotifications = typedMockFn('NotificationServicesController:disableNotificationServices').mockResolvedValue();
+    const mockKeyringAddNewAccount = typedMockFn('KeyringController:addNewAccount');
+    // Untyped mock as there is a TS(2742) issue.
+    // This will return `InternalAccount[]`
+    const mockAccountsListAccounts = jest.fn();
+    const mockAccountsUpdateAccountMetadata = typedMockFn('AccountsController:updateAccountMetadata').mockResolvedValue(true);
+    const mockNetworkControllerGetState = typedMockFn('NetworkController:getState').mockReturnValue({
+        selectedNetworkClientId: '',
+        networksMetadata: {},
+        networkConfigurationsByChainId: {},
+    });
+    const mockNetworkControllerAddNetwork = typedMockFn('NetworkController:addNetwork');
+    const mockNetworkControllerRemoveNetwork = typedMockFn('NetworkController:removeNetwork');
+    const mockNetworkControllerUpdateNetwork = typedMockFn('NetworkController:updateNetwork');
+    jest.spyOn(messenger, 'call').mockImplementation((...args) => {
+        const typedArgs = args;
+        const [actionType] = typedArgs;
+        if (actionType === 'SnapController:handleRequest') {
+            const [, params] = typedArgs;
+            if (params.request.method === 'getPublicKey') {
+                return mockSnapGetPublicKey();
+            }
+            if (params.request.method === 'signMessage') {
+                return mockSnapSignMessage();
+            }
+            throw new Error(`MOCK_FAIL - unsupported SnapController:handleRequest call: ${params.request.method}`);
+        }
+        if (actionType === 'AuthenticationController:getBearerToken') {
+            return mockAuthGetBearerToken();
+        }
+        if (actionType === 'AuthenticationController:getSessionProfile') {
+            return mockAuthGetSessionProfile();
+        }
+        if (actionType === 'AuthenticationController:performSignIn') {
+            return mockAuthPerformSignIn();
+        }
+        if (actionType === 'AuthenticationController:isSignedIn') {
+            return mockAuthIsSignedIn();
+        }
+        if (actionType ===
+            'NotificationServicesController:selectIsNotificationServicesEnabled') {
+            return mockNotificationServicesIsEnabled();
+        }
+        if (actionType ===
+            'NotificationServicesController:disableNotificationServices') {
+            return mockNotificationServicesDisableNotifications();
+        }
+        if (actionType === 'AuthenticationController:performSignOut') {
+            return mockAuthPerformSignOut();
+        }
+        if (actionType === 'KeyringController:getState') {
+            return { isUnlocked: true };
+        }
+        if (actionType === 'KeyringController:addNewAccount') {
+            return mockKeyringAddNewAccount();
+        }
+        if (actionType === 'AccountsController:listAccounts') {
+            return mockAccountsListAccounts();
+        }
+        if (typedArgs[0] === 'AccountsController:updateAccountMetadata') {
+            const [, ...params] = typedArgs;
+            return mockAccountsUpdateAccountMetadata(...params);
+        }
+        if (actionType === 'NetworkController:getState') {
+            return mockNetworkControllerGetState();
+        }
+        if (actionType === 'NetworkController:addNetwork') {
+            const [, ...params] = typedArgs;
+            return mockNetworkControllerAddNetwork(...params);
+        }
+        if (actionType === 'NetworkController:removeNetwork') {
+            const [, ...params] = typedArgs;
+            return mockNetworkControllerRemoveNetwork(...params);
+        }
+        if (actionType === 'NetworkController:updateNetwork') {
+            const [, ...params] = typedArgs;
+            return mockNetworkControllerUpdateNetwork(...params);
+        }
+        throw new Error(`MOCK_FAIL - unsupported messenger call: ${actionType}`);
+    });
+    return {
+        baseMessenger,
+        messenger,
+        mockSnapGetPublicKey,
+        mockSnapSignMessage,
+        mockAuthGetBearerToken,
+        mockAuthGetSessionProfile,
+        mockAuthPerformSignIn,
+        mockAuthIsSignedIn,
+        mockNotificationServicesIsEnabled,
+        mockNotificationServicesDisableNotifications,
+        mockAuthPerformSignOut,
+        mockKeyringAddNewAccount,
+        mockAccountsUpdateAccountMetadata,
+        mockAccountsListAccounts,
+        mockNetworkControllerGetState,
+        mockNetworkControllerAddNetwork,
+        mockNetworkControllerRemoveNetwork,
+        mockNetworkControllerUpdateNetwork,
+    };
+}
+exports.mockUserStorageMessenger = mockUserStorageMessenger;
+//# sourceMappingURL=mockMessenger.cjs.map

package/dist/controllers/user-storage/__fixtures__/mockMessenger.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"mockMessenger.cjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/__fixtures__/mockMessenger.ts"],"names":[],"mappings":";;;AACA,+DAAgE;AAEhE,kCAA+C;AAmB/C,MAAM,WAAW,GAAG,CAQlB,KAAiB,EACjB,EAAE,CAAC,IAAI,CAAC,EAAE,EAAsC,CAAC;AAOnD;;;;;GAKG;AACH,SAAgB,gCAAgC,CAAC,KAEhD;IACC,MAAM,aAAa,GAAG,IAAI,qCAAmB,EAG1C,CAAC;IACJ,MAAM,SAAS,GAAG,aAAa,CAAC,aAAa,CAAC;QAC5C,IAAI,EAAE,uBAAuB;QAC7B,cAAc,EAAE;YACd,4BAA4B;YAC5B,iCAAiC;YACjC,8BAA8B;YAC9B,yCAAyC;YACzC,4CAA4C;YAC5C,qCAAqC;YACrC,yCAAyC;YACzC,wCAAwC;YACxC,4DAA4D;YAC5D,oEAAoE;YACpE,iCAAiC;YACjC,0CAA0C;YAC1C,4BAA4B;YAC5B,8BAA8B;YAC9B,iCAAiC;YACjC,iCAAiC;SAClC;QACD,aAAa,EAAE,KAAK,EAAE,cAAc,IAAI;YACtC,wBAAwB;YACxB,0BAA0B;YAC1B,iCAAiC;YACjC,mCAAmC;YACnC,kCAAkC;SACnC;KACF,CAAC,CAAC;IAEH,OAAO;QACL,aAAa;QACb,SAAS;KACV,CAAC;AACJ,CAAC;AAxCD,4EAwCC;AAOD;;;;GAIG;AACH,SAAgB,wBAAwB,CACtC,kBAAuC;IAEvC,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,GAChC,kBAAkB,IAAI,gCAAgC,EAAE,CAAC;IAE3D,MAAM,oBAAoB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;IAC5E,MAAM,mBAAmB,GAAG,IAAI;SAC7B,EAAE,EAAE;SACJ,iBAAiB,CAAC,6BAA0B,CAAC,CAAC;IAEjD,MAAM,sBAAsB,GAAG,WAAW,CACxC,yCAAyC,CAC1C,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC;IAEzC,MAAM,yBAAyB,GAAG,WAAW,CAC3C,4CAA4C,CAC7C,CAAC,iBAAiB,CAAC;QAClB,YAAY,EAAE,EAAE;QAChB,SAAS,EAAE,iBAAiB;KAC7B,CAAC,CAAC;IAEH,MAAM,qBAAqB,GAAG,WAAW,CACvC,wCAAwC,CACzC,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;IAExC,MAAM,kBAAkB,GAAG,WAAW,CACpC,qCAAqC,CACtC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAExB,MAAM,sBAAsB,GAAG,WAAW,CACxC,yCAAyC,CAC1C,CAAC;IAEF,MAAM,iCAAiC,GAAG,WAAW,CACnD,oEAAoE,CACrE,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAExB,MAAM,4CAA4C,GAAG,WAAW,CAC9D,4DAA4D,CAC7D,CAAC,iBAAiB,EAAE,CAAC;IAEtB,MAAM,wBAAwB,GAAG,WAAW,CAC1C,iCAAiC,CAClC,CAAC;IAEF,6CAA6C;IAC7C,uCAAuC;IACvC,MAAM,wBAAwB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAE3C,MAAM,iCAAiC,GAAG,WAAW,CACnD,0CAA0C,CAC3C,CAAC,iBAAiB,CAAC,IAAa,CAAC,CAAC;IAEnC,MAAM,6BAA6B,GAAG,WAAW,CAC/C,4BAA4B,CAC7B,CAAC,eAAe,CAAC;QAChB,uBAAuB,EAAE,EAAE;QAC3B,gBAAgB,EAAE,EAAE;QACpB,8BAA8B,EAAE,EAAE;KACnC,CAAC,CAAC;IAEH,MAAM,+BAA+B,GAAG,WAAW,CACjD,8BAA8B,CAC/B,CAAC;IAEF,MAAM,kCAAkC,GAAG,WAAW,CACpD,iCAAiC,CAClC,CAAC;IAEF,MAAM,kCAAkC,GAAG,WAAW,CACpD,iCAAiC,CAClC,CAAC;IAEF,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,kBAAkB,CAAC,CAAC,GAAG,IAAI,EAAE,EAAE;QAC3D,MAAM,SAAS,GAAG,IAA6B,CAAC;QAChD,MAAM,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC;QAE/B,IAAI,UAAU,KAAK,8BAA8B,EAAE;YACjD,MAAM,CAAC,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;YAC7B,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,cAAc,EAAE;gBAC5C,OAAO,oBAAoB,EAAE,CAAC;aAC/B;YAED,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,aAAa,EAAE;gBAC3C,OAAO,mBAAmB,EAAE,CAAC;aAC9B;YAED,MAAM,IAAI,KAAK,CACb,8DACE,MAAM,CAAC,OAAO,CAAC,MACjB,EAAE,CACH,CAAC;SACH;QAED,IAAI,UAAU,KAAK,yCAAyC,EAAE;YAC5D,OAAO,sBAAsB,EAAE,CAAC;SACjC;QAED,IAAI,UAAU,KAAK,4CAA4C,EAAE;YAC/D,OAAO,yBAAyB,EAAE,CAAC;SACpC;QAED,IAAI,UAAU,KAAK,wCAAwC,EAAE;YAC3D,OAAO,qBAAqB,EAAE,CAAC;SAChC;QAED,IAAI,UAAU,KAAK,qCAAqC,EAAE;YACxD,OAAO,kBAAkB,EAAE,CAAC;SAC7B;QAED,IACE,UAAU;YACV,oEAAoE,EACpE;YACA,OAAO,iCAAiC,EAAE,CAAC;SAC5C;QAED,IACE,UAAU;YACV,4DAA4D,EAC5D;YACA,OAAO,4CAA4C,EAAE,CAAC;SACvD;QAED,IAAI,UAAU,KAAK,yCAAyC,EAAE;YAC5D,OAAO,sBAAsB,EAAE,CAAC;SACjC;QAED,IAAI,UAAU,KAAK,4BAA4B,EAAE;YAC/C,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;SAC7B;QAED,IAAI,UAAU,KAAK,iCAAiC,EAAE;YACpD,OAAO,wBAAwB,EAAE,CAAC;SACnC;QAED,IAAI,UAAU,KAAK,iCAAiC,EAAE;YACpD,OAAO,wBAAwB,EAAE,CAAC;SACnC;QAED,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,0CAA0C,EAAE;YAC/D,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,GAAG,SAAS,CAAC;YAChC,OAAO,iCAAiC,CAAC,GAAG,MAAM,CAAC,CAAC;SACrD;QAED,IAAI,UAAU,KAAK,4BAA4B,EAAE;YAC/C,OAAO,6BAA6B,EAAE,CAAC;SACxC;QAED,IAAI,UAAU,KAAK,8BAA8B,EAAE;YACjD,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,GAAG,SAAS,CAAC;YAChC,OAAO,+BAA+B,CAAC,GAAG,MAAM,CAAC,CAAC;SACnD;QAED,IAAI,UAAU,KAAK,iCAAiC,EAAE;YACpD,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,GAAG,SAAS,CAAC;YAChC,OAAO,kCAAkC,CAAC,GAAG,MAAM,CAAC,CAAC;SACtD;QAED,IAAI,UAAU,KAAK,iCAAiC,EAAE;YACpD,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,GAAG,SAAS,CAAC;YAChC,OAAO,kCAAkC,CAAC,GAAG,MAAM,CAAC,CAAC;SACtD;QAED,MAAM,IAAI,KAAK,CACb,2CAA2C,UAAoB,EAAE,CAClE,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,aAAa;QACb,SAAS;QACT,oBAAoB;QACpB,mBAAmB;QACnB,sBAAsB;QACtB,yBAAyB;QACzB,qBAAqB;QACrB,kBAAkB;QAClB,iCAAiC;QACjC,4CAA4C;QAC5C,sBAAsB;QACtB,wBAAwB;QACxB,iCAAiC;QACjC,wBAAwB;QACxB,6BAA6B;QAC7B,+BAA+B;QAC/B,kCAAkC;QAClC,kCAAkC;KACnC,CAAC;AACJ,CAAC;AA9LD,4DA8LC","sourcesContent":["import type { NotNamespacedBy } from '@metamask/base-controller';\nimport { ControllerMessenger } from '@metamask/base-controller';\n\nimport { MOCK_STORAGE_KEY_SIGNATURE } from '.';\nimport type {\n  AllowedActions,\n  AllowedEvents,\n  UserStorageControllerMessenger,\n} from '..';\n\ntype GetHandler<ActionType extends AllowedActions['type']> = Extract<\n  AllowedActions,\n  { type: ActionType }\n>['handler'];\n\ntype CallParams = {\n  [K in AllowedActions['type']]: [\n    K,\n    ...Parameters<Extract<AllowedActions, { type: K }>['handler']>,\n  ];\n}[AllowedActions['type']];\n\nconst typedMockFn = <\n  ActionType extends AllowedActions['type'],\n  Handler = GetHandler<ActionType>,\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  Func extends (...args: any) => any = Handler extends (...args: any[]) => any\n    ? Handler\n    : never,\n>(\n  _type: ActionType,\n) => jest.fn<ReturnType<Func>, Parameters<Func>>();\n\ntype ExternalEvents = NotNamespacedBy<\n  'UserStorageController',\n  AllowedEvents['type']\n>;\n\n/**\n * creates a custom user storage messenger, in case tests need different permissions\n * @param props - overrides\n * @param props.overrideEvents - override events\n * @returns base messenger, and messenger. You can pass this into the mocks below to mock messenger calls\n */\nexport function createCustomUserStorageMessenger(props?: {\n  overrideEvents?: ExternalEvents[];\n}) {\n  const baseMessenger = new ControllerMessenger<\n    AllowedActions,\n    AllowedEvents\n  >();\n  const messenger = baseMessenger.getRestricted({\n    name: 'UserStorageController',\n    allowedActions: [\n      'KeyringController:getState',\n      'KeyringController:addNewAccount',\n      'SnapController:handleRequest',\n      'AuthenticationController:getBearerToken',\n      'AuthenticationController:getSessionProfile',\n      'AuthenticationController:isSignedIn',\n      'AuthenticationController:performSignOut',\n      'AuthenticationController:performSignIn',\n      'NotificationServicesController:disableNotificationServices',\n      'NotificationServicesController:selectIsNotificationServicesEnabled',\n      'AccountsController:listAccounts',\n      'AccountsController:updateAccountMetadata',\n      'NetworkController:getState',\n      'NetworkController:addNetwork',\n      'NetworkController:updateNetwork',\n      'NetworkController:removeNetwork',\n    ],\n    allowedEvents: props?.overrideEvents ?? [\n      'KeyringController:lock',\n      'KeyringController:unlock',\n      'AccountsController:accountAdded',\n      'AccountsController:accountRenamed',\n      'NetworkController:networkRemoved',\n    ],\n  });\n\n  return {\n    baseMessenger,\n    messenger,\n  };\n}\n\ntype OverrideMessengers = {\n  baseMessenger: ControllerMessenger<AllowedActions, AllowedEvents>;\n  messenger: UserStorageControllerMessenger;\n};\n\n/**\n * Jest Mock Utility to generate a mock User Storage Messenger\n * @param overrideMessengers - override messengers if need to modify the underlying permissions\n * @returns series of mocks to actions that can be called\n */\nexport function mockUserStorageMessenger(\n  overrideMessengers?: OverrideMessengers,\n) {\n  const { baseMessenger, messenger } =\n    overrideMessengers ?? createCustomUserStorageMessenger();\n\n  const mockSnapGetPublicKey = jest.fn().mockResolvedValue('MOCK_PUBLIC_KEY');\n  const mockSnapSignMessage = jest\n    .fn()\n    .mockResolvedValue(MOCK_STORAGE_KEY_SIGNATURE);\n\n  const mockAuthGetBearerToken = typedMockFn(\n    'AuthenticationController:getBearerToken',\n  ).mockResolvedValue('MOCK_BEARER_TOKEN');\n\n  const mockAuthGetSessionProfile = typedMockFn(\n    'AuthenticationController:getSessionProfile',\n  ).mockResolvedValue({\n    identifierId: '',\n    profileId: 'MOCK_PROFILE_ID',\n  });\n\n  const mockAuthPerformSignIn = typedMockFn(\n    'AuthenticationController:performSignIn',\n  ).mockResolvedValue('New Access Token');\n\n  const mockAuthIsSignedIn = typedMockFn(\n    'AuthenticationController:isSignedIn',\n  ).mockReturnValue(true);\n\n  const mockAuthPerformSignOut = typedMockFn(\n    'AuthenticationController:performSignOut',\n  );\n\n  const mockNotificationServicesIsEnabled = typedMockFn(\n    'NotificationServicesController:selectIsNotificationServicesEnabled',\n  ).mockReturnValue(true);\n\n  const mockNotificationServicesDisableNotifications = typedMockFn(\n    'NotificationServicesController:disableNotificationServices',\n  ).mockResolvedValue();\n\n  const mockKeyringAddNewAccount = typedMockFn(\n    'KeyringController:addNewAccount',\n  );\n\n  // Untyped mock as there is a TS(2742) issue.\n  // This will return `InternalAccount[]`\n  const mockAccountsListAccounts = jest.fn();\n\n  const mockAccountsUpdateAccountMetadata = typedMockFn(\n    'AccountsController:updateAccountMetadata',\n  ).mockResolvedValue(true as never);\n\n  const mockNetworkControllerGetState = typedMockFn(\n    'NetworkController:getState',\n  ).mockReturnValue({\n    selectedNetworkClientId: '',\n    networksMetadata: {},\n    networkConfigurationsByChainId: {},\n  });\n\n  const mockNetworkControllerAddNetwork = typedMockFn(\n    'NetworkController:addNetwork',\n  );\n\n  const mockNetworkControllerRemoveNetwork = typedMockFn(\n    'NetworkController:removeNetwork',\n  );\n\n  const mockNetworkControllerUpdateNetwork = typedMockFn(\n    'NetworkController:updateNetwork',\n  );\n\n  jest.spyOn(messenger, 'call').mockImplementation((...args) => {\n    const typedArgs = args as unknown as CallParams;\n    const [actionType] = typedArgs;\n\n    if (actionType === 'SnapController:handleRequest') {\n      const [, params] = typedArgs;\n      if (params.request.method === 'getPublicKey') {\n        return mockSnapGetPublicKey();\n      }\n\n      if (params.request.method === 'signMessage') {\n        return mockSnapSignMessage();\n      }\n\n      throw new Error(\n        `MOCK_FAIL - unsupported SnapController:handleRequest call: ${\n          params.request.method as string\n        }`,\n      );\n    }\n\n    if (actionType === 'AuthenticationController:getBearerToken') {\n      return mockAuthGetBearerToken();\n    }\n\n    if (actionType === 'AuthenticationController:getSessionProfile') {\n      return mockAuthGetSessionProfile();\n    }\n\n    if (actionType === 'AuthenticationController:performSignIn') {\n      return mockAuthPerformSignIn();\n    }\n\n    if (actionType === 'AuthenticationController:isSignedIn') {\n      return mockAuthIsSignedIn();\n    }\n\n    if (\n      actionType ===\n      'NotificationServicesController:selectIsNotificationServicesEnabled'\n    ) {\n      return mockNotificationServicesIsEnabled();\n    }\n\n    if (\n      actionType ===\n      'NotificationServicesController:disableNotificationServices'\n    ) {\n      return mockNotificationServicesDisableNotifications();\n    }\n\n    if (actionType === 'AuthenticationController:performSignOut') {\n      return mockAuthPerformSignOut();\n    }\n\n    if (actionType === 'KeyringController:getState') {\n      return { isUnlocked: true };\n    }\n\n    if (actionType === 'KeyringController:addNewAccount') {\n      return mockKeyringAddNewAccount();\n    }\n\n    if (actionType === 'AccountsController:listAccounts') {\n      return mockAccountsListAccounts();\n    }\n\n    if (typedArgs[0] === 'AccountsController:updateAccountMetadata') {\n      const [, ...params] = typedArgs;\n      return mockAccountsUpdateAccountMetadata(...params);\n    }\n\n    if (actionType === 'NetworkController:getState') {\n      return mockNetworkControllerGetState();\n    }\n\n    if (actionType === 'NetworkController:addNetwork') {\n      const [, ...params] = typedArgs;\n      return mockNetworkControllerAddNetwork(...params);\n    }\n\n    if (actionType === 'NetworkController:removeNetwork') {\n      const [, ...params] = typedArgs;\n      return mockNetworkControllerRemoveNetwork(...params);\n    }\n\n    if (actionType === 'NetworkController:updateNetwork') {\n      const [, ...params] = typedArgs;\n      return mockNetworkControllerUpdateNetwork(...params);\n    }\n\n    throw new Error(\n      `MOCK_FAIL - unsupported messenger call: ${actionType as string}`,\n    );\n  });\n\n  return {\n    baseMessenger,\n    messenger,\n    mockSnapGetPublicKey,\n    mockSnapSignMessage,\n    mockAuthGetBearerToken,\n    mockAuthGetSessionProfile,\n    mockAuthPerformSignIn,\n    mockAuthIsSignedIn,\n    mockNotificationServicesIsEnabled,\n    mockNotificationServicesDisableNotifications,\n    mockAuthPerformSignOut,\n    mockKeyringAddNewAccount,\n    mockAccountsUpdateAccountMetadata,\n    mockAccountsListAccounts,\n    mockNetworkControllerGetState,\n    mockNetworkControllerAddNetwork,\n    mockNetworkControllerRemoveNetwork,\n    mockNetworkControllerUpdateNetwork,\n  };\n}\n"]}

package/dist/controllers/user-storage/__fixtures__/mockMessenger.d.cts

@@ -0,0 +1,102 @@
+/// <reference types="jest" />
+import type { NotNamespacedBy } from "@metamask/base-controller";
+import { ControllerMessenger } from "@metamask/base-controller";
+import type { AllowedActions, AllowedEvents, UserStorageControllerMessenger } from "../index.cjs";
+type ExternalEvents = NotNamespacedBy<'UserStorageController', AllowedEvents['type']>;
+/**
+ * creates a custom user storage messenger, in case tests need different permissions
+ * @param props - overrides
+ * @param props.overrideEvents - override events
+ * @returns base messenger, and messenger. You can pass this into the mocks below to mock messenger calls
+ */
+export declare function createCustomUserStorageMessenger(props?: {
+    overrideEvents?: ExternalEvents[];
+}): {
+    baseMessenger: ControllerMessenger<AllowedActions, AllowedEvents>;
+    messenger: import("@metamask/base-controller").RestrictedControllerMessenger<"UserStorageController", import("@metamask/snaps-controllers").HandleSnapRequest | {
+        type: "AuthenticationController:isSignedIn";
+        handler: () => boolean;
+    } | {
+        type: "AuthenticationController:performSignIn";
+        handler: () => Promise<string>;
+    } | {
+        type: "AuthenticationController:performSignOut";
+        handler: () => void;
+    } | {
+        type: "AuthenticationController:getBearerToken";
+        handler: () => Promise<string>;
+    } | {
+        type: "AuthenticationController:getSessionProfile";
+        handler: () => Promise<{
+            identifierId: string;
+            profileId: string;
+        }>;
+    } | import("@metamask/keyring-controller").KeyringControllerGetStateAction | import("../index.cjs").NotificationServicesControllerDisableNotificationServices | import("../index.cjs").NotificationServicesControllerSelectIsNotificationServicesEnabled | import("@metamask/accounts-controller").AccountsControllerListAccountsAction | import("@metamask/accounts-controller").AccountsControllerUpdateAccountMetadataAction | import("@metamask/keyring-controller").KeyringControllerAddNewAccountAction | import("@metamask/network-controller").NetworkControllerGetStateAction | import("@metamask/network-controller").NetworkControllerAddNetworkAction | import("@metamask/network-controller").NetworkControllerRemoveNetworkAction | import("@metamask/network-controller").NetworkControllerUpdateNetworkAction, import("@metamask/keyring-controller").KeyringControllerLockEvent | import("@metamask/keyring-controller").KeyringControllerUnlockEvent | import("../index.cjs").UserStorageControllerStateChangeEvent | import("../index.cjs").UserStorageControllerAccountSyncingInProgress | import("../index.cjs").UserStorageControllerAccountSyncingComplete | import("@metamask/accounts-controller").AccountsControllerAccountAddedEvent | import("@metamask/accounts-controller").AccountsControllerAccountRenamedEvent | import("@metamask/network-controller").NetworkControllerNetworkRemovedEvent, "SnapController:handleRequest" | "KeyringController:getState" | "AuthenticationController:isSignedIn" | "AuthenticationController:performSignIn" | "AuthenticationController:performSignOut" | "AuthenticationController:getBearerToken" | "AuthenticationController:getSessionProfile" | "NotificationServicesController:disableNotificationServices" | "NotificationServicesController:selectIsNotificationServicesEnabled" | "AccountsController:listAccounts" | "AccountsController:updateAccountMetadata" | "KeyringController:addNewAccount" | "NetworkController:getState" | "NetworkController:addNetwork" | "NetworkController:removeNetwork" | "NetworkController:updateNetwork", "KeyringController:lock" | "KeyringController:unlock" | "AccountsController:accountAdded" | "AccountsController:accountRenamed" | "NetworkController:networkRemoved">;
+};
+type OverrideMessengers = {
+    baseMessenger: ControllerMessenger<AllowedActions, AllowedEvents>;
+    messenger: UserStorageControllerMessenger;
+};
+/**
+ * Jest Mock Utility to generate a mock User Storage Messenger
+ * @param overrideMessengers - override messengers if need to modify the underlying permissions
+ * @returns series of mocks to actions that can be called
+ */
+export declare function mockUserStorageMessenger(overrideMessengers?: OverrideMessengers): {
+    baseMessenger: ControllerMessenger<AllowedActions, AllowedEvents>;
+    messenger: import("@metamask/base-controller").RestrictedControllerMessenger<"UserStorageController", import("@metamask/snaps-controllers").HandleSnapRequest | {
+        type: "AuthenticationController:isSignedIn";
+        handler: () => boolean;
+    } | {
+        type: "AuthenticationController:performSignIn";
+        handler: () => Promise<string>;
+    } | {
+        type: "AuthenticationController:performSignOut";
+        handler: () => void;
+    } | {
+        type: "AuthenticationController:getBearerToken";
+        handler: () => Promise<string>;
+    } | {
+        type: "AuthenticationController:getSessionProfile";
+        handler: () => Promise<{
+            identifierId: string;
+            profileId: string;
+        }>;
+    } | import("@metamask/keyring-controller").KeyringControllerGetStateAction | import("../index.cjs").NotificationServicesControllerDisableNotificationServices | import("../index.cjs").NotificationServicesControllerSelectIsNotificationServicesEnabled | import("@metamask/accounts-controller").AccountsControllerListAccountsAction | import("@metamask/accounts-controller").AccountsControllerUpdateAccountMetadataAction | import("@metamask/keyring-controller").KeyringControllerAddNewAccountAction | import("@metamask/network-controller").NetworkControllerGetStateAction | import("@metamask/network-controller").NetworkControllerAddNetworkAction | import("@metamask/network-controller").NetworkControllerRemoveNetworkAction | import("@metamask/network-controller").NetworkControllerUpdateNetworkAction, import("@metamask/keyring-controller").KeyringControllerLockEvent | import("@metamask/keyring-controller").KeyringControllerUnlockEvent | import("../index.cjs").UserStorageControllerStateChangeEvent | import("../index.cjs").UserStorageControllerAccountSyncingInProgress | import("../index.cjs").UserStorageControllerAccountSyncingComplete | import("@metamask/accounts-controller").AccountsControllerAccountAddedEvent | import("@metamask/accounts-controller").AccountsControllerAccountRenamedEvent | import("@metamask/network-controller").NetworkControllerNetworkRemovedEvent, "SnapController:handleRequest" | "KeyringController:getState" | "AuthenticationController:isSignedIn" | "AuthenticationController:performSignIn" | "AuthenticationController:performSignOut" | "AuthenticationController:getBearerToken" | "AuthenticationController:getSessionProfile" | "NotificationServicesController:disableNotificationServices" | "NotificationServicesController:selectIsNotificationServicesEnabled" | "AccountsController:listAccounts" | "AccountsController:updateAccountMetadata" | "KeyringController:addNewAccount" | "NetworkController:getState" | "NetworkController:addNetwork" | "NetworkController:removeNetwork" | "NetworkController:updateNetwork", "KeyringController:lock" | "KeyringController:unlock" | "AccountsController:accountAdded" | "AccountsController:accountRenamed" | "NetworkController:networkRemoved">;
+    mockSnapGetPublicKey: jest.Mock<any, any>;
+    mockSnapSignMessage: jest.Mock<any, any>;
+    mockAuthGetBearerToken: jest.Mock<Promise<string>, []>;
+    mockAuthGetSessionProfile: jest.Mock<Promise<{
+        identifierId: string;
+        profileId: string;
+    }>, []>;
+    mockAuthPerformSignIn: jest.Mock<Promise<string>, []>;
+    mockAuthIsSignedIn: jest.Mock<boolean, []>;
+    mockNotificationServicesIsEnabled: jest.Mock<boolean, []>;
+    mockNotificationServicesDisableNotifications: jest.Mock<Promise<void>, []>;
+    mockAuthPerformSignOut: jest.Mock<void, []>;
+    mockKeyringAddNewAccount: jest.Mock<Promise<string>, [accountCount?: number | undefined]>;
+    mockAccountsUpdateAccountMetadata: jest.Mock<void, [accountId: string, metadata: Partial<{
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number | undefined;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        } | undefined;
+        lastSelected?: number | undefined;
+    }>]>;
+    mockAccountsListAccounts: jest.Mock<any, any>;
+    mockNetworkControllerGetState: jest.Mock<import("@metamask/network-controller").NetworkState, []>;
+    mockNetworkControllerAddNetwork: jest.Mock<import("@metamask/network-controller").NetworkConfiguration, [fields: import("@metamask/network-controller").AddNetworkFields]>;
+    mockNetworkControllerRemoveNetwork: jest.Mock<void, [chainId: `0x${string}`]>;
+    mockNetworkControllerUpdateNetwork: jest.Mock<Promise<import("@metamask/network-controller").NetworkConfiguration>, [`0x${string}`, import("@metamask/network-controller").UpdateNetworkFields, ({
+        replacementSelectedRpcEndpointIndex?: number | undefined;
+    } | undefined)?]>;
+};
+export {};
+//# sourceMappingURL=mockMessenger.d.cts.map

package/dist/controllers/user-storage/__fixtures__/mockMessenger.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mockMessenger.d.cts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/__fixtures__/mockMessenger.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,kCAAkC;AACjE,OAAO,EAAE,mBAAmB,EAAE,kCAAkC;AAGhE,OAAO,KAAK,EACV,cAAc,EACd,aAAa,EACb,8BAA8B,EAC/B,qBAAW;AAyBZ,KAAK,cAAc,GAAG,eAAe,CACnC,uBAAuB,EACvB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,gCAAgC,CAAC,KAAK,CAAC,EAAE;IACvD,cAAc,CAAC,EAAE,cAAc,EAAE,CAAC;CACnC;;;;;;;;;;;;;;;;;;;;;EAsCA;AAED,KAAK,kBAAkB,GAAG;IACxB,aAAa,EAAE,mBAAmB,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;IAClE,SAAS,EAAE,8BAA8B,CAAC;CAC3C,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,kBAAkB,CAAC,EAAE,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA6LxC"}

package/dist/controllers/user-storage/__fixtures__/mockMessenger.d.mts

@@ -0,0 +1,102 @@
+/// <reference types="jest" />
+import type { NotNamespacedBy } from "@metamask/base-controller";
+import { ControllerMessenger } from "@metamask/base-controller";
+import type { AllowedActions, AllowedEvents, UserStorageControllerMessenger } from "../index.mjs";
+type ExternalEvents = NotNamespacedBy<'UserStorageController', AllowedEvents['type']>;
+/**
+ * creates a custom user storage messenger, in case tests need different permissions
+ * @param props - overrides
+ * @param props.overrideEvents - override events
+ * @returns base messenger, and messenger. You can pass this into the mocks below to mock messenger calls
+ */
+export declare function createCustomUserStorageMessenger(props?: {
+    overrideEvents?: ExternalEvents[];
+}): {
+    baseMessenger: ControllerMessenger<AllowedActions, AllowedEvents>;
+    messenger: import("@metamask/base-controller").RestrictedControllerMessenger<"UserStorageController", import("@metamask/snaps-controllers").HandleSnapRequest | {
+        type: "AuthenticationController:isSignedIn";
+        handler: () => boolean;
+    } | {
+        type: "AuthenticationController:performSignIn";
+        handler: () => Promise<string>;
+    } | {
+        type: "AuthenticationController:performSignOut";
+        handler: () => void;
+    } | {
+        type: "AuthenticationController:getBearerToken";
+        handler: () => Promise<string>;
+    } | {
+        type: "AuthenticationController:getSessionProfile";
+        handler: () => Promise<{
+            identifierId: string;
+            profileId: string;
+        }>;
+    } | import("@metamask/keyring-controller").KeyringControllerGetStateAction | import("../index.mjs").NotificationServicesControllerDisableNotificationServices | import("../index.mjs").NotificationServicesControllerSelectIsNotificationServicesEnabled | import("@metamask/accounts-controller").AccountsControllerListAccountsAction | import("@metamask/accounts-controller").AccountsControllerUpdateAccountMetadataAction | import("@metamask/keyring-controller").KeyringControllerAddNewAccountAction | import("@metamask/network-controller").NetworkControllerGetStateAction | import("@metamask/network-controller").NetworkControllerAddNetworkAction | import("@metamask/network-controller").NetworkControllerRemoveNetworkAction | import("@metamask/network-controller").NetworkControllerUpdateNetworkAction, import("@metamask/keyring-controller").KeyringControllerLockEvent | import("@metamask/keyring-controller").KeyringControllerUnlockEvent | import("../index.mjs").UserStorageControllerStateChangeEvent | import("../index.mjs").UserStorageControllerAccountSyncingInProgress | import("../index.mjs").UserStorageControllerAccountSyncingComplete | import("@metamask/accounts-controller").AccountsControllerAccountAddedEvent | import("@metamask/accounts-controller").AccountsControllerAccountRenamedEvent | import("@metamask/network-controller").NetworkControllerNetworkRemovedEvent, "SnapController:handleRequest" | "KeyringController:getState" | "AuthenticationController:isSignedIn" | "AuthenticationController:performSignIn" | "AuthenticationController:performSignOut" | "AuthenticationController:getBearerToken" | "AuthenticationController:getSessionProfile" | "NotificationServicesController:disableNotificationServices" | "NotificationServicesController:selectIsNotificationServicesEnabled" | "AccountsController:listAccounts" | "AccountsController:updateAccountMetadata" | "KeyringController:addNewAccount" | "NetworkController:getState" | "NetworkController:addNetwork" | "NetworkController:removeNetwork" | "NetworkController:updateNetwork", "KeyringController:lock" | "KeyringController:unlock" | "AccountsController:accountAdded" | "AccountsController:accountRenamed" | "NetworkController:networkRemoved">;
+};
+type OverrideMessengers = {
+    baseMessenger: ControllerMessenger<AllowedActions, AllowedEvents>;
+    messenger: UserStorageControllerMessenger;
+};
+/**
+ * Jest Mock Utility to generate a mock User Storage Messenger
+ * @param overrideMessengers - override messengers if need to modify the underlying permissions
+ * @returns series of mocks to actions that can be called
+ */
+export declare function mockUserStorageMessenger(overrideMessengers?: OverrideMessengers): {
+    baseMessenger: ControllerMessenger<AllowedActions, AllowedEvents>;
+    messenger: import("@metamask/base-controller").RestrictedControllerMessenger<"UserStorageController", import("@metamask/snaps-controllers").HandleSnapRequest | {
+        type: "AuthenticationController:isSignedIn";
+        handler: () => boolean;
+    } | {
+        type: "AuthenticationController:performSignIn";
+        handler: () => Promise<string>;
+    } | {
+        type: "AuthenticationController:performSignOut";
+        handler: () => void;
+    } | {
+        type: "AuthenticationController:getBearerToken";
+        handler: () => Promise<string>;
+    } | {
+        type: "AuthenticationController:getSessionProfile";
+        handler: () => Promise<{
+            identifierId: string;
+            profileId: string;
+        }>;
+    } | import("@metamask/keyring-controller").KeyringControllerGetStateAction | import("../index.mjs").NotificationServicesControllerDisableNotificationServices | import("../index.mjs").NotificationServicesControllerSelectIsNotificationServicesEnabled | import("@metamask/accounts-controller").AccountsControllerListAccountsAction | import("@metamask/accounts-controller").AccountsControllerUpdateAccountMetadataAction | import("@metamask/keyring-controller").KeyringControllerAddNewAccountAction | import("@metamask/network-controller").NetworkControllerGetStateAction | import("@metamask/network-controller").NetworkControllerAddNetworkAction | import("@metamask/network-controller").NetworkControllerRemoveNetworkAction | import("@metamask/network-controller").NetworkControllerUpdateNetworkAction, import("@metamask/keyring-controller").KeyringControllerLockEvent | import("@metamask/keyring-controller").KeyringControllerUnlockEvent | import("../index.mjs").UserStorageControllerStateChangeEvent | import("../index.mjs").UserStorageControllerAccountSyncingInProgress | import("../index.mjs").UserStorageControllerAccountSyncingComplete | import("@metamask/accounts-controller").AccountsControllerAccountAddedEvent | import("@metamask/accounts-controller").AccountsControllerAccountRenamedEvent | import("@metamask/network-controller").NetworkControllerNetworkRemovedEvent, "SnapController:handleRequest" | "KeyringController:getState" | "AuthenticationController:isSignedIn" | "AuthenticationController:performSignIn" | "AuthenticationController:performSignOut" | "AuthenticationController:getBearerToken" | "AuthenticationController:getSessionProfile" | "NotificationServicesController:disableNotificationServices" | "NotificationServicesController:selectIsNotificationServicesEnabled" | "AccountsController:listAccounts" | "AccountsController:updateAccountMetadata" | "KeyringController:addNewAccount" | "NetworkController:getState" | "NetworkController:addNetwork" | "NetworkController:removeNetwork" | "NetworkController:updateNetwork", "KeyringController:lock" | "KeyringController:unlock" | "AccountsController:accountAdded" | "AccountsController:accountRenamed" | "NetworkController:networkRemoved">;
+    mockSnapGetPublicKey: jest.Mock<any, any>;
+    mockSnapSignMessage: jest.Mock<any, any>;
+    mockAuthGetBearerToken: jest.Mock<Promise<string>, []>;
+    mockAuthGetSessionProfile: jest.Mock<Promise<{
+        identifierId: string;
+        profileId: string;
+    }>, []>;
+    mockAuthPerformSignIn: jest.Mock<Promise<string>, []>;
+    mockAuthIsSignedIn: jest.Mock<boolean, []>;
+    mockNotificationServicesIsEnabled: jest.Mock<boolean, []>;
+    mockNotificationServicesDisableNotifications: jest.Mock<Promise<void>, []>;
+    mockAuthPerformSignOut: jest.Mock<void, []>;
+    mockKeyringAddNewAccount: jest.Mock<Promise<string>, [accountCount?: number | undefined]>;
+    mockAccountsUpdateAccountMetadata: jest.Mock<void, [accountId: string, metadata: Partial<{
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number | undefined;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        } | undefined;
+        lastSelected?: number | undefined;
+    }>]>;
+    mockAccountsListAccounts: jest.Mock<any, any>;
+    mockNetworkControllerGetState: jest.Mock<import("@metamask/network-controller").NetworkState, []>;
+    mockNetworkControllerAddNetwork: jest.Mock<import("@metamask/network-controller").NetworkConfiguration, [fields: import("@metamask/network-controller").AddNetworkFields]>;
+    mockNetworkControllerRemoveNetwork: jest.Mock<void, [chainId: `0x${string}`]>;
+    mockNetworkControllerUpdateNetwork: jest.Mock<Promise<import("@metamask/network-controller").NetworkConfiguration>, [`0x${string}`, import("@metamask/network-controller").UpdateNetworkFields, ({
+        replacementSelectedRpcEndpointIndex?: number | undefined;
+    } | undefined)?]>;
+};
+export {};
+//# sourceMappingURL=mockMessenger.d.mts.map

package/dist/controllers/user-storage/__fixtures__/mockMessenger.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mockMessenger.d.mts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/__fixtures__/mockMessenger.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,kCAAkC;AACjE,OAAO,EAAE,mBAAmB,EAAE,kCAAkC;AAGhE,OAAO,KAAK,EACV,cAAc,EACd,aAAa,EACb,8BAA8B,EAC/B,qBAAW;AAyBZ,KAAK,cAAc,GAAG,eAAe,CACnC,uBAAuB,EACvB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,gCAAgC,CAAC,KAAK,CAAC,EAAE;IACvD,cAAc,CAAC,EAAE,cAAc,EAAE,CAAC;CACnC;;;;;;;;;;;;;;;;;;;;;EAsCA;AAED,KAAK,kBAAkB,GAAG;IACxB,aAAa,EAAE,mBAAmB,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;IAClE,SAAS,EAAE,8BAA8B,CAAC;CAC3C,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,kBAAkB,CAAC,EAAE,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA6LxC"}

package/dist/controllers/user-storage/__fixtures__/mockMessenger.mjs

@@ -0,0 +1,166 @@
+import { ControllerMessenger } from "@metamask/base-controller";
+import { MOCK_STORAGE_KEY_SIGNATURE } from "./index.mjs";
+const typedMockFn = (_type) => jest.fn();
+/**
+ * creates a custom user storage messenger, in case tests need different permissions
+ * @param props - overrides
+ * @param props.overrideEvents - override events
+ * @returns base messenger, and messenger. You can pass this into the mocks below to mock messenger calls
+ */
+export function createCustomUserStorageMessenger(props) {
+    const baseMessenger = new ControllerMessenger();
+    const messenger = baseMessenger.getRestricted({
+        name: 'UserStorageController',
+        allowedActions: [
+            'KeyringController:getState',
+            'KeyringController:addNewAccount',
+            'SnapController:handleRequest',
+            'AuthenticationController:getBearerToken',
+            'AuthenticationController:getSessionProfile',
+            'AuthenticationController:isSignedIn',
+            'AuthenticationController:performSignOut',
+            'AuthenticationController:performSignIn',
+            'NotificationServicesController:disableNotificationServices',
+            'NotificationServicesController:selectIsNotificationServicesEnabled',
+            'AccountsController:listAccounts',
+            'AccountsController:updateAccountMetadata',
+            'NetworkController:getState',
+            'NetworkController:addNetwork',
+            'NetworkController:updateNetwork',
+            'NetworkController:removeNetwork',
+        ],
+        allowedEvents: props?.overrideEvents ?? [
+            'KeyringController:lock',
+            'KeyringController:unlock',
+            'AccountsController:accountAdded',
+            'AccountsController:accountRenamed',
+            'NetworkController:networkRemoved',
+        ],
+    });
+    return {
+        baseMessenger,
+        messenger,
+    };
+}
+/**
+ * Jest Mock Utility to generate a mock User Storage Messenger
+ * @param overrideMessengers - override messengers if need to modify the underlying permissions
+ * @returns series of mocks to actions that can be called
+ */
+export function mockUserStorageMessenger(overrideMessengers) {
+    const { baseMessenger, messenger } = overrideMessengers ?? createCustomUserStorageMessenger();
+    const mockSnapGetPublicKey = jest.fn().mockResolvedValue('MOCK_PUBLIC_KEY');
+    const mockSnapSignMessage = jest
+        .fn()
+        .mockResolvedValue(MOCK_STORAGE_KEY_SIGNATURE);
+    const mockAuthGetBearerToken = typedMockFn('AuthenticationController:getBearerToken').mockResolvedValue('MOCK_BEARER_TOKEN');
+    const mockAuthGetSessionProfile = typedMockFn('AuthenticationController:getSessionProfile').mockResolvedValue({
+        identifierId: '',
+        profileId: 'MOCK_PROFILE_ID',
+    });
+    const mockAuthPerformSignIn = typedMockFn('AuthenticationController:performSignIn').mockResolvedValue('New Access Token');
+    const mockAuthIsSignedIn = typedMockFn('AuthenticationController:isSignedIn').mockReturnValue(true);
+    const mockAuthPerformSignOut = typedMockFn('AuthenticationController:performSignOut');
+    const mockNotificationServicesIsEnabled = typedMockFn('NotificationServicesController:selectIsNotificationServicesEnabled').mockReturnValue(true);
+    const mockNotificationServicesDisableNotifications = typedMockFn('NotificationServicesController:disableNotificationServices').mockResolvedValue();
+    const mockKeyringAddNewAccount = typedMockFn('KeyringController:addNewAccount');
+    // Untyped mock as there is a TS(2742) issue.
+    // This will return `InternalAccount[]`
+    const mockAccountsListAccounts = jest.fn();
+    const mockAccountsUpdateAccountMetadata = typedMockFn('AccountsController:updateAccountMetadata').mockResolvedValue(true);
+    const mockNetworkControllerGetState = typedMockFn('NetworkController:getState').mockReturnValue({
+        selectedNetworkClientId: '',
+        networksMetadata: {},
+        networkConfigurationsByChainId: {},
+    });
+    const mockNetworkControllerAddNetwork = typedMockFn('NetworkController:addNetwork');
+    const mockNetworkControllerRemoveNetwork = typedMockFn('NetworkController:removeNetwork');
+    const mockNetworkControllerUpdateNetwork = typedMockFn('NetworkController:updateNetwork');
+    jest.spyOn(messenger, 'call').mockImplementation((...args) => {
+        const typedArgs = args;
+        const [actionType] = typedArgs;
+        if (actionType === 'SnapController:handleRequest') {
+            const [, params] = typedArgs;
+            if (params.request.method === 'getPublicKey') {
+                return mockSnapGetPublicKey();
+            }
+            if (params.request.method === 'signMessage') {
+                return mockSnapSignMessage();
+            }
+            throw new Error(`MOCK_FAIL - unsupported SnapController:handleRequest call: ${params.request.method}`);
+        }
+        if (actionType === 'AuthenticationController:getBearerToken') {
+            return mockAuthGetBearerToken();
+        }
+        if (actionType === 'AuthenticationController:getSessionProfile') {
+            return mockAuthGetSessionProfile();
+        }
+        if (actionType === 'AuthenticationController:performSignIn') {
+            return mockAuthPerformSignIn();
+        }
+        if (actionType === 'AuthenticationController:isSignedIn') {
+            return mockAuthIsSignedIn();
+        }
+        if (actionType ===
+            'NotificationServicesController:selectIsNotificationServicesEnabled') {
+            return mockNotificationServicesIsEnabled();
+        }
+        if (actionType ===
+            'NotificationServicesController:disableNotificationServices') {
+            return mockNotificationServicesDisableNotifications();
+        }
+        if (actionType === 'AuthenticationController:performSignOut') {
+            return mockAuthPerformSignOut();
+        }
+        if (actionType === 'KeyringController:getState') {
+            return { isUnlocked: true };
+        }
+        if (actionType === 'KeyringController:addNewAccount') {
+            return mockKeyringAddNewAccount();
+        }
+        if (actionType === 'AccountsController:listAccounts') {
+            return mockAccountsListAccounts();
+        }
+        if (typedArgs[0] === 'AccountsController:updateAccountMetadata') {
+            const [, ...params] = typedArgs;
+            return mockAccountsUpdateAccountMetadata(...params);
+        }
+        if (actionType === 'NetworkController:getState') {
+            return mockNetworkControllerGetState();
+        }
+        if (actionType === 'NetworkController:addNetwork') {
+            const [, ...params] = typedArgs;
+            return mockNetworkControllerAddNetwork(...params);
+        }
+        if (actionType === 'NetworkController:removeNetwork') {
+            const [, ...params] = typedArgs;
+            return mockNetworkControllerRemoveNetwork(...params);
+        }
+        if (actionType === 'NetworkController:updateNetwork') {
+            const [, ...params] = typedArgs;
+            return mockNetworkControllerUpdateNetwork(...params);
+        }
+        throw new Error(`MOCK_FAIL - unsupported messenger call: ${actionType}`);
+    });
+    return {
+        baseMessenger,
+        messenger,
+        mockSnapGetPublicKey,
+        mockSnapSignMessage,
+        mockAuthGetBearerToken,
+        mockAuthGetSessionProfile,
+        mockAuthPerformSignIn,
+        mockAuthIsSignedIn,
+        mockNotificationServicesIsEnabled,
+        mockNotificationServicesDisableNotifications,
+        mockAuthPerformSignOut,
+        mockKeyringAddNewAccount,
+        mockAccountsUpdateAccountMetadata,
+        mockAccountsListAccounts,
+        mockNetworkControllerGetState,
+        mockNetworkControllerAddNetwork,
+        mockNetworkControllerRemoveNetwork,
+        mockNetworkControllerUpdateNetwork,
+    };
+}
+//# sourceMappingURL=mockMessenger.mjs.map

package/dist/controllers/user-storage/__fixtures__/mockMessenger.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"mockMessenger.mjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/__fixtures__/mockMessenger.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,kCAAkC;AAEhE,OAAO,EAAE,0BAA0B,EAAE,oBAAU;AAmB/C,MAAM,WAAW,GAAG,CAQlB,KAAiB,EACjB,EAAE,CAAC,IAAI,CAAC,EAAE,EAAsC,CAAC;AAOnD;;;;;GAKG;AACH,MAAM,UAAU,gCAAgC,CAAC,KAEhD;IACC,MAAM,aAAa,GAAG,IAAI,mBAAmB,EAG1C,CAAC;IACJ,MAAM,SAAS,GAAG,aAAa,CAAC,aAAa,CAAC;QAC5C,IAAI,EAAE,uBAAuB;QAC7B,cAAc,EAAE;YACd,4BAA4B;YAC5B,iCAAiC;YACjC,8BAA8B;YAC9B,yCAAyC;YACzC,4CAA4C;YAC5C,qCAAqC;YACrC,yCAAyC;YACzC,wCAAwC;YACxC,4DAA4D;YAC5D,oEAAoE;YACpE,iCAAiC;YACjC,0CAA0C;YAC1C,4BAA4B;YAC5B,8BAA8B;YAC9B,iCAAiC;YACjC,iCAAiC;SAClC;QACD,aAAa,EAAE,KAAK,EAAE,cAAc,IAAI;YACtC,wBAAwB;YACxB,0BAA0B;YAC1B,iCAAiC;YACjC,mCAAmC;YACnC,kCAAkC;SACnC;KACF,CAAC,CAAC;IAEH,OAAO;QACL,aAAa;QACb,SAAS;KACV,CAAC;AACJ,CAAC;AAOD;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CACtC,kBAAuC;IAEvC,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,GAChC,kBAAkB,IAAI,gCAAgC,EAAE,CAAC;IAE3D,MAAM,oBAAoB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;IAC5E,MAAM,mBAAmB,GAAG,IAAI;SAC7B,EAAE,EAAE;SACJ,iBAAiB,CAAC,0BAA0B,CAAC,CAAC;IAEjD,MAAM,sBAAsB,GAAG,WAAW,CACxC,yCAAyC,CAC1C,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC;IAEzC,MAAM,yBAAyB,GAAG,WAAW,CAC3C,4CAA4C,CAC7C,CAAC,iBAAiB,CAAC;QAClB,YAAY,EAAE,EAAE;QAChB,SAAS,EAAE,iBAAiB;KAC7B,CAAC,CAAC;IAEH,MAAM,qBAAqB,GAAG,WAAW,CACvC,wCAAwC,CACzC,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;IAExC,MAAM,kBAAkB,GAAG,WAAW,CACpC,qCAAqC,CACtC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAExB,MAAM,sBAAsB,GAAG,WAAW,CACxC,yCAAyC,CAC1C,CAAC;IAEF,MAAM,iCAAiC,GAAG,WAAW,CACnD,oEAAoE,CACrE,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAExB,MAAM,4CAA4C,GAAG,WAAW,CAC9D,4DAA4D,CAC7D,CAAC,iBAAiB,EAAE,CAAC;IAEtB,MAAM,wBAAwB,GAAG,WAAW,CAC1C,iCAAiC,CAClC,CAAC;IAEF,6CAA6C;IAC7C,uCAAuC;IACvC,MAAM,wBAAwB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAE3C,MAAM,iCAAiC,GAAG,WAAW,CACnD,0CAA0C,CAC3C,CAAC,iBAAiB,CAAC,IAAa,CAAC,CAAC;IAEnC,MAAM,6BAA6B,GAAG,WAAW,CAC/C,4BAA4B,CAC7B,CAAC,eAAe,CAAC;QAChB,uBAAuB,EAAE,EAAE;QAC3B,gBAAgB,EAAE,EAAE;QACpB,8BAA8B,EAAE,EAAE;KACnC,CAAC,CAAC;IAEH,MAAM,+BAA+B,GAAG,WAAW,CACjD,8BAA8B,CAC/B,CAAC;IAEF,MAAM,kCAAkC,GAAG,WAAW,CACpD,iCAAiC,CAClC,CAAC;IAEF,MAAM,kCAAkC,GAAG,WAAW,CACpD,iCAAiC,CAClC,CAAC;IAEF,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,kBAAkB,CAAC,CAAC,GAAG,IAAI,EAAE,EAAE;QAC3D,MAAM,SAAS,GAAG,IAA6B,CAAC;QAChD,MAAM,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC;QAE/B,IAAI,UAAU,KAAK,8BAA8B,EAAE;YACjD,MAAM,CAAC,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;YAC7B,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,cAAc,EAAE;gBAC5C,OAAO,oBAAoB,EAAE,CAAC;aAC/B;YAED,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,aAAa,EAAE;gBAC3C,OAAO,mBAAmB,EAAE,CAAC;aAC9B;YAED,MAAM,IAAI,KAAK,CACb,8DACE,MAAM,CAAC,OAAO,CAAC,MACjB,EAAE,CACH,CAAC;SACH;QAED,IAAI,UAAU,KAAK,yCAAyC,EAAE;YAC5D,OAAO,sBAAsB,EAAE,CAAC;SACjC;QAED,IAAI,UAAU,KAAK,4CAA4C,EAAE;YAC/D,OAAO,yBAAyB,EAAE,CAAC;SACpC;QAED,IAAI,UAAU,KAAK,wCAAwC,EAAE;YAC3D,OAAO,qBAAqB,EAAE,CAAC;SAChC;QAED,IAAI,UAAU,KAAK,qCAAqC,EAAE;YACxD,OAAO,kBAAkB,EAAE,CAAC;SAC7B;QAED,IACE,UAAU;YACV,oEAAoE,EACpE;YACA,OAAO,iCAAiC,EAAE,CAAC;SAC5C;QAED,IACE,UAAU;YACV,4DAA4D,EAC5D;YACA,OAAO,4CAA4C,EAAE,CAAC;SACvD;QAED,IAAI,UAAU,KAAK,yCAAyC,EAAE;YAC5D,OAAO,sBAAsB,EAAE,CAAC;SACjC;QAED,IAAI,UAAU,KAAK,4BAA4B,EAAE;YAC/C,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;SAC7B;QAED,IAAI,UAAU,KAAK,iCAAiC,EAAE;YACpD,OAAO,wBAAwB,EAAE,CAAC;SACnC;QAED,IAAI,UAAU,KAAK,iCAAiC,EAAE;YACpD,OAAO,wBAAwB,EAAE,CAAC;SACnC;QAED,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,0CAA0C,EAAE;YAC/D,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,GAAG,SAAS,CAAC;YAChC,OAAO,iCAAiC,CAAC,GAAG,MAAM,CAAC,CAAC;SACrD;QAED,IAAI,UAAU,KAAK,4BAA4B,EAAE;YAC/C,OAAO,6BAA6B,EAAE,CAAC;SACxC;QAED,IAAI,UAAU,KAAK,8BAA8B,EAAE;YACjD,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,GAAG,SAAS,CAAC;YAChC,OAAO,+BAA+B,CAAC,GAAG,MAAM,CAAC,CAAC;SACnD;QAED,IAAI,UAAU,KAAK,iCAAiC,EAAE;YACpD,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,GAAG,SAAS,CAAC;YAChC,OAAO,kCAAkC,CAAC,GAAG,MAAM,CAAC,CAAC;SACtD;QAED,IAAI,UAAU,KAAK,iCAAiC,EAAE;YACpD,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,GAAG,SAAS,CAAC;YAChC,OAAO,kCAAkC,CAAC,GAAG,MAAM,CAAC,CAAC;SACtD;QAED,MAAM,IAAI,KAAK,CACb,2CAA2C,UAAoB,EAAE,CAClE,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,aAAa;QACb,SAAS;QACT,oBAAoB;QACpB,mBAAmB;QACnB,sBAAsB;QACtB,yBAAyB;QACzB,qBAAqB;QACrB,kBAAkB;QAClB,iCAAiC;QACjC,4CAA4C;QAC5C,sBAAsB;QACtB,wBAAwB;QACxB,iCAAiC;QACjC,wBAAwB;QACxB,6BAA6B;QAC7B,+BAA+B;QAC/B,kCAAkC;QAClC,kCAAkC;KACnC,CAAC;AACJ,CAAC","sourcesContent":["import type { NotNamespacedBy } from '@metamask/base-controller';\nimport { ControllerMessenger } from '@metamask/base-controller';\n\nimport { MOCK_STORAGE_KEY_SIGNATURE } from '.';\nimport type {\n  AllowedActions,\n  AllowedEvents,\n  UserStorageControllerMessenger,\n} from '..';\n\ntype GetHandler<ActionType extends AllowedActions['type']> = Extract<\n  AllowedActions,\n  { type: ActionType }\n>['handler'];\n\ntype CallParams = {\n  [K in AllowedActions['type']]: [\n    K,\n    ...Parameters<Extract<AllowedActions, { type: K }>['handler']>,\n  ];\n}[AllowedActions['type']];\n\nconst typedMockFn = <\n  ActionType extends AllowedActions['type'],\n  Handler = GetHandler<ActionType>,\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  Func extends (...args: any) => any = Handler extends (...args: any[]) => any\n    ? Handler\n    : never,\n>(\n  _type: ActionType,\n) => jest.fn<ReturnType<Func>, Parameters<Func>>();\n\ntype ExternalEvents = NotNamespacedBy<\n  'UserStorageController',\n  AllowedEvents['type']\n>;\n\n/**\n * creates a custom user storage messenger, in case tests need different permissions\n * @param props - overrides\n * @param props.overrideEvents - override events\n * @returns base messenger, and messenger. You can pass this into the mocks below to mock messenger calls\n */\nexport function createCustomUserStorageMessenger(props?: {\n  overrideEvents?: ExternalEvents[];\n}) {\n  const baseMessenger = new ControllerMessenger<\n    AllowedActions,\n    AllowedEvents\n  >();\n  const messenger = baseMessenger.getRestricted({\n    name: 'UserStorageController',\n    allowedActions: [\n      'KeyringController:getState',\n      'KeyringController:addNewAccount',\n      'SnapController:handleRequest',\n      'AuthenticationController:getBearerToken',\n      'AuthenticationController:getSessionProfile',\n      'AuthenticationController:isSignedIn',\n      'AuthenticationController:performSignOut',\n      'AuthenticationController:performSignIn',\n      'NotificationServicesController:disableNotificationServices',\n      'NotificationServicesController:selectIsNotificationServicesEnabled',\n      'AccountsController:listAccounts',\n      'AccountsController:updateAccountMetadata',\n      'NetworkController:getState',\n      'NetworkController:addNetwork',\n      'NetworkController:updateNetwork',\n      'NetworkController:removeNetwork',\n    ],\n    allowedEvents: props?.overrideEvents ?? [\n      'KeyringController:lock',\n      'KeyringController:unlock',\n      'AccountsController:accountAdded',\n      'AccountsController:accountRenamed',\n      'NetworkController:networkRemoved',\n    ],\n  });\n\n  return {\n    baseMessenger,\n    messenger,\n  };\n}\n\ntype OverrideMessengers = {\n  baseMessenger: ControllerMessenger<AllowedActions, AllowedEvents>;\n  messenger: UserStorageControllerMessenger;\n};\n\n/**\n * Jest Mock Utility to generate a mock User Storage Messenger\n * @param overrideMessengers - override messengers if need to modify the underlying permissions\n * @returns series of mocks to actions that can be called\n */\nexport function mockUserStorageMessenger(\n  overrideMessengers?: OverrideMessengers,\n) {\n  const { baseMessenger, messenger } =\n    overrideMessengers ?? createCustomUserStorageMessenger();\n\n  const mockSnapGetPublicKey = jest.fn().mockResolvedValue('MOCK_PUBLIC_KEY');\n  const mockSnapSignMessage = jest\n    .fn()\n    .mockResolvedValue(MOCK_STORAGE_KEY_SIGNATURE);\n\n  const mockAuthGetBearerToken = typedMockFn(\n    'AuthenticationController:getBearerToken',\n  ).mockResolvedValue('MOCK_BEARER_TOKEN');\n\n  const mockAuthGetSessionProfile = typedMockFn(\n    'AuthenticationController:getSessionProfile',\n  ).mockResolvedValue({\n    identifierId: '',\n    profileId: 'MOCK_PROFILE_ID',\n  });\n\n  const mockAuthPerformSignIn = typedMockFn(\n    'AuthenticationController:performSignIn',\n  ).mockResolvedValue('New Access Token');\n\n  const mockAuthIsSignedIn = typedMockFn(\n    'AuthenticationController:isSignedIn',\n  ).mockReturnValue(true);\n\n  const mockAuthPerformSignOut = typedMockFn(\n    'AuthenticationController:performSignOut',\n  );\n\n  const mockNotificationServicesIsEnabled = typedMockFn(\n    'NotificationServicesController:selectIsNotificationServicesEnabled',\n  ).mockReturnValue(true);\n\n  const mockNotificationServicesDisableNotifications = typedMockFn(\n    'NotificationServicesController:disableNotificationServices',\n  ).mockResolvedValue();\n\n  const mockKeyringAddNewAccount = typedMockFn(\n    'KeyringController:addNewAccount',\n  );\n\n  // Untyped mock as there is a TS(2742) issue.\n  // This will return `InternalAccount[]`\n  const mockAccountsListAccounts = jest.fn();\n\n  const mockAccountsUpdateAccountMetadata = typedMockFn(\n    'AccountsController:updateAccountMetadata',\n  ).mockResolvedValue(true as never);\n\n  const mockNetworkControllerGetState = typedMockFn(\n    'NetworkController:getState',\n  ).mockReturnValue({\n    selectedNetworkClientId: '',\n    networksMetadata: {},\n    networkConfigurationsByChainId: {},\n  });\n\n  const mockNetworkControllerAddNetwork = typedMockFn(\n    'NetworkController:addNetwork',\n  );\n\n  const mockNetworkControllerRemoveNetwork = typedMockFn(\n    'NetworkController:removeNetwork',\n  );\n\n  const mockNetworkControllerUpdateNetwork = typedMockFn(\n    'NetworkController:updateNetwork',\n  );\n\n  jest.spyOn(messenger, 'call').mockImplementation((...args) => {\n    const typedArgs = args as unknown as CallParams;\n    const [actionType] = typedArgs;\n\n    if (actionType === 'SnapController:handleRequest') {\n      const [, params] = typedArgs;\n      if (params.request.method === 'getPublicKey') {\n        return mockSnapGetPublicKey();\n      }\n\n      if (params.request.method === 'signMessage') {\n        return mockSnapSignMessage();\n      }\n\n      throw new Error(\n        `MOCK_FAIL - unsupported SnapController:handleRequest call: ${\n          params.request.method as string\n        }`,\n      );\n    }\n\n    if (actionType === 'AuthenticationController:getBearerToken') {\n      return mockAuthGetBearerToken();\n    }\n\n    if (actionType === 'AuthenticationController:getSessionProfile') {\n      return mockAuthGetSessionProfile();\n    }\n\n    if (actionType === 'AuthenticationController:performSignIn') {\n      return mockAuthPerformSignIn();\n    }\n\n    if (actionType === 'AuthenticationController:isSignedIn') {\n      return mockAuthIsSignedIn();\n    }\n\n    if (\n      actionType ===\n      'NotificationServicesController:selectIsNotificationServicesEnabled'\n    ) {\n      return mockNotificationServicesIsEnabled();\n    }\n\n    if (\n      actionType ===\n      'NotificationServicesController:disableNotificationServices'\n    ) {\n      return mockNotificationServicesDisableNotifications();\n    }\n\n    if (actionType === 'AuthenticationController:performSignOut') {\n      return mockAuthPerformSignOut();\n    }\n\n    if (actionType === 'KeyringController:getState') {\n      return { isUnlocked: true };\n    }\n\n    if (actionType === 'KeyringController:addNewAccount') {\n      return mockKeyringAddNewAccount();\n    }\n\n    if (actionType === 'AccountsController:listAccounts') {\n      return mockAccountsListAccounts();\n    }\n\n    if (typedArgs[0] === 'AccountsController:updateAccountMetadata') {\n      const [, ...params] = typedArgs;\n      return mockAccountsUpdateAccountMetadata(...params);\n    }\n\n    if (actionType === 'NetworkController:getState') {\n      return mockNetworkControllerGetState();\n    }\n\n    if (actionType === 'NetworkController:addNetwork') {\n      const [, ...params] = typedArgs;\n      return mockNetworkControllerAddNetwork(...params);\n    }\n\n    if (actionType === 'NetworkController:removeNetwork') {\n      const [, ...params] = typedArgs;\n      return mockNetworkControllerRemoveNetwork(...params);\n    }\n\n    if (actionType === 'NetworkController:updateNetwork') {\n      const [, ...params] = typedArgs;\n      return mockNetworkControllerUpdateNetwork(...params);\n    }\n\n    throw new Error(\n      `MOCK_FAIL - unsupported messenger call: ${actionType as string}`,\n    );\n  });\n\n  return {\n    baseMessenger,\n    messenger,\n    mockSnapGetPublicKey,\n    mockSnapSignMessage,\n    mockAuthGetBearerToken,\n    mockAuthGetSessionProfile,\n    mockAuthPerformSignIn,\n    mockAuthIsSignedIn,\n    mockNotificationServicesIsEnabled,\n    mockNotificationServicesDisableNotifications,\n    mockAuthPerformSignOut,\n    mockKeyringAddNewAccount,\n    mockAccountsUpdateAccountMetadata,\n    mockAccountsListAccounts,\n    mockNetworkControllerGetState,\n    mockNetworkControllerAddNetwork,\n    mockNetworkControllerRemoveNetwork,\n    mockNetworkControllerUpdateNetwork,\n  };\n}\n"]}