@metamask/profile-sync-controller 17.0.0 → 18.0.0

package/CHANGELOG.md

@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [18.0.0]
+
+### Added
+
+- **BREAKING:** Add Contacts Syncing, a Backup and Sync feature ([#5776](https://github.com/MetaMask/core/pull/5776))
+  - React to contacts update and deletion events from `AddressBookController` and update the corresponding entries in user storage
+  - Dispatch downward "Big sync" after onboarding & wallet unlock
+    - Big sync will download contacts from user storage and resolve potential conflicts
+
+## [17.1.0]
+
+### Added
+
+- Add `EventQueue` class util to guarantee the order of some user-storage updates ([#5937](https://github.com/MetaMask/core/pull/5937))
+  - Add an instance of `EventQueue` to `UserStorageController`
+  - Event subscriptions for `AccountsController:accountAdded` and `AccountsController:accountRenamed` are now pushing their callbacks to the `UserStorageController` instance of `EventQueue`, so that we stay in control of the order these callbacks are fulfilled.
+
 ## [17.0.0]
 
 ### Added
@@ -614,7 +631,9 @@ 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@17.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@18.0.0...HEAD
+[18.0.0]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@17.1.0...@metamask/profile-sync-controller@18.0.0
+[17.1.0]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@17.0.0...@metamask/profile-sync-controller@17.1.0
 [17.0.0]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@16.0.0...@metamask/profile-sync-controller@17.0.0
 [16.0.0]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@15.0.0...@metamask/profile-sync-controller@16.0.0
 [15.0.0]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@14.0.0...@metamask/profile-sync-controller@15.0.0

package/dist/controllers/user-storage/UserStorageController.cjs

@@ -18,14 +18,19 @@ const keyring_controller_1 = require("@metamask/keyring-controller");
 const controller_integration_1 = require("./account-syncing/controller-integration.cjs");
 const setup_subscriptions_1 = require("./account-syncing/setup-subscriptions.cjs");
 const constants_1 = require("./constants.cjs");
-const controller_integration_2 = require("./network-syncing/controller-integration.cjs");
+const controller_integration_2 = require("./contact-syncing/controller-integration.cjs");
+const setup_subscriptions_2 = require("./contact-syncing/setup-subscriptions.cjs");
+const controller_integration_3 = require("./network-syncing/controller-integration.cjs");
 const sdk_1 = require("../../sdk/index.cjs");
+const event_queue_1 = require("../../shared/utils/event-queue.cjs");
 const auth_snap_requests_1 = require("../authentication/auth-snap-requests.cjs");
 const controllerName = 'UserStorageController';
 exports.defaultState = {
     isBackupAndSyncEnabled: true,
     isBackupAndSyncUpdateLoading: false,
     isAccountSyncingEnabled: true,
+    isContactSyncingEnabled: true,
+    isContactSyncingInProgress: false,
     hasAccountSyncingSyncedAtLeastOnce: false,
     isAccountSyncingReadyToBeDispatched: false,
     isAccountSyncingInProgress: false,
@@ -43,6 +48,14 @@ const metadata = {
         persist: true,
         anonymous: true,
     },
+    isContactSyncingEnabled: {
+        persist: true,
+        anonymous: true,
+    },
+    isContactSyncingInProgress: {
+        persist: false,
+        anonymous: false,
+    },
     hasAccountSyncingSyncedAtLeastOnce: {
         persist: true,
         anonymous: false,
@@ -111,6 +124,7 @@ class UserStorageController extends base_controller_1.BaseController {
             },
         });
         _UserStorageController_nativeScryptCrypto.set(this, undefined);
+        this.eventQueue = new event_queue_1.EventQueue();
         _UserStorageController__snapSignMessageCache.set(this, {});
         __classPrivateFieldGet(this, _UserStorageController_env, "f").isNetworkSyncingEnabled = Boolean(env?.isNetworkSyncingEnabled);
         __classPrivateFieldSet(this, _UserStorageController_config, config, "f");
@@ -139,9 +153,14 @@ class UserStorageController extends base_controller_1.BaseController {
             getUserStorageControllerInstance: () => this,
             getMessenger: () => this.messagingSystem,
         });
+        // Contact Syncing
+        (0, setup_subscriptions_2.setupContactSyncingSubscriptions)({
+            getUserStorageControllerInstance: () => this,
+            getMessenger: () => this.messagingSystem,
+        });
         // Network Syncing
         if (__classPrivateFieldGet(this, _UserStorageController_env, "f").isNetworkSyncingEnabled) {
-            (0, controller_integration_2.startNetworkSyncing)({
+            (0, controller_integration_3.startNetworkSyncing)({
                 messenger,
                 getUserStorageControllerInstance: () => this,
                 isMutationSyncBlocked: () => !this.state.hasNetworkSyncingSyncedAtLeastOnce,
@@ -301,6 +320,9 @@ class UserStorageController extends base_controller_1.BaseController {
                 if (feature === constants_1.BACKUPANDSYNC_FEATURES.accountSyncing) {
                     state.isAccountSyncingEnabled = enabled;
                 }
+                if (feature === constants_1.BACKUPANDSYNC_FEATURES.contactSyncing) {
+                    state.isContactSyncingEnabled = enabled;
+                }
             });
         }
         catch (e) {
@@ -330,6 +352,16 @@ class UserStorageController extends base_controller_1.BaseController {
             state.isAccountSyncingInProgress = isAccountSyncingInProgress;
         });
     }
+    /**
+     * Sets the isContactSyncingInProgress flag to prevent infinite loops during contact synchronization
+     *
+     * @param isContactSyncingInProgress - Whether contact syncing is in progress
+     */
+    async setIsContactSyncingInProgress(isContactSyncingInProgress) {
+        this.update((state) => {
+            state.isContactSyncingInProgress = isContactSyncingInProgress;
+        });
+    }
     /**
      * Syncs the internal accounts list with the user storage accounts list.
      * This method is used to make sure that the internal accounts list is up-to-date with the user storage accounts list and vice-versa.
@@ -376,7 +408,7 @@ class UserStorageController extends base_controller_1.BaseController {
             return;
         }
         const profileId = await __classPrivateFieldGet(this, _UserStorageController_auth, "f").getProfileId();
-        await (0, controller_integration_2.performMainNetworkSync)({
+        await (0, controller_integration_3.performMainNetworkSync)({
             messenger: this.messagingSystem,
             getUserStorageControllerInstance: () => this,
             maxNetworksToAdd: __classPrivateFieldGet(this, _UserStorageController_config, "f")?.networkSyncing?.maxNumberOfNetworksToAdd,
@@ -388,6 +420,29 @@ class UserStorageController extends base_controller_1.BaseController {
             s.hasNetworkSyncingSyncedAtLeastOnce = true;
         });
     }
+    /**
+     * Syncs the address book list with the user storage address book list.
+     * This method is used to make sure that the address book list is up-to-date with the user storage address book list and vice-versa.
+     * It will add new contacts to the address book list, update/merge conflicting contacts and re-upload the results in some cases to the user storage.
+     */
+    async syncContactsWithUserStorage() {
+        const profileId = await __classPrivateFieldGet(this, _UserStorageController_auth, "f").getProfileId();
+        const config = {
+            onContactUpdated: () => {
+                __classPrivateFieldGet(this, _UserStorageController_config, "f")?.contactSyncing?.onContactUpdated?.(profileId);
+            },
+            onContactDeleted: () => {
+                __classPrivateFieldGet(this, _UserStorageController_config, "f")?.contactSyncing?.onContactDeleted?.(profileId);
+            },
+            onContactSyncErroneousSituation: (errorMessage, sentryContext) => {
+                __classPrivateFieldGet(this, _UserStorageController_config, "f")?.contactSyncing?.onContactSyncErroneousSituation?.(profileId, errorMessage, sentryContext);
+            },
+        };
+        await (0, controller_integration_2.syncContactsWithUserStorage)(config, {
+            getMessenger: () => this.messagingSystem,
+            getUserStorageControllerInstance: () => this,
+        });
+    }
 }
 _UserStorageController_env = new WeakMap(), _UserStorageController_userStorage = new WeakMap(), _UserStorageController_auth = new WeakMap(), _UserStorageController_config = new WeakMap(), _UserStorageController_isUnlocked = new WeakMap(), _UserStorageController_storageKeyCache = new WeakMap(), _UserStorageController_keyringController = new WeakMap(), _UserStorageController_nativeScryptCrypto = new WeakMap(), _UserStorageController__snapSignMessageCache = new WeakMap(), _UserStorageController_instances = new WeakSet(), _UserStorageController_registerMessageHandlers = function _UserStorageController_registerMessageHandlers() {
     this.messagingSystem.registerActionHandler('UserStorageController:performGetStorage', this.performGetStorage.bind(this));

package/dist/controllers/user-storage/UserStorageController.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"UserStorageController.cjs","sourceRoot":"","sources":["../../../src/controllers/user-storage/UserStorageController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAYA,+DAA2D;AAC3D,qEAMsC;AAWtC,yFAGkD;AAClD,mFAAyF;AACzF,+CAAqD;AACrD,yFAGkD;AAClD,6CAA6C;AAO7C,iFAAoF;AAQpF,MAAM,cAAc,GAAG,uBAAuB,CAAC;AAoClC,QAAA,YAAY,GAA+B;IACtD,sBAAsB,EAAE,IAAI;IAC5B,4BAA4B,EAAE,KAAK;IACnC,uBAAuB,EAAE,IAAI;IAC7B,kCAAkC,EAAE,KAAK;IACzC,mCAAmC,EAAE,KAAK;IAC1C,0BAA0B,EAAE,KAAK;CAClC,CAAC;AAEF,MAAM,QAAQ,GAA8C;IAC1D,sBAAsB,EAAE;QACtB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,IAAI;KAChB;IACD,4BAA4B,EAAE;QAC5B,OAAO,EAAE,KAAK;QACd,SAAS,EAAE,KAAK;KACjB;IACD,uBAAuB,EAAE;QACvB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,IAAI;KAChB;IACD,kCAAkC,EAAE;QAClC,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;KACjB;IACD,mCAAmC,EAAE;QACnC,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;KACjB;IACD,0BAA0B,EAAE;QAC1B,OAAO,EAAE,KAAK;QACd,SAAS,EAAE,KAAK;KACjB;IACD,kCAAkC,EAAE;QAClC,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;KACjB;CACF,CAAC;AA6IF;;;;;;;GAOG;AACH,MAAqB,qBAAsB,SAAQ,gCAIlD;IAoDC,YAAY,EACV,SAAS,EACT,KAAK,EACL,GAAG,EACH,MAAM,EACN,kBAAkB,GASnB;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ;YACR,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE,EAAE,GAAG,oBAAY,EAAE,GAAG,KAAK,EAAE;SACrC,CAAC,CAAC;;QAvEL,4DAA4D;QAC5D,wDAAwD;QAC/C,qCAAO;YACd,uBAAuB,EAAE,KAAK;SAC/B,EAAC;QAEO,qDAA0B;QAE1B,sCAAQ;YACf,YAAY,EAAE,KAAK,EAAE,eAAwB,EAAE,EAAE;gBAC/C,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CACpD,4CAA4C,EAC5C,eAAe,CAChB,CAAC;gBACF,OAAO,cAAc,EAAE,SAAS,CAAC;YACnC,CAAC;YACD,UAAU,EAAE,GAAG,EAAE;gBACf,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;YAC1E,CAAC;YACD,MAAM,EAAE,KAAK,IAAI,EAAE;gBACjB,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CACpC,wCAAwC,CACzC,CAAC;YACJ,CAAC;SACF,EAAC;QAEO,gDAA2B;QAEpC,4CAAc,KAAK,EAAC;QAEpB,iDAAyD,EAAE,EAAC;QAEnD,mDAAqB;YAC5B,6BAA6B,EAAE,GAAG,EAAE;gBAClC,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC9C,4BAA4B,CAC7B,CAAC;gBACF,uBAAA,IAAI,qCAAe,UAAU,MAAA,CAAC;gBAE9B,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,0BAA0B,EAAE,GAAG,EAAE;oBAC9D,uBAAA,IAAI,qCAAe,IAAI,MAAA,CAAC;gBAC1B,CAAC,CAAC,CAAC;gBAEH,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,wBAAwB,EAAE,GAAG,EAAE;oBAC5D,uBAAA,IAAI,qCAAe,KAAK,MAAA,CAAC;gBAC3B,CAAC,CAAC,CAAC;YACL,CAAC;SACF,EAAC;QAEO,oDAAgD,SAAS,EAAC;QA6SnE,uDAA+D,EAAE,EAAC;QArRhE,uBAAA,IAAI,kCAAK,CAAC,uBAAuB,GAAG,OAAO,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC;QAC1E,uBAAA,IAAI,iCAAW,MAAM,MAAA,CAAC;QAEtB,uBAAA,IAAI,sCAAgB,IAAI,iBAAW,CACjC;YACE,GAAG,EAAE,SAAG,CAAC,GAAG;YACZ,IAAI,EAAE;gBACJ,cAAc,EAAE,CAAC,eAAwB,EAAE,EAAE,CAC3C,IAAI,CAAC,eAAe,CAAC,IAAI,CACvB,yCAAyC,EACzC,eAAe,CAChB;gBACH,cAAc,EAAE,KAAK,EAAE,eAAwB,EAAE,EAAE;oBACjD,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CACpC,4CAA4C,EAC5C,eAAe,CAChB,CAAC;gBACJ,CAAC;gBACD,WAAW,EAAE,CAAC,OAAe,EAAE,eAAwB,EAAE,EAAE,CACzD,uBAAA,IAAI,gFAAiB,MAArB,IAAI,EACF,OAA+B,EAC/B,eAAe,CAChB;aACJ;SACF,EACD;YACE,OAAO,EAAE;gBACP,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAC/B,uBAAA,IAAI,8CAAiB,CAAC,OAAO,CAAC,IAAI,IAAI;gBACxC,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE;oBACpC,uBAAA,IAAI,8CAAiB,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC;gBACvC,CAAC;aACF;SACF,CACF,MAAA,CAAC;QAEF,uBAAA,IAAI,gDAAmB,CAAC,6BAA6B,EAAE,CAAC;QACxD,uBAAA,IAAI,wFAAyB,MAA7B,IAAI,CAA2B,CAAC;QAChC,uBAAA,IAAI,6CAAuB,kBAAkB,MAAA,CAAC;QAE9C,kBAAkB;QAClB,IAAA,sDAAgC,EAAC;YAC/B,gCAAgC,EAAE,GAAG,EAAE,CAAC,IAAI;YAC5C,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,eAAe;SACzC,CAAC,CAAC;QAEH,kBAAkB;QAClB,IAAI,uBAAA,IAAI,kCAAK,CAAC,uBAAuB,EAAE;YACrC,IAAA,4CAAmB,EAAC;gBAClB,SAAS;gBACT,gCAAgC,EAAE,GAAG,EAAE,CAAC,IAAI;gBAC5C,qBAAqB,EAAE,GAAG,EAAE,CAC1B,CAAC,IAAI,CAAC,KAAK,CAAC,kCAAkC;aACjD,CAAC,CAAC;SACJ;IACH,CAAC;IA2CD;;;;;;;OAOG;IACI,KAAK,CAAC,iBAAiB,CAC5B,IAAsC,EACtC,eAAwB;QAExB,OAAO,MAAM,uBAAA,IAAI,0CAAa,CAAC,OAAO,CAAC,IAAI,EAAE;YAC3C,kBAAkB,EAAE,uBAAA,IAAI,iDAAoB;YAC5C,qBAAqB,EAAE,IAAI;YAC3B,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,kCAAkC,CAC7C,IAAoC,EACpC,eAAwB;QAExB,OAAO,MAAM,uBAAA,IAAI,0CAAa,CAAC,kBAAkB,CAAC,IAAI,EAAE;YACtD,kBAAkB,EAAE,uBAAA,IAAI,iDAAoB;YAC5C,qBAAqB,EAAE,IAAI;YAC3B,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,iBAAiB,CAC5B,IAAsC,EACtC,KAAa,EACb,eAAwB;QAExB,OAAO,MAAM,uBAAA,IAAI,0CAAa,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE;YAClD,kBAAkB,EAAE,uBAAA,IAAI,iDAAoB;YAC5C,qBAAqB,EAAE,IAAI;YAC3B,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,sBAAsB,CAGjC,IAAiB,EACjB,MAAuD,EACvD,eAAwB;QAExB,OAAO,MAAM,uBAAA,IAAI,0CAAa,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE;YACzD,kBAAkB,EAAE,uBAAA,IAAI,iDAAoB;YAC5C,qBAAqB,EAAE,IAAI;YAC3B,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,oBAAoB,CAC/B,IAAsC,EACtC,eAAwB;QAExB,OAAO,MAAM,uBAAA,IAAI,0CAAa,CAAC,UAAU,CAAC,IAAI,EAAE;YAC9C,kBAAkB,EAAE,uBAAA,IAAI,iDAAoB;YAC5C,qBAAqB,EAAE,IAAI;YAC3B,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,qCAAqC,CAChD,IAAoC,EACpC,eAAwB;QAExB,OAAO,MAAM,uBAAA,IAAI,0CAAa,CAAC,qBAAqB,CAAC,IAAI,EAAE;YACzD,kBAAkB,EAAE,uBAAA,IAAI,iDAAoB;YAC5C,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,yBAAyB,CAGpC,IAAiB,EACjB,MAA6C,EAC7C,eAAwB;QAExB,OAAO,MAAM,uBAAA,IAAI,0CAAa,CAAC,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE;YAC5D,kBAAkB,EAAE,uBAAA,IAAI,iDAAoB;YAC5C,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,aAAa;QACxB,OAAO,MAAM,uBAAA,IAAI,0CAAa,CAAC,aAAa,EAAE,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACI,oBAAoB;QACzB,uBAAA,IAAI,0CAAoB,EAAE,MAAA,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,kBAAkB;QACtB,IAAI,CAAC,uBAAA,IAAI,yCAAY,EAAE;YACrB,MAAM,IAAI,KAAK,CACb,uEAAuE,CACxE,CAAC;SACH;QAED,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC5C,4BAA4B,CAC7B,CAAC;QACF,OAAO,QAAQ;aACZ,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,iCAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC;aAChE,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC3C,CAAC;IAqCM,KAAK,CAAC,gCAAgC,CAC3C,OAA4C,EAC5C,OAAgB;QAEhB,IAAI;YACF,uBAAA,IAAI,gGAAiC,MAArC,IAAI,EAAkC,IAAI,CAAC,CAAC;YAE5C,IAAI,OAAO,EAAE;gBACX,8EAA8E;gBAC9E,MAAM,UAAU,GAAG,uBAAA,IAAI,mCAAM,CAAC,UAAU,EAAE,CAAC;gBAC3C,IAAI,CAAC,UAAU,EAAE;oBACf,MAAM,uBAAA,IAAI,mCAAM,CAAC,MAAM,EAAE,CAAC;iBAC3B;aACF;YAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,IAAI,OAAO,KAAK,kCAAsB,CAAC,IAAI,EAAE;oBAC3C,KAAK,CAAC,sBAAsB,GAAG,OAAO,CAAC;iBACxC;gBAED,IAAI,OAAO,KAAK,kCAAsB,CAAC,cAAc,EAAE;oBACrD,KAAK,CAAC,uBAAuB,GAAG,OAAO,CAAC;iBACzC;YACH,CAAC,CAAC,CAAC;SACJ;QAAC,OAAO,CAAC,EAAE;YACV,uBAAuB;YACvB,MAAM,YAAY,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACxE,uBAAuB;YACvB,MAAM,IAAI,KAAK,CACb,GAAG,cAAc,gBAAgB,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,IAAI,OAAO,MAAM,YAAY,EAAE,CAC/F,CAAC;SACH;gBAAS;YACR,uBAAA,IAAI,gGAAiC,MAArC,IAAI,EAAkC,KAAK,CAAC,CAAC;SAC9C;IACH,CAAC;IAUD,KAAK,CAAC,qCAAqC,CACzC,kCAA2C;QAE3C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,kCAAkC;gBACtC,kCAAkC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,sCAAsC,CAC1C,mCAA4C;QAE5C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,mCAAmC;gBACvC,mCAAmC,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,6BAA6B,CACjC,0BAAmC;QAEnC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,0BAA0B,GAAG,0BAA0B,CAAC;QAChE,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,mCAAmC;QACvC,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAEzD,IAAI;YACF,KAAK,MAAM,eAAe,IAAI,gBAAgB,EAAE;gBAC9C,MAAM,SAAS,GAAG,MAAM,uBAAA,IAAI,mCAAM,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;gBAEjE,MAAM,IAAA,4DAAmC,EACvC;oBACE,wBAAwB,EACtB,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,wBAAwB;oBACxD,cAAc,EAAE,GAAG,EAAE,CACnB,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,cAAc,EAAE,CAAC,SAAS,CAAC;oBAC3D,oBAAoB,EAAE,GAAG,EAAE,CACzB,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,oBAAoB,EAAE,CAAC,SAAS,CAAC;oBACjE,+BAA+B,EAAE,CAC/B,gBAAgB,EAChB,aAAa,EACb,EAAE,CACF,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,+BAA+B,EAAE,CAC7D,SAAS,EACT,gBAAgB,EAChB,aAAa,CACd;iBACJ,EACD;oBACE,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,eAAe;oBACxC,gCAAgC,EAAE,GAAG,EAAE,CAAC,IAAI;iBAC7C,EACD,eAAe,CAChB,CAAC;aACH;YAED,qFAAqF;YACrF,mFAAmF;YACnF,MAAM,IAAI,CAAC,qCAAqC,CAAC,IAAI,CAAC,CAAC;SACxD;QAAC,OAAO,CAAC,EAAE;YACV,wBAAwB;YACxB,uBAAuB;YACvB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAClB;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gCAAgC,CACpC,eAAgC;QAEhC,MAAM,IAAA,yDAAgC,EAAC,eAAe,EAAE;YACtD,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,eAAe;YACxC,gCAAgC,EAAE,GAAG,EAAE,CAAC,IAAI;SAC7C,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,IAAI,CAAC,uBAAA,IAAI,kCAAK,CAAC,uBAAuB,EAAE;YACtC,OAAO;SACR;QAED,MAAM,SAAS,GAAG,MAAM,uBAAA,IAAI,mCAAM,CAAC,YAAY,EAAE,CAAC;QAElD,MAAM,IAAA,+CAAsB,EAAC;YAC3B,SAAS,EAAE,IAAI,CAAC,eAAe;YAC/B,gCAAgC,EAAE,GAAG,EAAE,CAAC,IAAI;YAC5C,gBAAgB,EAAE,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,wBAAwB;YACxE,cAAc,EAAE,CAAC,GAAG,EAAE,EAAE,CACtB,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,cAAc,EAAE,CAAC,SAAS,EAAE,GAAG,CAAC;YAChE,gBAAgB,EAAE,CAAC,GAAG,EAAE,EAAE,CACxB,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,gBAAgB,EAAE,CAAC,SAAS,EAAE,GAAG,CAAC;YAClE,gBAAgB,EAAE,CAAC,GAAG,EAAE,EAAE,CACxB,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,gBAAgB,EAAE,CAAC,SAAS,EAAE,GAAG,CAAC;SACnE,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;YAChB,CAAC,CAAC,kCAAkC,GAAG,IAAI,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;CACF;;IArZG,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,yCAAyC,EACzC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAClC,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,0DAA0D,EAC1D,IAAI,CAAC,kCAAkC,CAAC,IAAI,CAAC,IAAI,CAAC,CACnD,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,yCAAyC,EACzC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAClC,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,8CAA8C,EAC9C,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CACvC,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,4CAA4C,EAC5C,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CACrC,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,iDAAiD,EACjD,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,CAC1C,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,qCAAqC,EACrC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAC9B,CAAC;AACJ,CAAC;AAuLD;;;;;;;GAOG;AACH,KAAK,iDACH,OAA6B,EAC7B,eAAwB;IAExB,kGAAkG;IAClG,IAAI,uBAAA,IAAI,oDAAuB,CAAC,OAAO,CAAC,EAAE;QACxC,OAAO,uBAAA,IAAI,oDAAuB,CAAC,OAAO,CAAC,CAAC;KAC7C;IAED,IAAI,CAAC,uBAAA,IAAI,yCAAY,EAAE;QACrB,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAC;KACH;IAED,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAC7C,8BAA8B,EAC9B,IAAA,iDAA4B,EAAC,OAAO,EAAE,eAAe,CAAC,CACvD,CAAW,CAAC;IAEb,uBAAA,IAAI,oDAAuB,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC;IAE9C,OAAO,MAAM,CAAC;AAChB,CAAC,2HAuCC,4BAAqC;IAErC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,KAAK,CAAC,4BAA4B,GAAG,4BAA4B,CAAC;IACpE,CAAC,CAAC,CAAC;AACL,CAAC;kBAhbkB,qBAAqB","sourcesContent":["import type {\n  AccountsControllerListAccountsAction,\n  AccountsControllerUpdateAccountMetadataAction,\n  AccountsControllerAccountRenamedEvent,\n  AccountsControllerUpdateAccountsAction,\n} from '@metamask/accounts-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport {\n  KeyringTypes,\n  type KeyringControllerGetStateAction,\n  type KeyringControllerLockEvent,\n  type KeyringControllerUnlockEvent,\n  type KeyringControllerWithKeyringAction,\n} from '@metamask/keyring-controller';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\nimport type {\n  NetworkControllerAddNetworkAction,\n  NetworkControllerGetStateAction,\n  NetworkControllerNetworkRemovedEvent,\n  NetworkControllerRemoveNetworkAction,\n  NetworkControllerUpdateNetworkAction,\n} from '@metamask/network-controller';\nimport type { HandleSnapRequest } from '@metamask/snaps-controllers';\n\nimport {\n  saveInternalAccountToUserStorage,\n  syncInternalAccountsWithUserStorage,\n} from './account-syncing/controller-integration';\nimport { setupAccountSyncingSubscriptions } from './account-syncing/setup-subscriptions';\nimport { BACKUPANDSYNC_FEATURES } from './constants';\nimport {\n  performMainNetworkSync,\n  startNetworkSyncing,\n} from './network-syncing/controller-integration';\nimport { Env, UserStorage } from '../../sdk';\nimport type { UserStorageFeatureKeys } from '../../shared/storage-schema';\nimport {\n  type UserStoragePathWithFeatureAndKey,\n  type UserStoragePathWithFeatureOnly,\n} from '../../shared/storage-schema';\nimport type { NativeScrypt } from '../../shared/types/encryption';\nimport { createSnapSignMessageRequest } from '../authentication/auth-snap-requests';\nimport type {\n  AuthenticationControllerGetBearerToken,\n  AuthenticationControllerGetSessionProfile,\n  AuthenticationControllerIsSignedIn,\n  AuthenticationControllerPerformSignIn,\n} from '../authentication/AuthenticationController';\n\nconst controllerName = 'UserStorageController';\n\n// State\nexport type UserStorageControllerState = {\n  /**\n   * Condition used by UI and to determine if we can use some of the User Storage methods.\n   */\n  isBackupAndSyncEnabled: boolean;\n  /**\n   * Loading state for the backup and sync update\n   */\n  isBackupAndSyncUpdateLoading: boolean;\n  /**\n   * Condition used by UI to determine if account syncing is enabled.\n   */\n  isAccountSyncingEnabled: boolean;\n  /**\n   * Condition used to determine if account syncing has been dispatched at least once.\n   * This is used for event listeners to determine if they should be triggered.\n   * This is also used in E2E tests for verification purposes.\n   */\n  hasAccountSyncingSyncedAtLeastOnce: boolean;\n  /**\n   * Condition used by UI to determine if account syncing is ready to be dispatched.\n   */\n  isAccountSyncingReadyToBeDispatched: boolean;\n  /**\n   * Condition used by UI to determine if account syncing is in progress.\n   */\n  isAccountSyncingInProgress: boolean;\n  /**\n   * Condition used to ensure that we do not perform any network sync mutations until we have synced at least once\n   */\n  hasNetworkSyncingSyncedAtLeastOnce?: boolean;\n};\n\nexport const defaultState: UserStorageControllerState = {\n  isBackupAndSyncEnabled: true,\n  isBackupAndSyncUpdateLoading: false,\n  isAccountSyncingEnabled: true,\n  hasAccountSyncingSyncedAtLeastOnce: false,\n  isAccountSyncingReadyToBeDispatched: false,\n  isAccountSyncingInProgress: false,\n};\n\nconst metadata: StateMetadata<UserStorageControllerState> = {\n  isBackupAndSyncEnabled: {\n    persist: true,\n    anonymous: true,\n  },\n  isBackupAndSyncUpdateLoading: {\n    persist: false,\n    anonymous: false,\n  },\n  isAccountSyncingEnabled: {\n    persist: true,\n    anonymous: true,\n  },\n  hasAccountSyncingSyncedAtLeastOnce: {\n    persist: true,\n    anonymous: false,\n  },\n  isAccountSyncingReadyToBeDispatched: {\n    persist: true,\n    anonymous: false,\n  },\n  isAccountSyncingInProgress: {\n    persist: false,\n    anonymous: false,\n  },\n  hasNetworkSyncingSyncedAtLeastOnce: {\n    persist: true,\n    anonymous: false,\n  },\n};\n\ntype ControllerConfig = {\n  accountSyncing?: {\n    maxNumberOfAccountsToAdd?: number;\n    /**\n     * Callback that fires when account sync adds an account.\n     * This is used for analytics.\n     */\n    onAccountAdded?: (profileId: string) => void;\n\n    /**\n     * Callback that fires when account sync updates the name of an account.\n     * This is used for analytics.\n     */\n    onAccountNameUpdated?: (profileId: string) => void;\n\n    /**\n     * Callback that fires when an erroneous situation happens during account sync.\n     * This is used for analytics.\n     */\n    onAccountSyncErroneousSituation?: (\n      profileId: string,\n      situationMessage: string,\n      sentryContext?: Record<string, unknown>,\n    ) => void;\n  };\n\n  networkSyncing?: {\n    maxNumberOfNetworksToAdd?: number;\n    /**\n     * Callback that fires when network sync adds a network\n     * This is used for analytics.\n     *\n     * @param profileId - ID for a given User (shared cross devices once authenticated)\n     * @param chainId - Chain ID for the network added (in hex)\n     */\n    onNetworkAdded?: (profileId: string, chainId: string) => void;\n    /**\n     * Callback that fires when network sync updates a network\n     * This is used for analytics.\n     *\n     * @param profileId - ID for a given User (shared cross devices once authenticated)\n     * @param chainId - Chain ID for the network added (in hex)\n     */\n    onNetworkUpdated?: (profileId: string, chainId: string) => void;\n    /**\n     * Callback that fires when network sync deletes a network\n     * This is used for analytics.\n     *\n     * @param profileId - ID for a given User (shared cross devices once authenticated)\n     * @param chainId - Chain ID for the network added (in hex)\n     */\n    onNetworkRemoved?: (profileId: string, chainId: string) => void;\n  };\n};\n\n// Messenger Actions\ntype CreateActionsObj<Controller extends keyof UserStorageController> = {\n  [K in Controller]: {\n    type: `${typeof controllerName}:${K}`;\n    handler: UserStorageController[K];\n  };\n};\ntype ActionsObj = CreateActionsObj<\n  | 'performGetStorage'\n  | 'performGetStorageAllFeatureEntries'\n  | 'performSetStorage'\n  | 'performBatchSetStorage'\n  | 'performDeleteStorage'\n  | 'performBatchDeleteStorage'\n  | 'getStorageKey'\n>;\nexport type UserStorageControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  UserStorageControllerState\n>;\nexport type Actions =\n  | ActionsObj[keyof ActionsObj]\n  | UserStorageControllerGetStateAction;\nexport type UserStorageControllerPerformGetStorage =\n  ActionsObj['performGetStorage'];\nexport type UserStorageControllerPerformGetStorageAllFeatureEntries =\n  ActionsObj['performGetStorageAllFeatureEntries'];\nexport type UserStorageControllerPerformSetStorage =\n  ActionsObj['performSetStorage'];\nexport type UserStorageControllerPerformBatchSetStorage =\n  ActionsObj['performBatchSetStorage'];\nexport type UserStorageControllerPerformDeleteStorage =\n  ActionsObj['performDeleteStorage'];\nexport type UserStorageControllerPerformBatchDeleteStorage =\n  ActionsObj['performBatchDeleteStorage'];\nexport type UserStorageControllerGetStorageKey = ActionsObj['getStorageKey'];\n\nexport type AllowedActions =\n  // Keyring Requests\n  | KeyringControllerGetStateAction\n  // Snap Requests\n  | HandleSnapRequest\n  // Auth Requests\n  | AuthenticationControllerGetBearerToken\n  | AuthenticationControllerGetSessionProfile\n  | AuthenticationControllerPerformSignIn\n  | AuthenticationControllerIsSignedIn\n  // Account Syncing\n  | AccountsControllerListAccountsAction\n  | AccountsControllerUpdateAccountMetadataAction\n  | AccountsControllerUpdateAccountsAction\n  | KeyringControllerWithKeyringAction\n  // Network Syncing\n  | NetworkControllerGetStateAction\n  | NetworkControllerAddNetworkAction\n  | NetworkControllerRemoveNetworkAction\n  | NetworkControllerUpdateNetworkAction;\n\n// Messenger events\nexport type UserStorageControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  UserStorageControllerState\n>;\n\nexport type Events = UserStorageControllerStateChangeEvent;\n\nexport type AllowedEvents =\n  | UserStorageControllerStateChangeEvent\n  | KeyringControllerLockEvent\n  | KeyringControllerUnlockEvent\n  // Account Syncing Events\n  | AccountsControllerAccountRenamedEvent\n  // Network Syncing Events\n  | NetworkControllerNetworkRemovedEvent;\n\n// Messenger\nexport type UserStorageControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  Actions | AllowedActions,\n  Events | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Reusable controller that allows any team to store synchronized data for a given user.\n * These can be settings shared cross MetaMask clients, or data we want to persist when uninstalling/reinstalling.\n *\n * NOTE:\n * - data stored on UserStorage is FULLY encrypted, with the only keys stored/managed on the client.\n * - No one can access this data unless they are have the SRP and are able to run the signing snap.\n */\nexport default class UserStorageController extends BaseController<\n  typeof controllerName,\n  UserStorageControllerState,\n  UserStorageControllerMessenger\n> {\n  // This is replaced with the actual value in the constructor\n  // We will remove this once the feature will be released\n  readonly #env = {\n    isNetworkSyncingEnabled: false,\n  };\n\n  readonly #userStorage: UserStorage;\n\n  readonly #auth = {\n    getProfileId: async (entropySourceId?: string) => {\n      const sessionProfile = await this.messagingSystem.call(\n        'AuthenticationController:getSessionProfile',\n        entropySourceId,\n      );\n      return sessionProfile?.profileId;\n    },\n    isSignedIn: () => {\n      return this.messagingSystem.call('AuthenticationController:isSignedIn');\n    },\n    signIn: async () => {\n      return await this.messagingSystem.call(\n        'AuthenticationController:performSignIn',\n      );\n    },\n  };\n\n  readonly #config?: ControllerConfig;\n\n  #isUnlocked = false;\n\n  #storageKeyCache: Record<`metamask:${string}`, string> = {};\n\n  readonly #keyringController = {\n    setupLockedStateSubscriptions: () => {\n      const { isUnlocked } = this.messagingSystem.call(\n        'KeyringController:getState',\n      );\n      this.#isUnlocked = isUnlocked;\n\n      this.messagingSystem.subscribe('KeyringController:unlock', () => {\n        this.#isUnlocked = true;\n      });\n\n      this.messagingSystem.subscribe('KeyringController:lock', () => {\n        this.#isUnlocked = false;\n      });\n    },\n  };\n\n  readonly #nativeScryptCrypto: NativeScrypt | undefined = undefined;\n\n  constructor({\n    messenger,\n    state,\n    env,\n    config,\n    nativeScryptCrypto,\n  }: {\n    messenger: UserStorageControllerMessenger;\n    state?: UserStorageControllerState;\n    config?: ControllerConfig;\n    env?: {\n      isNetworkSyncingEnabled?: boolean;\n    };\n    nativeScryptCrypto?: NativeScrypt;\n  }) {\n    super({\n      messenger,\n      metadata,\n      name: controllerName,\n      state: { ...defaultState, ...state },\n    });\n\n    this.#env.isNetworkSyncingEnabled = Boolean(env?.isNetworkSyncingEnabled);\n    this.#config = config;\n\n    this.#userStorage = new UserStorage(\n      {\n        env: Env.PRD,\n        auth: {\n          getAccessToken: (entropySourceId?: string) =>\n            this.messagingSystem.call(\n              'AuthenticationController:getBearerToken',\n              entropySourceId,\n            ),\n          getUserProfile: async (entropySourceId?: string) => {\n            return await this.messagingSystem.call(\n              'AuthenticationController:getSessionProfile',\n              entropySourceId,\n            );\n          },\n          signMessage: (message: string, entropySourceId?: string) =>\n            this.#snapSignMessage(\n              message as `metamask:${string}`,\n              entropySourceId,\n            ),\n        },\n      },\n      {\n        storage: {\n          getStorageKey: async (message) =>\n            this.#storageKeyCache[message] ?? null,\n          setStorageKey: async (message, key) => {\n            this.#storageKeyCache[message] = key;\n          },\n        },\n      },\n    );\n\n    this.#keyringController.setupLockedStateSubscriptions();\n    this.#registerMessageHandlers();\n    this.#nativeScryptCrypto = nativeScryptCrypto;\n\n    // Account Syncing\n    setupAccountSyncingSubscriptions({\n      getUserStorageControllerInstance: () => this,\n      getMessenger: () => this.messagingSystem,\n    });\n\n    // Network Syncing\n    if (this.#env.isNetworkSyncingEnabled) {\n      startNetworkSyncing({\n        messenger,\n        getUserStorageControllerInstance: () => this,\n        isMutationSyncBlocked: () =>\n          !this.state.hasNetworkSyncingSyncedAtLeastOnce,\n      });\n    }\n  }\n\n  /**\n   * Constructor helper for registering this controller's messaging system\n   * actions.\n   */\n  #registerMessageHandlers(): void {\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:performGetStorage',\n      this.performGetStorage.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:performGetStorageAllFeatureEntries',\n      this.performGetStorageAllFeatureEntries.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:performSetStorage',\n      this.performSetStorage.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:performBatchSetStorage',\n      this.performBatchSetStorage.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:performDeleteStorage',\n      this.performDeleteStorage.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:performBatchDeleteStorage',\n      this.performBatchDeleteStorage.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:getStorageKey',\n      this.getStorageKey.bind(this),\n    );\n  }\n\n  /**\n   * Allows retrieval of stored data. Data stored is string formatted.\n   * Developers can extend the entry path and entry name through the `schema.ts` file.\n   *\n   * @param path - string in the form of `${feature}.${key}` that matches schema\n   * @param entropySourceId - The entropy source ID used to generate the encryption key.\n   * @returns the decrypted string contents found from user storage (or null if not found)\n   */\n  public async performGetStorage(\n    path: UserStoragePathWithFeatureAndKey,\n    entropySourceId?: string,\n  ): Promise<string | null> {\n    return await this.#userStorage.getItem(path, {\n      nativeScryptCrypto: this.#nativeScryptCrypto,\n      validateAgainstSchema: true,\n      entropySourceId,\n    });\n  }\n\n  /**\n   * Allows retrieval of all stored data for a specific feature. Data stored is formatted as an array of strings.\n   * Developers can extend the entry path through the `schema.ts` file.\n   *\n   * @param path - string in the form of `${feature}` that matches schema\n   * @param entropySourceId - The entropy source ID used to generate the encryption key.\n   * @returns the array of decrypted string contents found from user storage (or null if not found)\n   */\n  public async performGetStorageAllFeatureEntries(\n    path: UserStoragePathWithFeatureOnly,\n    entropySourceId?: string,\n  ): Promise<string[] | null> {\n    return await this.#userStorage.getAllFeatureItems(path, {\n      nativeScryptCrypto: this.#nativeScryptCrypto,\n      validateAgainstSchema: true,\n      entropySourceId,\n    });\n  }\n\n  /**\n   * Allows storage of user data. Data stored must be string formatted.\n   * Developers can extend the entry path and entry name through the `schema.ts` file.\n   *\n   * @param path - string in the form of `${feature}.${key}` that matches schema\n   * @param value - The string data you want to store.\n   * @param entropySourceId - The entropy source ID used to generate the encryption key.\n   * @returns nothing. NOTE that an error is thrown if fails to store data.\n   */\n  public async performSetStorage(\n    path: UserStoragePathWithFeatureAndKey,\n    value: string,\n    entropySourceId?: string,\n  ): Promise<void> {\n    return await this.#userStorage.setItem(path, value, {\n      nativeScryptCrypto: this.#nativeScryptCrypto,\n      validateAgainstSchema: true,\n      entropySourceId,\n    });\n  }\n\n  /**\n   * Allows storage of multiple user data entries for one specific feature. Data stored must be string formatted.\n   * Developers can extend the entry path through the `schema.ts` file.\n   *\n   * @param path - string in the form of `${feature}` that matches schema\n   * @param values - data to store, in the form of an array of `[entryKey, entryValue]` pairs\n   * @param entropySourceId - The entropy source ID used to generate the encryption key.\n   * @returns nothing. NOTE that an error is thrown if fails to store data.\n   */\n  public async performBatchSetStorage<\n    FeatureName extends UserStoragePathWithFeatureOnly,\n  >(\n    path: FeatureName,\n    values: [UserStorageFeatureKeys<FeatureName>, string][],\n    entropySourceId?: string,\n  ): Promise<void> {\n    return await this.#userStorage.batchSetItems(path, values, {\n      nativeScryptCrypto: this.#nativeScryptCrypto,\n      validateAgainstSchema: true,\n      entropySourceId,\n    });\n  }\n\n  /**\n   * Allows deletion of user data. Developers can extend the entry path and entry name through the `schema.ts` file.\n   *\n   * @param path - string in the form of `${feature}.${key}` that matches schema\n   * @param entropySourceId - The entropy source ID used to generate the encryption key.\n   * @returns nothing. NOTE that an error is thrown if fails to delete data.\n   */\n  public async performDeleteStorage(\n    path: UserStoragePathWithFeatureAndKey,\n    entropySourceId?: string,\n  ): Promise<void> {\n    return await this.#userStorage.deleteItem(path, {\n      nativeScryptCrypto: this.#nativeScryptCrypto,\n      validateAgainstSchema: true,\n      entropySourceId,\n    });\n  }\n\n  /**\n   * Allows deletion of all user data entries for a specific feature.\n   * Developers can extend the entry path through the `schema.ts` file.\n   *\n   * @param path - string in the form of `${feature}` that matches schema\n   * @param entropySourceId - The entropy source ID used to generate the encryption key.\n   * @returns nothing. NOTE that an error is thrown if fails to delete data.\n   */\n  public async performDeleteStorageAllFeatureEntries(\n    path: UserStoragePathWithFeatureOnly,\n    entropySourceId?: string,\n  ): Promise<void> {\n    return await this.#userStorage.deleteAllFeatureItems(path, {\n      nativeScryptCrypto: this.#nativeScryptCrypto,\n      entropySourceId,\n    });\n  }\n\n  /**\n   * Allows delete of multiple user data entries for one specific feature. Data deleted must be string formatted.\n   * Developers can extend the entry path through the `schema.ts` file.\n   *\n   * @param path - string in the form of `${feature}` that matches schema\n   * @param values - data to store, in the form of an array of entryKey[]\n   * @param entropySourceId - The entropy source ID used to generate the encryption key.\n   * @returns nothing. NOTE that an error is thrown if fails to store data.\n   */\n  public async performBatchDeleteStorage<\n    FeatureName extends UserStoragePathWithFeatureOnly,\n  >(\n    path: FeatureName,\n    values: UserStorageFeatureKeys<FeatureName>[],\n    entropySourceId?: string,\n  ): Promise<void> {\n    return await this.#userStorage.batchDeleteItems(path, values, {\n      nativeScryptCrypto: this.#nativeScryptCrypto,\n      entropySourceId,\n    });\n  }\n\n  /**\n   * Retrieves the storage key, for internal use only!\n   *\n   * @returns the storage key\n   */\n  public async getStorageKey(): Promise<string> {\n    return await this.#userStorage.getStorageKey();\n  }\n\n  /**\n   * Flushes the storage key cache.\n   * CAUTION: This is only public for testing purposes.\n   * It should not be used in production code.\n   */\n  public flushStorageKeyCache(): void {\n    this.#storageKeyCache = {};\n  }\n\n  /**\n   * Lists all the available HD keyring metadata IDs.\n   * These IDs can be used in a multi-SRP context to segregate data specific to different SRPs.\n   *\n   * @returns A promise that resolves to an array of HD keyring metadata IDs.\n   */\n  async listEntropySources() {\n    if (!this.#isUnlocked) {\n      throw new Error(\n        'listEntropySources - unable to list entropy sources, wallet is locked',\n      );\n    }\n\n    const { keyrings } = this.messagingSystem.call(\n      'KeyringController:getState',\n    );\n    return keyrings\n      .filter((keyring) => keyring.type === KeyringTypes.hd.toString())\n      .map((keyring) => keyring.metadata.id);\n  }\n\n  #_snapSignMessageCache: Record<`metamask:${string}`, string> = {};\n\n  /**\n   * Signs a specific message using an underlying auth snap.\n   *\n   * @param message - A specific tagged message to sign.\n   * @param entropySourceId - The entropy source ID used to derive the key,\n   * when multiple sources are available (Multi-SRP).\n   * @returns A Signature created by the snap.\n   */\n  async #snapSignMessage(\n    message: `metamask:${string}`,\n    entropySourceId?: string,\n  ): Promise<string> {\n    // the message is SRP specific already, so there's no need to use the entropySourceId in the cache\n    if (this.#_snapSignMessageCache[message]) {\n      return this.#_snapSignMessageCache[message];\n    }\n\n    if (!this.#isUnlocked) {\n      throw new Error(\n        '#snapSignMessage - unable to call snap, wallet is locked',\n      );\n    }\n\n    const result = (await this.messagingSystem.call(\n      'SnapController:handleRequest',\n      createSnapSignMessageRequest(message, entropySourceId),\n    )) as string;\n\n    this.#_snapSignMessageCache[message] = result;\n\n    return result;\n  }\n\n  public async setIsBackupAndSyncFeatureEnabled(\n    feature: keyof typeof BACKUPANDSYNC_FEATURES,\n    enabled: boolean,\n  ): Promise<void> {\n    try {\n      this.#setIsBackupAndSyncUpdateLoading(true);\n\n      if (enabled) {\n        // If any of the features are enabled, we need to ensure the user is signed in\n        const isSignedIn = this.#auth.isSignedIn();\n        if (!isSignedIn) {\n          await this.#auth.signIn();\n        }\n      }\n\n      this.update((state) => {\n        if (feature === BACKUPANDSYNC_FEATURES.main) {\n          state.isBackupAndSyncEnabled = enabled;\n        }\n\n        if (feature === BACKUPANDSYNC_FEATURES.accountSyncing) {\n          state.isAccountSyncingEnabled = enabled;\n        }\n      });\n    } catch (e) {\n      // istanbul ignore next\n      const errorMessage = e instanceof Error ? e.message : JSON.stringify(e);\n      // istanbul ignore next\n      throw new Error(\n        `${controllerName} - failed to ${enabled ? 'enable' : 'disable'} ${feature} - ${errorMessage}`,\n      );\n    } finally {\n      this.#setIsBackupAndSyncUpdateLoading(false);\n    }\n  }\n\n  #setIsBackupAndSyncUpdateLoading(\n    isBackupAndSyncUpdateLoading: boolean,\n  ): void {\n    this.update((state) => {\n      state.isBackupAndSyncUpdateLoading = isBackupAndSyncUpdateLoading;\n    });\n  }\n\n  async setHasAccountSyncingSyncedAtLeastOnce(\n    hasAccountSyncingSyncedAtLeastOnce: boolean,\n  ): Promise<void> {\n    this.update((state) => {\n      state.hasAccountSyncingSyncedAtLeastOnce =\n        hasAccountSyncingSyncedAtLeastOnce;\n    });\n  }\n\n  async setIsAccountSyncingReadyToBeDispatched(\n    isAccountSyncingReadyToBeDispatched: boolean,\n  ): Promise<void> {\n    this.update((state) => {\n      state.isAccountSyncingReadyToBeDispatched =\n        isAccountSyncingReadyToBeDispatched;\n    });\n  }\n\n  async setIsAccountSyncingInProgress(\n    isAccountSyncingInProgress: boolean,\n  ): Promise<void> {\n    this.update((state) => {\n      state.isAccountSyncingInProgress = isAccountSyncingInProgress;\n    });\n  }\n\n  /**\n   * Syncs the internal accounts list with the user storage accounts list.\n   * This method is used to make sure that the internal accounts list is up-to-date with the user storage accounts list and vice-versa.\n   * It will add new accounts to the internal accounts list, update/merge conflicting names and re-upload the results in some cases to the user storage.\n   */\n  async syncInternalAccountsWithUserStorage(): Promise<void> {\n    const entropySourceIds = await this.listEntropySources();\n\n    try {\n      for (const entropySourceId of entropySourceIds) {\n        const profileId = await this.#auth.getProfileId(entropySourceId);\n\n        await syncInternalAccountsWithUserStorage(\n          {\n            maxNumberOfAccountsToAdd:\n              this.#config?.accountSyncing?.maxNumberOfAccountsToAdd,\n            onAccountAdded: () =>\n              this.#config?.accountSyncing?.onAccountAdded?.(profileId),\n            onAccountNameUpdated: () =>\n              this.#config?.accountSyncing?.onAccountNameUpdated?.(profileId),\n            onAccountSyncErroneousSituation: (\n              situationMessage,\n              sentryContext,\n            ) =>\n              this.#config?.accountSyncing?.onAccountSyncErroneousSituation?.(\n                profileId,\n                situationMessage,\n                sentryContext,\n              ),\n          },\n          {\n            getMessenger: () => this.messagingSystem,\n            getUserStorageControllerInstance: () => this,\n          },\n          entropySourceId,\n        );\n      }\n\n      // We do this here and not in the finally statement because we want to make sure that\n      // the accounts are saved / updated / deleted at least once before we set this flag\n      await this.setHasAccountSyncingSyncedAtLeastOnce(true);\n    } catch (e) {\n      // Silently fail for now\n      // istanbul ignore next\n      console.error(e);\n    }\n  }\n\n  /**\n   * Saves an individual internal account to the user storage.\n   *\n   * @param internalAccount - The internal account to save\n   */\n  async saveInternalAccountToUserStorage(\n    internalAccount: InternalAccount,\n  ): Promise<void> {\n    await saveInternalAccountToUserStorage(internalAccount, {\n      getMessenger: () => this.messagingSystem,\n      getUserStorageControllerInstance: () => this,\n    });\n  }\n\n  async syncNetworks() {\n    if (!this.#env.isNetworkSyncingEnabled) {\n      return;\n    }\n\n    const profileId = await this.#auth.getProfileId();\n\n    await performMainNetworkSync({\n      messenger: this.messagingSystem,\n      getUserStorageControllerInstance: () => this,\n      maxNetworksToAdd: this.#config?.networkSyncing?.maxNumberOfNetworksToAdd,\n      onNetworkAdded: (cId) =>\n        this.#config?.networkSyncing?.onNetworkAdded?.(profileId, cId),\n      onNetworkUpdated: (cId) =>\n        this.#config?.networkSyncing?.onNetworkUpdated?.(profileId, cId),\n      onNetworkRemoved: (cId) =>\n        this.#config?.networkSyncing?.onNetworkRemoved?.(profileId, cId),\n    });\n\n    this.update((s) => {\n      s.hasNetworkSyncingSyncedAtLeastOnce = true;\n    });\n  }\n}\n"]}
+{"version":3,"file":"UserStorageController.cjs","sourceRoot":"","sources":["../../../src/controllers/user-storage/UserStorageController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAqBA,+DAA2D;AAC3D,qEAMsC;AAWtC,yFAGkD;AAClD,mFAAyF;AACzF,+CAAqD;AACrD,yFAAuF;AACvF,mFAAyF;AACzF,yFAGkD;AAClD,6CAA6C;AAO7C,oEAA4D;AAC5D,iFAAoF;AAQpF,MAAM,cAAc,GAAG,uBAAuB,CAAC;AA4ClC,QAAA,YAAY,GAA+B;IACtD,sBAAsB,EAAE,IAAI;IAC5B,4BAA4B,EAAE,KAAK;IACnC,uBAAuB,EAAE,IAAI;IAC7B,uBAAuB,EAAE,IAAI;IAC7B,0BAA0B,EAAE,KAAK;IACjC,kCAAkC,EAAE,KAAK;IACzC,mCAAmC,EAAE,KAAK;IAC1C,0BAA0B,EAAE,KAAK;CAClC,CAAC;AAEF,MAAM,QAAQ,GAA8C;IAC1D,sBAAsB,EAAE;QACtB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,IAAI;KAChB;IACD,4BAA4B,EAAE;QAC5B,OAAO,EAAE,KAAK;QACd,SAAS,EAAE,KAAK;KACjB;IACD,uBAAuB,EAAE;QACvB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,IAAI;KAChB;IACD,uBAAuB,EAAE;QACvB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,IAAI;KAChB;IACD,0BAA0B,EAAE;QAC1B,OAAO,EAAE,KAAK;QACd,SAAS,EAAE,KAAK;KACjB;IACD,kCAAkC,EAAE;QAClC,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;KACjB;IACD,mCAAmC,EAAE;QACnC,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;KACjB;IACD,0BAA0B,EAAE;QAC1B,OAAO,EAAE,KAAK;QACd,SAAS,EAAE,KAAK;KACjB;IACD,kCAAkC,EAAE;QAClC,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;KACjB;CACF,CAAC;AA4KF;;;;;;;GAOG;AACH,MAAqB,qBAAsB,SAAQ,gCAIlD;IAsDC,YAAY,EACV,SAAS,EACT,KAAK,EACL,GAAG,EACH,MAAM,EACN,kBAAkB,GASnB;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ;YACR,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE,EAAE,GAAG,oBAAY,EAAE,GAAG,KAAK,EAAE;SACrC,CAAC,CAAC;;QAzEL,4DAA4D;QAC5D,wDAAwD;QAC/C,qCAAO;YACd,uBAAuB,EAAE,KAAK;SAC/B,EAAC;QAEO,qDAA0B;QAE1B,sCAAQ;YACf,YAAY,EAAE,KAAK,EAAE,eAAwB,EAAE,EAAE;gBAC/C,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CACpD,4CAA4C,EAC5C,eAAe,CAChB,CAAC;gBACF,OAAO,cAAc,EAAE,SAAS,CAAC;YACnC,CAAC;YACD,UAAU,EAAE,GAAG,EAAE;gBACf,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;YAC1E,CAAC;YACD,MAAM,EAAE,KAAK,IAAI,EAAE;gBACjB,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CACpC,wCAAwC,CACzC,CAAC;YACJ,CAAC;SACF,EAAC;QAEO,gDAA2B;QAEpC,4CAAc,KAAK,EAAC;QAEpB,iDAAyD,EAAE,EAAC;QAEnD,mDAAqB;YAC5B,6BAA6B,EAAE,GAAG,EAAE;gBAClC,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC9C,4BAA4B,CAC7B,CAAC;gBACF,uBAAA,IAAI,qCAAe,UAAU,MAAA,CAAC;gBAE9B,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,0BAA0B,EAAE,GAAG,EAAE;oBAC9D,uBAAA,IAAI,qCAAe,IAAI,MAAA,CAAC;gBAC1B,CAAC,CAAC,CAAC;gBAEH,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,wBAAwB,EAAE,GAAG,EAAE;oBAC5D,uBAAA,IAAI,qCAAe,KAAK,MAAA,CAAC;gBAC3B,CAAC,CAAC,CAAC;YACL,CAAC;SACF,EAAC;QAEO,oDAAgD,SAAS,EAAC;QAEnE,eAAU,GAAG,IAAI,wBAAU,EAAE,CAAC;QAmT9B,uDAA+D,EAAE,EAAC;QA3RhE,uBAAA,IAAI,kCAAK,CAAC,uBAAuB,GAAG,OAAO,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC;QAC1E,uBAAA,IAAI,iCAAW,MAAM,MAAA,CAAC;QAEtB,uBAAA,IAAI,sCAAgB,IAAI,iBAAW,CACjC;YACE,GAAG,EAAE,SAAG,CAAC,GAAG;YACZ,IAAI,EAAE;gBACJ,cAAc,EAAE,CAAC,eAAwB,EAAE,EAAE,CAC3C,IAAI,CAAC,eAAe,CAAC,IAAI,CACvB,yCAAyC,EACzC,eAAe,CAChB;gBACH,cAAc,EAAE,KAAK,EAAE,eAAwB,EAAE,EAAE;oBACjD,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CACpC,4CAA4C,EAC5C,eAAe,CAChB,CAAC;gBACJ,CAAC;gBACD,WAAW,EAAE,CAAC,OAAe,EAAE,eAAwB,EAAE,EAAE,CACzD,uBAAA,IAAI,gFAAiB,MAArB,IAAI,EACF,OAA+B,EAC/B,eAAe,CAChB;aACJ;SACF,EACD;YACE,OAAO,EAAE;gBACP,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAC/B,uBAAA,IAAI,8CAAiB,CAAC,OAAO,CAAC,IAAI,IAAI;gBACxC,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE;oBACpC,uBAAA,IAAI,8CAAiB,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC;gBACvC,CAAC;aACF;SACF,CACF,MAAA,CAAC;QAEF,uBAAA,IAAI,gDAAmB,CAAC,6BAA6B,EAAE,CAAC;QACxD,uBAAA,IAAI,wFAAyB,MAA7B,IAAI,CAA2B,CAAC;QAChC,uBAAA,IAAI,6CAAuB,kBAAkB,MAAA,CAAC;QAE9C,kBAAkB;QAClB,IAAA,sDAAgC,EAAC;YAC/B,gCAAgC,EAAE,GAAG,EAAE,CAAC,IAAI;YAC5C,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,eAAe;SACzC,CAAC,CAAC;QAEH,kBAAkB;QAClB,IAAA,sDAAgC,EAAC;YAC/B,gCAAgC,EAAE,GAAG,EAAE,CAAC,IAAI;YAC5C,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,eAAe;SACzC,CAAC,CAAC;QAEH,kBAAkB;QAClB,IAAI,uBAAA,IAAI,kCAAK,CAAC,uBAAuB,EAAE;YACrC,IAAA,4CAAmB,EAAC;gBAClB,SAAS;gBACT,gCAAgC,EAAE,GAAG,EAAE,CAAC,IAAI;gBAC5C,qBAAqB,EAAE,GAAG,EAAE,CAC1B,CAAC,IAAI,CAAC,KAAK,CAAC,kCAAkC;aACjD,CAAC,CAAC;SACJ;IACH,CAAC;IA2CD;;;;;;;OAOG;IACI,KAAK,CAAC,iBAAiB,CAC5B,IAAsC,EACtC,eAAwB;QAExB,OAAO,MAAM,uBAAA,IAAI,0CAAa,CAAC,OAAO,CAAC,IAAI,EAAE;YAC3C,kBAAkB,EAAE,uBAAA,IAAI,iDAAoB;YAC5C,qBAAqB,EAAE,IAAI;YAC3B,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,kCAAkC,CAC7C,IAAoC,EACpC,eAAwB;QAExB,OAAO,MAAM,uBAAA,IAAI,0CAAa,CAAC,kBAAkB,CAAC,IAAI,EAAE;YACtD,kBAAkB,EAAE,uBAAA,IAAI,iDAAoB;YAC5C,qBAAqB,EAAE,IAAI;YAC3B,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,iBAAiB,CAC5B,IAAsC,EACtC,KAAa,EACb,eAAwB;QAExB,OAAO,MAAM,uBAAA,IAAI,0CAAa,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE;YAClD,kBAAkB,EAAE,uBAAA,IAAI,iDAAoB;YAC5C,qBAAqB,EAAE,IAAI;YAC3B,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,sBAAsB,CAGjC,IAAiB,EACjB,MAAuD,EACvD,eAAwB;QAExB,OAAO,MAAM,uBAAA,IAAI,0CAAa,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE;YACzD,kBAAkB,EAAE,uBAAA,IAAI,iDAAoB;YAC5C,qBAAqB,EAAE,IAAI;YAC3B,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,oBAAoB,CAC/B,IAAsC,EACtC,eAAwB;QAExB,OAAO,MAAM,uBAAA,IAAI,0CAAa,CAAC,UAAU,CAAC,IAAI,EAAE;YAC9C,kBAAkB,EAAE,uBAAA,IAAI,iDAAoB;YAC5C,qBAAqB,EAAE,IAAI;YAC3B,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,qCAAqC,CAChD,IAAoC,EACpC,eAAwB;QAExB,OAAO,MAAM,uBAAA,IAAI,0CAAa,CAAC,qBAAqB,CAAC,IAAI,EAAE;YACzD,kBAAkB,EAAE,uBAAA,IAAI,iDAAoB;YAC5C,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,yBAAyB,CAGpC,IAAiB,EACjB,MAA6C,EAC7C,eAAwB;QAExB,OAAO,MAAM,uBAAA,IAAI,0CAAa,CAAC,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE;YAC5D,kBAAkB,EAAE,uBAAA,IAAI,iDAAoB;YAC5C,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,aAAa;QACxB,OAAO,MAAM,uBAAA,IAAI,0CAAa,CAAC,aAAa,EAAE,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACI,oBAAoB;QACzB,uBAAA,IAAI,0CAAoB,EAAE,MAAA,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,kBAAkB;QACtB,IAAI,CAAC,uBAAA,IAAI,yCAAY,EAAE;YACrB,MAAM,IAAI,KAAK,CACb,uEAAuE,CACxE,CAAC;SACH;QAED,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC5C,4BAA4B,CAC7B,CAAC;QACF,OAAO,QAAQ;aACZ,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,iCAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC;aAChE,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC3C,CAAC;IAqCM,KAAK,CAAC,gCAAgC,CAC3C,OAA4C,EAC5C,OAAgB;QAEhB,IAAI;YACF,uBAAA,IAAI,gGAAiC,MAArC,IAAI,EAAkC,IAAI,CAAC,CAAC;YAE5C,IAAI,OAAO,EAAE;gBACX,8EAA8E;gBAC9E,MAAM,UAAU,GAAG,uBAAA,IAAI,mCAAM,CAAC,UAAU,EAAE,CAAC;gBAC3C,IAAI,CAAC,UAAU,EAAE;oBACf,MAAM,uBAAA,IAAI,mCAAM,CAAC,MAAM,EAAE,CAAC;iBAC3B;aACF;YAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,IAAI,OAAO,KAAK,kCAAsB,CAAC,IAAI,EAAE;oBAC3C,KAAK,CAAC,sBAAsB,GAAG,OAAO,CAAC;iBACxC;gBAED,IAAI,OAAO,KAAK,kCAAsB,CAAC,cAAc,EAAE;oBACrD,KAAK,CAAC,uBAAuB,GAAG,OAAO,CAAC;iBACzC;gBAED,IAAI,OAAO,KAAK,kCAAsB,CAAC,cAAc,EAAE;oBACrD,KAAK,CAAC,uBAAuB,GAAG,OAAO,CAAC;iBACzC;YACH,CAAC,CAAC,CAAC;SACJ;QAAC,OAAO,CAAC,EAAE;YACV,uBAAuB;YACvB,MAAM,YAAY,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACxE,uBAAuB;YACvB,MAAM,IAAI,KAAK,CACb,GAAG,cAAc,gBAAgB,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,IAAI,OAAO,MAAM,YAAY,EAAE,CAC/F,CAAC;SACH;gBAAS;YACR,uBAAA,IAAI,gGAAiC,MAArC,IAAI,EAAkC,KAAK,CAAC,CAAC;SAC9C;IACH,CAAC;IAUD,KAAK,CAAC,qCAAqC,CACzC,kCAA2C;QAE3C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,kCAAkC;gBACtC,kCAAkC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,sCAAsC,CAC1C,mCAA4C;QAE5C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,mCAAmC;gBACvC,mCAAmC,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,6BAA6B,CACjC,0BAAmC;QAEnC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,0BAA0B,GAAG,0BAA0B,CAAC;QAChE,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,6BAA6B,CACjC,0BAAmC;QAEnC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,0BAA0B,GAAG,0BAA0B,CAAC;QAChE,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,mCAAmC;QACvC,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAEzD,IAAI;YACF,KAAK,MAAM,eAAe,IAAI,gBAAgB,EAAE;gBAC9C,MAAM,SAAS,GAAG,MAAM,uBAAA,IAAI,mCAAM,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;gBAEjE,MAAM,IAAA,4DAAmC,EACvC;oBACE,wBAAwB,EACtB,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,wBAAwB;oBACxD,cAAc,EAAE,GAAG,EAAE,CACnB,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,cAAc,EAAE,CAAC,SAAS,CAAC;oBAC3D,oBAAoB,EAAE,GAAG,EAAE,CACzB,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,oBAAoB,EAAE,CAAC,SAAS,CAAC;oBACjE,+BAA+B,EAAE,CAC/B,gBAAgB,EAChB,aAAa,EACb,EAAE,CACF,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,+BAA+B,EAAE,CAC7D,SAAS,EACT,gBAAgB,EAChB,aAAa,CACd;iBACJ,EACD;oBACE,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,eAAe;oBACxC,gCAAgC,EAAE,GAAG,EAAE,CAAC,IAAI;iBAC7C,EACD,eAAe,CAChB,CAAC;aACH;YAED,qFAAqF;YACrF,mFAAmF;YACnF,MAAM,IAAI,CAAC,qCAAqC,CAAC,IAAI,CAAC,CAAC;SACxD;QAAC,OAAO,CAAC,EAAE;YACV,wBAAwB;YACxB,uBAAuB;YACvB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAClB;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gCAAgC,CACpC,eAAgC;QAEhC,MAAM,IAAA,yDAAgC,EAAC,eAAe,EAAE;YACtD,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,eAAe;YACxC,gCAAgC,EAAE,GAAG,EAAE,CAAC,IAAI;SAC7C,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,IAAI,CAAC,uBAAA,IAAI,kCAAK,CAAC,uBAAuB,EAAE;YACtC,OAAO;SACR;QAED,MAAM,SAAS,GAAG,MAAM,uBAAA,IAAI,mCAAM,CAAC,YAAY,EAAE,CAAC;QAElD,MAAM,IAAA,+CAAsB,EAAC;YAC3B,SAAS,EAAE,IAAI,CAAC,eAAe;YAC/B,gCAAgC,EAAE,GAAG,EAAE,CAAC,IAAI;YAC5C,gBAAgB,EAAE,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,wBAAwB;YACxE,cAAc,EAAE,CAAC,GAAG,EAAE,EAAE,CACtB,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,cAAc,EAAE,CAAC,SAAS,EAAE,GAAG,CAAC;YAChE,gBAAgB,EAAE,CAAC,GAAG,EAAE,EAAE,CACxB,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,gBAAgB,EAAE,CAAC,SAAS,EAAE,GAAG,CAAC;YAClE,gBAAgB,EAAE,CAAC,GAAG,EAAE,EAAE,CACxB,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,gBAAgB,EAAE,CAAC,SAAS,EAAE,GAAG,CAAC;SACnE,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;YAChB,CAAC,CAAC,kCAAkC,GAAG,IAAI,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,2BAA2B;QAC/B,MAAM,SAAS,GAAG,MAAM,uBAAA,IAAI,mCAAM,CAAC,YAAY,EAAE,CAAC;QAElD,MAAM,MAAM,GAAG;YACb,gBAAgB,EAAE,GAAG,EAAE;gBACrB,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,gBAAgB,EAAE,CAAC,SAAS,CAAC,CAAC;YAC9D,CAAC;YACD,gBAAgB,EAAE,GAAG,EAAE;gBACrB,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,gBAAgB,EAAE,CAAC,SAAS,CAAC,CAAC;YAC9D,CAAC;YACD,+BAA+B,EAAE,CAC/B,YAAoB,EACpB,aAAuC,EACvC,EAAE;gBACF,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,+BAA+B,EAAE,CAC7D,SAAS,EACT,YAAY,EACZ,aAAa,CACd,CAAC;YACJ,CAAC;SACF,CAAC;QAEF,MAAM,IAAA,oDAA2B,EAAC,MAAM,EAAE;YACxC,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,eAAe;YACxC,gCAAgC,EAAE,GAAG,EAAE,CAAC,IAAI;SAC7C,CAAC,CAAC;IACL,CAAC;CACF;;IAvcG,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,yCAAyC,EACzC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAClC,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,0DAA0D,EAC1D,IAAI,CAAC,kCAAkC,CAAC,IAAI,CAAC,IAAI,CAAC,CACnD,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,yCAAyC,EACzC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAClC,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,8CAA8C,EAC9C,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CACvC,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,4CAA4C,EAC5C,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CACrC,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,iDAAiD,EACjD,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,CAC1C,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,qCAAqC,EACrC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAC9B,CAAC;AACJ,CAAC;AAuLD;;;;;;;GAOG;AACH,KAAK,iDACH,OAA6B,EAC7B,eAAwB;IAExB,kGAAkG;IAClG,IAAI,uBAAA,IAAI,oDAAuB,CAAC,OAAO,CAAC,EAAE;QACxC,OAAO,uBAAA,IAAI,oDAAuB,CAAC,OAAO,CAAC,CAAC;KAC7C;IAED,IAAI,CAAC,uBAAA,IAAI,yCAAY,EAAE;QACrB,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAC;KACH;IAED,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAC7C,8BAA8B,EAC9B,IAAA,iDAA4B,EAAC,OAAO,EAAE,eAAe,CAAC,CACvD,CAAW,CAAC;IAEb,uBAAA,IAAI,oDAAuB,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC;IAE9C,OAAO,MAAM,CAAC;AAChB,CAAC,2HA2CC,4BAAqC;IAErC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,KAAK,CAAC,4BAA4B,GAAG,4BAA4B,CAAC;IACpE,CAAC,CAAC,CAAC;AACL,CAAC;kBA5bkB,qBAAqB","sourcesContent":["import type {\n  AccountsControllerListAccountsAction,\n  AccountsControllerUpdateAccountMetadataAction,\n  AccountsControllerAccountRenamedEvent,\n  AccountsControllerAccountAddedEvent,\n  AccountsControllerUpdateAccountsAction,\n} from '@metamask/accounts-controller';\nimport type {\n  AddressBookControllerContactUpdatedEvent,\n  AddressBookControllerContactDeletedEvent,\n  AddressBookControllerActions,\n  AddressBookControllerListAction,\n  AddressBookControllerSetAction,\n  AddressBookControllerDeleteAction,\n} from '@metamask/address-book-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport {\n  KeyringTypes,\n  type KeyringControllerGetStateAction,\n  type KeyringControllerLockEvent,\n  type KeyringControllerUnlockEvent,\n  type KeyringControllerWithKeyringAction,\n} from '@metamask/keyring-controller';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\nimport type {\n  NetworkControllerAddNetworkAction,\n  NetworkControllerGetStateAction,\n  NetworkControllerNetworkRemovedEvent,\n  NetworkControllerRemoveNetworkAction,\n  NetworkControllerUpdateNetworkAction,\n} from '@metamask/network-controller';\nimport type { HandleSnapRequest } from '@metamask/snaps-controllers';\n\nimport {\n  saveInternalAccountToUserStorage,\n  syncInternalAccountsWithUserStorage,\n} from './account-syncing/controller-integration';\nimport { setupAccountSyncingSubscriptions } from './account-syncing/setup-subscriptions';\nimport { BACKUPANDSYNC_FEATURES } from './constants';\nimport { syncContactsWithUserStorage } from './contact-syncing/controller-integration';\nimport { setupContactSyncingSubscriptions } from './contact-syncing/setup-subscriptions';\nimport {\n  performMainNetworkSync,\n  startNetworkSyncing,\n} from './network-syncing/controller-integration';\nimport { Env, UserStorage } from '../../sdk';\nimport type { UserStorageFeatureKeys } from '../../shared/storage-schema';\nimport {\n  type UserStoragePathWithFeatureAndKey,\n  type UserStoragePathWithFeatureOnly,\n} from '../../shared/storage-schema';\nimport type { NativeScrypt } from '../../shared/types/encryption';\nimport { EventQueue } from '../../shared/utils/event-queue';\nimport { createSnapSignMessageRequest } from '../authentication/auth-snap-requests';\nimport type {\n  AuthenticationControllerGetBearerToken,\n  AuthenticationControllerGetSessionProfile,\n  AuthenticationControllerIsSignedIn,\n  AuthenticationControllerPerformSignIn,\n} from '../authentication/AuthenticationController';\n\nconst controllerName = 'UserStorageController';\n\n// State\nexport type UserStorageControllerState = {\n  /**\n   * Condition used by UI and to determine if we can use some of the User Storage methods.\n   */\n  isBackupAndSyncEnabled: boolean;\n  /**\n   * Loading state for the backup and sync update\n   */\n  isBackupAndSyncUpdateLoading: boolean;\n  /**\n   * Condition used by UI to determine if account syncing is enabled.\n   */\n  isAccountSyncingEnabled: boolean;\n  /**\n   * Condition used by UI to determine if contact syncing is enabled.\n   */\n  isContactSyncingEnabled: boolean;\n  /**\n   * Condition used by UI to determine if contact syncing is in progress.\n   */\n  isContactSyncingInProgress: boolean;\n  /**\n   * Condition used to determine if account syncing has been dispatched at least once.\n   * This is used for event listeners to determine if they should be triggered.\n   * This is also used in E2E tests for verification purposes.\n   */\n  hasAccountSyncingSyncedAtLeastOnce: boolean;\n  /**\n   * Condition used by UI to determine if account syncing is ready to be dispatched.\n   */\n  isAccountSyncingReadyToBeDispatched: boolean;\n  /**\n   * Condition used by UI to determine if account syncing is in progress.\n   */\n  isAccountSyncingInProgress: boolean;\n  /**\n   * Condition used to ensure that we do not perform any network sync mutations until we have synced at least once\n   */\n  hasNetworkSyncingSyncedAtLeastOnce?: boolean;\n};\n\nexport const defaultState: UserStorageControllerState = {\n  isBackupAndSyncEnabled: true,\n  isBackupAndSyncUpdateLoading: false,\n  isAccountSyncingEnabled: true,\n  isContactSyncingEnabled: true,\n  isContactSyncingInProgress: false,\n  hasAccountSyncingSyncedAtLeastOnce: false,\n  isAccountSyncingReadyToBeDispatched: false,\n  isAccountSyncingInProgress: false,\n};\n\nconst metadata: StateMetadata<UserStorageControllerState> = {\n  isBackupAndSyncEnabled: {\n    persist: true,\n    anonymous: true,\n  },\n  isBackupAndSyncUpdateLoading: {\n    persist: false,\n    anonymous: false,\n  },\n  isAccountSyncingEnabled: {\n    persist: true,\n    anonymous: true,\n  },\n  isContactSyncingEnabled: {\n    persist: true,\n    anonymous: true,\n  },\n  isContactSyncingInProgress: {\n    persist: false,\n    anonymous: false,\n  },\n  hasAccountSyncingSyncedAtLeastOnce: {\n    persist: true,\n    anonymous: false,\n  },\n  isAccountSyncingReadyToBeDispatched: {\n    persist: true,\n    anonymous: false,\n  },\n  isAccountSyncingInProgress: {\n    persist: false,\n    anonymous: false,\n  },\n  hasNetworkSyncingSyncedAtLeastOnce: {\n    persist: true,\n    anonymous: false,\n  },\n};\n\ntype ControllerConfig = {\n  accountSyncing?: {\n    maxNumberOfAccountsToAdd?: number;\n    /**\n     * Callback that fires when account sync adds an account.\n     * This is used for analytics.\n     */\n    onAccountAdded?: (profileId: string) => void;\n\n    /**\n     * Callback that fires when account sync updates the name of an account.\n     * This is used for analytics.\n     */\n    onAccountNameUpdated?: (profileId: string) => void;\n\n    /**\n     * Callback that fires when an erroneous situation happens during account sync.\n     * This is used for analytics.\n     */\n    onAccountSyncErroneousSituation?: (\n      profileId: string,\n      situationMessage: string,\n      sentryContext?: Record<string, unknown>,\n    ) => void;\n  };\n  contactSyncing?: {\n    /**\n     * Callback that fires when contact sync updates a contact.\n     * This is used for analytics.\n     */\n    onContactUpdated?: (profileId: string) => void;\n\n    /**\n     * Callback that fires when contact sync deletes a contact.\n     * This is used for analytics.\n     */\n    onContactDeleted?: (profileId: string) => void;\n\n    /**\n     * Callback that fires when an erroneous situation happens during contact sync.\n     * This is used for analytics.\n     */\n    onContactSyncErroneousSituation?: (\n      profileId: string,\n      situationMessage: string,\n      sentryContext?: Record<string, unknown>,\n    ) => void;\n  };\n  networkSyncing?: {\n    maxNumberOfNetworksToAdd?: number;\n    /**\n     * Callback that fires when network sync adds a network\n     * This is used for analytics.\n     *\n     * @param profileId - ID for a given User (shared cross devices once authenticated)\n     * @param chainId - Chain ID for the network added (in hex)\n     */\n    onNetworkAdded?: (profileId: string, chainId: string) => void;\n    /**\n     * Callback that fires when network sync updates a network\n     * This is used for analytics.\n     *\n     * @param profileId - ID for a given User (shared cross devices once authenticated)\n     * @param chainId - Chain ID for the network added (in hex)\n     */\n    onNetworkUpdated?: (profileId: string, chainId: string) => void;\n    /**\n     * Callback that fires when network sync deletes a network\n     * This is used for analytics.\n     *\n     * @param profileId - ID for a given User (shared cross devices once authenticated)\n     * @param chainId - Chain ID for the network added (in hex)\n     */\n    onNetworkRemoved?: (profileId: string, chainId: string) => void;\n  };\n};\n\n// Messenger Actions\ntype CreateActionsObj<Controller extends keyof UserStorageController> = {\n  [K in Controller]: {\n    type: `${typeof controllerName}:${K}`;\n    handler: UserStorageController[K];\n  };\n};\ntype ActionsObj = CreateActionsObj<\n  | 'performGetStorage'\n  | 'performGetStorageAllFeatureEntries'\n  | 'performSetStorage'\n  | 'performBatchSetStorage'\n  | 'performDeleteStorage'\n  | 'performBatchDeleteStorage'\n  | 'getStorageKey'\n>;\nexport type UserStorageControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  UserStorageControllerState\n>;\nexport type Actions =\n  | ActionsObj[keyof ActionsObj]\n  | UserStorageControllerGetStateAction;\nexport type UserStorageControllerPerformGetStorage =\n  ActionsObj['performGetStorage'];\nexport type UserStorageControllerPerformGetStorageAllFeatureEntries =\n  ActionsObj['performGetStorageAllFeatureEntries'];\nexport type UserStorageControllerPerformSetStorage =\n  ActionsObj['performSetStorage'];\nexport type UserStorageControllerPerformBatchSetStorage =\n  ActionsObj['performBatchSetStorage'];\nexport type UserStorageControllerPerformDeleteStorage =\n  ActionsObj['performDeleteStorage'];\nexport type UserStorageControllerPerformBatchDeleteStorage =\n  ActionsObj['performBatchDeleteStorage'];\nexport type UserStorageControllerGetStorageKey = ActionsObj['getStorageKey'];\n\nexport type AllowedActions =\n  // Keyring Requests\n  | KeyringControllerGetStateAction\n  // Snap Requests\n  | HandleSnapRequest\n  // Auth Requests\n  | AuthenticationControllerGetBearerToken\n  | AuthenticationControllerGetSessionProfile\n  | AuthenticationControllerPerformSignIn\n  | AuthenticationControllerIsSignedIn\n  // Account Syncing\n  | AccountsControllerListAccountsAction\n  | AccountsControllerUpdateAccountMetadataAction\n  | AccountsControllerUpdateAccountsAction\n  | KeyringControllerWithKeyringAction\n  // Network Syncing\n  | NetworkControllerGetStateAction\n  | NetworkControllerAddNetworkAction\n  | NetworkControllerRemoveNetworkAction\n  | NetworkControllerUpdateNetworkAction\n  // Contact Syncing\n  | AddressBookControllerListAction\n  | AddressBookControllerSetAction\n  | AddressBookControllerDeleteAction\n  | AddressBookControllerActions;\n\n// Messenger events\nexport type UserStorageControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  UserStorageControllerState\n>;\n\nexport type Events = UserStorageControllerStateChangeEvent;\n\nexport type AllowedEvents =\n  | UserStorageControllerStateChangeEvent\n  | KeyringControllerLockEvent\n  | KeyringControllerUnlockEvent\n  // Account Syncing Events\n  | AccountsControllerAccountRenamedEvent\n  | AccountsControllerAccountAddedEvent\n  // Network Syncing Events\n  | NetworkControllerNetworkRemovedEvent\n  // Address Book Events\n  | AddressBookControllerContactUpdatedEvent\n  | AddressBookControllerContactDeletedEvent;\n\n// Messenger\nexport type UserStorageControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  Actions | AllowedActions,\n  Events | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Reusable controller that allows any team to store synchronized data for a given user.\n * These can be settings shared cross MetaMask clients, or data we want to persist when uninstalling/reinstalling.\n *\n * NOTE:\n * - data stored on UserStorage is FULLY encrypted, with the only keys stored/managed on the client.\n * - No one can access this data unless they are have the SRP and are able to run the signing snap.\n */\nexport default class UserStorageController extends BaseController<\n  typeof controllerName,\n  UserStorageControllerState,\n  UserStorageControllerMessenger\n> {\n  // This is replaced with the actual value in the constructor\n  // We will remove this once the feature will be released\n  readonly #env = {\n    isNetworkSyncingEnabled: false,\n  };\n\n  readonly #userStorage: UserStorage;\n\n  readonly #auth = {\n    getProfileId: async (entropySourceId?: string) => {\n      const sessionProfile = await this.messagingSystem.call(\n        'AuthenticationController:getSessionProfile',\n        entropySourceId,\n      );\n      return sessionProfile?.profileId;\n    },\n    isSignedIn: () => {\n      return this.messagingSystem.call('AuthenticationController:isSignedIn');\n    },\n    signIn: async () => {\n      return await this.messagingSystem.call(\n        'AuthenticationController:performSignIn',\n      );\n    },\n  };\n\n  readonly #config?: ControllerConfig;\n\n  #isUnlocked = false;\n\n  #storageKeyCache: Record<`metamask:${string}`, string> = {};\n\n  readonly #keyringController = {\n    setupLockedStateSubscriptions: () => {\n      const { isUnlocked } = this.messagingSystem.call(\n        'KeyringController:getState',\n      );\n      this.#isUnlocked = isUnlocked;\n\n      this.messagingSystem.subscribe('KeyringController:unlock', () => {\n        this.#isUnlocked = true;\n      });\n\n      this.messagingSystem.subscribe('KeyringController:lock', () => {\n        this.#isUnlocked = false;\n      });\n    },\n  };\n\n  readonly #nativeScryptCrypto: NativeScrypt | undefined = undefined;\n\n  eventQueue = new EventQueue();\n\n  constructor({\n    messenger,\n    state,\n    env,\n    config,\n    nativeScryptCrypto,\n  }: {\n    messenger: UserStorageControllerMessenger;\n    state?: UserStorageControllerState;\n    config?: ControllerConfig;\n    env?: {\n      isNetworkSyncingEnabled?: boolean;\n    };\n    nativeScryptCrypto?: NativeScrypt;\n  }) {\n    super({\n      messenger,\n      metadata,\n      name: controllerName,\n      state: { ...defaultState, ...state },\n    });\n\n    this.#env.isNetworkSyncingEnabled = Boolean(env?.isNetworkSyncingEnabled);\n    this.#config = config;\n\n    this.#userStorage = new UserStorage(\n      {\n        env: Env.PRD,\n        auth: {\n          getAccessToken: (entropySourceId?: string) =>\n            this.messagingSystem.call(\n              'AuthenticationController:getBearerToken',\n              entropySourceId,\n            ),\n          getUserProfile: async (entropySourceId?: string) => {\n            return await this.messagingSystem.call(\n              'AuthenticationController:getSessionProfile',\n              entropySourceId,\n            );\n          },\n          signMessage: (message: string, entropySourceId?: string) =>\n            this.#snapSignMessage(\n              message as `metamask:${string}`,\n              entropySourceId,\n            ),\n        },\n      },\n      {\n        storage: {\n          getStorageKey: async (message) =>\n            this.#storageKeyCache[message] ?? null,\n          setStorageKey: async (message, key) => {\n            this.#storageKeyCache[message] = key;\n          },\n        },\n      },\n    );\n\n    this.#keyringController.setupLockedStateSubscriptions();\n    this.#registerMessageHandlers();\n    this.#nativeScryptCrypto = nativeScryptCrypto;\n\n    // Account Syncing\n    setupAccountSyncingSubscriptions({\n      getUserStorageControllerInstance: () => this,\n      getMessenger: () => this.messagingSystem,\n    });\n\n    // Contact Syncing\n    setupContactSyncingSubscriptions({\n      getUserStorageControllerInstance: () => this,\n      getMessenger: () => this.messagingSystem,\n    });\n\n    // Network Syncing\n    if (this.#env.isNetworkSyncingEnabled) {\n      startNetworkSyncing({\n        messenger,\n        getUserStorageControllerInstance: () => this,\n        isMutationSyncBlocked: () =>\n          !this.state.hasNetworkSyncingSyncedAtLeastOnce,\n      });\n    }\n  }\n\n  /**\n   * Constructor helper for registering this controller's messaging system\n   * actions.\n   */\n  #registerMessageHandlers(): void {\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:performGetStorage',\n      this.performGetStorage.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:performGetStorageAllFeatureEntries',\n      this.performGetStorageAllFeatureEntries.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:performSetStorage',\n      this.performSetStorage.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:performBatchSetStorage',\n      this.performBatchSetStorage.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:performDeleteStorage',\n      this.performDeleteStorage.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:performBatchDeleteStorage',\n      this.performBatchDeleteStorage.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:getStorageKey',\n      this.getStorageKey.bind(this),\n    );\n  }\n\n  /**\n   * Allows retrieval of stored data. Data stored is string formatted.\n   * Developers can extend the entry path and entry name through the `schema.ts` file.\n   *\n   * @param path - string in the form of `${feature}.${key}` that matches schema\n   * @param entropySourceId - The entropy source ID used to generate the encryption key.\n   * @returns the decrypted string contents found from user storage (or null if not found)\n   */\n  public async performGetStorage(\n    path: UserStoragePathWithFeatureAndKey,\n    entropySourceId?: string,\n  ): Promise<string | null> {\n    return await this.#userStorage.getItem(path, {\n      nativeScryptCrypto: this.#nativeScryptCrypto,\n      validateAgainstSchema: true,\n      entropySourceId,\n    });\n  }\n\n  /**\n   * Allows retrieval of all stored data for a specific feature. Data stored is formatted as an array of strings.\n   * Developers can extend the entry path through the `schema.ts` file.\n   *\n   * @param path - string in the form of `${feature}` that matches schema\n   * @param entropySourceId - The entropy source ID used to generate the encryption key.\n   * @returns the array of decrypted string contents found from user storage (or null if not found)\n   */\n  public async performGetStorageAllFeatureEntries(\n    path: UserStoragePathWithFeatureOnly,\n    entropySourceId?: string,\n  ): Promise<string[] | null> {\n    return await this.#userStorage.getAllFeatureItems(path, {\n      nativeScryptCrypto: this.#nativeScryptCrypto,\n      validateAgainstSchema: true,\n      entropySourceId,\n    });\n  }\n\n  /**\n   * Allows storage of user data. Data stored must be string formatted.\n   * Developers can extend the entry path and entry name through the `schema.ts` file.\n   *\n   * @param path - string in the form of `${feature}.${key}` that matches schema\n   * @param value - The string data you want to store.\n   * @param entropySourceId - The entropy source ID used to generate the encryption key.\n   * @returns nothing. NOTE that an error is thrown if fails to store data.\n   */\n  public async performSetStorage(\n    path: UserStoragePathWithFeatureAndKey,\n    value: string,\n    entropySourceId?: string,\n  ): Promise<void> {\n    return await this.#userStorage.setItem(path, value, {\n      nativeScryptCrypto: this.#nativeScryptCrypto,\n      validateAgainstSchema: true,\n      entropySourceId,\n    });\n  }\n\n  /**\n   * Allows storage of multiple user data entries for one specific feature. Data stored must be string formatted.\n   * Developers can extend the entry path through the `schema.ts` file.\n   *\n   * @param path - string in the form of `${feature}` that matches schema\n   * @param values - data to store, in the form of an array of `[entryKey, entryValue]` pairs\n   * @param entropySourceId - The entropy source ID used to generate the encryption key.\n   * @returns nothing. NOTE that an error is thrown if fails to store data.\n   */\n  public async performBatchSetStorage<\n    FeatureName extends UserStoragePathWithFeatureOnly,\n  >(\n    path: FeatureName,\n    values: [UserStorageFeatureKeys<FeatureName>, string][],\n    entropySourceId?: string,\n  ): Promise<void> {\n    return await this.#userStorage.batchSetItems(path, values, {\n      nativeScryptCrypto: this.#nativeScryptCrypto,\n      validateAgainstSchema: true,\n      entropySourceId,\n    });\n  }\n\n  /**\n   * Allows deletion of user data. Developers can extend the entry path and entry name through the `schema.ts` file.\n   *\n   * @param path - string in the form of `${feature}.${key}` that matches schema\n   * @param entropySourceId - The entropy source ID used to generate the encryption key.\n   * @returns nothing. NOTE that an error is thrown if fails to delete data.\n   */\n  public async performDeleteStorage(\n    path: UserStoragePathWithFeatureAndKey,\n    entropySourceId?: string,\n  ): Promise<void> {\n    return await this.#userStorage.deleteItem(path, {\n      nativeScryptCrypto: this.#nativeScryptCrypto,\n      validateAgainstSchema: true,\n      entropySourceId,\n    });\n  }\n\n  /**\n   * Allows deletion of all user data entries for a specific feature.\n   * Developers can extend the entry path through the `schema.ts` file.\n   *\n   * @param path - string in the form of `${feature}` that matches schema\n   * @param entropySourceId - The entropy source ID used to generate the encryption key.\n   * @returns nothing. NOTE that an error is thrown if fails to delete data.\n   */\n  public async performDeleteStorageAllFeatureEntries(\n    path: UserStoragePathWithFeatureOnly,\n    entropySourceId?: string,\n  ): Promise<void> {\n    return await this.#userStorage.deleteAllFeatureItems(path, {\n      nativeScryptCrypto: this.#nativeScryptCrypto,\n      entropySourceId,\n    });\n  }\n\n  /**\n   * Allows delete of multiple user data entries for one specific feature. Data deleted must be string formatted.\n   * Developers can extend the entry path through the `schema.ts` file.\n   *\n   * @param path - string in the form of `${feature}` that matches schema\n   * @param values - data to store, in the form of an array of entryKey[]\n   * @param entropySourceId - The entropy source ID used to generate the encryption key.\n   * @returns nothing. NOTE that an error is thrown if fails to store data.\n   */\n  public async performBatchDeleteStorage<\n    FeatureName extends UserStoragePathWithFeatureOnly,\n  >(\n    path: FeatureName,\n    values: UserStorageFeatureKeys<FeatureName>[],\n    entropySourceId?: string,\n  ): Promise<void> {\n    return await this.#userStorage.batchDeleteItems(path, values, {\n      nativeScryptCrypto: this.#nativeScryptCrypto,\n      entropySourceId,\n    });\n  }\n\n  /**\n   * Retrieves the storage key, for internal use only!\n   *\n   * @returns the storage key\n   */\n  public async getStorageKey(): Promise<string> {\n    return await this.#userStorage.getStorageKey();\n  }\n\n  /**\n   * Flushes the storage key cache.\n   * CAUTION: This is only public for testing purposes.\n   * It should not be used in production code.\n   */\n  public flushStorageKeyCache(): void {\n    this.#storageKeyCache = {};\n  }\n\n  /**\n   * Lists all the available HD keyring metadata IDs.\n   * These IDs can be used in a multi-SRP context to segregate data specific to different SRPs.\n   *\n   * @returns A promise that resolves to an array of HD keyring metadata IDs.\n   */\n  async listEntropySources() {\n    if (!this.#isUnlocked) {\n      throw new Error(\n        'listEntropySources - unable to list entropy sources, wallet is locked',\n      );\n    }\n\n    const { keyrings } = this.messagingSystem.call(\n      'KeyringController:getState',\n    );\n    return keyrings\n      .filter((keyring) => keyring.type === KeyringTypes.hd.toString())\n      .map((keyring) => keyring.metadata.id);\n  }\n\n  #_snapSignMessageCache: Record<`metamask:${string}`, string> = {};\n\n  /**\n   * Signs a specific message using an underlying auth snap.\n   *\n   * @param message - A specific tagged message to sign.\n   * @param entropySourceId - The entropy source ID used to derive the key,\n   * when multiple sources are available (Multi-SRP).\n   * @returns A Signature created by the snap.\n   */\n  async #snapSignMessage(\n    message: `metamask:${string}`,\n    entropySourceId?: string,\n  ): Promise<string> {\n    // the message is SRP specific already, so there's no need to use the entropySourceId in the cache\n    if (this.#_snapSignMessageCache[message]) {\n      return this.#_snapSignMessageCache[message];\n    }\n\n    if (!this.#isUnlocked) {\n      throw new Error(\n        '#snapSignMessage - unable to call snap, wallet is locked',\n      );\n    }\n\n    const result = (await this.messagingSystem.call(\n      'SnapController:handleRequest',\n      createSnapSignMessageRequest(message, entropySourceId),\n    )) as string;\n\n    this.#_snapSignMessageCache[message] = result;\n\n    return result;\n  }\n\n  public async setIsBackupAndSyncFeatureEnabled(\n    feature: keyof typeof BACKUPANDSYNC_FEATURES,\n    enabled: boolean,\n  ): Promise<void> {\n    try {\n      this.#setIsBackupAndSyncUpdateLoading(true);\n\n      if (enabled) {\n        // If any of the features are enabled, we need to ensure the user is signed in\n        const isSignedIn = this.#auth.isSignedIn();\n        if (!isSignedIn) {\n          await this.#auth.signIn();\n        }\n      }\n\n      this.update((state) => {\n        if (feature === BACKUPANDSYNC_FEATURES.main) {\n          state.isBackupAndSyncEnabled = enabled;\n        }\n\n        if (feature === BACKUPANDSYNC_FEATURES.accountSyncing) {\n          state.isAccountSyncingEnabled = enabled;\n        }\n\n        if (feature === BACKUPANDSYNC_FEATURES.contactSyncing) {\n          state.isContactSyncingEnabled = enabled;\n        }\n      });\n    } catch (e) {\n      // istanbul ignore next\n      const errorMessage = e instanceof Error ? e.message : JSON.stringify(e);\n      // istanbul ignore next\n      throw new Error(\n        `${controllerName} - failed to ${enabled ? 'enable' : 'disable'} ${feature} - ${errorMessage}`,\n      );\n    } finally {\n      this.#setIsBackupAndSyncUpdateLoading(false);\n    }\n  }\n\n  #setIsBackupAndSyncUpdateLoading(\n    isBackupAndSyncUpdateLoading: boolean,\n  ): void {\n    this.update((state) => {\n      state.isBackupAndSyncUpdateLoading = isBackupAndSyncUpdateLoading;\n    });\n  }\n\n  async setHasAccountSyncingSyncedAtLeastOnce(\n    hasAccountSyncingSyncedAtLeastOnce: boolean,\n  ): Promise<void> {\n    this.update((state) => {\n      state.hasAccountSyncingSyncedAtLeastOnce =\n        hasAccountSyncingSyncedAtLeastOnce;\n    });\n  }\n\n  async setIsAccountSyncingReadyToBeDispatched(\n    isAccountSyncingReadyToBeDispatched: boolean,\n  ): Promise<void> {\n    this.update((state) => {\n      state.isAccountSyncingReadyToBeDispatched =\n        isAccountSyncingReadyToBeDispatched;\n    });\n  }\n\n  async setIsAccountSyncingInProgress(\n    isAccountSyncingInProgress: boolean,\n  ): Promise<void> {\n    this.update((state) => {\n      state.isAccountSyncingInProgress = isAccountSyncingInProgress;\n    });\n  }\n\n  /**\n   * Sets the isContactSyncingInProgress flag to prevent infinite loops during contact synchronization\n   *\n   * @param isContactSyncingInProgress - Whether contact syncing is in progress\n   */\n  async setIsContactSyncingInProgress(\n    isContactSyncingInProgress: boolean,\n  ): Promise<void> {\n    this.update((state) => {\n      state.isContactSyncingInProgress = isContactSyncingInProgress;\n    });\n  }\n\n  /**\n   * Syncs the internal accounts list with the user storage accounts list.\n   * This method is used to make sure that the internal accounts list is up-to-date with the user storage accounts list and vice-versa.\n   * It will add new accounts to the internal accounts list, update/merge conflicting names and re-upload the results in some cases to the user storage.\n   */\n  async syncInternalAccountsWithUserStorage(): Promise<void> {\n    const entropySourceIds = await this.listEntropySources();\n\n    try {\n      for (const entropySourceId of entropySourceIds) {\n        const profileId = await this.#auth.getProfileId(entropySourceId);\n\n        await syncInternalAccountsWithUserStorage(\n          {\n            maxNumberOfAccountsToAdd:\n              this.#config?.accountSyncing?.maxNumberOfAccountsToAdd,\n            onAccountAdded: () =>\n              this.#config?.accountSyncing?.onAccountAdded?.(profileId),\n            onAccountNameUpdated: () =>\n              this.#config?.accountSyncing?.onAccountNameUpdated?.(profileId),\n            onAccountSyncErroneousSituation: (\n              situationMessage,\n              sentryContext,\n            ) =>\n              this.#config?.accountSyncing?.onAccountSyncErroneousSituation?.(\n                profileId,\n                situationMessage,\n                sentryContext,\n              ),\n          },\n          {\n            getMessenger: () => this.messagingSystem,\n            getUserStorageControllerInstance: () => this,\n          },\n          entropySourceId,\n        );\n      }\n\n      // We do this here and not in the finally statement because we want to make sure that\n      // the accounts are saved / updated / deleted at least once before we set this flag\n      await this.setHasAccountSyncingSyncedAtLeastOnce(true);\n    } catch (e) {\n      // Silently fail for now\n      // istanbul ignore next\n      console.error(e);\n    }\n  }\n\n  /**\n   * Saves an individual internal account to the user storage.\n   *\n   * @param internalAccount - The internal account to save\n   */\n  async saveInternalAccountToUserStorage(\n    internalAccount: InternalAccount,\n  ): Promise<void> {\n    await saveInternalAccountToUserStorage(internalAccount, {\n      getMessenger: () => this.messagingSystem,\n      getUserStorageControllerInstance: () => this,\n    });\n  }\n\n  async syncNetworks() {\n    if (!this.#env.isNetworkSyncingEnabled) {\n      return;\n    }\n\n    const profileId = await this.#auth.getProfileId();\n\n    await performMainNetworkSync({\n      messenger: this.messagingSystem,\n      getUserStorageControllerInstance: () => this,\n      maxNetworksToAdd: this.#config?.networkSyncing?.maxNumberOfNetworksToAdd,\n      onNetworkAdded: (cId) =>\n        this.#config?.networkSyncing?.onNetworkAdded?.(profileId, cId),\n      onNetworkUpdated: (cId) =>\n        this.#config?.networkSyncing?.onNetworkUpdated?.(profileId, cId),\n      onNetworkRemoved: (cId) =>\n        this.#config?.networkSyncing?.onNetworkRemoved?.(profileId, cId),\n    });\n\n    this.update((s) => {\n      s.hasNetworkSyncingSyncedAtLeastOnce = true;\n    });\n  }\n\n  /**\n   * Syncs the address book list with the user storage address book list.\n   * This method is used to make sure that the address book list is up-to-date with the user storage address book list and vice-versa.\n   * It will add new contacts to the address book list, update/merge conflicting contacts and re-upload the results in some cases to the user storage.\n   */\n  async syncContactsWithUserStorage(): Promise<void> {\n    const profileId = await this.#auth.getProfileId();\n\n    const config = {\n      onContactUpdated: () => {\n        this.#config?.contactSyncing?.onContactUpdated?.(profileId);\n      },\n      onContactDeleted: () => {\n        this.#config?.contactSyncing?.onContactDeleted?.(profileId);\n      },\n      onContactSyncErroneousSituation: (\n        errorMessage: string,\n        sentryContext?: Record<string, unknown>,\n      ) => {\n        this.#config?.contactSyncing?.onContactSyncErroneousSituation?.(\n          profileId,\n          errorMessage,\n          sentryContext,\n        );\n      },\n    };\n\n    await syncContactsWithUserStorage(config, {\n      getMessenger: () => this.messagingSystem,\n      getUserStorageControllerInstance: () => this,\n    });\n  }\n}\n"]}

package/dist/controllers/user-storage/UserStorageController.d.cts

@@ -1,4 +1,5 @@
-import type { AccountsControllerListAccountsAction, AccountsControllerUpdateAccountMetadataAction, AccountsControllerAccountRenamedEvent, AccountsControllerUpdateAccountsAction } from "@metamask/accounts-controller";
+import type { AccountsControllerListAccountsAction, AccountsControllerUpdateAccountMetadataAction, AccountsControllerAccountRenamedEvent, AccountsControllerAccountAddedEvent, AccountsControllerUpdateAccountsAction } from "@metamask/accounts-controller";
+import type { AddressBookControllerContactUpdatedEvent, AddressBookControllerContactDeletedEvent, AddressBookControllerActions, AddressBookControllerListAction, AddressBookControllerSetAction, AddressBookControllerDeleteAction } from "@metamask/address-book-controller";
 import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedMessenger } from "@metamask/base-controller";
 import { BaseController } from "@metamask/base-controller";
 import { type KeyringControllerGetStateAction, type KeyringControllerLockEvent, type KeyringControllerUnlockEvent, type KeyringControllerWithKeyringAction } from "@metamask/keyring-controller";
@@ -9,6 +10,7 @@ import { BACKUPANDSYNC_FEATURES } from "./constants.cjs";
 import type { UserStorageFeatureKeys } from "../../shared/storage-schema.cjs";
 import { type UserStoragePathWithFeatureAndKey, type UserStoragePathWithFeatureOnly } from "../../shared/storage-schema.cjs";
 import type { NativeScrypt } from "../../shared/types/encryption.cjs";
+import { EventQueue } from "../../shared/utils/event-queue.cjs";
 import type { AuthenticationControllerGetBearerToken, AuthenticationControllerGetSessionProfile, AuthenticationControllerIsSignedIn, AuthenticationControllerPerformSignIn } from "../authentication/AuthenticationController.cjs";
 declare const controllerName = "UserStorageController";
 export type UserStorageControllerState = {
@@ -24,6 +26,14 @@ export type UserStorageControllerState = {
      * Condition used by UI to determine if account syncing is enabled.
      */
     isAccountSyncingEnabled: boolean;
+    /**
+     * Condition used by UI to determine if contact syncing is enabled.
+     */
+    isContactSyncingEnabled: boolean;
+    /**
+     * Condition used by UI to determine if contact syncing is in progress.
+     */
+    isContactSyncingInProgress: boolean;
     /**
      * Condition used to determine if account syncing has been dispatched at least once.
      * This is used for event listeners to determine if they should be triggered.
@@ -63,6 +73,23 @@ type ControllerConfig = {
          */
         onAccountSyncErroneousSituation?: (profileId: string, situationMessage: string, sentryContext?: Record<string, unknown>) => void;
     };
+    contactSyncing?: {
+        /**
+         * Callback that fires when contact sync updates a contact.
+         * This is used for analytics.
+         */
+        onContactUpdated?: (profileId: string) => void;
+        /**
+         * Callback that fires when contact sync deletes a contact.
+         * This is used for analytics.
+         */
+        onContactDeleted?: (profileId: string) => void;
+        /**
+         * Callback that fires when an erroneous situation happens during contact sync.
+         * This is used for analytics.
+         */
+        onContactSyncErroneousSituation?: (profileId: string, situationMessage: string, sentryContext?: Record<string, unknown>) => void;
+    };
     networkSyncing?: {
         maxNumberOfNetworksToAdd?: number;
         /**
@@ -107,10 +134,10 @@ export type UserStorageControllerPerformBatchSetStorage = ActionsObj['performBat
 export type UserStorageControllerPerformDeleteStorage = ActionsObj['performDeleteStorage'];
 export type UserStorageControllerPerformBatchDeleteStorage = ActionsObj['performBatchDeleteStorage'];
 export type UserStorageControllerGetStorageKey = ActionsObj['getStorageKey'];
-export type AllowedActions = KeyringControllerGetStateAction | HandleSnapRequest | AuthenticationControllerGetBearerToken | AuthenticationControllerGetSessionProfile | AuthenticationControllerPerformSignIn | AuthenticationControllerIsSignedIn | AccountsControllerListAccountsAction | AccountsControllerUpdateAccountMetadataAction | AccountsControllerUpdateAccountsAction | KeyringControllerWithKeyringAction | NetworkControllerGetStateAction | NetworkControllerAddNetworkAction | NetworkControllerRemoveNetworkAction | NetworkControllerUpdateNetworkAction;
+export type AllowedActions = KeyringControllerGetStateAction | HandleSnapRequest | AuthenticationControllerGetBearerToken | AuthenticationControllerGetSessionProfile | AuthenticationControllerPerformSignIn | AuthenticationControllerIsSignedIn | AccountsControllerListAccountsAction | AccountsControllerUpdateAccountMetadataAction | AccountsControllerUpdateAccountsAction | KeyringControllerWithKeyringAction | NetworkControllerGetStateAction | NetworkControllerAddNetworkAction | NetworkControllerRemoveNetworkAction | NetworkControllerUpdateNetworkAction | AddressBookControllerListAction | AddressBookControllerSetAction | AddressBookControllerDeleteAction | AddressBookControllerActions;
 export type UserStorageControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, UserStorageControllerState>;
 export type Events = UserStorageControllerStateChangeEvent;
-export type AllowedEvents = UserStorageControllerStateChangeEvent | KeyringControllerLockEvent | KeyringControllerUnlockEvent | AccountsControllerAccountRenamedEvent | NetworkControllerNetworkRemovedEvent;
+export type AllowedEvents = UserStorageControllerStateChangeEvent | KeyringControllerLockEvent | KeyringControllerUnlockEvent | AccountsControllerAccountRenamedEvent | AccountsControllerAccountAddedEvent | NetworkControllerNetworkRemovedEvent | AddressBookControllerContactUpdatedEvent | AddressBookControllerContactDeletedEvent;
 export type UserStorageControllerMessenger = RestrictedMessenger<typeof controllerName, Actions | AllowedActions, Events | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
 /**
  * Reusable controller that allows any team to store synchronized data for a given user.
@@ -122,6 +149,7 @@ export type UserStorageControllerMessenger = RestrictedMessenger<typeof controll
  */
 export default class UserStorageController extends BaseController<typeof controllerName, UserStorageControllerState, UserStorageControllerMessenger> {
     #private;
+    eventQueue: EventQueue;
     constructor({ messenger, state, env, config, nativeScryptCrypto, }: {
         messenger: UserStorageControllerMessenger;
         state?: UserStorageControllerState;
@@ -219,6 +247,12 @@ export default class UserStorageController extends BaseController<typeof control
     setHasAccountSyncingSyncedAtLeastOnce(hasAccountSyncingSyncedAtLeastOnce: boolean): Promise<void>;
     setIsAccountSyncingReadyToBeDispatched(isAccountSyncingReadyToBeDispatched: boolean): Promise<void>;
     setIsAccountSyncingInProgress(isAccountSyncingInProgress: boolean): Promise<void>;
+    /**
+     * Sets the isContactSyncingInProgress flag to prevent infinite loops during contact synchronization
+     *
+     * @param isContactSyncingInProgress - Whether contact syncing is in progress
+     */
+    setIsContactSyncingInProgress(isContactSyncingInProgress: boolean): Promise<void>;
     /**
      * Syncs the internal accounts list with the user storage accounts list.
      * This method is used to make sure that the internal accounts list is up-to-date with the user storage accounts list and vice-versa.
@@ -232,6 +266,12 @@ export default class UserStorageController extends BaseController<typeof control
      */
     saveInternalAccountToUserStorage(internalAccount: InternalAccount): Promise<void>;
     syncNetworks(): Promise<void>;
+    /**
+     * Syncs the address book list with the user storage address book list.
+     * This method is used to make sure that the address book list is up-to-date with the user storage address book list and vice-versa.
+     * It will add new contacts to the address book list, update/merge conflicting contacts and re-upload the results in some cases to the user storage.
+     */
+    syncContactsWithUserStorage(): Promise<void>;
 }
 export {};
 //# sourceMappingURL=UserStorageController.d.cts.map

package/dist/controllers/user-storage/UserStorageController.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"UserStorageController.d.cts","sourceRoot":"","sources":["../../../src/controllers/user-storage/UserStorageController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oCAAoC,EACpC,6CAA6C,EAC7C,qCAAqC,EACrC,sCAAsC,EACvC,sCAAsC;AACvC,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EAEpB,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,EAEL,KAAK,+BAA+B,EACpC,KAAK,0BAA0B,EAC/B,KAAK,4BAA4B,EACjC,KAAK,kCAAkC,EACxC,qCAAqC;AACtC,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AACtE,OAAO,KAAK,EACV,iCAAiC,EACjC,+BAA+B,EAC/B,oCAAoC,EACpC,oCAAoC,EACpC,oCAAoC,EACrC,qCAAqC;AACtC,OAAO,KAAK,EAAE,iBAAiB,EAAE,oCAAoC;AAOrE,OAAO,EAAE,sBAAsB,EAAE,wBAAoB;AAMrD,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAoC;AAC1E,OAAO,EACL,KAAK,gCAAgC,EACrC,KAAK,8BAA8B,EACpC,wCAAoC;AACrC,OAAO,KAAK,EAAE,YAAY,EAAE,0CAAsC;AAElE,OAAO,KAAK,EACV,sCAAsC,EACtC,yCAAyC,EACzC,kCAAkC,EAClC,qCAAqC,EACtC,uDAAmD;AAEpD,QAAA,MAAM,cAAc,0BAA0B,CAAC;AAG/C,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,sBAAsB,EAAE,OAAO,CAAC;IAChC;;OAEG;IACH,4BAA4B,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,uBAAuB,EAAE,OAAO,CAAC;IACjC;;;;OAIG;IACH,kCAAkC,EAAE,OAAO,CAAC;IAC5C;;OAEG;IACH,mCAAmC,EAAE,OAAO,CAAC;IAC7C;;OAEG;IACH,0BAA0B,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,kCAAkC,CAAC,EAAE,OAAO,CAAC;CAC9C,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,0BAO1B,CAAC;AAiCF,KAAK,gBAAgB,GAAG;IACtB,cAAc,CAAC,EAAE;QACf,wBAAwB,CAAC,EAAE,MAAM,CAAC;QAClC;;;WAGG;QACH,cAAc,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;QAE7C;;;WAGG;QACH,oBAAoB,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;QAEnD;;;WAGG;QACH,+BAA+B,CAAC,EAAE,CAChC,SAAS,EAAE,MAAM,EACjB,gBAAgB,EAAE,MAAM,EACxB,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KACpC,IAAI,CAAC;KACX,CAAC;IAEF,cAAc,CAAC,EAAE;QACf,wBAAwB,CAAC,EAAE,MAAM,CAAC;QAClC;;;;;;WAMG;QACH,cAAc,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;QAC9D;;;;;;WAMG;QACH,gBAAgB,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;QAChE;;;;;;WAMG;QACH,gBAAgB,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;KACjE,CAAC;CACH,CAAC;AAGF,KAAK,gBAAgB,CAAC,UAAU,SAAS,MAAM,qBAAqB,IAAI;KACrE,CAAC,IAAI,UAAU,GAAG;QACjB,IAAI,EAAE,GAAG,OAAO,cAAc,IAAI,CAAC,EAAE,CAAC;QACtC,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC;KACnC;CACF,CAAC;AACF,KAAK,UAAU,GAAG,gBAAgB,CAC9B,mBAAmB,GACnB,oCAAoC,GACpC,mBAAmB,GACnB,wBAAwB,GACxB,sBAAsB,GACtB,2BAA2B,GAC3B,eAAe,CAClB,CAAC;AACF,MAAM,MAAM,mCAAmC,GAAG,wBAAwB,CACxE,OAAO,cAAc,EACrB,0BAA0B,CAC3B,CAAC;AACF,MAAM,MAAM,OAAO,GACf,UAAU,CAAC,MAAM,UAAU,CAAC,GAC5B,mCAAmC,CAAC;AACxC,MAAM,MAAM,sCAAsC,GAChD,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAClC,MAAM,MAAM,uDAAuD,GACjE,UAAU,CAAC,oCAAoC,CAAC,CAAC;AACnD,MAAM,MAAM,sCAAsC,GAChD,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAClC,MAAM,MAAM,2CAA2C,GACrD,UAAU,CAAC,wBAAwB,CAAC,CAAC;AACvC,MAAM,MAAM,yCAAyC,GACnD,UAAU,CAAC,sBAAsB,CAAC,CAAC;AACrC,MAAM,MAAM,8CAA8C,GACxD,UAAU,CAAC,2BAA2B,CAAC,CAAC;AAC1C,MAAM,MAAM,kCAAkC,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;AAE7E,MAAM,MAAM,cAAc,GAEtB,+BAA+B,GAE/B,iBAAiB,GAEjB,sCAAsC,GACtC,yCAAyC,GACzC,qCAAqC,GACrC,kCAAkC,GAElC,oCAAoC,GACpC,6CAA6C,GAC7C,sCAAsC,GACtC,kCAAkC,GAElC,+BAA+B,GAC/B,iCAAiC,GACjC,oCAAoC,GACpC,oCAAoC,CAAC;AAGzC,MAAM,MAAM,qCAAqC,GAAG,0BAA0B,CAC5E,OAAO,cAAc,EACrB,0BAA0B,CAC3B,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,qCAAqC,CAAC;AAE3D,MAAM,MAAM,aAAa,GACrB,qCAAqC,GACrC,0BAA0B,GAC1B,4BAA4B,GAE5B,qCAAqC,GAErC,oCAAoC,CAAC;AAGzC,MAAM,MAAM,8BAA8B,GAAG,mBAAmB,CAC9D,OAAO,cAAc,EACrB,OAAO,GAAG,cAAc,EACxB,MAAM,GAAG,aAAa,EACtB,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,qBAAsB,SAAQ,cAAc,CAC/D,OAAO,cAAc,EACrB,0BAA0B,EAC1B,8BAA8B,CAC/B;;gBAoDa,EACV,SAAS,EACT,KAAK,EACL,GAAG,EACH,MAAM,EACN,kBAAkB,GACnB,EAAE;QACD,SAAS,EAAE,8BAA8B,CAAC;QAC1C,KAAK,CAAC,EAAE,0BAA0B,CAAC;QACnC,MAAM,CAAC,EAAE,gBAAgB,CAAC;QAC1B,GAAG,CAAC,EAAE;YACJ,uBAAuB,CAAC,EAAE,OAAO,CAAC;SACnC,CAAC;QACF,kBAAkB,CAAC,EAAE,YAAY,CAAC;KACnC;IA0GD;;;;;;;OAOG;IACU,iBAAiB,CAC5B,IAAI,EAAE,gCAAgC,EACtC,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAQzB;;;;;;;OAOG;IACU,kCAAkC,CAC7C,IAAI,EAAE,8BAA8B,EACpC,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC;IAQ3B;;;;;;;;OAQG;IACU,iBAAiB,CAC5B,IAAI,EAAE,gCAAgC,EACtC,KAAK,EAAE,MAAM,EACb,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;;;;OAQG;IACU,sBAAsB,CACjC,WAAW,SAAS,8BAA8B,EAElD,IAAI,EAAE,WAAW,EACjB,MAAM,EAAE,CAAC,sBAAsB,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,EAAE,EACvD,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;;OAMG;IACU,oBAAoB,CAC/B,IAAI,EAAE,gCAAgC,EACtC,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;;;OAOG;IACU,qCAAqC,CAChD,IAAI,EAAE,8BAA8B,EACpC,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC;IAOhB;;;;;;;;OAQG;IACU,yBAAyB,CACpC,WAAW,SAAS,8BAA8B,EAElD,IAAI,EAAE,WAAW,EACjB,MAAM,EAAE,sBAAsB,CAAC,WAAW,CAAC,EAAE,EAC7C,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC;IAOhB;;;;OAIG;IACU,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAI7C;;;;OAIG;IACI,oBAAoB,IAAI,IAAI;IAInC;;;;;OAKG;IACG,kBAAkB;IAkDX,gCAAgC,CAC3C,OAAO,EAAE,MAAM,OAAO,sBAAsB,EAC5C,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,IAAI,CAAC;IAyCV,qCAAqC,CACzC,kCAAkC,EAAE,OAAO,GAC1C,OAAO,CAAC,IAAI,CAAC;IAOV,sCAAsC,CAC1C,mCAAmC,EAAE,OAAO,GAC3C,OAAO,CAAC,IAAI,CAAC;IAOV,6BAA6B,CACjC,0BAA0B,EAAE,OAAO,GAClC,OAAO,CAAC,IAAI,CAAC;IAMhB;;;;OAIG;IACG,mCAAmC,IAAI,OAAO,CAAC,IAAI,CAAC;IA2C1D;;;;OAIG;IACG,gCAAgC,CACpC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAAC,IAAI,CAAC;IAOV,YAAY;CAuBnB"}
+{"version":3,"file":"UserStorageController.d.cts","sourceRoot":"","sources":["../../../src/controllers/user-storage/UserStorageController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oCAAoC,EACpC,6CAA6C,EAC7C,qCAAqC,EACrC,mCAAmC,EACnC,sCAAsC,EACvC,sCAAsC;AACvC,OAAO,KAAK,EACV,wCAAwC,EACxC,wCAAwC,EACxC,4BAA4B,EAC5B,+BAA+B,EAC/B,8BAA8B,EAC9B,iCAAiC,EAClC,0CAA0C;AAC3C,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EAEpB,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,EAEL,KAAK,+BAA+B,EACpC,KAAK,0BAA0B,EAC/B,KAAK,4BAA4B,EACjC,KAAK,kCAAkC,EACxC,qCAAqC;AACtC,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AACtE,OAAO,KAAK,EACV,iCAAiC,EACjC,+BAA+B,EAC/B,oCAAoC,EACpC,oCAAoC,EACpC,oCAAoC,EACrC,qCAAqC;AACtC,OAAO,KAAK,EAAE,iBAAiB,EAAE,oCAAoC;AAOrE,OAAO,EAAE,sBAAsB,EAAE,wBAAoB;AAQrD,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAoC;AAC1E,OAAO,EACL,KAAK,gCAAgC,EACrC,KAAK,8BAA8B,EACpC,wCAAoC;AACrC,OAAO,KAAK,EAAE,YAAY,EAAE,0CAAsC;AAClE,OAAO,EAAE,UAAU,EAAE,2CAAuC;AAE5D,OAAO,KAAK,EACV,sCAAsC,EACtC,yCAAyC,EACzC,kCAAkC,EAClC,qCAAqC,EACtC,uDAAmD;AAEpD,QAAA,MAAM,cAAc,0BAA0B,CAAC;AAG/C,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,sBAAsB,EAAE,OAAO,CAAC;IAChC;;OAEG;IACH,4BAA4B,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,uBAAuB,EAAE,OAAO,CAAC;IACjC;;OAEG;IACH,uBAAuB,EAAE,OAAO,CAAC;IACjC;;OAEG;IACH,0BAA0B,EAAE,OAAO,CAAC;IACpC;;;;OAIG;IACH,kCAAkC,EAAE,OAAO,CAAC;IAC5C;;OAEG;IACH,mCAAmC,EAAE,OAAO,CAAC;IAC7C;;OAEG;IACH,0BAA0B,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,kCAAkC,CAAC,EAAE,OAAO,CAAC;CAC9C,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,0BAS1B,CAAC;AAyCF,KAAK,gBAAgB,GAAG;IACtB,cAAc,CAAC,EAAE;QACf,wBAAwB,CAAC,EAAE,MAAM,CAAC;QAClC;;;WAGG;QACH,cAAc,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;QAE7C;;;WAGG;QACH,oBAAoB,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;QAEnD;;;WAGG;QACH,+BAA+B,CAAC,EAAE,CAChC,SAAS,EAAE,MAAM,EACjB,gBAAgB,EAAE,MAAM,EACxB,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KACpC,IAAI,CAAC;KACX,CAAC;IACF,cAAc,CAAC,EAAE;QACf;;;WAGG;QACH,gBAAgB,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;QAE/C;;;WAGG;QACH,gBAAgB,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;QAE/C;;;WAGG;QACH,+BAA+B,CAAC,EAAE,CAChC,SAAS,EAAE,MAAM,EACjB,gBAAgB,EAAE,MAAM,EACxB,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KACpC,IAAI,CAAC;KACX,CAAC;IACF,cAAc,CAAC,EAAE;QACf,wBAAwB,CAAC,EAAE,MAAM,CAAC;QAClC;;;;;;WAMG;QACH,cAAc,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;QAC9D;;;;;;WAMG;QACH,gBAAgB,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;QAChE;;;;;;WAMG;QACH,gBAAgB,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;KACjE,CAAC;CACH,CAAC;AAGF,KAAK,gBAAgB,CAAC,UAAU,SAAS,MAAM,qBAAqB,IAAI;KACrE,CAAC,IAAI,UAAU,GAAG;QACjB,IAAI,EAAE,GAAG,OAAO,cAAc,IAAI,CAAC,EAAE,CAAC;QACtC,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC;KACnC;CACF,CAAC;AACF,KAAK,UAAU,GAAG,gBAAgB,CAC9B,mBAAmB,GACnB,oCAAoC,GACpC,mBAAmB,GACnB,wBAAwB,GACxB,sBAAsB,GACtB,2BAA2B,GAC3B,eAAe,CAClB,CAAC;AACF,MAAM,MAAM,mCAAmC,GAAG,wBAAwB,CACxE,OAAO,cAAc,EACrB,0BAA0B,CAC3B,CAAC;AACF,MAAM,MAAM,OAAO,GACf,UAAU,CAAC,MAAM,UAAU,CAAC,GAC5B,mCAAmC,CAAC;AACxC,MAAM,MAAM,sCAAsC,GAChD,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAClC,MAAM,MAAM,uDAAuD,GACjE,UAAU,CAAC,oCAAoC,CAAC,CAAC;AACnD,MAAM,MAAM,sCAAsC,GAChD,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAClC,MAAM,MAAM,2CAA2C,GACrD,UAAU,CAAC,wBAAwB,CAAC,CAAC;AACvC,MAAM,MAAM,yCAAyC,GACnD,UAAU,CAAC,sBAAsB,CAAC,CAAC;AACrC,MAAM,MAAM,8CAA8C,GACxD,UAAU,CAAC,2BAA2B,CAAC,CAAC;AAC1C,MAAM,MAAM,kCAAkC,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;AAE7E,MAAM,MAAM,cAAc,GAEtB,+BAA+B,GAE/B,iBAAiB,GAEjB,sCAAsC,GACtC,yCAAyC,GACzC,qCAAqC,GACrC,kCAAkC,GAElC,oCAAoC,GACpC,6CAA6C,GAC7C,sCAAsC,GACtC,kCAAkC,GAElC,+BAA+B,GAC/B,iCAAiC,GACjC,oCAAoC,GACpC,oCAAoC,GAEpC,+BAA+B,GAC/B,8BAA8B,GAC9B,iCAAiC,GACjC,4BAA4B,CAAC;AAGjC,MAAM,MAAM,qCAAqC,GAAG,0BAA0B,CAC5E,OAAO,cAAc,EACrB,0BAA0B,CAC3B,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,qCAAqC,CAAC;AAE3D,MAAM,MAAM,aAAa,GACrB,qCAAqC,GACrC,0BAA0B,GAC1B,4BAA4B,GAE5B,qCAAqC,GACrC,mCAAmC,GAEnC,oCAAoC,GAEpC,wCAAwC,GACxC,wCAAwC,CAAC;AAG7C,MAAM,MAAM,8BAA8B,GAAG,mBAAmB,CAC9D,OAAO,cAAc,EACrB,OAAO,GAAG,cAAc,EACxB,MAAM,GAAG,aAAa,EACtB,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,qBAAsB,SAAQ,cAAc,CAC/D,OAAO,cAAc,EACrB,0BAA0B,EAC1B,8BAA8B,CAC/B;;IAoDC,UAAU,aAAoB;gBAElB,EACV,SAAS,EACT,KAAK,EACL,GAAG,EACH,MAAM,EACN,kBAAkB,GACnB,EAAE;QACD,SAAS,EAAE,8BAA8B,CAAC;QAC1C,KAAK,CAAC,EAAE,0BAA0B,CAAC;QACnC,MAAM,CAAC,EAAE,gBAAgB,CAAC;QAC1B,GAAG,CAAC,EAAE;YACJ,uBAAuB,CAAC,EAAE,OAAO,CAAC;SACnC,CAAC;QACF,kBAAkB,CAAC,EAAE,YAAY,CAAC;KACnC;IAgHD;;;;;;;OAOG;IACU,iBAAiB,CAC5B,IAAI,EAAE,gCAAgC,EACtC,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAQzB;;;;;;;OAOG;IACU,kCAAkC,CAC7C,IAAI,EAAE,8BAA8B,EACpC,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC;IAQ3B;;;;;;;;OAQG;IACU,iBAAiB,CAC5B,IAAI,EAAE,gCAAgC,EACtC,KAAK,EAAE,MAAM,EACb,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;;;;OAQG;IACU,sBAAsB,CACjC,WAAW,SAAS,8BAA8B,EAElD,IAAI,EAAE,WAAW,EACjB,MAAM,EAAE,CAAC,sBAAsB,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,EAAE,EACvD,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;;OAMG;IACU,oBAAoB,CAC/B,IAAI,EAAE,gCAAgC,EACtC,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;;;OAOG;IACU,qCAAqC,CAChD,IAAI,EAAE,8BAA8B,EACpC,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC;IAOhB;;;;;;;;OAQG;IACU,yBAAyB,CACpC,WAAW,SAAS,8BAA8B,EAElD,IAAI,EAAE,WAAW,EACjB,MAAM,EAAE,sBAAsB,CAAC,WAAW,CAAC,EAAE,EAC7C,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC;IAOhB;;;;OAIG;IACU,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAI7C;;;;OAIG;IACI,oBAAoB,IAAI,IAAI;IAInC;;;;;OAKG;IACG,kBAAkB;IAkDX,gCAAgC,CAC3C,OAAO,EAAE,MAAM,OAAO,sBAAsB,EAC5C,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,IAAI,CAAC;IA6CV,qCAAqC,CACzC,kCAAkC,EAAE,OAAO,GAC1C,OAAO,CAAC,IAAI,CAAC;IAOV,sCAAsC,CAC1C,mCAAmC,EAAE,OAAO,GAC3C,OAAO,CAAC,IAAI,CAAC;IAOV,6BAA6B,CACjC,0BAA0B,EAAE,OAAO,GAClC,OAAO,CAAC,IAAI,CAAC;IAMhB;;;;OAIG;IACG,6BAA6B,CACjC,0BAA0B,EAAE,OAAO,GAClC,OAAO,CAAC,IAAI,CAAC;IAMhB;;;;OAIG;IACG,mCAAmC,IAAI,OAAO,CAAC,IAAI,CAAC;IA2C1D;;;;OAIG;IACG,gCAAgC,CACpC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAAC,IAAI,CAAC;IAOV,YAAY;IAwBlB;;;;OAIG;IACG,2BAA2B,IAAI,OAAO,CAAC,IAAI,CAAC;CA2BnD"}

package/dist/controllers/user-storage/UserStorageController.d.mts

@@ -1,4 +1,5 @@
-import type { AccountsControllerListAccountsAction, AccountsControllerUpdateAccountMetadataAction, AccountsControllerAccountRenamedEvent, AccountsControllerUpdateAccountsAction } from "@metamask/accounts-controller";
+import type { AccountsControllerListAccountsAction, AccountsControllerUpdateAccountMetadataAction, AccountsControllerAccountRenamedEvent, AccountsControllerAccountAddedEvent, AccountsControllerUpdateAccountsAction } from "@metamask/accounts-controller";
+import type { AddressBookControllerContactUpdatedEvent, AddressBookControllerContactDeletedEvent, AddressBookControllerActions, AddressBookControllerListAction, AddressBookControllerSetAction, AddressBookControllerDeleteAction } from "@metamask/address-book-controller";
 import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedMessenger } from "@metamask/base-controller";
 import { BaseController } from "@metamask/base-controller";
 import { type KeyringControllerGetStateAction, type KeyringControllerLockEvent, type KeyringControllerUnlockEvent, type KeyringControllerWithKeyringAction } from "@metamask/keyring-controller";
@@ -9,6 +10,7 @@ import { BACKUPANDSYNC_FEATURES } from "./constants.mjs";
 import type { UserStorageFeatureKeys } from "../../shared/storage-schema.mjs";
 import { type UserStoragePathWithFeatureAndKey, type UserStoragePathWithFeatureOnly } from "../../shared/storage-schema.mjs";
 import type { NativeScrypt } from "../../shared/types/encryption.mjs";
+import { EventQueue } from "../../shared/utils/event-queue.mjs";
 import type { AuthenticationControllerGetBearerToken, AuthenticationControllerGetSessionProfile, AuthenticationControllerIsSignedIn, AuthenticationControllerPerformSignIn } from "../authentication/AuthenticationController.mjs";
 declare const controllerName = "UserStorageController";
 export type UserStorageControllerState = {
@@ -24,6 +26,14 @@ export type UserStorageControllerState = {
      * Condition used by UI to determine if account syncing is enabled.
      */
     isAccountSyncingEnabled: boolean;
+    /**
+     * Condition used by UI to determine if contact syncing is enabled.
+     */
+    isContactSyncingEnabled: boolean;
+    /**
+     * Condition used by UI to determine if contact syncing is in progress.
+     */
+    isContactSyncingInProgress: boolean;
     /**
      * Condition used to determine if account syncing has been dispatched at least once.
      * This is used for event listeners to determine if they should be triggered.
@@ -63,6 +73,23 @@ type ControllerConfig = {
          */
         onAccountSyncErroneousSituation?: (profileId: string, situationMessage: string, sentryContext?: Record<string, unknown>) => void;
     };
+    contactSyncing?: {
+        /**
+         * Callback that fires when contact sync updates a contact.
+         * This is used for analytics.
+         */
+        onContactUpdated?: (profileId: string) => void;
+        /**
+         * Callback that fires when contact sync deletes a contact.
+         * This is used for analytics.
+         */
+        onContactDeleted?: (profileId: string) => void;
+        /**
+         * Callback that fires when an erroneous situation happens during contact sync.
+         * This is used for analytics.
+         */
+        onContactSyncErroneousSituation?: (profileId: string, situationMessage: string, sentryContext?: Record<string, unknown>) => void;
+    };
     networkSyncing?: {
         maxNumberOfNetworksToAdd?: number;
         /**
@@ -107,10 +134,10 @@ export type UserStorageControllerPerformBatchSetStorage = ActionsObj['performBat
 export type UserStorageControllerPerformDeleteStorage = ActionsObj['performDeleteStorage'];
 export type UserStorageControllerPerformBatchDeleteStorage = ActionsObj['performBatchDeleteStorage'];
 export type UserStorageControllerGetStorageKey = ActionsObj['getStorageKey'];
-export type AllowedActions = KeyringControllerGetStateAction | HandleSnapRequest | AuthenticationControllerGetBearerToken | AuthenticationControllerGetSessionProfile | AuthenticationControllerPerformSignIn | AuthenticationControllerIsSignedIn | AccountsControllerListAccountsAction | AccountsControllerUpdateAccountMetadataAction | AccountsControllerUpdateAccountsAction | KeyringControllerWithKeyringAction | NetworkControllerGetStateAction | NetworkControllerAddNetworkAction | NetworkControllerRemoveNetworkAction | NetworkControllerUpdateNetworkAction;
+export type AllowedActions = KeyringControllerGetStateAction | HandleSnapRequest | AuthenticationControllerGetBearerToken | AuthenticationControllerGetSessionProfile | AuthenticationControllerPerformSignIn | AuthenticationControllerIsSignedIn | AccountsControllerListAccountsAction | AccountsControllerUpdateAccountMetadataAction | AccountsControllerUpdateAccountsAction | KeyringControllerWithKeyringAction | NetworkControllerGetStateAction | NetworkControllerAddNetworkAction | NetworkControllerRemoveNetworkAction | NetworkControllerUpdateNetworkAction | AddressBookControllerListAction | AddressBookControllerSetAction | AddressBookControllerDeleteAction | AddressBookControllerActions;
 export type UserStorageControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, UserStorageControllerState>;
 export type Events = UserStorageControllerStateChangeEvent;
-export type AllowedEvents = UserStorageControllerStateChangeEvent | KeyringControllerLockEvent | KeyringControllerUnlockEvent | AccountsControllerAccountRenamedEvent | NetworkControllerNetworkRemovedEvent;
+export type AllowedEvents = UserStorageControllerStateChangeEvent | KeyringControllerLockEvent | KeyringControllerUnlockEvent | AccountsControllerAccountRenamedEvent | AccountsControllerAccountAddedEvent | NetworkControllerNetworkRemovedEvent | AddressBookControllerContactUpdatedEvent | AddressBookControllerContactDeletedEvent;
 export type UserStorageControllerMessenger = RestrictedMessenger<typeof controllerName, Actions | AllowedActions, Events | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
 /**
  * Reusable controller that allows any team to store synchronized data for a given user.
@@ -122,6 +149,7 @@ export type UserStorageControllerMessenger = RestrictedMessenger<typeof controll
  */
 export default class UserStorageController extends BaseController<typeof controllerName, UserStorageControllerState, UserStorageControllerMessenger> {
     #private;
+    eventQueue: EventQueue;
     constructor({ messenger, state, env, config, nativeScryptCrypto, }: {
         messenger: UserStorageControllerMessenger;
         state?: UserStorageControllerState;
@@ -219,6 +247,12 @@ export default class UserStorageController extends BaseController<typeof control
     setHasAccountSyncingSyncedAtLeastOnce(hasAccountSyncingSyncedAtLeastOnce: boolean): Promise<void>;
     setIsAccountSyncingReadyToBeDispatched(isAccountSyncingReadyToBeDispatched: boolean): Promise<void>;
     setIsAccountSyncingInProgress(isAccountSyncingInProgress: boolean): Promise<void>;
+    /**
+     * Sets the isContactSyncingInProgress flag to prevent infinite loops during contact synchronization
+     *
+     * @param isContactSyncingInProgress - Whether contact syncing is in progress
+     */
+    setIsContactSyncingInProgress(isContactSyncingInProgress: boolean): Promise<void>;
     /**
      * Syncs the internal accounts list with the user storage accounts list.
      * This method is used to make sure that the internal accounts list is up-to-date with the user storage accounts list and vice-versa.
@@ -232,6 +266,12 @@ export default class UserStorageController extends BaseController<typeof control
      */
     saveInternalAccountToUserStorage(internalAccount: InternalAccount): Promise<void>;
     syncNetworks(): Promise<void>;
+    /**
+     * Syncs the address book list with the user storage address book list.
+     * This method is used to make sure that the address book list is up-to-date with the user storage address book list and vice-versa.
+     * It will add new contacts to the address book list, update/merge conflicting contacts and re-upload the results in some cases to the user storage.
+     */
+    syncContactsWithUserStorage(): Promise<void>;
 }
 export {};
 //# sourceMappingURL=UserStorageController.d.mts.map