@metamask-previews/profile-sync-controller 7.0.1-preview-74b4a89 → 8.0.0-preview-ea165590

package/CHANGELOG.md

@@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [8.0.0]
+
+### Added
+
+- Add `perform{BatchSetStorage,DeleteStorage,BatchDeleteStorage}` as messenger actions ([#5311](https://github.com/MetaMask/core/pull/5311))
+- Add optional `validateAgainstSchema` option when creating user storage entry paths ([#5326](https://github.com/MetaMask/core/pull/5326))
+
+### Changed
+
+- **BREAKING:** Bump `@metamask/accounts-controller` peer dependency from `^23.0.0` to `^24.0.0` ([#5318](https://github.com/MetaMask/core/pull/5318))
+- Change `maxNumberOfAccountsToAdd` default value from `100` to `Infinity` ([#5322](https://github.com/MetaMask/core/pull/5322))
+
+### Removed
+
+- Removed unused events from `UserStorageController` ([#5324](https://github.com/MetaMask/core/pull/5324))
+
 ## [7.0.1]
 
 ### Changed
@@ -467,7 +483,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@7.0.1...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@8.0.0...HEAD
+[8.0.0]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@7.0.1...@metamask/profile-sync-controller@8.0.0
 [7.0.1]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@7.0.0...@metamask/profile-sync-controller@7.0.1
 [7.0.0]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@6.0.0...@metamask/profile-sync-controller@7.0.0
 [6.0.0]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@5.0.0...@metamask/profile-sync-controller@6.0.0

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

@@ -17,6 +17,7 @@ function createCustomUserStorageMessenger(props) {
         name: 'UserStorageController',
         allowedActions: [
             'KeyringController:getState',
+            'KeyringController:withKeyring',
             'SnapController:handleRequest',
             'AuthenticationController:getBearerToken',
             'AuthenticationController:getSessionProfile',
@@ -65,9 +66,9 @@ function mockUserStorageMessenger(overrideMessengers) {
     const mockAuthIsSignedIn = typedMockFn('AuthenticationController:isSignedIn').mockReturnValue(true);
     const mockAuthPerformSignOut = typedMockFn('AuthenticationController:performSignOut');
     const mockKeyringWithKeyring = typedMockFn('KeyringController:withKeyring');
-    // Untyped mock as there is a TS(2742) issue.
-    // This will return `InternalAccount[]`
     const mockAccountsListAccounts = jest.fn();
+    const mockKeyringGetAccounts = jest.fn();
+    const mockKeyringAddAccounts = jest.fn();
     const mockAccountsUpdateAccountMetadata = typedMockFn('AccountsController:updateAccountMetadata').mockResolvedValue(true);
     const mockNetworkControllerGetState = typedMockFn('NetworkController:getState').mockReturnValue({
         selectedNetworkClientId: '',
@@ -110,7 +111,12 @@ function mockUserStorageMessenger(overrideMessengers) {
         }
         if (actionType === 'KeyringController:withKeyring') {
             const [, ...params] = typedArgs;
-            return mockKeyringWithKeyring(...params);
+            const [, operation] = params;
+            const keyring = {
+                getAccounts: mockKeyringGetAccounts,
+                addAccounts: mockKeyringAddAccounts,
+            };
+            return operation(keyring);
         }
         if (actionType === 'AccountsController:listAccounts') {
             return mockAccountsListAccounts();
@@ -146,6 +152,8 @@ function mockUserStorageMessenger(overrideMessengers) {
         mockAuthPerformSignIn,
         mockAuthIsSignedIn,
         mockAuthPerformSignOut,
+        mockKeyringGetAccounts,
+        mockKeyringAddAccounts,
         mockKeyringWithKeyring,
         mockAccountsUpdateAccountMetadata,
         mockAccountsListAccounts,

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

@@ -1 +1 @@
-{"version":3,"file":"mockMessenger.cjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/__fixtures__/mockMessenger.ts"],"names":[],"mappings":";;;AACA,+DAAsD;AAEtD,kCAA+C;AAmB/C,MAAM,WAAW,GAAG,CAQlB,KAAiB,EACjB,EAAE,CAAC,IAAI,CAAC,EAAE,EAAsC,CAAC;AAOnD;;;;;;GAMG;AACH,SAAgB,gCAAgC,CAAC,KAEhD;IACC,MAAM,aAAa,GAAG,IAAI,2BAAS,EAAiC,CAAC;IACrE,MAAM,SAAS,GAAG,aAAa,CAAC,aAAa,CAAC;QAC5C,IAAI,EAAE,uBAAuB;QAC7B,cAAc,EAAE;YACd,4BAA4B;YAC5B,8BAA8B;YAC9B,yCAAyC;YACzC,4CAA4C;YAC5C,qCAAqC;YACrC,yCAAyC;YACzC,wCAAwC;YACxC,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;AAlCD,4EAkCC;AAOD;;;;;GAKG;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,sBAAsB,GAAG,WAAW,CAAC,+BAA+B,CAAC,CAAC;IAE5E,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,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,+BAA+B,EAAE;YAClD,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,GAAG,SAAS,CAAC;YAChC,OAAO,sBAAsB,CAAC,GAAG,MAAM,CAAC,CAAC;SAC1C;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,sBAAsB;QACtB,sBAAsB;QACtB,iCAAiC;QACjC,wBAAwB;QACxB,6BAA6B;QAC7B,+BAA+B;QAC/B,kCAAkC;QAClC,kCAAkC;KACnC,CAAC;AACJ,CAAC;AArKD,4DAqKC","sourcesContent":["import type { NotNamespacedBy } from '@metamask/base-controller';\nimport { Messenger } 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 *\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 Messenger<AllowedActions, AllowedEvents>();\n  const messenger = baseMessenger.getRestricted({\n    name: 'UserStorageController',\n    allowedActions: [\n      'KeyringController:getState',\n      'SnapController:handleRequest',\n      'AuthenticationController:getBearerToken',\n      'AuthenticationController:getSessionProfile',\n      'AuthenticationController:isSignedIn',\n      'AuthenticationController:performSignOut',\n      'AuthenticationController:performSignIn',\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: Messenger<AllowedActions, AllowedEvents>;\n  messenger: UserStorageControllerMessenger;\n};\n\n/**\n * Jest Mock Utility to generate a mock User Storage Messenger\n *\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 mockKeyringWithKeyring = typedMockFn('KeyringController:withKeyring');\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 (actionType === 'AuthenticationController:performSignOut') {\n      return mockAuthPerformSignOut();\n    }\n\n    if (actionType === 'KeyringController:getState') {\n      return { isUnlocked: true };\n    }\n\n    if (actionType === 'KeyringController:withKeyring') {\n      const [, ...params] = typedArgs;\n      return mockKeyringWithKeyring(...params);\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    mockAuthPerformSignOut,\n    mockKeyringWithKeyring,\n    mockAccountsUpdateAccountMetadata,\n    mockAccountsListAccounts,\n    mockNetworkControllerGetState,\n    mockNetworkControllerAddNetwork,\n    mockNetworkControllerRemoveNetwork,\n    mockNetworkControllerUpdateNetwork,\n  };\n}\n"]}
+{"version":3,"file":"mockMessenger.cjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/__fixtures__/mockMessenger.ts"],"names":[],"mappings":";;;AACA,+DAAsD;AAGtD,kCAA+C;AAmB/C,MAAM,WAAW,GAAG,CAQlB,KAAiB,EACjB,EAAE,CAAC,IAAI,CAAC,EAAE,EAAsC,CAAC;AAOnD;;;;;;GAMG;AACH,SAAgB,gCAAgC,CAAC,KAEhD;IACC,MAAM,aAAa,GAAG,IAAI,2BAAS,EAAiC,CAAC;IACrE,MAAM,SAAS,GAAG,aAAa,CAAC,aAAa,CAAC;QAC5C,IAAI,EAAE,uBAAuB;QAC7B,cAAc,EAAE;YACd,4BAA4B;YAC5B,+BAA+B;YAC/B,8BAA8B;YAC9B,yCAAyC;YACzC,4CAA4C;YAC5C,qCAAqC;YACrC,yCAAyC;YACzC,wCAAwC;YACxC,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;AAnCD,4EAmCC;AAOD;;;;;GAKG;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,sBAAsB,GAAG,WAAW,CAAC,+BAA+B,CAAC,CAAC;IAE5E,MAAM,wBAAwB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAE3C,MAAM,sBAAsB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IACzC,MAAM,sBAAsB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAEzC,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,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,+BAA+B,EAAE;YAClD,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,GAAG,SAAS,CAAC;YAChC,MAAM,CAAC,EAAE,SAAS,CAAC,GAAG,MAAM,CAAC;YAE7B,MAAM,OAAO,GAAG;gBACd,WAAW,EAAE,sBAAsB;gBACnC,WAAW,EAAE,sBAAsB;aACJ,CAAC;YAElC,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC;SAC3B;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,sBAAsB;QACtB,sBAAsB;QACtB,sBAAsB;QACtB,sBAAsB;QACtB,iCAAiC;QACjC,wBAAwB;QACxB,6BAA6B;QAC7B,+BAA+B;QAC/B,kCAAkC;QAClC,kCAAkC;KACnC,CAAC;AACJ,CAAC;AA/KD,4DA+KC","sourcesContent":["import type { NotNamespacedBy } from '@metamask/base-controller';\nimport { Messenger } from '@metamask/base-controller';\nimport type { EthKeyring } from '@metamask/keyring-internal-api';\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 *\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 Messenger<AllowedActions, AllowedEvents>();\n  const messenger = baseMessenger.getRestricted({\n    name: 'UserStorageController',\n    allowedActions: [\n      'KeyringController:getState',\n      'KeyringController:withKeyring',\n      'SnapController:handleRequest',\n      'AuthenticationController:getBearerToken',\n      'AuthenticationController:getSessionProfile',\n      'AuthenticationController:isSignedIn',\n      'AuthenticationController:performSignOut',\n      'AuthenticationController:performSignIn',\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: Messenger<AllowedActions, AllowedEvents>;\n  messenger: UserStorageControllerMessenger;\n};\n\n/**\n * Jest Mock Utility to generate a mock User Storage Messenger\n *\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 mockKeyringWithKeyring = typedMockFn('KeyringController:withKeyring');\n\n  const mockAccountsListAccounts = jest.fn();\n\n  const mockKeyringGetAccounts = jest.fn();\n  const mockKeyringAddAccounts = 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 (actionType === 'AuthenticationController:performSignOut') {\n      return mockAuthPerformSignOut();\n    }\n\n    if (actionType === 'KeyringController:getState') {\n      return { isUnlocked: true };\n    }\n\n    if (actionType === 'KeyringController:withKeyring') {\n      const [, ...params] = typedArgs;\n      const [, operation] = params;\n\n      const keyring = {\n        getAccounts: mockKeyringGetAccounts,\n        addAccounts: mockKeyringAddAccounts,\n      } as unknown as EthKeyring<never>;\n\n      return operation(keyring);\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    mockAuthPerformSignOut,\n    mockKeyringGetAccounts,\n    mockKeyringAddAccounts,\n    mockKeyringWithKeyring,\n    mockAccountsUpdateAccountMetadata,\n    mockAccountsListAccounts,\n    mockNetworkControllerGetState,\n    mockNetworkControllerAddNetwork,\n    mockNetworkControllerRemoveNetwork,\n    mockNetworkControllerUpdateNetwork,\n  };\n}\n"]}

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

@@ -1,6 +1,7 @@
 /// <reference types="jest" />
 import type { NotNamespacedBy } from "@metamask/base-controller";
 import { Messenger } from "@metamask/base-controller";
+import type { EthKeyring } from "@metamask/keyring-internal-api";
 import type { AllowedActions, AllowedEvents, UserStorageControllerMessenger } from "../index.cjs";
 type ExternalEvents = NotNamespacedBy<'UserStorageController', AllowedEvents['type']>;
 /**
@@ -32,7 +33,7 @@ export declare function createCustomUserStorageMessenger(props?: {
             identifierId: string;
             profileId: string;
         }>;
-    } | import("@metamask/keyring-controller").KeyringControllerGetStateAction | import("@metamask/accounts-controller").AccountsControllerListAccountsAction | import("@metamask/accounts-controller").AccountsControllerUpdateAccountMetadataAction | 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("@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" | "AccountsController:listAccounts" | "AccountsController:updateAccountMetadata" | "NetworkController:getState" | "NetworkController:addNetwork" | "NetworkController:removeNetwork" | "NetworkController:updateNetwork", "KeyringController:lock" | "KeyringController:unlock" | "AccountsController:accountAdded" | "AccountsController:accountRenamed" | "NetworkController:networkRemoved">;
+    } | import("@metamask/keyring-controller").KeyringControllerGetStateAction | import("@metamask/accounts-controller").AccountsControllerListAccountsAction | import("@metamask/accounts-controller").AccountsControllerUpdateAccountMetadataAction | import("@metamask/keyring-controller").KeyringControllerWithKeyringAction | 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("@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" | "AccountsController:listAccounts" | "AccountsController:updateAccountMetadata" | "KeyringController:withKeyring" | "NetworkController:getState" | "NetworkController:addNetwork" | "NetworkController:removeNetwork" | "NetworkController:updateNetwork", "KeyringController:lock" | "KeyringController:unlock" | "AccountsController:accountAdded" | "AccountsController:accountRenamed" | "NetworkController:networkRemoved">;
 };
 type OverrideMessengers = {
     baseMessenger: Messenger<AllowedActions, AllowedEvents>;
@@ -64,7 +65,7 @@ export declare function mockUserStorageMessenger(overrideMessengers?: OverrideMe
             identifierId: string;
             profileId: string;
         }>;
-    } | import("@metamask/keyring-controller").KeyringControllerGetStateAction | import("@metamask/accounts-controller").AccountsControllerListAccountsAction | import("@metamask/accounts-controller").AccountsControllerUpdateAccountMetadataAction | 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("@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" | "AccountsController:listAccounts" | "AccountsController:updateAccountMetadata" | "NetworkController:getState" | "NetworkController:addNetwork" | "NetworkController:removeNetwork" | "NetworkController:updateNetwork", "KeyringController:lock" | "KeyringController:unlock" | "AccountsController:accountAdded" | "AccountsController:accountRenamed" | "NetworkController:networkRemoved">;
+    } | import("@metamask/keyring-controller").KeyringControllerGetStateAction | import("@metamask/accounts-controller").AccountsControllerListAccountsAction | import("@metamask/accounts-controller").AccountsControllerUpdateAccountMetadataAction | import("@metamask/keyring-controller").KeyringControllerWithKeyringAction | 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("@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" | "AccountsController:listAccounts" | "AccountsController:updateAccountMetadata" | "KeyringController:withKeyring" | "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>, []>;
@@ -75,7 +76,9 @@ export declare function mockUserStorageMessenger(overrideMessengers?: OverrideMe
     mockAuthPerformSignIn: jest.Mock<Promise<string>, []>;
     mockAuthIsSignedIn: jest.Mock<boolean, []>;
     mockAuthPerformSignOut: jest.Mock<void, []>;
-    mockKeyringWithKeyring: jest.Mock<Promise<unknown>, [selector: import("@metamask/keyring-controller").KeyringSelector, operation: (keyring: import("@metamask/keyring-internal-api").EthKeyring<import("@metamask/utils").Json>) => Promise<unknown>]>;
+    mockKeyringGetAccounts: jest.Mock<any, any>;
+    mockKeyringAddAccounts: jest.Mock<any, any>;
+    mockKeyringWithKeyring: jest.Mock<Promise<unknown>, [selector: import("@metamask/keyring-controller").KeyringSelector, operation: (keyring: EthKeyring<import("@metamask/utils").Json>) => Promise<unknown>]>;
     mockAccountsUpdateAccountMetadata: jest.Mock<void, [accountId: string, metadata: Partial<{
         name: string;
         importTime: number;

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

@@ -1 +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,SAAS,EAAE,kCAAkC;AAGtD,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;;;;;;GAMG;AACH,wBAAgB,gCAAgC,CAAC,KAAK,CAAC,EAAE;IACvD,cAAc,CAAC,EAAE,cAAc,EAAE,CAAC;CACnC;;;;;;;;;;;;;;;;;;;;;EAgCA;AAED,KAAK,kBAAkB,GAAG;IACxB,aAAa,EAAE,SAAS,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;IACxD,SAAS,EAAE,8BAA8B,CAAC;CAC3C,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,kBAAkB,CAAC,EAAE,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoKxC"}
+{"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,SAAS,EAAE,kCAAkC;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,uCAAuC;AAGjE,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;;;;;;GAMG;AACH,wBAAgB,gCAAgC,CAAC,KAAK,CAAC,EAAE;IACvD,cAAc,CAAC,EAAE,cAAc,EAAE,CAAC;CACnC;;;;;;;;;;;;;;;;;;;;;EAiCA;AAED,KAAK,kBAAkB,GAAG;IACxB,aAAa,EAAE,SAAS,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;IACxD,SAAS,EAAE,8BAA8B,CAAC;CAC3C,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,kBAAkB,CAAC,EAAE,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA8KxC"}

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

@@ -1,6 +1,7 @@
 /// <reference types="jest" />
 import type { NotNamespacedBy } from "@metamask/base-controller";
 import { Messenger } from "@metamask/base-controller";
+import type { EthKeyring } from "@metamask/keyring-internal-api";
 import type { AllowedActions, AllowedEvents, UserStorageControllerMessenger } from "../index.mjs";
 type ExternalEvents = NotNamespacedBy<'UserStorageController', AllowedEvents['type']>;
 /**
@@ -32,7 +33,7 @@ export declare function createCustomUserStorageMessenger(props?: {
             identifierId: string;
             profileId: string;
         }>;
-    } | import("@metamask/keyring-controller").KeyringControllerGetStateAction | import("@metamask/accounts-controller").AccountsControllerListAccountsAction | import("@metamask/accounts-controller").AccountsControllerUpdateAccountMetadataAction | 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("@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" | "AccountsController:listAccounts" | "AccountsController:updateAccountMetadata" | "NetworkController:getState" | "NetworkController:addNetwork" | "NetworkController:removeNetwork" | "NetworkController:updateNetwork", "KeyringController:lock" | "KeyringController:unlock" | "AccountsController:accountAdded" | "AccountsController:accountRenamed" | "NetworkController:networkRemoved">;
+    } | import("@metamask/keyring-controller").KeyringControllerGetStateAction | import("@metamask/accounts-controller").AccountsControllerListAccountsAction | import("@metamask/accounts-controller").AccountsControllerUpdateAccountMetadataAction | import("@metamask/keyring-controller").KeyringControllerWithKeyringAction | 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("@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" | "AccountsController:listAccounts" | "AccountsController:updateAccountMetadata" | "KeyringController:withKeyring" | "NetworkController:getState" | "NetworkController:addNetwork" | "NetworkController:removeNetwork" | "NetworkController:updateNetwork", "KeyringController:lock" | "KeyringController:unlock" | "AccountsController:accountAdded" | "AccountsController:accountRenamed" | "NetworkController:networkRemoved">;
 };
 type OverrideMessengers = {
     baseMessenger: Messenger<AllowedActions, AllowedEvents>;
@@ -64,7 +65,7 @@ export declare function mockUserStorageMessenger(overrideMessengers?: OverrideMe
             identifierId: string;
             profileId: string;
         }>;
-    } | import("@metamask/keyring-controller").KeyringControllerGetStateAction | import("@metamask/accounts-controller").AccountsControllerListAccountsAction | import("@metamask/accounts-controller").AccountsControllerUpdateAccountMetadataAction | 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("@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" | "AccountsController:listAccounts" | "AccountsController:updateAccountMetadata" | "NetworkController:getState" | "NetworkController:addNetwork" | "NetworkController:removeNetwork" | "NetworkController:updateNetwork", "KeyringController:lock" | "KeyringController:unlock" | "AccountsController:accountAdded" | "AccountsController:accountRenamed" | "NetworkController:networkRemoved">;
+    } | import("@metamask/keyring-controller").KeyringControllerGetStateAction | import("@metamask/accounts-controller").AccountsControllerListAccountsAction | import("@metamask/accounts-controller").AccountsControllerUpdateAccountMetadataAction | import("@metamask/keyring-controller").KeyringControllerWithKeyringAction | 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("@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" | "AccountsController:listAccounts" | "AccountsController:updateAccountMetadata" | "KeyringController:withKeyring" | "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>, []>;
@@ -75,7 +76,9 @@ export declare function mockUserStorageMessenger(overrideMessengers?: OverrideMe
     mockAuthPerformSignIn: jest.Mock<Promise<string>, []>;
     mockAuthIsSignedIn: jest.Mock<boolean, []>;
     mockAuthPerformSignOut: jest.Mock<void, []>;
-    mockKeyringWithKeyring: jest.Mock<Promise<unknown>, [selector: import("@metamask/keyring-controller").KeyringSelector, operation: (keyring: import("@metamask/keyring-internal-api").EthKeyring<import("@metamask/utils").Json>) => Promise<unknown>]>;
+    mockKeyringGetAccounts: jest.Mock<any, any>;
+    mockKeyringAddAccounts: jest.Mock<any, any>;
+    mockKeyringWithKeyring: jest.Mock<Promise<unknown>, [selector: import("@metamask/keyring-controller").KeyringSelector, operation: (keyring: EthKeyring<import("@metamask/utils").Json>) => Promise<unknown>]>;
     mockAccountsUpdateAccountMetadata: jest.Mock<void, [accountId: string, metadata: Partial<{
         name: string;
         importTime: number;

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

@@ -1 +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,SAAS,EAAE,kCAAkC;AAGtD,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;;;;;;GAMG;AACH,wBAAgB,gCAAgC,CAAC,KAAK,CAAC,EAAE;IACvD,cAAc,CAAC,EAAE,cAAc,EAAE,CAAC;CACnC;;;;;;;;;;;;;;;;;;;;;EAgCA;AAED,KAAK,kBAAkB,GAAG;IACxB,aAAa,EAAE,SAAS,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;IACxD,SAAS,EAAE,8BAA8B,CAAC;CAC3C,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,kBAAkB,CAAC,EAAE,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoKxC"}
+{"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,SAAS,EAAE,kCAAkC;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,uCAAuC;AAGjE,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;;;;;;GAMG;AACH,wBAAgB,gCAAgC,CAAC,KAAK,CAAC,EAAE;IACvD,cAAc,CAAC,EAAE,cAAc,EAAE,CAAC;CACnC;;;;;;;;;;;;;;;;;;;;;EAiCA;AAED,KAAK,kBAAkB,GAAG;IACxB,aAAa,EAAE,SAAS,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;IACxD,SAAS,EAAE,8BAA8B,CAAC;CAC3C,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,kBAAkB,CAAC,EAAE,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA8KxC"}

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

@@ -14,6 +14,7 @@ export function createCustomUserStorageMessenger(props) {
         name: 'UserStorageController',
         allowedActions: [
             'KeyringController:getState',
+            'KeyringController:withKeyring',
             'SnapController:handleRequest',
             'AuthenticationController:getBearerToken',
             'AuthenticationController:getSessionProfile',
@@ -61,9 +62,9 @@ export function mockUserStorageMessenger(overrideMessengers) {
     const mockAuthIsSignedIn = typedMockFn('AuthenticationController:isSignedIn').mockReturnValue(true);
     const mockAuthPerformSignOut = typedMockFn('AuthenticationController:performSignOut');
     const mockKeyringWithKeyring = typedMockFn('KeyringController:withKeyring');
-    // Untyped mock as there is a TS(2742) issue.
-    // This will return `InternalAccount[]`
     const mockAccountsListAccounts = jest.fn();
+    const mockKeyringGetAccounts = jest.fn();
+    const mockKeyringAddAccounts = jest.fn();
     const mockAccountsUpdateAccountMetadata = typedMockFn('AccountsController:updateAccountMetadata').mockResolvedValue(true);
     const mockNetworkControllerGetState = typedMockFn('NetworkController:getState').mockReturnValue({
         selectedNetworkClientId: '',
@@ -106,7 +107,12 @@ export function mockUserStorageMessenger(overrideMessengers) {
         }
         if (actionType === 'KeyringController:withKeyring') {
             const [, ...params] = typedArgs;
-            return mockKeyringWithKeyring(...params);
+            const [, operation] = params;
+            const keyring = {
+                getAccounts: mockKeyringGetAccounts,
+                addAccounts: mockKeyringAddAccounts,
+            };
+            return operation(keyring);
         }
         if (actionType === 'AccountsController:listAccounts') {
             return mockAccountsListAccounts();
@@ -142,6 +148,8 @@ export function mockUserStorageMessenger(overrideMessengers) {
         mockAuthPerformSignIn,
         mockAuthIsSignedIn,
         mockAuthPerformSignOut,
+        mockKeyringGetAccounts,
+        mockKeyringAddAccounts,
         mockKeyringWithKeyring,
         mockAccountsUpdateAccountMetadata,
         mockAccountsListAccounts,

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

@@ -1 +1 @@
-{"version":3,"file":"mockMessenger.mjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/__fixtures__/mockMessenger.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,kCAAkC;AAEtD,OAAO,EAAE,0BAA0B,EAAE,oBAAU;AAmB/C,MAAM,WAAW,GAAG,CAQlB,KAAiB,EACjB,EAAE,CAAC,IAAI,CAAC,EAAE,EAAsC,CAAC;AAOnD;;;;;;GAMG;AACH,MAAM,UAAU,gCAAgC,CAAC,KAEhD;IACC,MAAM,aAAa,GAAG,IAAI,SAAS,EAAiC,CAAC;IACrE,MAAM,SAAS,GAAG,aAAa,CAAC,aAAa,CAAC;QAC5C,IAAI,EAAE,uBAAuB;QAC7B,cAAc,EAAE;YACd,4BAA4B;YAC5B,8BAA8B;YAC9B,yCAAyC;YACzC,4CAA4C;YAC5C,qCAAqC;YACrC,yCAAyC;YACzC,wCAAwC;YACxC,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;;;;;GAKG;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,sBAAsB,GAAG,WAAW,CAAC,+BAA+B,CAAC,CAAC;IAE5E,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,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,+BAA+B,EAAE;YAClD,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,GAAG,SAAS,CAAC;YAChC,OAAO,sBAAsB,CAAC,GAAG,MAAM,CAAC,CAAC;SAC1C;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,sBAAsB;QACtB,sBAAsB;QACtB,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 { Messenger } 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 *\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 Messenger<AllowedActions, AllowedEvents>();\n  const messenger = baseMessenger.getRestricted({\n    name: 'UserStorageController',\n    allowedActions: [\n      'KeyringController:getState',\n      'SnapController:handleRequest',\n      'AuthenticationController:getBearerToken',\n      'AuthenticationController:getSessionProfile',\n      'AuthenticationController:isSignedIn',\n      'AuthenticationController:performSignOut',\n      'AuthenticationController:performSignIn',\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: Messenger<AllowedActions, AllowedEvents>;\n  messenger: UserStorageControllerMessenger;\n};\n\n/**\n * Jest Mock Utility to generate a mock User Storage Messenger\n *\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 mockKeyringWithKeyring = typedMockFn('KeyringController:withKeyring');\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 (actionType === 'AuthenticationController:performSignOut') {\n      return mockAuthPerformSignOut();\n    }\n\n    if (actionType === 'KeyringController:getState') {\n      return { isUnlocked: true };\n    }\n\n    if (actionType === 'KeyringController:withKeyring') {\n      const [, ...params] = typedArgs;\n      return mockKeyringWithKeyring(...params);\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    mockAuthPerformSignOut,\n    mockKeyringWithKeyring,\n    mockAccountsUpdateAccountMetadata,\n    mockAccountsListAccounts,\n    mockNetworkControllerGetState,\n    mockNetworkControllerAddNetwork,\n    mockNetworkControllerRemoveNetwork,\n    mockNetworkControllerUpdateNetwork,\n  };\n}\n"]}
+{"version":3,"file":"mockMessenger.mjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/__fixtures__/mockMessenger.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,kCAAkC;AAGtD,OAAO,EAAE,0BAA0B,EAAE,oBAAU;AAmB/C,MAAM,WAAW,GAAG,CAQlB,KAAiB,EACjB,EAAE,CAAC,IAAI,CAAC,EAAE,EAAsC,CAAC;AAOnD;;;;;;GAMG;AACH,MAAM,UAAU,gCAAgC,CAAC,KAEhD;IACC,MAAM,aAAa,GAAG,IAAI,SAAS,EAAiC,CAAC;IACrE,MAAM,SAAS,GAAG,aAAa,CAAC,aAAa,CAAC;QAC5C,IAAI,EAAE,uBAAuB;QAC7B,cAAc,EAAE;YACd,4BAA4B;YAC5B,+BAA+B;YAC/B,8BAA8B;YAC9B,yCAAyC;YACzC,4CAA4C;YAC5C,qCAAqC;YACrC,yCAAyC;YACzC,wCAAwC;YACxC,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;;;;;GAKG;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,sBAAsB,GAAG,WAAW,CAAC,+BAA+B,CAAC,CAAC;IAE5E,MAAM,wBAAwB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAE3C,MAAM,sBAAsB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IACzC,MAAM,sBAAsB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAEzC,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,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,+BAA+B,EAAE;YAClD,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,GAAG,SAAS,CAAC;YAChC,MAAM,CAAC,EAAE,SAAS,CAAC,GAAG,MAAM,CAAC;YAE7B,MAAM,OAAO,GAAG;gBACd,WAAW,EAAE,sBAAsB;gBACnC,WAAW,EAAE,sBAAsB;aACJ,CAAC;YAElC,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC;SAC3B;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,sBAAsB;QACtB,sBAAsB;QACtB,sBAAsB;QACtB,sBAAsB;QACtB,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 { Messenger } from '@metamask/base-controller';\nimport type { EthKeyring } from '@metamask/keyring-internal-api';\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 *\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 Messenger<AllowedActions, AllowedEvents>();\n  const messenger = baseMessenger.getRestricted({\n    name: 'UserStorageController',\n    allowedActions: [\n      'KeyringController:getState',\n      'KeyringController:withKeyring',\n      'SnapController:handleRequest',\n      'AuthenticationController:getBearerToken',\n      'AuthenticationController:getSessionProfile',\n      'AuthenticationController:isSignedIn',\n      'AuthenticationController:performSignOut',\n      'AuthenticationController:performSignIn',\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: Messenger<AllowedActions, AllowedEvents>;\n  messenger: UserStorageControllerMessenger;\n};\n\n/**\n * Jest Mock Utility to generate a mock User Storage Messenger\n *\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 mockKeyringWithKeyring = typedMockFn('KeyringController:withKeyring');\n\n  const mockAccountsListAccounts = jest.fn();\n\n  const mockKeyringGetAccounts = jest.fn();\n  const mockKeyringAddAccounts = 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 (actionType === 'AuthenticationController:performSignOut') {\n      return mockAuthPerformSignOut();\n    }\n\n    if (actionType === 'KeyringController:getState') {\n      return { isUnlocked: true };\n    }\n\n    if (actionType === 'KeyringController:withKeyring') {\n      const [, ...params] = typedArgs;\n      const [, operation] = params;\n\n      const keyring = {\n        getAccounts: mockKeyringGetAccounts,\n        addAccounts: mockKeyringAddAccounts,\n      } as unknown as EthKeyring<never>;\n\n      return operation(keyring);\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    mockAuthPerformSignOut,\n    mockKeyringGetAccounts,\n    mockKeyringAddAccounts,\n    mockKeyringWithKeyring,\n    mockAccountsUpdateAccountMetadata,\n    mockAccountsListAccounts,\n    mockNetworkControllerGetState,\n    mockNetworkControllerAddNetwork,\n    mockNetworkControllerRemoveNetwork,\n    mockNetworkControllerUpdateNetwork,\n  };\n}\n"]}

package/dist/controllers/user-storage/account-syncing/__fixtures__/test-utils.cjs

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createExpectedAccountSyncBatchDeleteBody = exports.createExpectedAccountSyncBatchUpsertBody = exports.mockUserStorageMessengerForAccountSyncing = void 0;
+const keyring_controller_1 = require("@metamask/keyring-controller");
 const mockAccounts_1 = require("./mockAccounts.cjs");
 const encryption_1 = require("../../../../shared/encryption/index.cjs");
 const mockMessenger_1 = require("../../__fixtures__/mockMessenger.cjs");
@@ -15,9 +16,14 @@ const utils_1 = require("../utils.cjs");
  */
 function mockUserStorageMessengerForAccountSyncing(options) {
     const messengerMocks = (0, mockMessenger_1.mockUserStorageMessenger)();
-    messengerMocks.mockKeyringWithKeyring.mockImplementation(async () => {
+    messengerMocks.mockKeyringAddAccounts.mockImplementation(async () => {
         messengerMocks.baseMessenger.publish('AccountsController:accountAdded', mockAccounts_1.MOCK_INTERNAL_ACCOUNTS.ONE[0]);
-        return mockAccounts_1.MOCK_INTERNAL_ACCOUNTS.ONE[0].address;
+    });
+    messengerMocks.mockKeyringGetAccounts.mockImplementation(async () => {
+        return (options?.accounts?.accountsList
+            ?.filter((a) => a.metadata.keyring.type === keyring_controller_1.KeyringTypes.hd)
+            .map((a) => a.address) ??
+            mockAccounts_1.MOCK_INTERNAL_ACCOUNTS.ALL.map((a) => a.address));
     });
     messengerMocks.mockAccountsListAccounts.mockReturnValue((options?.accounts?.accountsList ??
         mockAccounts_1.MOCK_INTERNAL_ACCOUNTS.ALL));

package/dist/controllers/user-storage/account-syncing/__fixtures__/test-utils.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"test-utils.cjs","sourceRoot":"","sources":["../../../../../src/controllers/user-storage/account-syncing/__fixtures__/test-utils.ts"],"names":[],"mappings":";;;AAEA,qDAAwD;AACxD,wEAAiE;AACjE,wEAA4E;AAC5E,wCAAkE;AAElE;;;;;;;GAOG;AACH,SAAgB,yCAAyC,CAAC,OAIzD;IACC,MAAM,cAAc,GAAG,IAAA,wCAAwB,GAAE,CAAC;IAElD,cAAc,CAAC,sBAAsB,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAAE;QAClE,cAAc,CAAC,aAAa,CAAC,OAAO,CAClC,iCAAiC,EACjC,qCAAsB,CAAC,GAAG,CAAC,CAAC,CAAoB,CACjD,CAAC;QACF,OAAO,qCAAsB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,cAAc,CAAC,wBAAwB,CAAC,eAAe,CACrD,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY;QAC9B,qCAAsB,CAAC,GAAG,CAAsB,CACnD,CAAC;IAEF,OAAO,cAAc,CAAC;AACxB,CAAC;AArBD,8FAqBC;AAED;;;;;;GAMG;AACH,SAAgB,wCAAwC,CACtD,IAAiC,EACjC,UAAkB;IAElB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC;QAC1C,IAAA,6BAAgB,EAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC;QAC/C,IAAI,CAAC,SAAS,CAAC,IAAA,8CAAsC,EAAC,UAAU,CAAC,CAAC;KACnE,CAAC,CAAC;AACL,CAAC;AARD,4FAQC;AAED;;;;;;GAMG;AACH,SAAgB,wCAAwC,CACtD,IAAc,EACd,UAAkB;IAElB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAC3B,IAAA,6BAAgB,EAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,CAChD,CAAC;AACJ,CAAC;AAPD,4FAOC","sourcesContent":["import type { InternalAccount } from '@metamask/keyring-internal-api';\n\nimport { MOCK_INTERNAL_ACCOUNTS } from './mockAccounts';\nimport { createSHA256Hash } from '../../../../shared/encryption';\nimport { mockUserStorageMessenger } from '../../__fixtures__/mockMessenger';\nimport { mapInternalAccountToUserStorageAccount } from '../utils';\n\n/**\n * Test Utility - create a mock user storage messenger for account syncing tests\n *\n * @param options - options for the mock messenger\n * @param options.accounts - options for the accounts part of the controller\n * @param options.accounts.accountsList - list of accounts to return for the 'AccountsController:listAccounts' action\n * @returns Mock User Storage Messenger\n */\nexport function mockUserStorageMessengerForAccountSyncing(options?: {\n  accounts?: {\n    accountsList?: InternalAccount[];\n  };\n}) {\n  const messengerMocks = mockUserStorageMessenger();\n\n  messengerMocks.mockKeyringWithKeyring.mockImplementation(async () => {\n    messengerMocks.baseMessenger.publish(\n      'AccountsController:accountAdded',\n      MOCK_INTERNAL_ACCOUNTS.ONE[0] as InternalAccount,\n    );\n    return MOCK_INTERNAL_ACCOUNTS.ONE[0].address;\n  });\n\n  messengerMocks.mockAccountsListAccounts.mockReturnValue(\n    (options?.accounts?.accountsList ??\n      MOCK_INTERNAL_ACCOUNTS.ALL) as InternalAccount[],\n  );\n\n  return messengerMocks;\n}\n\n/**\n * Test Utility - creates a realistic expected batch upsert payload\n *\n * @param data - data supposed to be upserted\n * @param storageKey - storage key\n * @returns expected body\n */\nexport function createExpectedAccountSyncBatchUpsertBody(\n  data: [string, InternalAccount][],\n  storageKey: string,\n) {\n  return data.map(([entryKey, entryValue]) => [\n    createSHA256Hash(String(entryKey) + storageKey),\n    JSON.stringify(mapInternalAccountToUserStorageAccount(entryValue)),\n  ]);\n}\n\n/**\n * Test Utility - creates a realistic expected batch delete payload\n *\n * @param data - data supposed to be deleted\n * @param storageKey - storage key\n * @returns expected body\n */\nexport function createExpectedAccountSyncBatchDeleteBody(\n  data: string[],\n  storageKey: string,\n) {\n  return data.map((entryKey) =>\n    createSHA256Hash(String(entryKey) + storageKey),\n  );\n}\n"]}
+{"version":3,"file":"test-utils.cjs","sourceRoot":"","sources":["../../../../../src/controllers/user-storage/account-syncing/__fixtures__/test-utils.ts"],"names":[],"mappings":";;;AAAA,qEAA4D;AAG5D,qDAAwD;AACxD,wEAAiE;AACjE,wEAA4E;AAC5E,wCAAkE;AAElE;;;;;;;GAOG;AACH,SAAgB,yCAAyC,CAAC,OAIzD;IACC,MAAM,cAAc,GAAG,IAAA,wCAAwB,GAAE,CAAC;IAElD,cAAc,CAAC,sBAAsB,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAAE;QAClE,cAAc,CAAC,aAAa,CAAC,OAAO,CAClC,iCAAiC,EACjC,qCAAsB,CAAC,GAAG,CAAC,CAAC,CAAoB,CACjD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,cAAc,CAAC,sBAAsB,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAAE;QAClE,OAAO,CACL,OAAO,EAAE,QAAQ,EAAE,YAAY;YAC7B,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAK,iCAAY,CAAC,EAAE,CAAC;aAC3D,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;YACxB,qCAAsB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CACjD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,cAAc,CAAC,wBAAwB,CAAC,eAAe,CACrD,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY;QAC9B,qCAAsB,CAAC,GAAG,CAAsB,CACnD,CAAC;IAEF,OAAO,cAAc,CAAC;AACxB,CAAC;AA7BD,8FA6BC;AAED;;;;;;GAMG;AACH,SAAgB,wCAAwC,CACtD,IAAiC,EACjC,UAAkB;IAElB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC;QAC1C,IAAA,6BAAgB,EAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC;QAC/C,IAAI,CAAC,SAAS,CAAC,IAAA,8CAAsC,EAAC,UAAU,CAAC,CAAC;KACnE,CAAC,CAAC;AACL,CAAC;AARD,4FAQC;AAED;;;;;;GAMG;AACH,SAAgB,wCAAwC,CACtD,IAAc,EACd,UAAkB;IAElB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAC3B,IAAA,6BAAgB,EAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,CAChD,CAAC;AACJ,CAAC;AAPD,4FAOC","sourcesContent":["import { KeyringTypes } from '@metamask/keyring-controller';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\n\nimport { MOCK_INTERNAL_ACCOUNTS } from './mockAccounts';\nimport { createSHA256Hash } from '../../../../shared/encryption';\nimport { mockUserStorageMessenger } from '../../__fixtures__/mockMessenger';\nimport { mapInternalAccountToUserStorageAccount } from '../utils';\n\n/**\n * Test Utility - create a mock user storage messenger for account syncing tests\n *\n * @param options - options for the mock messenger\n * @param options.accounts - options for the accounts part of the controller\n * @param options.accounts.accountsList - list of accounts to return for the 'AccountsController:listAccounts' action\n * @returns Mock User Storage Messenger\n */\nexport function mockUserStorageMessengerForAccountSyncing(options?: {\n  accounts?: {\n    accountsList?: InternalAccount[];\n  };\n}) {\n  const messengerMocks = mockUserStorageMessenger();\n\n  messengerMocks.mockKeyringAddAccounts.mockImplementation(async () => {\n    messengerMocks.baseMessenger.publish(\n      'AccountsController:accountAdded',\n      MOCK_INTERNAL_ACCOUNTS.ONE[0] as InternalAccount,\n    );\n  });\n\n  messengerMocks.mockKeyringGetAccounts.mockImplementation(async () => {\n    return (\n      options?.accounts?.accountsList\n        ?.filter((a) => a.metadata.keyring.type === KeyringTypes.hd)\n        .map((a) => a.address) ??\n      MOCK_INTERNAL_ACCOUNTS.ALL.map((a) => a.address)\n    );\n  });\n\n  messengerMocks.mockAccountsListAccounts.mockReturnValue(\n    (options?.accounts?.accountsList ??\n      MOCK_INTERNAL_ACCOUNTS.ALL) as InternalAccount[],\n  );\n\n  return messengerMocks;\n}\n\n/**\n * Test Utility - creates a realistic expected batch upsert payload\n *\n * @param data - data supposed to be upserted\n * @param storageKey - storage key\n * @returns expected body\n */\nexport function createExpectedAccountSyncBatchUpsertBody(\n  data: [string, InternalAccount][],\n  storageKey: string,\n) {\n  return data.map(([entryKey, entryValue]) => [\n    createSHA256Hash(String(entryKey) + storageKey),\n    JSON.stringify(mapInternalAccountToUserStorageAccount(entryValue)),\n  ]);\n}\n\n/**\n * Test Utility - creates a realistic expected batch delete payload\n *\n * @param data - data supposed to be deleted\n * @param storageKey - storage key\n * @returns expected body\n */\nexport function createExpectedAccountSyncBatchDeleteBody(\n  data: string[],\n  storageKey: string,\n) {\n  return data.map((entryKey) =>\n    createSHA256Hash(String(entryKey) + storageKey),\n  );\n}\n"]}

package/dist/controllers/user-storage/account-syncing/__fixtures__/test-utils.d.cts

@@ -32,7 +32,7 @@ export declare function mockUserStorageMessengerForAccountSyncing(options?: {
             identifierId: string;
             profileId: string;
         }>;
-    } | import("@metamask/keyring-controller").KeyringControllerGetStateAction | import("@metamask/accounts-controller").AccountsControllerListAccountsAction | import("@metamask/accounts-controller").AccountsControllerUpdateAccountMetadataAction | 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("@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" | "AccountsController:listAccounts" | "AccountsController:updateAccountMetadata" | "NetworkController:getState" | "NetworkController:addNetwork" | "NetworkController:removeNetwork" | "NetworkController:updateNetwork", "KeyringController:lock" | "KeyringController:unlock" | "AccountsController:accountAdded" | "AccountsController:accountRenamed" | "NetworkController:networkRemoved">;
+    } | import("@metamask/keyring-controller").KeyringControllerGetStateAction | import("@metamask/accounts-controller").AccountsControllerListAccountsAction | import("@metamask/accounts-controller").AccountsControllerUpdateAccountMetadataAction | import("@metamask/keyring-controller").KeyringControllerWithKeyringAction | 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("@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" | "AccountsController:listAccounts" | "AccountsController:updateAccountMetadata" | "KeyringController:withKeyring" | "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>, []>;
@@ -43,6 +43,8 @@ export declare function mockUserStorageMessengerForAccountSyncing(options?: {
     mockAuthPerformSignIn: jest.Mock<Promise<string>, []>;
     mockAuthIsSignedIn: jest.Mock<boolean, []>;
     mockAuthPerformSignOut: jest.Mock<void, []>;
+    mockKeyringGetAccounts: jest.Mock<any, any>;
+    mockKeyringAddAccounts: jest.Mock<any, any>;
     mockKeyringWithKeyring: jest.Mock<Promise<unknown>, [selector: import("@metamask/keyring-controller").KeyringSelector, operation: (keyring: import("@metamask/keyring-internal-api").EthKeyring<import("@metamask/utils").Json>) => Promise<unknown>]>;
     mockAccountsUpdateAccountMetadata: jest.Mock<void, [accountId: string, metadata: Partial<{
         name: string;

package/dist/controllers/user-storage/account-syncing/__fixtures__/test-utils.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"test-utils.d.cts","sourceRoot":"","sources":["../../../../../src/controllers/user-storage/account-syncing/__fixtures__/test-utils.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AAOtE;;;;;;;GAOG;AACH,wBAAgB,yCAAyC,CAAC,OAAO,CAAC,EAAE;IAClE,QAAQ,CAAC,EAAE;QACT,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;KAClC,CAAC;CACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiBA;AAED;;;;;;GAMG;AACH,wBAAgB,wCAAwC,CACtD,IAAI,EAAE,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE,EACjC,UAAU,EAAE,MAAM,cAMnB;AAED;;;;;;GAMG;AACH,wBAAgB,wCAAwC,CACtD,IAAI,EAAE,MAAM,EAAE,EACd,UAAU,EAAE,MAAM,YAKnB"}
+{"version":3,"file":"test-utils.d.cts","sourceRoot":"","sources":["../../../../../src/controllers/user-storage/account-syncing/__fixtures__/test-utils.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AAOtE;;;;;;;GAOG;AACH,wBAAgB,yCAAyC,CAAC,OAAO,CAAC,EAAE;IAClE,QAAQ,CAAC,EAAE;QACT,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;KAClC,CAAC;CACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAyBA;AAED;;;;;;GAMG;AACH,wBAAgB,wCAAwC,CACtD,IAAI,EAAE,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE,EACjC,UAAU,EAAE,MAAM,cAMnB;AAED;;;;;;GAMG;AACH,wBAAgB,wCAAwC,CACtD,IAAI,EAAE,MAAM,EAAE,EACd,UAAU,EAAE,MAAM,YAKnB"}

package/dist/controllers/user-storage/account-syncing/__fixtures__/test-utils.d.mts

@@ -32,7 +32,7 @@ export declare function mockUserStorageMessengerForAccountSyncing(options?: {
             identifierId: string;
             profileId: string;
         }>;
-    } | import("@metamask/keyring-controller").KeyringControllerGetStateAction | import("@metamask/accounts-controller").AccountsControllerListAccountsAction | import("@metamask/accounts-controller").AccountsControllerUpdateAccountMetadataAction | 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("@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" | "AccountsController:listAccounts" | "AccountsController:updateAccountMetadata" | "NetworkController:getState" | "NetworkController:addNetwork" | "NetworkController:removeNetwork" | "NetworkController:updateNetwork", "KeyringController:lock" | "KeyringController:unlock" | "AccountsController:accountAdded" | "AccountsController:accountRenamed" | "NetworkController:networkRemoved">;
+    } | import("@metamask/keyring-controller").KeyringControllerGetStateAction | import("@metamask/accounts-controller").AccountsControllerListAccountsAction | import("@metamask/accounts-controller").AccountsControllerUpdateAccountMetadataAction | import("@metamask/keyring-controller").KeyringControllerWithKeyringAction | 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("@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" | "AccountsController:listAccounts" | "AccountsController:updateAccountMetadata" | "KeyringController:withKeyring" | "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>, []>;
@@ -43,6 +43,8 @@ export declare function mockUserStorageMessengerForAccountSyncing(options?: {
     mockAuthPerformSignIn: jest.Mock<Promise<string>, []>;
     mockAuthIsSignedIn: jest.Mock<boolean, []>;
     mockAuthPerformSignOut: jest.Mock<void, []>;
+    mockKeyringGetAccounts: jest.Mock<any, any>;
+    mockKeyringAddAccounts: jest.Mock<any, any>;
     mockKeyringWithKeyring: jest.Mock<Promise<unknown>, [selector: import("@metamask/keyring-controller").KeyringSelector, operation: (keyring: import("@metamask/keyring-internal-api").EthKeyring<import("@metamask/utils").Json>) => Promise<unknown>]>;
     mockAccountsUpdateAccountMetadata: jest.Mock<void, [accountId: string, metadata: Partial<{
         name: string;

package/dist/controllers/user-storage/account-syncing/__fixtures__/test-utils.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"test-utils.d.mts","sourceRoot":"","sources":["../../../../../src/controllers/user-storage/account-syncing/__fixtures__/test-utils.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AAOtE;;;;;;;GAOG;AACH,wBAAgB,yCAAyC,CAAC,OAAO,CAAC,EAAE;IAClE,QAAQ,CAAC,EAAE;QACT,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;KAClC,CAAC;CACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiBA;AAED;;;;;;GAMG;AACH,wBAAgB,wCAAwC,CACtD,IAAI,EAAE,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE,EACjC,UAAU,EAAE,MAAM,cAMnB;AAED;;;;;;GAMG;AACH,wBAAgB,wCAAwC,CACtD,IAAI,EAAE,MAAM,EAAE,EACd,UAAU,EAAE,MAAM,YAKnB"}
+{"version":3,"file":"test-utils.d.mts","sourceRoot":"","sources":["../../../../../src/controllers/user-storage/account-syncing/__fixtures__/test-utils.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AAOtE;;;;;;;GAOG;AACH,wBAAgB,yCAAyC,CAAC,OAAO,CAAC,EAAE;IAClE,QAAQ,CAAC,EAAE;QACT,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;KAClC,CAAC;CACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAyBA;AAED;;;;;;GAMG;AACH,wBAAgB,wCAAwC,CACtD,IAAI,EAAE,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE,EACjC,UAAU,EAAE,MAAM,cAMnB;AAED;;;;;;GAMG;AACH,wBAAgB,wCAAwC,CACtD,IAAI,EAAE,MAAM,EAAE,EACd,UAAU,EAAE,MAAM,YAKnB"}

package/dist/controllers/user-storage/account-syncing/__fixtures__/test-utils.mjs

@@ -1,3 +1,4 @@
+import { KeyringTypes } from "@metamask/keyring-controller";
 import { MOCK_INTERNAL_ACCOUNTS } from "./mockAccounts.mjs";
 import { createSHA256Hash } from "../../../../shared/encryption/index.mjs";
 import { mockUserStorageMessenger } from "../../__fixtures__/mockMessenger.mjs";
@@ -12,9 +13,14 @@ import { mapInternalAccountToUserStorageAccount } from "../utils.mjs";
  */
 export function mockUserStorageMessengerForAccountSyncing(options) {
     const messengerMocks = mockUserStorageMessenger();
-    messengerMocks.mockKeyringWithKeyring.mockImplementation(async () => {
+    messengerMocks.mockKeyringAddAccounts.mockImplementation(async () => {
         messengerMocks.baseMessenger.publish('AccountsController:accountAdded', MOCK_INTERNAL_ACCOUNTS.ONE[0]);
-        return MOCK_INTERNAL_ACCOUNTS.ONE[0].address;
+    });
+    messengerMocks.mockKeyringGetAccounts.mockImplementation(async () => {
+        return (options?.accounts?.accountsList
+            ?.filter((a) => a.metadata.keyring.type === KeyringTypes.hd)
+            .map((a) => a.address) ??
+            MOCK_INTERNAL_ACCOUNTS.ALL.map((a) => a.address));
     });
     messengerMocks.mockAccountsListAccounts.mockReturnValue((options?.accounts?.accountsList ??
         MOCK_INTERNAL_ACCOUNTS.ALL));

package/dist/controllers/user-storage/account-syncing/__fixtures__/test-utils.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"test-utils.mjs","sourceRoot":"","sources":["../../../../../src/controllers/user-storage/account-syncing/__fixtures__/test-utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,sBAAsB,EAAE,2BAAuB;AACxD,OAAO,EAAE,gBAAgB,EAAE,gDAAsC;AACjE,OAAO,EAAE,wBAAwB,EAAE,6CAAyC;AAC5E,OAAO,EAAE,sCAAsC,EAAE,qBAAiB;AAElE;;;;;;;GAOG;AACH,MAAM,UAAU,yCAAyC,CAAC,OAIzD;IACC,MAAM,cAAc,GAAG,wBAAwB,EAAE,CAAC;IAElD,cAAc,CAAC,sBAAsB,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAAE;QAClE,cAAc,CAAC,aAAa,CAAC,OAAO,CAClC,iCAAiC,EACjC,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAoB,CACjD,CAAC;QACF,OAAO,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,cAAc,CAAC,wBAAwB,CAAC,eAAe,CACrD,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY;QAC9B,sBAAsB,CAAC,GAAG,CAAsB,CACnD,CAAC;IAEF,OAAO,cAAc,CAAC;AACxB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,wCAAwC,CACtD,IAAiC,EACjC,UAAkB;IAElB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC;QAC1C,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC;QAC/C,IAAI,CAAC,SAAS,CAAC,sCAAsC,CAAC,UAAU,CAAC,CAAC;KACnE,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,wCAAwC,CACtD,IAAc,EACd,UAAkB;IAElB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAC3B,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,CAChD,CAAC;AACJ,CAAC","sourcesContent":["import type { InternalAccount } from '@metamask/keyring-internal-api';\n\nimport { MOCK_INTERNAL_ACCOUNTS } from './mockAccounts';\nimport { createSHA256Hash } from '../../../../shared/encryption';\nimport { mockUserStorageMessenger } from '../../__fixtures__/mockMessenger';\nimport { mapInternalAccountToUserStorageAccount } from '../utils';\n\n/**\n * Test Utility - create a mock user storage messenger for account syncing tests\n *\n * @param options - options for the mock messenger\n * @param options.accounts - options for the accounts part of the controller\n * @param options.accounts.accountsList - list of accounts to return for the 'AccountsController:listAccounts' action\n * @returns Mock User Storage Messenger\n */\nexport function mockUserStorageMessengerForAccountSyncing(options?: {\n  accounts?: {\n    accountsList?: InternalAccount[];\n  };\n}) {\n  const messengerMocks = mockUserStorageMessenger();\n\n  messengerMocks.mockKeyringWithKeyring.mockImplementation(async () => {\n    messengerMocks.baseMessenger.publish(\n      'AccountsController:accountAdded',\n      MOCK_INTERNAL_ACCOUNTS.ONE[0] as InternalAccount,\n    );\n    return MOCK_INTERNAL_ACCOUNTS.ONE[0].address;\n  });\n\n  messengerMocks.mockAccountsListAccounts.mockReturnValue(\n    (options?.accounts?.accountsList ??\n      MOCK_INTERNAL_ACCOUNTS.ALL) as InternalAccount[],\n  );\n\n  return messengerMocks;\n}\n\n/**\n * Test Utility - creates a realistic expected batch upsert payload\n *\n * @param data - data supposed to be upserted\n * @param storageKey - storage key\n * @returns expected body\n */\nexport function createExpectedAccountSyncBatchUpsertBody(\n  data: [string, InternalAccount][],\n  storageKey: string,\n) {\n  return data.map(([entryKey, entryValue]) => [\n    createSHA256Hash(String(entryKey) + storageKey),\n    JSON.stringify(mapInternalAccountToUserStorageAccount(entryValue)),\n  ]);\n}\n\n/**\n * Test Utility - creates a realistic expected batch delete payload\n *\n * @param data - data supposed to be deleted\n * @param storageKey - storage key\n * @returns expected body\n */\nexport function createExpectedAccountSyncBatchDeleteBody(\n  data: string[],\n  storageKey: string,\n) {\n  return data.map((entryKey) =>\n    createSHA256Hash(String(entryKey) + storageKey),\n  );\n}\n"]}
+{"version":3,"file":"test-utils.mjs","sourceRoot":"","sources":["../../../../../src/controllers/user-storage/account-syncing/__fixtures__/test-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,qCAAqC;AAG5D,OAAO,EAAE,sBAAsB,EAAE,2BAAuB;AACxD,OAAO,EAAE,gBAAgB,EAAE,gDAAsC;AACjE,OAAO,EAAE,wBAAwB,EAAE,6CAAyC;AAC5E,OAAO,EAAE,sCAAsC,EAAE,qBAAiB;AAElE;;;;;;;GAOG;AACH,MAAM,UAAU,yCAAyC,CAAC,OAIzD;IACC,MAAM,cAAc,GAAG,wBAAwB,EAAE,CAAC;IAElD,cAAc,CAAC,sBAAsB,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAAE;QAClE,cAAc,CAAC,aAAa,CAAC,OAAO,CAClC,iCAAiC,EACjC,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAoB,CACjD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,cAAc,CAAC,sBAAsB,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAAE;QAClE,OAAO,CACL,OAAO,EAAE,QAAQ,EAAE,YAAY;YAC7B,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAK,YAAY,CAAC,EAAE,CAAC;aAC3D,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;YACxB,sBAAsB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CACjD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,cAAc,CAAC,wBAAwB,CAAC,eAAe,CACrD,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY;QAC9B,sBAAsB,CAAC,GAAG,CAAsB,CACnD,CAAC;IAEF,OAAO,cAAc,CAAC;AACxB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,wCAAwC,CACtD,IAAiC,EACjC,UAAkB;IAElB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC;QAC1C,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC;QAC/C,IAAI,CAAC,SAAS,CAAC,sCAAsC,CAAC,UAAU,CAAC,CAAC;KACnE,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,wCAAwC,CACtD,IAAc,EACd,UAAkB;IAElB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAC3B,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,CAChD,CAAC;AACJ,CAAC","sourcesContent":["import { KeyringTypes } from '@metamask/keyring-controller';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\n\nimport { MOCK_INTERNAL_ACCOUNTS } from './mockAccounts';\nimport { createSHA256Hash } from '../../../../shared/encryption';\nimport { mockUserStorageMessenger } from '../../__fixtures__/mockMessenger';\nimport { mapInternalAccountToUserStorageAccount } from '../utils';\n\n/**\n * Test Utility - create a mock user storage messenger for account syncing tests\n *\n * @param options - options for the mock messenger\n * @param options.accounts - options for the accounts part of the controller\n * @param options.accounts.accountsList - list of accounts to return for the 'AccountsController:listAccounts' action\n * @returns Mock User Storage Messenger\n */\nexport function mockUserStorageMessengerForAccountSyncing(options?: {\n  accounts?: {\n    accountsList?: InternalAccount[];\n  };\n}) {\n  const messengerMocks = mockUserStorageMessenger();\n\n  messengerMocks.mockKeyringAddAccounts.mockImplementation(async () => {\n    messengerMocks.baseMessenger.publish(\n      'AccountsController:accountAdded',\n      MOCK_INTERNAL_ACCOUNTS.ONE[0] as InternalAccount,\n    );\n  });\n\n  messengerMocks.mockKeyringGetAccounts.mockImplementation(async () => {\n    return (\n      options?.accounts?.accountsList\n        ?.filter((a) => a.metadata.keyring.type === KeyringTypes.hd)\n        .map((a) => a.address) ??\n      MOCK_INTERNAL_ACCOUNTS.ALL.map((a) => a.address)\n    );\n  });\n\n  messengerMocks.mockAccountsListAccounts.mockReturnValue(\n    (options?.accounts?.accountsList ??\n      MOCK_INTERNAL_ACCOUNTS.ALL) as InternalAccount[],\n  );\n\n  return messengerMocks;\n}\n\n/**\n * Test Utility - creates a realistic expected batch upsert payload\n *\n * @param data - data supposed to be upserted\n * @param storageKey - storage key\n * @returns expected body\n */\nexport function createExpectedAccountSyncBatchUpsertBody(\n  data: [string, InternalAccount][],\n  storageKey: string,\n) {\n  return data.map(([entryKey, entryValue]) => [\n    createSHA256Hash(String(entryKey) + storageKey),\n    JSON.stringify(mapInternalAccountToUserStorageAccount(entryValue)),\n  ]);\n}\n\n/**\n * Test Utility - creates a realistic expected batch delete payload\n *\n * @param data - data supposed to be deleted\n * @param storageKey - storage key\n * @returns expected body\n */\nexport function createExpectedAccountSyncBatchDeleteBody(\n  data: string[],\n  storageKey: string,\n) {\n  return data.map((entryKey) =>\n    createSHA256Hash(String(entryKey) + storageKey),\n  );\n}\n"]}

package/dist/controllers/user-storage/account-syncing/controller-integration.cjs

@@ -19,7 +19,7 @@ async function saveInternalAccountToUserStorage(internalAccount, config, options
     if (!isAccountSyncingEnabled ||
         !(0, sync_utils_1.canPerformAccountSyncing)(config, options) ||
         !(0, keyring_api_1.isEvmAccountType)(internalAccount.type) ||
-        !(0, utils_1.doesInternalAccountHaveCorrectKeyringType)(internalAccount)) {
+        !(await (0, utils_1.isInternalAccountFromPrimarySRPHdKeyring)(internalAccount, options))) {
         return;
     }
     try {
@@ -100,12 +100,15 @@ async function syncInternalAccountsWithUserStorage(config, options) {
             const numberOfAccountsToAdd = Math.min(userStorageAccountsList.length, maxNumberOfAccountsToAdd) -
                 internalAccountsList.length;
             // Create new accounts to match the user storage accounts list
+            // NOTE: we only support the primary SRP HD keyring for now
+            // This is why we are hardcoding the index to 0
             await getMessenger().call('KeyringController:withKeyring', {
                 type: keyring_controller_1.KeyringTypes.hd,
+                index: 0,
             }, async (keyring) => {
                 keyring.addAccounts(numberOfAccountsToAdd);
             });
-            // Keeping this for analytics purposes, but should probably be re-thought
+            // TODO: below code is kept for analytics but should probably be re-thought
             for (let i = 0; i < numberOfAccountsToAdd; i++) {
                 onAccountAdded?.();
             }