@metamask/profile-sync-controller 0.4.0 → 0.6.0

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

@@ -1,20 +1,459 @@
-import {
-  UserStorageController,
-  defaultState
-} from "../../chunk-SZ6WMC6C.mjs";
-import "../../chunk-ZUPTMFEA.mjs";
-import "../../chunk-EHZFPUJH.mjs";
-import "../../chunk-NMIF3LSX.mjs";
-import "../../chunk-76NMME23.mjs";
-import "../../chunk-2VEMA6OE.mjs";
-import "../../chunk-KHASG4H3.mjs";
-import "../../chunk-COBJUBZE.mjs";
-import "../../chunk-H25EBXG5.mjs";
-import "../../chunk-76VRE4BI.mjs";
-import "../../chunk-KTCSRECK.mjs";
-import "../../chunk-U5UIDVOO.mjs";
-export {
-  UserStorageController as default,
-  defaultState
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _UserStorageController_instances, _UserStorageController_auth, _UserStorageController_accounts, _UserStorageController_config, _UserStorageController_notificationServices, _UserStorageController_isUnlocked, _UserStorageController_keyringController, _UserStorageController_nativeScryptCrypto, _UserStorageController_registerMessageHandlers, _UserStorageController_assertProfileSyncingEnabled, _UserStorageController_getStorageKeyAndBearerToken, _UserStorageController_createStorageKey, _UserStorageController__snapSignMessageCache, _UserStorageController_snapSignMessage, _UserStorageController_setIsProfileSyncingUpdateLoading;
+import { BaseController } from "@metamask/base-controller";
+import { createSnapSignMessageRequest } from "../authentication/auth-snap-requests.mjs";
+import { isNameDefaultAccountName, mapInternalAccountToUserStorageAccount } from "./accounts/user-storage.mjs";
+import { createSHA256Hash } from "./encryption/index.mjs";
+import { startNetworkSyncing } from "./network-syncing/controller-integration.mjs";
+import { getUserStorage, getUserStorageAllFeatureEntries, upsertUserStorage } from "./services.mjs";
+const controllerName = 'UserStorageController';
+export const defaultState = {
+    isProfileSyncingEnabled: true,
+    isProfileSyncingUpdateLoading: false,
+};
+const metadata = {
+    isProfileSyncingEnabled: {
+        persist: true,
+        anonymous: true,
+    },
+    isProfileSyncingUpdateLoading: {
+        persist: false,
+        anonymous: false,
+    },
+};
+/**
+ * Reusable controller that allows any team to store synchronized data for a given user.
+ * These can be settings shared cross MetaMask clients, or data we want to persist when uninstalling/reinstalling.
+ *
+ * NOTE:
+ * - data stored on UserStorage is FULLY encrypted, with the only keys stored/managed on the client.
+ * - No one can access this data unless they are have the SRP and are able to run the signing snap.
+ */
+class UserStorageController extends BaseController {
+    constructor({ messenger, state, env, config, getMetaMetricsState, nativeScryptCrypto, }) {
+        super({
+            messenger,
+            metadata,
+            name: controllerName,
+            state: { ...defaultState, ...state },
+        });
+        _UserStorageController_instances.add(this);
+        _UserStorageController_auth.set(this, {
+            getBearerToken: async () => {
+                return await this.messagingSystem.call('AuthenticationController:getBearerToken');
+            },
+            getProfileId: async () => {
+                const sessionProfile = await this.messagingSystem.call('AuthenticationController:getSessionProfile');
+                return sessionProfile?.profileId;
+            },
+            isAuthEnabled: () => {
+                return this.messagingSystem.call('AuthenticationController:isSignedIn');
+            },
+            signIn: async () => {
+                return await this.messagingSystem.call('AuthenticationController:performSignIn');
+            },
+            signOut: async () => {
+                return this.messagingSystem.call('AuthenticationController:performSignOut');
+            },
+        });
+        _UserStorageController_accounts.set(this, {
+            // This is replaced with the actual value in the constructor
+            // We will remove this once the feature will be released
+            isAccountSyncingEnabled: false,
+            isAccountSyncingInProgress: false,
+            canSync: () => {
+                try {
+                    __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_assertProfileSyncingEnabled).call(this);
+                    return (__classPrivateFieldGet(this, _UserStorageController_accounts, "f").isAccountSyncingEnabled && __classPrivateFieldGet(this, _UserStorageController_auth, "f").isAuthEnabled());
+                }
+                catch {
+                    return false;
+                }
+            },
+            setupAccountSyncingSubscriptions: () => {
+                this.messagingSystem.subscribe('AccountsController:accountAdded', 
+                // eslint-disable-next-line @typescript-eslint/no-misused-promises
+                async (account) => {
+                    if (__classPrivateFieldGet(this, _UserStorageController_accounts, "f").isAccountSyncingInProgress) {
+                        return;
+                    }
+                    await this.saveInternalAccountToUserStorage(account);
+                });
+                this.messagingSystem.subscribe('AccountsController:accountRenamed', 
+                // eslint-disable-next-line @typescript-eslint/no-misused-promises
+                async (account) => {
+                    if (__classPrivateFieldGet(this, _UserStorageController_accounts, "f").isAccountSyncingInProgress) {
+                        return;
+                    }
+                    await this.saveInternalAccountToUserStorage(account);
+                });
+            },
+            getInternalAccountsList: async () => {
+                return this.messagingSystem.call('AccountsController:listAccounts');
+            },
+            getUserStorageAccountsList: async () => {
+                const rawAccountsListResponse = await this.performGetStorageAllFeatureEntries('accounts');
+                return (rawAccountsListResponse?.map((rawAccount) => JSON.parse(rawAccount)) ??
+                    null);
+            },
+            saveInternalAccountToUserStorage: async (internalAccount) => {
+                // Map the internal account to the user storage account schema
+                const mappedAccount = mapInternalAccountToUserStorageAccount(internalAccount);
+                await this.performSetStorage(`accounts.${internalAccount.address}`, JSON.stringify(mappedAccount));
+            },
+            saveInternalAccountsListToUserStorage: async () => {
+                const internalAccountsList = await __classPrivateFieldGet(this, _UserStorageController_accounts, "f").getInternalAccountsList();
+                if (!internalAccountsList) {
+                    return;
+                }
+                const userStorageAccountsList = internalAccountsList.map(mapInternalAccountToUserStorageAccount);
+                await Promise.all(userStorageAccountsList.map(async (userStorageAccount) => {
+                    await this.performSetStorage(`accounts.${userStorageAccount.a}`, JSON.stringify(userStorageAccount));
+                }));
+            },
+        });
+        _UserStorageController_config.set(this, void 0);
+        _UserStorageController_notificationServices.set(this, {
+            disableNotificationServices: async () => {
+                return await this.messagingSystem.call('NotificationServicesController:disableNotificationServices');
+            },
+            selectIsNotificationServicesEnabled: async () => {
+                return this.messagingSystem.call('NotificationServicesController:selectIsNotificationServicesEnabled');
+            },
+        });
+        _UserStorageController_isUnlocked.set(this, false);
+        _UserStorageController_keyringController.set(this, {
+            setupLockedStateSubscriptions: () => {
+                const { isUnlocked } = this.messagingSystem.call('KeyringController:getState');
+                __classPrivateFieldSet(this, _UserStorageController_isUnlocked, isUnlocked, "f");
+                this.messagingSystem.subscribe('KeyringController:unlock', () => {
+                    __classPrivateFieldSet(this, _UserStorageController_isUnlocked, true, "f");
+                });
+                this.messagingSystem.subscribe('KeyringController:lock', () => {
+                    __classPrivateFieldSet(this, _UserStorageController_isUnlocked, false, "f");
+                });
+            },
+        });
+        _UserStorageController_nativeScryptCrypto.set(this, undefined);
+        _UserStorageController__snapSignMessageCache.set(this, {});
+        __classPrivateFieldSet(this, _UserStorageController_config, config, "f");
+        __classPrivateFieldGet(this, _UserStorageController_accounts, "f").isAccountSyncingEnabled = Boolean(env?.isAccountSyncingEnabled);
+        this.getMetaMetricsState = getMetaMetricsState;
+        __classPrivateFieldGet(this, _UserStorageController_keyringController, "f").setupLockedStateSubscriptions();
+        __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_registerMessageHandlers).call(this);
+        __classPrivateFieldSet(this, _UserStorageController_nativeScryptCrypto, nativeScryptCrypto, "f");
+        __classPrivateFieldGet(this, _UserStorageController_accounts, "f").setupAccountSyncingSubscriptions();
+        // Network Syncing
+        if (env?.isNetworkSyncingEnabled) {
+            startNetworkSyncing({
+                messenger,
+                getStorageConfig: async () => {
+                    const { storageKey, bearerToken } = await __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_getStorageKeyAndBearerToken).call(this);
+                    return {
+                        storageKey,
+                        bearerToken,
+                        nativeScryptCrypto: __classPrivateFieldGet(this, _UserStorageController_nativeScryptCrypto, "f"),
+                    };
+                },
+            });
+        }
+    }
+    async enableProfileSyncing() {
+        try {
+            __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_setIsProfileSyncingUpdateLoading).call(this, true);
+            const authEnabled = __classPrivateFieldGet(this, _UserStorageController_auth, "f").isAuthEnabled();
+            if (!authEnabled) {
+                await __classPrivateFieldGet(this, _UserStorageController_auth, "f").signIn();
+            }
+            this.update((state) => {
+                state.isProfileSyncingEnabled = true;
+            });
+            __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_setIsProfileSyncingUpdateLoading).call(this, false);
+        }
+        catch (e) {
+            __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_setIsProfileSyncingUpdateLoading).call(this, false);
+            const errorMessage = e instanceof Error ? e.message : JSON.stringify(e);
+            throw new Error(`${controllerName} - failed to enable profile syncing - ${errorMessage}`);
+        }
+    }
+    async setIsProfileSyncingEnabled(isProfileSyncingEnabled) {
+        this.update((state) => {
+            state.isProfileSyncingEnabled = isProfileSyncingEnabled;
+        });
+    }
+    async disableProfileSyncing() {
+        const isAlreadyDisabled = !this.state.isProfileSyncingEnabled;
+        if (isAlreadyDisabled) {
+            return;
+        }
+        try {
+            __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_setIsProfileSyncingUpdateLoading).call(this, true);
+            const isNotificationServicesEnabled = await __classPrivateFieldGet(this, _UserStorageController_notificationServices, "f").selectIsNotificationServicesEnabled();
+            if (isNotificationServicesEnabled) {
+                await __classPrivateFieldGet(this, _UserStorageController_notificationServices, "f").disableNotificationServices();
+            }
+            const isMetaMetricsParticipation = this.getMetaMetricsState();
+            if (!isMetaMetricsParticipation) {
+                await __classPrivateFieldGet(this, _UserStorageController_auth, "f").signOut();
+            }
+            __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_setIsProfileSyncingUpdateLoading).call(this, false);
+            this.update((state) => {
+                state.isProfileSyncingEnabled = false;
+            });
+        }
+        catch (e) {
+            __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_setIsProfileSyncingUpdateLoading).call(this, false);
+            const errorMessage = e instanceof Error ? e.message : JSON.stringify(e);
+            throw new Error(`${controllerName} - failed to disable profile syncing - ${errorMessage}`);
+        }
+    }
+    /**
+     * Allows retrieval of stored data. Data stored is string formatted.
+     * Developers can extend the entry path and entry name through the `schema.ts` file.
+     *
+     * @param path - string in the form of `${feature}.${key}` that matches schema
+     * @returns the decrypted string contents found from user storage (or null if not found)
+     */
+    async performGetStorage(path) {
+        __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_assertProfileSyncingEnabled).call(this);
+        const { bearerToken, storageKey } = await __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_getStorageKeyAndBearerToken).call(this);
+        const result = await getUserStorage({
+            path,
+            bearerToken,
+            storageKey,
+            nativeScryptCrypto: __classPrivateFieldGet(this, _UserStorageController_nativeScryptCrypto, "f"),
+        });
+        return result;
+    }
+    /**
+     * Allows retrieval of all stored data for a specific feature. Data stored is formatted as an array of strings.
+     * Developers can extend the entry path through the `schema.ts` file.
+     *
+     * @param path - string in the form of `${feature}` that matches schema
+     * @returns the array of decrypted string contents found from user storage (or null if not found)
+     */
+    async performGetStorageAllFeatureEntries(path) {
+        __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_assertProfileSyncingEnabled).call(this);
+        const { bearerToken, storageKey } = await __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_getStorageKeyAndBearerToken).call(this);
+        const result = await getUserStorageAllFeatureEntries({
+            path,
+            bearerToken,
+            storageKey,
+            nativeScryptCrypto: __classPrivateFieldGet(this, _UserStorageController_nativeScryptCrypto, "f"),
+        });
+        return result;
+    }
+    /**
+     * Allows storage of user data. Data stored must be string formatted.
+     * Developers can extend the entry path and entry name through the `schema.ts` file.
+     *
+     * @param path - string in the form of `${feature}.${key}` that matches schema
+     * @param value - The string data you want to store.
+     * @returns nothing. NOTE that an error is thrown if fails to store data.
+     */
+    async performSetStorage(path, value) {
+        __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_assertProfileSyncingEnabled).call(this);
+        const { bearerToken, storageKey } = await __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_getStorageKeyAndBearerToken).call(this);
+        await upsertUserStorage(value, {
+            path,
+            bearerToken,
+            storageKey,
+            nativeScryptCrypto: __classPrivateFieldGet(this, _UserStorageController_nativeScryptCrypto, "f"),
+        });
+    }
+    /**
+     * Retrieves the storage key, for internal use only!
+     *
+     * @returns the storage key
+     */
+    async getStorageKey() {
+        __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_assertProfileSyncingEnabled).call(this);
+        const storageKey = await __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_createStorageKey).call(this);
+        return storageKey;
+    }
+    /**
+     * 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.
+     * 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.
+     */
+    async syncInternalAccountsWithUserStorage() {
+        if (!__classPrivateFieldGet(this, _UserStorageController_accounts, "f").canSync()) {
+            return;
+        }
+        try {
+            __classPrivateFieldGet(this, _UserStorageController_accounts, "f").isAccountSyncingInProgress = true;
+            const profileId = await __classPrivateFieldGet(this, _UserStorageController_auth, "f").getProfileId();
+            const userStorageAccountsList = await __classPrivateFieldGet(this, _UserStorageController_accounts, "f").getUserStorageAccountsList();
+            if (!userStorageAccountsList || !userStorageAccountsList.length) {
+                await __classPrivateFieldGet(this, _UserStorageController_accounts, "f").saveInternalAccountsListToUserStorage();
+                return;
+            }
+            // Compare internal accounts list with user storage accounts list
+            // First step: compare lengths
+            let internalAccountsList = await __classPrivateFieldGet(this, _UserStorageController_accounts, "f").getInternalAccountsList();
+            if (!internalAccountsList || !internalAccountsList.length) {
+                throw new Error(`Failed to get internal accounts list`);
+            }
+            const hasMoreInternalAccountsThanUserStorageAccounts = internalAccountsList.length > userStorageAccountsList.length;
+            // We don't want to remove existing accounts for a user
+            // so we only add new accounts if the user has more accounts than the internal accounts list
+            if (!hasMoreInternalAccountsThanUserStorageAccounts) {
+                const numberOfAccountsToAdd = userStorageAccountsList.length - internalAccountsList.length;
+                // Create new accounts to match the user storage accounts list
+                const addNewAccountsPromises = Array.from({
+                    length: numberOfAccountsToAdd,
+                }).map(async () => {
+                    await this.messagingSystem.call('KeyringController:addNewAccount');
+                    __classPrivateFieldGet(this, _UserStorageController_config, "f")?.accountSyncing?.onAccountAdded?.(profileId);
+                });
+                await Promise.all(addNewAccountsPromises);
+            }
+            // Second step: compare account names
+            // Get the internal accounts list again since new accounts might have been added in the previous step
+            internalAccountsList = await __classPrivateFieldGet(this, _UserStorageController_accounts, "f").getInternalAccountsList();
+            for await (const internalAccount of internalAccountsList) {
+                const userStorageAccount = userStorageAccountsList.find((account) => account.a === internalAccount.address);
+                if (!userStorageAccount) {
+                    await __classPrivateFieldGet(this, _UserStorageController_accounts, "f").saveInternalAccountToUserStorage(internalAccount);
+                    continue;
+                }
+                // One or both accounts have default names
+                const isInternalAccountNameDefault = isNameDefaultAccountName(internalAccount.metadata.name);
+                const isUserStorageAccountNameDefault = isNameDefaultAccountName(userStorageAccount.n);
+                // Internal account has default name
+                if (isInternalAccountNameDefault) {
+                    if (!isUserStorageAccountNameDefault) {
+                        this.messagingSystem.call('AccountsController:updateAccountMetadata', internalAccount.id, {
+                            name: userStorageAccount.n,
+                        });
+                        __classPrivateFieldGet(this, _UserStorageController_config, "f")?.accountSyncing?.onAccountNameUpdated?.(profileId);
+                    }
+                    continue;
+                }
+                // Internal account has custom name but user storage account has default name
+                if (isUserStorageAccountNameDefault) {
+                    await __classPrivateFieldGet(this, _UserStorageController_accounts, "f").saveInternalAccountToUserStorage(internalAccount);
+                    continue;
+                }
+                // Both accounts have custom names
+                // User storage account has a nameLastUpdatedAt timestamp
+                // Note: not storing the undefined checks in constants to act as a type guard
+                if (userStorageAccount.nlu !== undefined) {
+                    if (internalAccount.metadata.nameLastUpdatedAt !== undefined) {
+                        const isInternalAccountNameNewer = internalAccount.metadata.nameLastUpdatedAt >
+                            userStorageAccount.nlu;
+                        if (isInternalAccountNameNewer) {
+                            await __classPrivateFieldGet(this, _UserStorageController_accounts, "f").saveInternalAccountToUserStorage(internalAccount);
+                            continue;
+                        }
+                    }
+                    this.messagingSystem.call('AccountsController:updateAccountMetadata', internalAccount.id, {
+                        name: userStorageAccount.n,
+                        nameLastUpdatedAt: userStorageAccount.nlu,
+                    });
+                    __classPrivateFieldGet(this, _UserStorageController_config, "f")?.accountSyncing?.onAccountNameUpdated?.(profileId);
+                    continue;
+                }
+                else if (internalAccount.metadata.nameLastUpdatedAt !== undefined) {
+                    await __classPrivateFieldGet(this, _UserStorageController_accounts, "f").saveInternalAccountToUserStorage(internalAccount);
+                    continue;
+                }
+            }
+        }
+        catch (e) {
+            const errorMessage = e instanceof Error ? e.message : JSON.stringify(e);
+            throw new Error(`${controllerName} - failed to sync user storage accounts list - ${errorMessage}`);
+        }
+        finally {
+            __classPrivateFieldGet(this, _UserStorageController_accounts, "f").isAccountSyncingInProgress = false;
+        }
+    }
+    /**
+     * Saves an individual internal account to the user storage.
+     * @param internalAccount - The internal account to save
+     */
+    async saveInternalAccountToUserStorage(internalAccount) {
+        if (!__classPrivateFieldGet(this, _UserStorageController_accounts, "f").canSync()) {
+            return;
+        }
+        try {
+            await __classPrivateFieldGet(this, _UserStorageController_accounts, "f").saveInternalAccountToUserStorage(internalAccount);
+        }
+        catch (e) {
+            const errorMessage = e instanceof Error ? e.message : JSON.stringify(e);
+            throw new Error(`${controllerName} - failed to save account to user storage - ${errorMessage}`);
+        }
+    }
+}
+_UserStorageController_auth = new WeakMap(), _UserStorageController_accounts = new WeakMap(), _UserStorageController_config = new WeakMap(), _UserStorageController_notificationServices = new WeakMap(), _UserStorageController_isUnlocked = 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));
+    this.messagingSystem.registerActionHandler('UserStorageController:performGetStorageAllFeatureEntries', this.performGetStorageAllFeatureEntries.bind(this));
+    this.messagingSystem.registerActionHandler('UserStorageController:performSetStorage', this.performSetStorage.bind(this));
+    this.messagingSystem.registerActionHandler('UserStorageController:getStorageKey', this.getStorageKey.bind(this));
+    this.messagingSystem.registerActionHandler('UserStorageController:enableProfileSyncing', this.enableProfileSyncing.bind(this));
+    this.messagingSystem.registerActionHandler('UserStorageController:disableProfileSyncing', this.disableProfileSyncing.bind(this));
+    this.messagingSystem.registerActionHandler('UserStorageController:syncInternalAccountsWithUserStorage', this.syncInternalAccountsWithUserStorage.bind(this));
+    this.messagingSystem.registerActionHandler('UserStorageController:saveInternalAccountToUserStorage', this.saveInternalAccountToUserStorage.bind(this));
+}, _UserStorageController_assertProfileSyncingEnabled = function _UserStorageController_assertProfileSyncingEnabled() {
+    if (!this.state.isProfileSyncingEnabled) {
+        throw new Error(`${controllerName}: Unable to call method, user is not authenticated`);
+    }
+}, _UserStorageController_getStorageKeyAndBearerToken = 
+/**
+ * Utility to get the bearer token and storage key
+ */
+async function _UserStorageController_getStorageKeyAndBearerToken() {
+    const bearerToken = await __classPrivateFieldGet(this, _UserStorageController_auth, "f").getBearerToken();
+    if (!bearerToken) {
+        throw new Error('UserStorageController - unable to get bearer token');
+    }
+    const storageKey = await __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_createStorageKey).call(this);
+    return { bearerToken, storageKey };
+}, _UserStorageController_createStorageKey = 
+/**
+ * Rather than storing the storage key, we can compute the storage key when needed.
+ *
+ * @returns the storage key
+ */
+async function _UserStorageController_createStorageKey() {
+    const id = await __classPrivateFieldGet(this, _UserStorageController_auth, "f").getProfileId();
+    if (!id) {
+        throw new Error('UserStorageController - unable to create storage key');
+    }
+    const storageKeySignature = await __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_snapSignMessage).call(this, `metamask:${id}`);
+    const storageKey = createSHA256Hash(storageKeySignature);
+    return storageKey;
+}, _UserStorageController_snapSignMessage = 
+/**
+ * Signs a specific message using an underlying auth snap.
+ *
+ * @param message - A specific tagged message to sign.
+ * @returns A Signature created by the snap.
+ */
+async function _UserStorageController_snapSignMessage(message) {
+    if (__classPrivateFieldGet(this, _UserStorageController__snapSignMessageCache, "f")[message]) {
+        return __classPrivateFieldGet(this, _UserStorageController__snapSignMessageCache, "f")[message];
+    }
+    if (!__classPrivateFieldGet(this, _UserStorageController_isUnlocked, "f")) {
+        throw new Error('#snapSignMessage - unable to call snap, wallet is locked');
+    }
+    const result = (await this.messagingSystem.call('SnapController:handleRequest', createSnapSignMessageRequest(message)));
+    __classPrivateFieldGet(this, _UserStorageController__snapSignMessageCache, "f")[message] = result;
+    return result;
+}, _UserStorageController_setIsProfileSyncingUpdateLoading = function _UserStorageController_setIsProfileSyncingUpdateLoading(isProfileSyncingUpdateLoading) {
+    this.update((state) => {
+        state.isProfileSyncingUpdateLoading = isProfileSyncingUpdateLoading;
+    });
+};
+export default UserStorageController;
 //# sourceMappingURL=UserStorageController.mjs.map

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

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"UserStorageController.mjs","sourceRoot":"","sources":["../../../src/controllers/user-storage/UserStorageController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAYA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAW3D,OAAO,EAAE,4BAA4B,EAAE,iDAA6C;AASpF,OAAO,EACL,wBAAwB,EACxB,sCAAsC,EACvC,oCAAgC;AACjC,OAAO,EAAE,gBAAgB,EAAE,+BAAqB;AAChD,OAAO,EAAE,mBAAmB,EAAE,qDAAiD;AAK/E,OAAO,EACL,cAAc,EACd,+BAA+B,EAC/B,iBAAiB,EAClB,uBAAmB;AA6CpB,MAAM,cAAc,GAAG,uBAAuB,CAAC;AAc/C,MAAM,CAAC,MAAM,YAAY,GAA+B;IACtD,uBAAuB,EAAE,IAAI;IAC7B,6BAA6B,EAAE,KAAK;CACrC,CAAC;AAEF,MAAM,QAAQ,GAA8C;IAC1D,uBAAuB,EAAE;QACvB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,IAAI;KAChB;IACD,6BAA6B,EAAE;QAC7B,OAAO,EAAE,KAAK;QACd,SAAS,EAAE,KAAK;KACjB;CACF,CAAC;AAsHF;;;;;;;GAOG;AACH,MAAqB,qBAAsB,SAAQ,cAIlD;IA0JC,YAAY,EACV,SAAS,EACT,KAAK,EACL,GAAG,EACH,MAAM,EACN,mBAAmB,EACnB,kBAAkB,GAWnB;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ;YACR,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE,EAAE,GAAG,YAAY,EAAE,GAAG,KAAK,EAAE;SACrC,CAAC,CAAC;;QAhLL,sCAAQ;YACN,cAAc,EAAE,KAAK,IAAI,EAAE;gBACzB,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CACpC,yCAAyC,CAC1C,CAAC;YACJ,CAAC;YACD,YAAY,EAAE,KAAK,IAAI,EAAE;gBACvB,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CACpD,4CAA4C,CAC7C,CAAC;gBACF,OAAO,cAAc,EAAE,SAAS,CAAC;YACnC,CAAC;YACD,aAAa,EAAE,GAAG,EAAE;gBAClB,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;YACD,OAAO,EAAE,KAAK,IAAI,EAAE;gBAClB,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAC9B,yCAAyC,CAC1C,CAAC;YACJ,CAAC;SACF,EAAC;QAEF,0CAAY;YACV,4DAA4D;YAC5D,wDAAwD;YACxD,uBAAuB,EAAE,KAAK;YAC9B,0BAA0B,EAAE,KAAK;YACjC,OAAO,EAAE,GAAG,EAAE;gBACZ,IAAI;oBACF,uBAAA,IAAI,4FAA6B,MAAjC,IAAI,CAA+B,CAAC;oBAEpC,OAAO,CACL,uBAAA,IAAI,uCAAU,CAAC,uBAAuB,IAAI,uBAAA,IAAI,mCAAM,CAAC,aAAa,EAAE,CACrE,CAAC;iBACH;gBAAC,MAAM;oBACN,OAAO,KAAK,CAAC;iBACd;YACH,CAAC;YACD,gCAAgC,EAAE,GAAG,EAAE;gBACrC,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,iCAAiC;gBACjC,kEAAkE;gBAClE,KAAK,EAAE,OAAO,EAAE,EAAE;oBAChB,IAAI,uBAAA,IAAI,uCAAU,CAAC,0BAA0B,EAAE;wBAC7C,OAAO;qBACR;oBACD,MAAM,IAAI,CAAC,gCAAgC,CAAC,OAAO,CAAC,CAAC;gBACvD,CAAC,CACF,CAAC;gBAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC;gBACnC,kEAAkE;gBAClE,KAAK,EAAE,OAAO,EAAE,EAAE;oBAChB,IAAI,uBAAA,IAAI,uCAAU,CAAC,0BAA0B,EAAE;wBAC7C,OAAO;qBACR;oBACD,MAAM,IAAI,CAAC,gCAAgC,CAAC,OAAO,CAAC,CAAC;gBACvD,CAAC,CACF,CAAC;YACJ,CAAC;YACD,uBAAuB,EAAE,KAAK,IAAgC,EAAE;gBAC9D,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;YACtE,CAAC;YACD,0BAA0B,EAAE,KAAK,IAE/B,EAAE;gBACF,MAAM,uBAAuB,GAC3B,MAAM,IAAI,CAAC,kCAAkC,CAAC,UAAU,CAAC,CAAC;gBAE5D,OAAO,CACL,uBAAuB,EAAE,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;oBACpE,IAAI,CACL,CAAC;YACJ,CAAC;YACD,gCAAgC,EAAE,KAAK,EACrC,eAAgC,EAChC,EAAE;gBACF,8DAA8D;gBAC9D,MAAM,aAAa,GACjB,sCAAsC,CAAC,eAAe,CAAC,CAAC;gBAE1D,MAAM,IAAI,CAAC,iBAAiB,CAC1B,YAAY,eAAe,CAAC,OAAO,EAAE,EACrC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAC9B,CAAC;YACJ,CAAC;YACD,qCAAqC,EAAE,KAAK,IAAI,EAAE;gBAChD,MAAM,oBAAoB,GACxB,MAAM,uBAAA,IAAI,uCAAU,CAAC,uBAAuB,EAAE,CAAC;gBAEjD,IAAI,CAAC,oBAAoB,EAAE;oBACzB,OAAO;iBACR;gBAED,MAAM,uBAAuB,GAAG,oBAAoB,CAAC,GAAG,CACtD,sCAAsC,CACvC,CAAC;gBAEF,MAAM,OAAO,CAAC,GAAG,CACf,uBAAuB,CAAC,GAAG,CAAC,KAAK,EAAE,kBAAkB,EAAE,EAAE;oBACvD,MAAM,IAAI,CAAC,iBAAiB,CAC1B,YAAY,kBAAkB,CAAC,CAAC,EAAE,EAClC,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,CACnC,CAAC;gBACJ,CAAC,CAAC,CACH,CAAC;YACJ,CAAC;SACF,EAAC;QAEF,gDAA2B;QAE3B,sDAAwB;YACtB,2BAA2B,EAAE,KAAK,IAAI,EAAE;gBACtC,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CACpC,4DAA4D,CAC7D,CAAC;YACJ,CAAC;YACD,mCAAmC,EAAE,KAAK,IAAI,EAAE;gBAC9C,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAC9B,oEAAoE,CACrE,CAAC;YACJ,CAAC;SACF,EAAC;QAEF,4CAAc,KAAK,EAAC;QAEpB,mDAAqB;YACnB,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;QAEF,oDAAgD,SAAS,EAAC;QAyS1D,uDAA+D,EAAE,EAAC;QA5QhE,uBAAA,IAAI,iCAAW,MAAM,MAAA,CAAC;QAEtB,uBAAA,IAAI,uCAAU,CAAC,uBAAuB,GAAG,OAAO,CAC9C,GAAG,EAAE,uBAAuB,CAC7B,CAAC;QAEF,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;QAC/C,uBAAA,IAAI,gDAAmB,CAAC,6BAA6B,EAAE,CAAC;QACxD,uBAAA,IAAI,wFAAyB,MAA7B,IAAI,CAA2B,CAAC;QAChC,uBAAA,IAAI,6CAAuB,kBAAkB,MAAA,CAAC;QAC9C,uBAAA,IAAI,uCAAU,CAAC,gCAAgC,EAAE,CAAC;QAElD,kBAAkB;QAClB,IAAI,GAAG,EAAE,uBAAuB,EAAE;YAChC,mBAAmB,CAAC;gBAClB,SAAS;gBACT,gBAAgB,EAAE,KAAK,IAAI,EAAE;oBAC3B,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAC/B,MAAM,uBAAA,IAAI,4FAA6B,MAAjC,IAAI,CAA+B,CAAC;oBAC5C,OAAO;wBACL,UAAU;wBACV,WAAW;wBACX,kBAAkB,EAAE,uBAAA,IAAI,iDAAoB;qBAC7C,CAAC;gBACJ,CAAC;aACF,CAAC,CAAC;SACJ;IACH,CAAC;IAgDM,KAAK,CAAC,oBAAoB;QAC/B,IAAI;YACF,uBAAA,IAAI,iGAAkC,MAAtC,IAAI,EAAmC,IAAI,CAAC,CAAC;YAE7C,MAAM,WAAW,GAAG,uBAAA,IAAI,mCAAM,CAAC,aAAa,EAAE,CAAC;YAC/C,IAAI,CAAC,WAAW,EAAE;gBAChB,MAAM,uBAAA,IAAI,mCAAM,CAAC,MAAM,EAAE,CAAC;aAC3B;YAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,uBAAuB,GAAG,IAAI,CAAC;YACvC,CAAC,CAAC,CAAC;YAEH,uBAAA,IAAI,iGAAkC,MAAtC,IAAI,EAAmC,KAAK,CAAC,CAAC;SAC/C;QAAC,OAAO,CAAC,EAAE;YACV,uBAAA,IAAI,iGAAkC,MAAtC,IAAI,EAAmC,KAAK,CAAC,CAAC;YAC9C,MAAM,YAAY,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACxE,MAAM,IAAI,KAAK,CACb,GAAG,cAAc,yCAAyC,YAAY,EAAE,CACzE,CAAC;SACH;IACH,CAAC;IAEM,KAAK,CAAC,0BAA0B,CACrC,uBAAgC;QAEhC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,qBAAqB;QAChC,MAAM,iBAAiB,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC;QAC9D,IAAI,iBAAiB,EAAE;YACrB,OAAO;SACR;QAED,IAAI;YACF,uBAAA,IAAI,iGAAkC,MAAtC,IAAI,EAAmC,IAAI,CAAC,CAAC;YAE7C,MAAM,6BAA6B,GACjC,MAAM,uBAAA,IAAI,mDAAsB,CAAC,mCAAmC,EAAE,CAAC;YAEzE,IAAI,6BAA6B,EAAE;gBACjC,MAAM,uBAAA,IAAI,mDAAsB,CAAC,2BAA2B,EAAE,CAAC;aAChE;YAED,MAAM,0BAA0B,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAE9D,IAAI,CAAC,0BAA0B,EAAE;gBAC/B,MAAM,uBAAA,IAAI,mCAAM,CAAC,OAAO,EAAE,CAAC;aAC5B;YAED,uBAAA,IAAI,iGAAkC,MAAtC,IAAI,EAAmC,KAAK,CAAC,CAAC;YAE9C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,uBAAuB,GAAG,KAAK,CAAC;YACxC,CAAC,CAAC,CAAC;SACJ;QAAC,OAAO,CAAC,EAAE;YACV,uBAAA,IAAI,iGAAkC,MAAtC,IAAI,EAAmC,KAAK,CAAC,CAAC;YAC9C,MAAM,YAAY,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACxE,MAAM,IAAI,KAAK,CACb,GAAG,cAAc,0CAA0C,YAAY,EAAE,CAC1E,CAAC;SACH;IACH,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,iBAAiB,CAC5B,IAAsC;QAEtC,uBAAA,IAAI,4FAA6B,MAAjC,IAAI,CAA+B,CAAC;QAEpC,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAC/B,MAAM,uBAAA,IAAI,4FAA6B,MAAjC,IAAI,CAA+B,CAAC;QAE5C,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC;YAClC,IAAI;YACJ,WAAW;YACX,UAAU;YACV,kBAAkB,EAAE,uBAAA,IAAI,iDAAoB;SAC7C,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,kCAAkC,CAC7C,IAAoC;QAEpC,uBAAA,IAAI,4FAA6B,MAAjC,IAAI,CAA+B,CAAC;QAEpC,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAC/B,MAAM,uBAAA,IAAI,4FAA6B,MAAjC,IAAI,CAA+B,CAAC;QAE5C,MAAM,MAAM,GAAG,MAAM,+BAA+B,CAAC;YACnD,IAAI;YACJ,WAAW;YACX,UAAU;YACV,kBAAkB,EAAE,uBAAA,IAAI,iDAAoB;SAC7C,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,iBAAiB,CAC5B,IAAsC,EACtC,KAAa;QAEb,uBAAA,IAAI,4FAA6B,MAAjC,IAAI,CAA+B,CAAC;QAEpC,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAC/B,MAAM,uBAAA,IAAI,4FAA6B,MAAjC,IAAI,CAA+B,CAAC;QAE5C,MAAM,iBAAiB,CAAC,KAAK,EAAE;YAC7B,IAAI;YACJ,WAAW;YACX,UAAU;YACV,kBAAkB,EAAE,uBAAA,IAAI,iDAAoB;SAC7C,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,aAAa;QACxB,uBAAA,IAAI,4FAA6B,MAAjC,IAAI,CAA+B,CAAC;QACpC,MAAM,UAAU,GAAG,MAAM,uBAAA,IAAI,iFAAkB,MAAtB,IAAI,CAAoB,CAAC;QAClD,OAAO,UAAU,CAAC;IACpB,CAAC;IA+ED;;;;OAIG;IACH,KAAK,CAAC,mCAAmC;QACvC,IAAI,CAAC,uBAAA,IAAI,uCAAU,CAAC,OAAO,EAAE,EAAE;YAC7B,OAAO;SACR;QAED,IAAI;YACF,uBAAA,IAAI,uCAAU,CAAC,0BAA0B,GAAG,IAAI,CAAC;YAEjD,MAAM,SAAS,GAAG,MAAM,uBAAA,IAAI,mCAAM,CAAC,YAAY,EAAE,CAAC;YAElD,MAAM,uBAAuB,GAC3B,MAAM,uBAAA,IAAI,uCAAU,CAAC,0BAA0B,EAAE,CAAC;YAEpD,IAAI,CAAC,uBAAuB,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE;gBAC/D,MAAM,uBAAA,IAAI,uCAAU,CAAC,qCAAqC,EAAE,CAAC;gBAC7D,OAAO;aACR;YAED,iEAAiE;YACjE,8BAA8B;YAC9B,IAAI,oBAAoB,GAAG,MAAM,uBAAA,IAAI,uCAAU,CAAC,uBAAuB,EAAE,CAAC;YAE1E,IAAI,CAAC,oBAAoB,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE;gBACzD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;aACzD;YAED,MAAM,8CAA8C,GAClD,oBAAoB,CAAC,MAAM,GAAG,uBAAuB,CAAC,MAAM,CAAC;YAE/D,uDAAuD;YACvD,4FAA4F;YAC5F,IAAI,CAAC,8CAA8C,EAAE;gBACnD,MAAM,qBAAqB,GACzB,uBAAuB,CAAC,MAAM,GAAG,oBAAoB,CAAC,MAAM,CAAC;gBAE/D,8DAA8D;gBAC9D,MAAM,sBAAsB,GAAG,KAAK,CAAC,IAAI,CAAC;oBACxC,MAAM,EAAE,qBAAqB;iBAC9B,CAAC,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;oBAChB,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;oBACnE,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,cAAc,EAAE,CAAC,SAAS,CAAC,CAAC;gBAC5D,CAAC,CAAC,CAAC;gBAEH,MAAM,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;aAC3C;YAED,qCAAqC;YACrC,qGAAqG;YACrG,oBAAoB,GAAG,MAAM,uBAAA,IAAI,uCAAU,CAAC,uBAAuB,EAAE,CAAC;YAEtE,IAAI,KAAK,EAAE,MAAM,eAAe,IAAI,oBAAoB,EAAE;gBACxD,MAAM,kBAAkB,GAAG,uBAAuB,CAAC,IAAI,CACrD,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,KAAK,eAAe,CAAC,OAAO,CACnD,CAAC;gBAEF,IAAI,CAAC,kBAAkB,EAAE;oBACvB,MAAM,uBAAA,IAAI,uCAAU,CAAC,gCAAgC,CACnD,eAAe,CAChB,CAAC;oBACF,SAAS;iBACV;gBAED,0CAA0C;gBAC1C,MAAM,4BAA4B,GAAG,wBAAwB,CAC3D,eAAe,CAAC,QAAQ,CAAC,IAAI,CAC9B,CAAC;gBACF,MAAM,+BAA+B,GAAG,wBAAwB,CAC9D,kBAAkB,CAAC,CAAC,CACrB,CAAC;gBAEF,oCAAoC;gBACpC,IAAI,4BAA4B,EAAE;oBAChC,IAAI,CAAC,+BAA+B,EAAE;wBACpC,IAAI,CAAC,eAAe,CAAC,IAAI,CACvB,0CAA0C,EAC1C,eAAe,CAAC,EAAE,EAClB;4BACE,IAAI,EAAE,kBAAkB,CAAC,CAAC;yBAC3B,CACF,CAAC;wBAEF,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,oBAAoB,EAAE,CAAC,SAAS,CAAC,CAAC;qBACjE;oBACD,SAAS;iBACV;gBAED,6EAA6E;gBAC7E,IAAI,+BAA+B,EAAE;oBACnC,MAAM,uBAAA,IAAI,uCAAU,CAAC,gCAAgC,CACnD,eAAe,CAChB,CAAC;oBACF,SAAS;iBACV;gBAED,kCAAkC;gBAElC,yDAAyD;gBACzD,6EAA6E;gBAC7E,IAAI,kBAAkB,CAAC,GAAG,KAAK,SAAS,EAAE;oBACxC,IAAI,eAAe,CAAC,QAAQ,CAAC,iBAAiB,KAAK,SAAS,EAAE;wBAC5D,MAAM,0BAA0B,GAC9B,eAAe,CAAC,QAAQ,CAAC,iBAAiB;4BAC1C,kBAAkB,CAAC,GAAG,CAAC;wBAEzB,IAAI,0BAA0B,EAAE;4BAC9B,MAAM,uBAAA,IAAI,uCAAU,CAAC,gCAAgC,CACnD,eAAe,CAChB,CAAC;4BACF,SAAS;yBACV;qBACF;oBAED,IAAI,CAAC,eAAe,CAAC,IAAI,CACvB,0CAA0C,EAC1C,eAAe,CAAC,EAAE,EAClB;wBACE,IAAI,EAAE,kBAAkB,CAAC,CAAC;wBAC1B,iBAAiB,EAAE,kBAAkB,CAAC,GAAG;qBAC1C,CACF,CAAC;oBAEF,uBAAA,IAAI,qCAAQ,EAAE,cAAc,EAAE,oBAAoB,EAAE,CAAC,SAAS,CAAC,CAAC;oBAEhE,SAAS;iBACV;qBAAM,IAAI,eAAe,CAAC,QAAQ,CAAC,iBAAiB,KAAK,SAAS,EAAE;oBACnE,MAAM,uBAAA,IAAI,uCAAU,CAAC,gCAAgC,CACnD,eAAe,CAChB,CAAC;oBACF,SAAS;iBACV;aACF;SACF;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,YAAY,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACxE,MAAM,IAAI,KAAK,CACb,GAAG,cAAc,kDAAkD,YAAY,EAAE,CAClF,CAAC;SACH;gBAAS;YACR,uBAAA,IAAI,uCAAU,CAAC,0BAA0B,GAAG,KAAK,CAAC;SACnD;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gCAAgC,CACpC,eAAgC;QAEhC,IAAI,CAAC,uBAAA,IAAI,uCAAU,CAAC,OAAO,EAAE,EAAE;YAC7B,OAAO;SACR;QAED,IAAI;YACF,MAAM,uBAAA,IAAI,uCAAU,CAAC,gCAAgC,CAAC,eAAe,CAAC,CAAC;SACxE;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,YAAY,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACxE,MAAM,IAAI,KAAK,CACb,GAAG,cAAc,+CAA+C,YAAY,EAAE,CAC/E,CAAC;SACH;IACH,CAAC;CACF;;IArbG,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,qCAAqC,EACrC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAC9B,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,6CAA6C,EAC7C,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CACtC,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,2DAA2D,EAC3D,IAAI,CAAC,mCAAmC,CAAC,IAAI,CAAC,IAAI,CAAC,CACpD,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,wDAAwD,EACxD,IAAI,CAAC,gCAAgC,CAAC,IAAI,CAAC,IAAI,CAAC,CACjD,CAAC;AACJ,CAAC;IA4JC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,uBAAuB,EAAE;QACvC,MAAM,IAAI,KAAK,CACb,GAAG,cAAc,oDAAoD,CACtE,CAAC;KACH;AACH,CAAC;AAED;;GAEG;AACH,KAAK;IAIH,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,mCAAM,CAAC,cAAc,EAAE,CAAC;IACtD,IAAI,CAAC,WAAW,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;KACvE;IACD,MAAM,UAAU,GAAG,MAAM,uBAAA,IAAI,iFAAkB,MAAtB,IAAI,CAAoB,CAAC;IAElD,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC;AACrC,CAAC;AAED;;;;GAIG;AACH,KAAK;IACH,MAAM,EAAE,GAAW,MAAM,uBAAA,IAAI,mCAAM,CAAC,YAAY,EAAE,CAAC;IACnD,IAAI,CAAC,EAAE,EAAE;QACP,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;KACzE;IAED,MAAM,mBAAmB,GAAG,MAAM,uBAAA,IAAI,gFAAiB,MAArB,IAAI,EAAkB,YAAY,EAAE,EAAE,CAAC,CAAC;IAC1E,MAAM,UAAU,GAAG,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;IACzD,OAAO,UAAU,CAAC;AACpB,CAAC;AAID;;;;;GAKG;AACH,KAAK,iDAAkB,OAA6B;IAClD,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,4BAA4B,CAAC,OAAO,CAAC,CACtC,CAAW,CAAC;IAEb,uBAAA,IAAI,oDAAuB,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC;IAE9C,OAAO,MAAM,CAAC;AAChB,CAAC,6HAGC,6BAAsC;IAEtC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,KAAK,CAAC,6BAA6B,GAAG,6BAA6B,CAAC;IACtE,CAAC,CAAC,CAAC;AACL,CAAC;eAtekB,qBAAqB","sourcesContent":["import type {\n  AccountsControllerListAccountsAction,\n  AccountsControllerUpdateAccountMetadataAction,\n  AccountsControllerAccountRenamedEvent,\n  AccountsControllerAccountAddedEvent,\n} from '@metamask/accounts-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  RestrictedControllerMessenger,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { InternalAccount } from '@metamask/keyring-api';\nimport type {\n  KeyringControllerGetStateAction,\n  KeyringControllerLockEvent,\n  KeyringControllerUnlockEvent,\n  KeyringControllerAddNewAccountAction,\n} from '@metamask/keyring-controller';\nimport type { NetworkConfiguration } from '@metamask/network-controller';\nimport type { HandleSnapRequest } from '@metamask/snaps-controllers';\n\nimport { createSnapSignMessageRequest } from '../authentication/auth-snap-requests';\nimport type {\n  AuthenticationControllerGetBearerToken,\n  AuthenticationControllerGetSessionProfile,\n  AuthenticationControllerIsSignedIn,\n  AuthenticationControllerPerformSignIn,\n  AuthenticationControllerPerformSignOut,\n} from '../authentication/AuthenticationController';\nimport type { UserStorageAccount } from './accounts/user-storage';\nimport {\n  isNameDefaultAccountName,\n  mapInternalAccountToUserStorageAccount,\n} from './accounts/user-storage';\nimport { createSHA256Hash } from './encryption';\nimport { startNetworkSyncing } from './network-syncing/controller-integration';\nimport type {\n  UserStoragePathWithFeatureAndKey,\n  UserStoragePathWithFeatureOnly,\n} from './schema';\nimport {\n  getUserStorage,\n  getUserStorageAllFeatureEntries,\n  upsertUserStorage,\n} from './services';\n\n// TODO: add external NetworkController event\n// Need to listen for when a network gets added\ntype NetworkControllerNetworkAddedEvent = {\n  type: 'NetworkController:networkAdded';\n  payload: [networkConfiguration: NetworkConfiguration];\n};\n\n// TODO: add external NetworkController event\n// Need to listen for when a network is updated, or the default rpc/block explorer changes\ntype NetworkControllerNetworkChangedEvent = {\n  type: 'NetworkController:networkChanged';\n  payload: [networkConfiguration: NetworkConfiguration];\n};\n\n// TODO: add external NetworkController event\n// Need to listen for when a network gets deleted\ntype NetworkControllerNetworkDeletedEvent = {\n  type: 'NetworkController:networkDeleted';\n  payload: [networkConfiguration: NetworkConfiguration];\n};\n\n// TODO: fix external dependencies\nexport declare type NotificationServicesControllerDisableNotificationServices =\n  {\n    type: `NotificationServicesController:disableNotificationServices`;\n    handler: () => Promise<void>;\n  };\n\nexport declare type NotificationServicesControllerSelectIsNotificationServicesEnabled =\n  {\n    type: `NotificationServicesController:selectIsNotificationServicesEnabled`;\n    handler: () => boolean;\n  };\n\nexport declare type NativeScrypt = (\n  passwd: string,\n  salt: Uint8Array,\n  N: number,\n  r: number,\n  p: number,\n  size: number,\n) => Promise<Uint8Array>;\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  isProfileSyncingEnabled: boolean | null;\n  /**\n   * Loading state for the profile syncing update\n   */\n  isProfileSyncingUpdateLoading: boolean;\n};\n\nexport const defaultState: UserStorageControllerState = {\n  isProfileSyncingEnabled: true,\n  isProfileSyncingUpdateLoading: false,\n};\n\nconst metadata: StateMetadata<UserStorageControllerState> = {\n  isProfileSyncingEnabled: {\n    persist: true,\n    anonymous: true,\n  },\n  isProfileSyncingUpdateLoading: {\n    persist: false,\n    anonymous: false,\n  },\n};\n\ntype ControllerConfig = {\n  accountSyncing?: {\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\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  | 'getStorageKey'\n  | 'enableProfileSyncing'\n  | 'disableProfileSyncing'\n  | 'syncInternalAccountsWithUserStorage'\n  | 'saveInternalAccountToUserStorage'\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 UserStorageControllerGetStorageKey = ActionsObj['getStorageKey'];\nexport type UserStorageControllerEnableProfileSyncing =\n  ActionsObj['enableProfileSyncing'];\nexport type UserStorageControllerDisableProfileSyncing =\n  ActionsObj['disableProfileSyncing'];\nexport type UserStorageControllerSyncInternalAccountsWithUserStorage =\n  ActionsObj['syncInternalAccountsWithUserStorage'];\nexport type UserStorageControllerSaveInternalAccountToUserStorage =\n  ActionsObj['saveInternalAccountToUserStorage'];\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  | AuthenticationControllerPerformSignOut\n  // Metamask Notifications\n  | NotificationServicesControllerDisableNotificationServices\n  | NotificationServicesControllerSelectIsNotificationServicesEnabled\n  // Account syncing\n  | AccountsControllerListAccountsAction\n  | AccountsControllerUpdateAccountMetadataAction\n  | KeyringControllerAddNewAccountAction;\n\n// Messenger events\nexport type UserStorageControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  UserStorageControllerState\n>;\nexport type UserStorageControllerAccountSyncingInProgress = {\n  type: `${typeof controllerName}:accountSyncingInProgress`;\n  payload: [boolean];\n};\nexport type UserStorageControllerAccountSyncingComplete = {\n  type: `${typeof controllerName}:accountSyncingComplete`;\n  payload: [boolean];\n};\nexport type Events =\n  | UserStorageControllerStateChangeEvent\n  | UserStorageControllerAccountSyncingInProgress\n  | UserStorageControllerAccountSyncingComplete;\n\nexport type AllowedEvents =\n  | UserStorageControllerStateChangeEvent\n  | UserStorageControllerAccountSyncingInProgress\n  | UserStorageControllerAccountSyncingComplete\n  | KeyringControllerLockEvent\n  | KeyringControllerUnlockEvent\n  // Account Syncing Events\n  | AccountsControllerAccountAddedEvent\n  | AccountsControllerAccountRenamedEvent\n  // Network Syncing Events\n  | NetworkControllerNetworkAddedEvent\n  | NetworkControllerNetworkChangedEvent\n  | NetworkControllerNetworkDeletedEvent;\n\n// Messenger\nexport type UserStorageControllerMessenger = RestrictedControllerMessenger<\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  #auth = {\n    getBearerToken: async () => {\n      return await this.messagingSystem.call(\n        'AuthenticationController:getBearerToken',\n      );\n    },\n    getProfileId: async () => {\n      const sessionProfile = await this.messagingSystem.call(\n        'AuthenticationController:getSessionProfile',\n      );\n      return sessionProfile?.profileId;\n    },\n    isAuthEnabled: () => {\n      return this.messagingSystem.call('AuthenticationController:isSignedIn');\n    },\n    signIn: async () => {\n      return await this.messagingSystem.call(\n        'AuthenticationController:performSignIn',\n      );\n    },\n    signOut: async () => {\n      return this.messagingSystem.call(\n        'AuthenticationController:performSignOut',\n      );\n    },\n  };\n\n  #accounts = {\n    // This is replaced with the actual value in the constructor\n    // We will remove this once the feature will be released\n    isAccountSyncingEnabled: false,\n    isAccountSyncingInProgress: false,\n    canSync: () => {\n      try {\n        this.#assertProfileSyncingEnabled();\n\n        return (\n          this.#accounts.isAccountSyncingEnabled && this.#auth.isAuthEnabled()\n        );\n      } catch {\n        return false;\n      }\n    },\n    setupAccountSyncingSubscriptions: () => {\n      this.messagingSystem.subscribe(\n        'AccountsController:accountAdded',\n        // eslint-disable-next-line @typescript-eslint/no-misused-promises\n        async (account) => {\n          if (this.#accounts.isAccountSyncingInProgress) {\n            return;\n          }\n          await this.saveInternalAccountToUserStorage(account);\n        },\n      );\n\n      this.messagingSystem.subscribe(\n        'AccountsController:accountRenamed',\n        // eslint-disable-next-line @typescript-eslint/no-misused-promises\n        async (account) => {\n          if (this.#accounts.isAccountSyncingInProgress) {\n            return;\n          }\n          await this.saveInternalAccountToUserStorage(account);\n        },\n      );\n    },\n    getInternalAccountsList: async (): Promise<InternalAccount[]> => {\n      return this.messagingSystem.call('AccountsController:listAccounts');\n    },\n    getUserStorageAccountsList: async (): Promise<\n      UserStorageAccount[] | null\n    > => {\n      const rawAccountsListResponse =\n        await this.performGetStorageAllFeatureEntries('accounts');\n\n      return (\n        rawAccountsListResponse?.map((rawAccount) => JSON.parse(rawAccount)) ??\n        null\n      );\n    },\n    saveInternalAccountToUserStorage: async (\n      internalAccount: InternalAccount,\n    ) => {\n      // Map the internal account to the user storage account schema\n      const mappedAccount =\n        mapInternalAccountToUserStorageAccount(internalAccount);\n\n      await this.performSetStorage(\n        `accounts.${internalAccount.address}`,\n        JSON.stringify(mappedAccount),\n      );\n    },\n    saveInternalAccountsListToUserStorage: async () => {\n      const internalAccountsList =\n        await this.#accounts.getInternalAccountsList();\n\n      if (!internalAccountsList) {\n        return;\n      }\n\n      const userStorageAccountsList = internalAccountsList.map(\n        mapInternalAccountToUserStorageAccount,\n      );\n\n      await Promise.all(\n        userStorageAccountsList.map(async (userStorageAccount) => {\n          await this.performSetStorage(\n            `accounts.${userStorageAccount.a}`,\n            JSON.stringify(userStorageAccount),\n          );\n        }),\n      );\n    },\n  };\n\n  #config?: ControllerConfig;\n\n  #notificationServices = {\n    disableNotificationServices: async () => {\n      return await this.messagingSystem.call(\n        'NotificationServicesController:disableNotificationServices',\n      );\n    },\n    selectIsNotificationServicesEnabled: async () => {\n      return this.messagingSystem.call(\n        'NotificationServicesController:selectIsNotificationServicesEnabled',\n      );\n    },\n  };\n\n  #isUnlocked = false;\n\n  #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  #nativeScryptCrypto: NativeScrypt | undefined = undefined;\n\n  getMetaMetricsState: () => boolean;\n\n  constructor({\n    messenger,\n    state,\n    env,\n    config,\n    getMetaMetricsState,\n    nativeScryptCrypto,\n  }: {\n    messenger: UserStorageControllerMessenger;\n    state?: UserStorageControllerState;\n    config?: ControllerConfig;\n    env?: {\n      isAccountSyncingEnabled?: boolean;\n      isNetworkSyncingEnabled?: boolean;\n    };\n    getMetaMetricsState: () => boolean;\n    nativeScryptCrypto?: NativeScrypt;\n  }) {\n    super({\n      messenger,\n      metadata,\n      name: controllerName,\n      state: { ...defaultState, ...state },\n    });\n\n    this.#config = config;\n\n    this.#accounts.isAccountSyncingEnabled = Boolean(\n      env?.isAccountSyncingEnabled,\n    );\n\n    this.getMetaMetricsState = getMetaMetricsState;\n    this.#keyringController.setupLockedStateSubscriptions();\n    this.#registerMessageHandlers();\n    this.#nativeScryptCrypto = nativeScryptCrypto;\n    this.#accounts.setupAccountSyncingSubscriptions();\n\n    // Network Syncing\n    if (env?.isNetworkSyncingEnabled) {\n      startNetworkSyncing({\n        messenger,\n        getStorageConfig: async () => {\n          const { storageKey, bearerToken } =\n            await this.#getStorageKeyAndBearerToken();\n          return {\n            storageKey,\n            bearerToken,\n            nativeScryptCrypto: this.#nativeScryptCrypto,\n          };\n        },\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:getStorageKey',\n      this.getStorageKey.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:enableProfileSyncing',\n      this.enableProfileSyncing.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:disableProfileSyncing',\n      this.disableProfileSyncing.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:syncInternalAccountsWithUserStorage',\n      this.syncInternalAccountsWithUserStorage.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:saveInternalAccountToUserStorage',\n      this.saveInternalAccountToUserStorage.bind(this),\n    );\n  }\n\n  public async enableProfileSyncing(): Promise<void> {\n    try {\n      this.#setIsProfileSyncingUpdateLoading(true);\n\n      const authEnabled = this.#auth.isAuthEnabled();\n      if (!authEnabled) {\n        await this.#auth.signIn();\n      }\n\n      this.update((state) => {\n        state.isProfileSyncingEnabled = true;\n      });\n\n      this.#setIsProfileSyncingUpdateLoading(false);\n    } catch (e) {\n      this.#setIsProfileSyncingUpdateLoading(false);\n      const errorMessage = e instanceof Error ? e.message : JSON.stringify(e);\n      throw new Error(\n        `${controllerName} - failed to enable profile syncing - ${errorMessage}`,\n      );\n    }\n  }\n\n  public async setIsProfileSyncingEnabled(\n    isProfileSyncingEnabled: boolean,\n  ): Promise<void> {\n    this.update((state) => {\n      state.isProfileSyncingEnabled = isProfileSyncingEnabled;\n    });\n  }\n\n  public async disableProfileSyncing(): Promise<void> {\n    const isAlreadyDisabled = !this.state.isProfileSyncingEnabled;\n    if (isAlreadyDisabled) {\n      return;\n    }\n\n    try {\n      this.#setIsProfileSyncingUpdateLoading(true);\n\n      const isNotificationServicesEnabled =\n        await this.#notificationServices.selectIsNotificationServicesEnabled();\n\n      if (isNotificationServicesEnabled) {\n        await this.#notificationServices.disableNotificationServices();\n      }\n\n      const isMetaMetricsParticipation = this.getMetaMetricsState();\n\n      if (!isMetaMetricsParticipation) {\n        await this.#auth.signOut();\n      }\n\n      this.#setIsProfileSyncingUpdateLoading(false);\n\n      this.update((state) => {\n        state.isProfileSyncingEnabled = false;\n      });\n    } catch (e) {\n      this.#setIsProfileSyncingUpdateLoading(false);\n      const errorMessage = e instanceof Error ? e.message : JSON.stringify(e);\n      throw new Error(\n        `${controllerName} - failed to disable profile syncing - ${errorMessage}`,\n      );\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   * @returns the decrypted string contents found from user storage (or null if not found)\n   */\n  public async performGetStorage(\n    path: UserStoragePathWithFeatureAndKey,\n  ): Promise<string | null> {\n    this.#assertProfileSyncingEnabled();\n\n    const { bearerToken, storageKey } =\n      await this.#getStorageKeyAndBearerToken();\n\n    const result = await getUserStorage({\n      path,\n      bearerToken,\n      storageKey,\n      nativeScryptCrypto: this.#nativeScryptCrypto,\n    });\n\n    return result;\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   * @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  ): Promise<string[] | null> {\n    this.#assertProfileSyncingEnabled();\n\n    const { bearerToken, storageKey } =\n      await this.#getStorageKeyAndBearerToken();\n\n    const result = await getUserStorageAllFeatureEntries({\n      path,\n      bearerToken,\n      storageKey,\n      nativeScryptCrypto: this.#nativeScryptCrypto,\n    });\n\n    return result;\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   * @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  ): Promise<void> {\n    this.#assertProfileSyncingEnabled();\n\n    const { bearerToken, storageKey } =\n      await this.#getStorageKeyAndBearerToken();\n\n    await upsertUserStorage(value, {\n      path,\n      bearerToken,\n      storageKey,\n      nativeScryptCrypto: this.#nativeScryptCrypto,\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    this.#assertProfileSyncingEnabled();\n    const storageKey = await this.#createStorageKey();\n    return storageKey;\n  }\n\n  #assertProfileSyncingEnabled(): void {\n    if (!this.state.isProfileSyncingEnabled) {\n      throw new Error(\n        `${controllerName}: Unable to call method, user is not authenticated`,\n      );\n    }\n  }\n\n  /**\n   * Utility to get the bearer token and storage key\n   */\n  async #getStorageKeyAndBearerToken(): Promise<{\n    bearerToken: string;\n    storageKey: string;\n  }> {\n    const bearerToken = await this.#auth.getBearerToken();\n    if (!bearerToken) {\n      throw new Error('UserStorageController - unable to get bearer token');\n    }\n    const storageKey = await this.#createStorageKey();\n\n    return { bearerToken, storageKey };\n  }\n\n  /**\n   * Rather than storing the storage key, we can compute the storage key when needed.\n   *\n   * @returns the storage key\n   */\n  async #createStorageKey(): Promise<string> {\n    const id: string = await this.#auth.getProfileId();\n    if (!id) {\n      throw new Error('UserStorageController - unable to create storage key');\n    }\n\n    const storageKeySignature = await this.#snapSignMessage(`metamask:${id}`);\n    const storageKey = createSHA256Hash(storageKeySignature);\n    return storageKey;\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   * @returns A Signature created by the snap.\n   */\n  async #snapSignMessage(message: `metamask:${string}`): Promise<string> {\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),\n    )) as string;\n\n    this.#_snapSignMessageCache[message] = result;\n\n    return result;\n  }\n\n  #setIsProfileSyncingUpdateLoading(\n    isProfileSyncingUpdateLoading: boolean,\n  ): void {\n    this.update((state) => {\n      state.isProfileSyncingUpdateLoading = isProfileSyncingUpdateLoading;\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    if (!this.#accounts.canSync()) {\n      return;\n    }\n\n    try {\n      this.#accounts.isAccountSyncingInProgress = true;\n\n      const profileId = await this.#auth.getProfileId();\n\n      const userStorageAccountsList =\n        await this.#accounts.getUserStorageAccountsList();\n\n      if (!userStorageAccountsList || !userStorageAccountsList.length) {\n        await this.#accounts.saveInternalAccountsListToUserStorage();\n        return;\n      }\n\n      // Compare internal accounts list with user storage accounts list\n      // First step: compare lengths\n      let internalAccountsList = await this.#accounts.getInternalAccountsList();\n\n      if (!internalAccountsList || !internalAccountsList.length) {\n        throw new Error(`Failed to get internal accounts list`);\n      }\n\n      const hasMoreInternalAccountsThanUserStorageAccounts =\n        internalAccountsList.length > userStorageAccountsList.length;\n\n      // We don't want to remove existing accounts for a user\n      // so we only add new accounts if the user has more accounts than the internal accounts list\n      if (!hasMoreInternalAccountsThanUserStorageAccounts) {\n        const numberOfAccountsToAdd =\n          userStorageAccountsList.length - internalAccountsList.length;\n\n        // Create new accounts to match the user storage accounts list\n        const addNewAccountsPromises = Array.from({\n          length: numberOfAccountsToAdd,\n        }).map(async () => {\n          await this.messagingSystem.call('KeyringController:addNewAccount');\n          this.#config?.accountSyncing?.onAccountAdded?.(profileId);\n        });\n\n        await Promise.all(addNewAccountsPromises);\n      }\n\n      // Second step: compare account names\n      // Get the internal accounts list again since new accounts might have been added in the previous step\n      internalAccountsList = await this.#accounts.getInternalAccountsList();\n\n      for await (const internalAccount of internalAccountsList) {\n        const userStorageAccount = userStorageAccountsList.find(\n          (account) => account.a === internalAccount.address,\n        );\n\n        if (!userStorageAccount) {\n          await this.#accounts.saveInternalAccountToUserStorage(\n            internalAccount,\n          );\n          continue;\n        }\n\n        // One or both accounts have default names\n        const isInternalAccountNameDefault = isNameDefaultAccountName(\n          internalAccount.metadata.name,\n        );\n        const isUserStorageAccountNameDefault = isNameDefaultAccountName(\n          userStorageAccount.n,\n        );\n\n        // Internal account has default name\n        if (isInternalAccountNameDefault) {\n          if (!isUserStorageAccountNameDefault) {\n            this.messagingSystem.call(\n              'AccountsController:updateAccountMetadata',\n              internalAccount.id,\n              {\n                name: userStorageAccount.n,\n              },\n            );\n\n            this.#config?.accountSyncing?.onAccountNameUpdated?.(profileId);\n          }\n          continue;\n        }\n\n        // Internal account has custom name but user storage account has default name\n        if (isUserStorageAccountNameDefault) {\n          await this.#accounts.saveInternalAccountToUserStorage(\n            internalAccount,\n          );\n          continue;\n        }\n\n        // Both accounts have custom names\n\n        // User storage account has a nameLastUpdatedAt timestamp\n        // Note: not storing the undefined checks in constants to act as a type guard\n        if (userStorageAccount.nlu !== undefined) {\n          if (internalAccount.metadata.nameLastUpdatedAt !== undefined) {\n            const isInternalAccountNameNewer =\n              internalAccount.metadata.nameLastUpdatedAt >\n              userStorageAccount.nlu;\n\n            if (isInternalAccountNameNewer) {\n              await this.#accounts.saveInternalAccountToUserStorage(\n                internalAccount,\n              );\n              continue;\n            }\n          }\n\n          this.messagingSystem.call(\n            'AccountsController:updateAccountMetadata',\n            internalAccount.id,\n            {\n              name: userStorageAccount.n,\n              nameLastUpdatedAt: userStorageAccount.nlu,\n            },\n          );\n\n          this.#config?.accountSyncing?.onAccountNameUpdated?.(profileId);\n\n          continue;\n        } else if (internalAccount.metadata.nameLastUpdatedAt !== undefined) {\n          await this.#accounts.saveInternalAccountToUserStorage(\n            internalAccount,\n          );\n          continue;\n        }\n      }\n    } catch (e) {\n      const errorMessage = e instanceof Error ? e.message : JSON.stringify(e);\n      throw new Error(\n        `${controllerName} - failed to sync user storage accounts list - ${errorMessage}`,\n      );\n    } finally {\n      this.#accounts.isAccountSyncingInProgress = false;\n    }\n  }\n\n  /**\n   * Saves an individual internal account to the user storage.\n   * @param internalAccount - The internal account to save\n   */\n  async saveInternalAccountToUserStorage(\n    internalAccount: InternalAccount,\n  ): Promise<void> {\n    if (!this.#accounts.canSync()) {\n      return;\n    }\n\n    try {\n      await this.#accounts.saveInternalAccountToUserStorage(internalAccount);\n    } catch (e) {\n      const errorMessage = e instanceof Error ? e.message : JSON.stringify(e);\n      throw new Error(\n        `${controllerName} - failed to save account to user storage - ${errorMessage}`,\n      );\n    }\n  }\n}\n"]}

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

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./mockResponses.cjs"), exports);
+__exportStar(require("./mockStorage.cjs"), exports);
+//# sourceMappingURL=index.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/__fixtures__/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAgC;AAChC,oDAA8B","sourcesContent":["export * from './mockResponses';\nexport * from './mockStorage';\n"]}

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

@@ -0,0 +1,3 @@
+export * from "./mockResponses.cjs";
+export * from "./mockStorage.cjs";
+//# sourceMappingURL=index.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/__fixtures__/index.ts"],"names":[],"mappings":"AAAA,oCAAgC;AAChC,kCAA8B"}

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

@@ -0,0 +1,3 @@
+export * from "./mockResponses.mjs";
+export * from "./mockStorage.mjs";
+//# sourceMappingURL=index.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/__fixtures__/index.ts"],"names":[],"mappings":"AAAA,oCAAgC;AAChC,kCAA8B"}

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

@@ -0,0 +1,3 @@
+export * from "./mockResponses.mjs";
+export * from "./mockStorage.mjs";
+//# sourceMappingURL=index.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/__fixtures__/index.ts"],"names":[],"mappings":"AAAA,oCAAgC;AAChC,kCAA8B","sourcesContent":["export * from './mockResponses';\nexport * from './mockStorage';\n"]}