@metamask/profile-sync-controller 29.0.0 → 31.0.0

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

@@ -1,183 +0,0 @@
-import type { AddressBookControllerContactUpdatedEvent, AddressBookControllerContactDeletedEvent, AddressBookControllerActions, AddressBookControllerListAction, AddressBookControllerSetAction, AddressBookControllerDeleteAction } from "@metamask/address-book-controller";
-import { BaseController } from "@metamask/base-controller";
-import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
-import type { TraceCallback } from "@metamask/controller-utils";
-import type { KeyringControllerGetStateAction, KeyringControllerLockEvent, KeyringControllerUnlockEvent } from "@metamask/keyring-controller";
-import type { Messenger } from "@metamask/messenger";
-import type { SnapControllerHandleRequestAction } from "@metamask/snaps-controllers";
-import type { UserStorageGenericFeatureKey, UserStorageGenericPathWithFeatureAndKey, UserStorageGenericPathWithFeatureOnly } from "../../sdk/index.mjs";
-import { Env } from "../../sdk/index.mjs";
-import type { NativeScrypt } from "../../shared/types/encryption.mjs";
-import { EventQueue } from "../../shared/utils/event-queue.mjs";
-import type { AuthenticationControllerGetBearerTokenAction, AuthenticationControllerGetSessionProfileAction, AuthenticationControllerIsSignedInAction, AuthenticationControllerPerformSignInAction } from "../authentication/AuthenticationController-method-action-types.mjs";
-import { BACKUPANDSYNC_FEATURES } from "./constants.mjs";
-import type { UserStorageControllerMethodActions } from "./UserStorageController-method-action-types.mjs";
-declare const controllerName = "UserStorageController";
-export type UserStorageControllerState = {
-    /**
-     * Condition used by UI and to determine if we can use some of the User Storage methods.
-     */
-    isBackupAndSyncEnabled: boolean;
-    /**
-     * Loading state for the backup and sync update
-     */
-    isBackupAndSyncUpdateLoading: boolean;
-    /**
-     * 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;
-};
-export declare const defaultState: UserStorageControllerState;
-type ControllerConfig = {
-    env: Env;
-    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;
-    };
-};
-export type UserStorageControllerGetStateAction = ControllerGetStateAction<typeof controllerName, UserStorageControllerState>;
-export type Actions = UserStorageControllerGetStateAction | UserStorageControllerMethodActions;
-export type AllowedActions = KeyringControllerGetStateAction | SnapControllerHandleRequestAction | AuthenticationControllerGetBearerTokenAction | AuthenticationControllerGetSessionProfileAction | AuthenticationControllerPerformSignInAction | AuthenticationControllerIsSignedInAction | AddressBookControllerListAction | AddressBookControllerSetAction | AddressBookControllerDeleteAction | AddressBookControllerActions;
-export type UserStorageControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, UserStorageControllerState>;
-export type Events = UserStorageControllerStateChangeEvent;
-export type AllowedEvents = KeyringControllerLockEvent | KeyringControllerUnlockEvent | AddressBookControllerContactUpdatedEvent | AddressBookControllerContactDeletedEvent;
-export type UserStorageControllerMessenger = Messenger<typeof controllerName, Actions | AllowedActions, Events | AllowedEvents>;
-/**
- * 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.
- */
-export declare class UserStorageController extends BaseController<typeof controllerName, UserStorageControllerState, UserStorageControllerMessenger> {
-    #private;
-    eventQueue: EventQueue;
-    constructor({ messenger, state, config, nativeScryptCrypto, trace, }: {
-        messenger: UserStorageControllerMessenger;
-        state?: UserStorageControllerState;
-        config?: Partial<ControllerConfig>;
-        nativeScryptCrypto?: NativeScrypt;
-        trace?: TraceCallback;
-    });
-    /**
-     * 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
-     * @param entropySourceId - The entropy source ID used to generate the encryption key.
-     * @returns the decrypted string contents found from user storage (or null if not found)
-     */
-    performGetStorage(path: UserStorageGenericPathWithFeatureAndKey, entropySourceId?: string): Promise<string | null>;
-    /**
-     * 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
-     * @param entropySourceId - The entropy source ID used to generate the encryption key.
-     * @returns the array of decrypted string contents found from user storage (or null if not found)
-     */
-    performGetStorageAllFeatureEntries(path: UserStorageGenericPathWithFeatureOnly, entropySourceId?: string): Promise<string[] | null>;
-    /**
-     * 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.
-     * @param entropySourceId - The entropy source ID used to generate the encryption key.
-     * @returns nothing. NOTE that an error is thrown if fails to store data.
-     */
-    performSetStorage(path: UserStorageGenericPathWithFeatureAndKey, value: string, entropySourceId?: string): Promise<void>;
-    /**
-     * Allows storage of multiple user data entries for one specific feature. Data stored must be string formatted.
-     * Developers can extend the entry path through the `schema.ts` file.
-     *
-     * @param path - string in the form of `${feature}` that matches schema
-     * @param values - data to store, in the form of an array of `[entryKey, entryValue]` pairs
-     * @param entropySourceId - The entropy source ID used to generate the encryption key.
-     * @returns nothing. NOTE that an error is thrown if fails to store data.
-     */
-    performBatchSetStorage(path: UserStorageGenericPathWithFeatureOnly, values: [UserStorageGenericFeatureKey, string][], entropySourceId?: string): Promise<void>;
-    /**
-     * Allows deletion of user data. 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 entropySourceId - The entropy source ID used to generate the encryption key.
-     * @returns nothing. NOTE that an error is thrown if fails to delete data.
-     */
-    performDeleteStorage(path: UserStorageGenericPathWithFeatureAndKey, entropySourceId?: string): Promise<void>;
-    /**
-     * Allows deletion of all user data entries for a specific feature.
-     * Developers can extend the entry path through the `schema.ts` file.
-     *
-     * @param path - string in the form of `${feature}` that matches schema
-     * @param entropySourceId - The entropy source ID used to generate the encryption key.
-     * @returns nothing. NOTE that an error is thrown if fails to delete data.
-     */
-    performDeleteStorageAllFeatureEntries(path: UserStorageGenericPathWithFeatureOnly, entropySourceId?: string): Promise<void>;
-    /**
-     * Allows delete of multiple user data entries for one specific feature. Data deleted must be string formatted.
-     * Developers can extend the entry path through the `schema.ts` file.
-     *
-     * @param path - string in the form of `${feature}` that matches schema
-     * @param values - data to store, in the form of an array of entryKey[]
-     * @param entropySourceId - The entropy source ID used to generate the encryption key.
-     * @returns nothing. NOTE that an error is thrown if fails to store data.
-     */
-    performBatchDeleteStorage(path: UserStorageGenericPathWithFeatureOnly, values: UserStorageGenericFeatureKey[], entropySourceId?: string): Promise<void>;
-    /**
-     * Retrieves the storage key, for internal use only!
-     *
-     * @returns the storage key
-     */
-    getStorageKey(): Promise<string>;
-    /**
-     * Flushes the storage key cache.
-     * CAUTION: This is only public for testing purposes.
-     * It should not be used in production code.
-     */
-    flushStorageKeyCache(): void;
-    /**
-     * Lists all the available HD keyring metadata IDs.
-     * These IDs can be used in a multi-SRP context to segregate data specific to different SRPs.
-     *
-     * @returns A promise that resolves to an array of HD keyring metadata IDs.
-     */
-    listEntropySources(): Promise<string[]>;
-    setIsBackupAndSyncFeatureEnabled(feature: keyof typeof BACKUPANDSYNC_FEATURES, enabled: 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 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

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

@@ -1 +0,0 @@
-{"version":3,"file":"UserStorageController.d.mts","sourceRoot":"","sources":["../../../src/controllers/user-storage/UserStorageController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wCAAwC,EACxC,wCAAwC,EACxC,4BAA4B,EAC5B,+BAA+B,EAC/B,8BAA8B,EAC9B,iCAAiC,EAClC,0CAA0C;AAC3C,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,KAAK,EACV,aAAa,EAGd,mCAAmC;AAEpC,OAAO,KAAK,EACV,+BAA+B,EAC/B,0BAA0B,EAC1B,4BAA4B,EAC7B,qCAAqC;AACtC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,iCAAiC,EAAE,oCAAoC;AAErF,OAAO,KAAK,EACV,4BAA4B,EAC5B,uCAAuC,EACvC,qCAAqC,EACtC,4BAA2B;AAC5B,OAAO,EAAE,GAAG,EAAe,4BAA2B;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,0CAAyC;AACrE,OAAO,EAAE,UAAU,EAAE,2CAA0C;AAE/D,OAAO,KAAK,EACV,4CAA4C,EAC5C,+CAA+C,EAC/C,wCAAwC,EACxC,2CAA2C,EAC5C,2EAA0E;AAC3E,OAAO,EAAE,sBAAsB,EAAE,wBAAuB;AAGxD,OAAO,KAAK,EAAE,kCAAkC,EAAE,wDAAuD;AAEzG,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;CACrC,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,0BAM1B,CAAC;AAmCF,KAAK,gBAAgB,GAAG;IACtB,GAAG,EAAE,GAAG,CAAC;IACT,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;CACH,CAAC;AAiBF,MAAM,MAAM,mCAAmC,GAAG,wBAAwB,CACxE,OAAO,cAAc,EACrB,0BAA0B,CAC3B,CAAC;AACF,MAAM,MAAM,OAAO,GACf,mCAAmC,GACnC,kCAAkC,CAAC;AAEvC,MAAM,MAAM,cAAc,GAEtB,+BAA+B,GAE/B,iCAAiC,GAEjC,4CAA4C,GAC5C,+CAA+C,GAC/C,2CAA2C,GAC3C,wCAAwC,GAExC,+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,0BAA0B,GAC1B,4BAA4B,GAE5B,wCAAwC,GACxC,wCAAwC,CAAC;AAG7C,MAAM,MAAM,8BAA8B,GAAG,SAAS,CACpD,OAAO,cAAc,EACrB,OAAO,GAAG,cAAc,EACxB,MAAM,GAAG,aAAa,CACvB,CAAC;AAEF;;;;;;;GAOG;AACH,qBAAa,qBAAsB,SAAQ,cAAc,CACvD,OAAO,cAAc,EACrB,0BAA0B,EAC1B,8BAA8B,CAC/B;;IAsDC,UAAU,aAAoB;gBAElB,EACV,SAAS,EACT,KAAK,EACL,MAAM,EACN,kBAAkB,EAClB,KAAK,GACN,EAAE;QACD,SAAS,EAAE,8BAA8B,CAAC;QAC1C,KAAK,CAAC,EAAE,0BAA0B,CAAC;QACnC,MAAM,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;QACnC,kBAAkB,CAAC,EAAE,YAAY,CAAC;QAClC,KAAK,CAAC,EAAE,aAAa,CAAC;KACvB;IAsFD;;;;;;;OAOG;IACU,iBAAiB,CAC5B,IAAI,EAAE,uCAAuC,EAC7C,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAOzB;;;;;;;OAOG;IACU,kCAAkC,CAC7C,IAAI,EAAE,qCAAqC,EAC3C,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC;IAO3B;;;;;;;;OAQG;IACU,iBAAiB,CAC5B,IAAI,EAAE,uCAAuC,EAC7C,KAAK,EAAE,MAAM,EACb,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC;IAOhB;;;;;;;;OAQG;IACU,sBAAsB,CACjC,IAAI,EAAE,qCAAqC,EAC3C,MAAM,EAAE,CAAC,4BAA4B,EAAE,MAAM,CAAC,EAAE,EAChD,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC;IAOhB;;;;;;OAMG;IACU,oBAAoB,CAC/B,IAAI,EAAE,uCAAuC,EAC7C,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC;IAOhB;;;;;;;OAOG;IACU,qCAAqC,CAChD,IAAI,EAAE,qCAAqC,EAC3C,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC;IAOhB;;;;;;;;OAQG;IACU,yBAAyB,CACpC,IAAI,EAAE,qCAAqC,EAC3C,MAAM,EAAE,4BAA4B,EAAE,EACtC,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,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAiGhC,gCAAgC,CAC3C,OAAO,EAAE,MAAM,OAAO,sBAAsB,EAC5C,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,IAAI,CAAC;IA6ChB;;;;OAIG;IACG,6BAA6B,CACjC,0BAA0B,EAAE,OAAO,GAClC,OAAO,CAAC,IAAI,CAAC;IAMhB;;;;OAIG;IACG,2BAA2B,IAAI,OAAO,CAAC,IAAI,CAAC;CA4BnD"}

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

@@ -1,409 +0,0 @@
-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 __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 _UserStorageController_instances, _UserStorageController_userStorage, _UserStorageController_auth, _UserStorageController_config, _UserStorageController_trace, _UserStorageController_isUnlocked, _UserStorageController_storageKeyCache, _UserStorageController_snapSignMessageCache, _UserStorageController_keyringController, _UserStorageController_nativeScryptCrypto, _UserStorageController_getHdKeyringEntropySourceIds, _UserStorageController_getPrimaryEntropySourceId, _UserStorageController_scopedCacheKey, _UserStorageController_snapSignMessage, _UserStorageController_setIsBackupAndSyncUpdateLoading;
-import { BaseController } from "@metamask/base-controller";
-import { KeyringTypes } from "@metamask/keyring-controller";
-import { Env, UserStorage } from "../../sdk/index.mjs";
-import { EventQueue } from "../../shared/utils/event-queue.mjs";
-import { createSnapSignMessageRequest } from "../authentication/auth-snap-requests.mjs";
-import { BACKUPANDSYNC_FEATURES } from "./constants.mjs";
-import { syncContactsWithUserStorage } from "./contact-syncing/controller-integration.mjs";
-import { setupContactSyncingSubscriptions } from "./contact-syncing/setup-subscriptions.mjs";
-const controllerName = 'UserStorageController';
-export const defaultState = {
-    isBackupAndSyncEnabled: true,
-    isBackupAndSyncUpdateLoading: false,
-    isAccountSyncingEnabled: true,
-    isContactSyncingEnabled: true,
-    isContactSyncingInProgress: false,
-};
-const metadata = {
-    isBackupAndSyncEnabled: {
-        includeInStateLogs: true,
-        persist: true,
-        includeInDebugSnapshot: true,
-        usedInUi: true,
-    },
-    isBackupAndSyncUpdateLoading: {
-        includeInStateLogs: false,
-        persist: false,
-        includeInDebugSnapshot: false,
-        usedInUi: true,
-    },
-    isAccountSyncingEnabled: {
-        includeInStateLogs: true,
-        persist: true,
-        includeInDebugSnapshot: true,
-        usedInUi: true,
-    },
-    isContactSyncingEnabled: {
-        includeInStateLogs: true,
-        persist: true,
-        includeInDebugSnapshot: true,
-        usedInUi: true,
-    },
-    isContactSyncingInProgress: {
-        includeInStateLogs: false,
-        persist: false,
-        includeInDebugSnapshot: false,
-        usedInUi: true,
-    },
-};
-const MESSENGER_EXPOSED_METHODS = [
-    'performGetStorage',
-    'performGetStorageAllFeatureEntries',
-    'performSetStorage',
-    'performBatchSetStorage',
-    'performDeleteStorage',
-    'performBatchDeleteStorage',
-    'getStorageKey',
-    'performDeleteStorageAllFeatureEntries',
-    'listEntropySources',
-    'setIsBackupAndSyncFeatureEnabled',
-    'setIsContactSyncingInProgress',
-    'syncContactsWithUserStorage',
-];
-/**
- * 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.
- */
-export class UserStorageController extends BaseController {
-    constructor({ messenger, state, config, nativeScryptCrypto, trace, }) {
-        super({
-            messenger,
-            metadata,
-            name: controllerName,
-            state: { ...defaultState, ...state },
-        });
-        _UserStorageController_instances.add(this);
-        _UserStorageController_userStorage.set(this, void 0);
-        _UserStorageController_auth.set(this, {
-            getProfileId: async (entropySourceId) => {
-                const sessionProfile = await this.messenger.call('AuthenticationController:getSessionProfile', entropySourceId);
-                return sessionProfile?.profileId;
-            },
-            isSignedIn: () => {
-                return this.messenger.call('AuthenticationController:isSignedIn');
-            },
-            signIn: async () => {
-                return await this.messenger.call('AuthenticationController:performSignIn');
-            },
-        });
-        _UserStorageController_config.set(this, {
-            env: Env.PRD,
-        });
-        _UserStorageController_trace.set(this, void 0);
-        _UserStorageController_isUnlocked.set(this, false);
-        // Both caches are keyed by `${entropySourceId}:${message}` (the primary SRP
-        // resolves to its HD keyring metadata ID) so two SRPs that transiently
-        // resolve to the same `profileId` can never share a cached storage key /
-        // signature and leak data across each other's user storage.
-        _UserStorageController_storageKeyCache.set(this, {});
-        _UserStorageController_snapSignMessageCache.set(this, {});
-        _UserStorageController_keyringController.set(this, {
-            setupLockedStateSubscriptions: () => {
-                const { isUnlocked } = this.messenger.call('KeyringController:getState');
-                __classPrivateFieldSet(this, _UserStorageController_isUnlocked, isUnlocked, "f");
-                this.messenger.subscribe('KeyringController:unlock', () => {
-                    __classPrivateFieldSet(this, _UserStorageController_isUnlocked, true, "f");
-                });
-                this.messenger.subscribe('KeyringController:lock', () => {
-                    __classPrivateFieldSet(this, _UserStorageController_isUnlocked, false, "f");
-                });
-            },
-        });
-        _UserStorageController_nativeScryptCrypto.set(this, undefined);
-        this.eventQueue = new EventQueue();
-        __classPrivateFieldSet(this, _UserStorageController_config, {
-            ...__classPrivateFieldGet(this, _UserStorageController_config, "f"),
-            ...config,
-        }, "f");
-        __classPrivateFieldSet(this, _UserStorageController_trace, trace ??
-            (async (_request, fn) => {
-                if (!fn) {
-                    return undefined;
-                }
-                return await Promise.resolve(fn());
-            }), "f");
-        __classPrivateFieldSet(this, _UserStorageController_userStorage, new UserStorage({
-            env: __classPrivateFieldGet(this, _UserStorageController_config, "f").env,
-            auth: {
-                getAccessToken: (entropySourceId) => this.messenger.call('AuthenticationController:getBearerToken', entropySourceId),
-                getUserProfile: async (entropySourceId) => {
-                    return await this.messenger.call('AuthenticationController:getSessionProfile', entropySourceId);
-                },
-                signMessage: (message, entropySourceId) => __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_snapSignMessage).call(this, message, entropySourceId),
-            },
-        }, {
-            storage: {
-                getStorageKey: async (message, entropySourceId) => {
-                    // No derived key can exist while locked (the KeyringController
-                    // clears its keyrings on lock, so the scope is unresolvable).
-                    if (!__classPrivateFieldGet(this, _UserStorageController_isUnlocked, "f")) {
-                        return null;
-                    }
-                    return (__classPrivateFieldGet(this, _UserStorageController_storageKeyCache, "f")[__classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_scopedCacheKey).call(this, message, entropySourceId)] ?? null);
-                },
-                // Only ever reached after a successful signature, i.e. while unlocked.
-                setStorageKey: async (message, key, entropySourceId) => {
-                    __classPrivateFieldGet(this, _UserStorageController_storageKeyCache, "f")[__classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_scopedCacheKey).call(this, message, entropySourceId)] = key;
-                },
-            },
-        }), "f");
-        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
-        __classPrivateFieldGet(this, _UserStorageController_keyringController, "f").setupLockedStateSubscriptions();
-        __classPrivateFieldSet(this, _UserStorageController_nativeScryptCrypto, nativeScryptCrypto, "f");
-        // Contact Syncing
-        setupContactSyncingSubscriptions({
-            getUserStorageControllerInstance: () => this,
-            getMessenger: () => this.messenger,
-            trace: __classPrivateFieldGet(this, _UserStorageController_trace, "f"),
-        });
-    }
-    /**
-     * 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
-     * @param entropySourceId - The entropy source ID used to generate the encryption key.
-     * @returns the decrypted string contents found from user storage (or null if not found)
-     */
-    async performGetStorage(path, entropySourceId) {
-        return await __classPrivateFieldGet(this, _UserStorageController_userStorage, "f").getItem(path, {
-            nativeScryptCrypto: __classPrivateFieldGet(this, _UserStorageController_nativeScryptCrypto, "f"),
-            entropySourceId,
-        });
-    }
-    /**
-     * 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
-     * @param entropySourceId - The entropy source ID used to generate the encryption key.
-     * @returns the array of decrypted string contents found from user storage (or null if not found)
-     */
-    async performGetStorageAllFeatureEntries(path, entropySourceId) {
-        return await __classPrivateFieldGet(this, _UserStorageController_userStorage, "f").getAllFeatureItems(path, {
-            nativeScryptCrypto: __classPrivateFieldGet(this, _UserStorageController_nativeScryptCrypto, "f"),
-            entropySourceId,
-        });
-    }
-    /**
-     * 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.
-     * @param entropySourceId - The entropy source ID used to generate the encryption key.
-     * @returns nothing. NOTE that an error is thrown if fails to store data.
-     */
-    async performSetStorage(path, value, entropySourceId) {
-        return await __classPrivateFieldGet(this, _UserStorageController_userStorage, "f").setItem(path, value, {
-            nativeScryptCrypto: __classPrivateFieldGet(this, _UserStorageController_nativeScryptCrypto, "f"),
-            entropySourceId,
-        });
-    }
-    /**
-     * Allows storage of multiple user data entries for one specific feature. Data stored must be string formatted.
-     * Developers can extend the entry path through the `schema.ts` file.
-     *
-     * @param path - string in the form of `${feature}` that matches schema
-     * @param values - data to store, in the form of an array of `[entryKey, entryValue]` pairs
-     * @param entropySourceId - The entropy source ID used to generate the encryption key.
-     * @returns nothing. NOTE that an error is thrown if fails to store data.
-     */
-    async performBatchSetStorage(path, values, entropySourceId) {
-        return await __classPrivateFieldGet(this, _UserStorageController_userStorage, "f").batchSetItems(path, values, {
-            nativeScryptCrypto: __classPrivateFieldGet(this, _UserStorageController_nativeScryptCrypto, "f"),
-            entropySourceId,
-        });
-    }
-    /**
-     * Allows deletion of user data. 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 entropySourceId - The entropy source ID used to generate the encryption key.
-     * @returns nothing. NOTE that an error is thrown if fails to delete data.
-     */
-    async performDeleteStorage(path, entropySourceId) {
-        return await __classPrivateFieldGet(this, _UserStorageController_userStorage, "f").deleteItem(path, {
-            nativeScryptCrypto: __classPrivateFieldGet(this, _UserStorageController_nativeScryptCrypto, "f"),
-            entropySourceId,
-        });
-    }
-    /**
-     * Allows deletion of all user data entries for a specific feature.
-     * Developers can extend the entry path through the `schema.ts` file.
-     *
-     * @param path - string in the form of `${feature}` that matches schema
-     * @param entropySourceId - The entropy source ID used to generate the encryption key.
-     * @returns nothing. NOTE that an error is thrown if fails to delete data.
-     */
-    async performDeleteStorageAllFeatureEntries(path, entropySourceId) {
-        return await __classPrivateFieldGet(this, _UserStorageController_userStorage, "f").deleteAllFeatureItems(path, {
-            nativeScryptCrypto: __classPrivateFieldGet(this, _UserStorageController_nativeScryptCrypto, "f"),
-            entropySourceId,
-        });
-    }
-    /**
-     * Allows delete of multiple user data entries for one specific feature. Data deleted must be string formatted.
-     * Developers can extend the entry path through the `schema.ts` file.
-     *
-     * @param path - string in the form of `${feature}` that matches schema
-     * @param values - data to store, in the form of an array of entryKey[]
-     * @param entropySourceId - The entropy source ID used to generate the encryption key.
-     * @returns nothing. NOTE that an error is thrown if fails to store data.
-     */
-    async performBatchDeleteStorage(path, values, entropySourceId) {
-        return await __classPrivateFieldGet(this, _UserStorageController_userStorage, "f").batchDeleteItems(path, values, {
-            nativeScryptCrypto: __classPrivateFieldGet(this, _UserStorageController_nativeScryptCrypto, "f"),
-            entropySourceId,
-        });
-    }
-    /**
-     * Retrieves the storage key, for internal use only!
-     *
-     * @returns the storage key
-     */
-    async getStorageKey() {
-        return await __classPrivateFieldGet(this, _UserStorageController_userStorage, "f").getStorageKey();
-    }
-    /**
-     * Flushes the storage key cache.
-     * CAUTION: This is only public for testing purposes.
-     * It should not be used in production code.
-     */
-    flushStorageKeyCache() {
-        __classPrivateFieldSet(this, _UserStorageController_storageKeyCache, {}, "f");
-    }
-    /**
-     * Lists all the available HD keyring metadata IDs.
-     * These IDs can be used in a multi-SRP context to segregate data specific to different SRPs.
-     *
-     * @returns A promise that resolves to an array of HD keyring metadata IDs.
-     */
-    async listEntropySources() {
-        if (!__classPrivateFieldGet(this, _UserStorageController_isUnlocked, "f")) {
-            throw new Error('listEntropySources - unable to list entropy sources, wallet is locked');
-        }
-        return __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_getHdKeyringEntropySourceIds).call(this);
-    }
-    async setIsBackupAndSyncFeatureEnabled(feature, enabled) {
-        try {
-            __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_setIsBackupAndSyncUpdateLoading).call(this, true);
-            if (enabled) {
-                // If any of the features are enabled, we need to ensure the user is signed in
-                const isSignedIn = __classPrivateFieldGet(this, _UserStorageController_auth, "f").isSignedIn();
-                if (!isSignedIn) {
-                    await __classPrivateFieldGet(this, _UserStorageController_auth, "f").signIn();
-                }
-            }
-            this.update((state) => {
-                if (feature === BACKUPANDSYNC_FEATURES.main) {
-                    state.isBackupAndSyncEnabled = enabled;
-                }
-                if (feature === BACKUPANDSYNC_FEATURES.accountSyncing) {
-                    state.isAccountSyncingEnabled = enabled;
-                }
-                if (feature === BACKUPANDSYNC_FEATURES.contactSyncing) {
-                    state.isContactSyncingEnabled = enabled;
-                }
-            });
-        }
-        catch (e) {
-            // istanbul ignore next
-            const errorMessage = e instanceof Error ? e.message : JSON.stringify(e);
-            // istanbul ignore next
-            throw new Error(`${controllerName} - failed to ${enabled ? 'enable' : 'disable'} ${feature} - ${errorMessage}`);
-        }
-        finally {
-            __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_setIsBackupAndSyncUpdateLoading).call(this, false);
-        }
-    }
-    /**
-     * 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 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 syncContactsWithUserStorage(config, {
-            getMessenger: () => this.messenger,
-            getUserStorageControllerInstance: () => this,
-            trace: __classPrivateFieldGet(this, _UserStorageController_trace, "f"),
-        });
-    }
-}
-_UserStorageController_userStorage = new WeakMap(), _UserStorageController_auth = new WeakMap(), _UserStorageController_config = new WeakMap(), _UserStorageController_trace = new WeakMap(), _UserStorageController_isUnlocked = new WeakMap(), _UserStorageController_storageKeyCache = new WeakMap(), _UserStorageController_snapSignMessageCache = new WeakMap(), _UserStorageController_keyringController = new WeakMap(), _UserStorageController_nativeScryptCrypto = new WeakMap(), _UserStorageController_instances = new WeakSet(), _UserStorageController_getHdKeyringEntropySourceIds = function _UserStorageController_getHdKeyringEntropySourceIds() {
-    const { keyrings } = this.messenger.call('KeyringController:getState');
-    return (keyrings ?? [])
-        .filter((keyring) => keyring.type === KeyringTypes.hd.toString())
-        .map((keyring) => keyring.metadata.id);
-}, _UserStorageController_getPrimaryEntropySourceId = function _UserStorageController_getPrimaryEntropySourceId() {
-    const [primaryEntropySourceId] = __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_getHdKeyringEntropySourceIds).call(this);
-    if (!primaryEntropySourceId) {
-        throw new Error('#getPrimaryEntropySourceId - no HD keyring available');
-    }
-    return primaryEntropySourceId;
-}, _UserStorageController_scopedCacheKey = function _UserStorageController_scopedCacheKey(message, entropySourceId) {
-    return `${entropySourceId ?? __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_getPrimaryEntropySourceId).call(this)}:${message}`;
-}, _UserStorageController_snapSignMessage = 
-/**
- * Signs a specific message using an underlying auth snap.
- *
- * @param message - A specific tagged message to sign.
- * @param entropySourceId - The entropy source ID used to derive the key,
- * when multiple sources are available (Multi-SRP).
- * @returns A Signature created by the snap.
- */
-async function _UserStorageController_snapSignMessage(message, entropySourceId) {
-    if (!__classPrivateFieldGet(this, _UserStorageController_isUnlocked, "f")) {
-        throw new Error('#snapSignMessage - unable to call snap, wallet is locked');
-    }
-    const cacheKey = __classPrivateFieldGet(this, _UserStorageController_instances, "m", _UserStorageController_scopedCacheKey).call(this, message, entropySourceId);
-    if (__classPrivateFieldGet(this, _UserStorageController_snapSignMessageCache, "f")[cacheKey]) {
-        return __classPrivateFieldGet(this, _UserStorageController_snapSignMessageCache, "f")[cacheKey];
-    }
-    const result = (await this.messenger.call('SnapController:handleRequest', createSnapSignMessageRequest(message, entropySourceId)));
-    __classPrivateFieldGet(this, _UserStorageController_snapSignMessageCache, "f")[cacheKey] = result;
-    return result;
-}, _UserStorageController_setIsBackupAndSyncUpdateLoading = function _UserStorageController_setIsBackupAndSyncUpdateLoading(isBackupAndSyncUpdateLoading) {
-    this.update((state) => {
-        state.isBackupAndSyncUpdateLoading = isBackupAndSyncUpdateLoading;
-    });
-};
-//# sourceMappingURL=UserStorageController.mjs.map