@metamask-previews/profile-sync-controller 24.0.0-preview-b13da658 → 24.0.0-preview-a421f85b

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

@@ -0,0 +1,271 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.syncInternalAccountsWithUserStorage = exports.saveInternalAccountsListToUserStorage = exports.saveInternalAccountToUserStorage = void 0;
+const keyring_controller_1 = require("@metamask/keyring-controller");
+const sync_utils_1 = require("./sync-utils.cjs");
+const utils_1 = require("./utils.cjs");
+const storage_schema_1 = require("../../../shared/storage-schema.cjs");
+const constants_1 = require("../constants.cjs");
+/**
+ * Saves an individual internal account to the user storage.
+ *
+ * @param internalAccount - The internal account to save
+ * @param options - parameters used for saving the internal account
+ * @returns Promise that resolves when the account is saved
+ */
+async function saveInternalAccountToUserStorage(internalAccount, options) {
+    const { trace } = options;
+    const saveAccount = async () => {
+        const { getUserStorageControllerInstance } = options;
+        if (getUserStorageControllerInstance().getIsMultichainAccountSyncingEnabled()) {
+            // If multichain account syncing is enabled, we do not push account syncing V1 data anymore.
+            // AccountTreeController handles proper multichain account syncing
+            return;
+        }
+        if (!(0, sync_utils_1.canPerformAccountSyncing)(options) ||
+            internalAccount.metadata.keyring.type !== String(keyring_controller_1.KeyringTypes.hd) // sync only EVM accounts until we support multichain accounts
+        ) {
+            return;
+        }
+        // properties of `options` are (wrongly?) typed as `Json` and eslint crashes if we try to interpret it as such and call a `?.toString()` on it.
+        // but we know this is a string?, so we can safely cast it
+        const entropySourceId = internalAccount.options?.entropySource;
+        try {
+            // Map the internal account to the user storage account schema
+            const mappedAccount = (0, utils_1.mapInternalAccountToUserStorageAccount)(internalAccount);
+            await getUserStorageControllerInstance().performSetStorage(`${storage_schema_1.USER_STORAGE_FEATURE_NAMES.accounts}.${internalAccount.address}`, JSON.stringify(mappedAccount), entropySourceId);
+        }
+        catch (e) {
+            // istanbul ignore next
+            const errorMessage = e instanceof Error ? e.message : JSON.stringify(e);
+            throw new Error(`UserStorageController - failed to save account to user storage - ${errorMessage}`);
+        }
+    };
+    if (trace) {
+        return await trace({ name: constants_1.TraceName.AccountSyncSaveIndividual }, saveAccount);
+    }
+    return await saveAccount();
+}
+exports.saveInternalAccountToUserStorage = saveInternalAccountToUserStorage;
+/**
+ * Saves the list of internal accounts to the user storage.
+ *
+ * @param options - parameters used for saving the list of internal accounts
+ * @param entropySourceId - The entropy source ID used to derive the key,
+ * when multiple sources are available (Multi-SRP).
+ * @returns Promise that resolves when all accounts are saved
+ */
+async function saveInternalAccountsListToUserStorage(options, entropySourceId) {
+    const { getUserStorageControllerInstance } = options;
+    if (getUserStorageControllerInstance().getIsMultichainAccountSyncingEnabled()) {
+        // If multichain account syncing is enabled, we do not push account syncing V1 data anymore.
+        // AccountTreeController handles proper multichain account syncing
+        return;
+    }
+    const internalAccountsList = await (0, sync_utils_1.getInternalAccountsList)(options, entropySourceId);
+    if (!internalAccountsList?.length) {
+        return;
+    }
+    const internalAccountsListFormattedForUserStorage = internalAccountsList.map(utils_1.mapInternalAccountToUserStorageAccount);
+    await getUserStorageControllerInstance().performBatchSetStorage(storage_schema_1.USER_STORAGE_FEATURE_NAMES.accounts, internalAccountsListFormattedForUserStorage.map((account) => [
+        account.a,
+        JSON.stringify(account),
+    ]), entropySourceId);
+}
+exports.saveInternalAccountsListToUserStorage = saveInternalAccountsListToUserStorage;
+/**
+ * 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.
+ *
+ * @param config - parameters used for syncing the internal accounts list with the user storage accounts list
+ * @param options - parameters used for syncing the internal accounts list with the user storage accounts list
+ * @param entropySourceId - The entropy source ID used to derive the key,
+ * @returns Promise that resolves when synchronization is complete
+ */
+async function syncInternalAccountsWithUserStorage(config, options, entropySourceId) {
+    const { trace } = options;
+    const performAccountSync = async () => {
+        if (!(0, sync_utils_1.canPerformAccountSyncing)(options)) {
+            return;
+        }
+        const { maxNumberOfAccountsToAdd = Infinity, onAccountAdded, onAccountNameUpdated, onAccountSyncErroneousSituation, } = config;
+        const { getMessenger, getUserStorageControllerInstance } = options;
+        try {
+            await getUserStorageControllerInstance().setIsAccountSyncingInProgress(true);
+            const userStorageAccountsList = await (0, sync_utils_1.getUserStorageAccountsList)(options, entropySourceId);
+            if (!userStorageAccountsList || !userStorageAccountsList.length) {
+                await saveInternalAccountsListToUserStorage(options, entropySourceId);
+                return;
+            }
+            // Keep a record if erroneous situations are found during the sync
+            // This is done so we can send the context to Sentry in case of an erroneous situation
+            let erroneousSituationsFound = false;
+            // Prepare an array of internal accounts to be saved to the user storage
+            const internalAccountsToBeSavedToUserStorage = [];
+            // Compare internal accounts list with user storage accounts list
+            // First step: compare lengths
+            const internalAccountsList = await (0, sync_utils_1.getInternalAccountsList)(options, entropySourceId);
+            if (!internalAccountsList || !internalAccountsList.length) {
+                throw new Error(`Failed to get internal accounts list`);
+            }
+            const hasMoreUserStorageAccountsThanInternalAccounts = userStorageAccountsList.length > internalAccountsList.length;
+            // We don't want to remove existing accounts for a user
+            // so we only add new accounts if the user has more accounts in user storage than internal accounts
+            if (hasMoreUserStorageAccountsThanInternalAccounts) {
+                const numberOfAccountsToAdd = Math.min(userStorageAccountsList.length, maxNumberOfAccountsToAdd) -
+                    internalAccountsList.length;
+                // Create new accounts to match the user storage accounts list
+                await getMessenger().call('KeyringController:withKeyring', {
+                    id: entropySourceId,
+                }, async ({ keyring }) => {
+                    await keyring.addAccounts(numberOfAccountsToAdd);
+                });
+                // TODO: below code is kept for analytics but should probably be re-thought
+                for (let i = 0; i < numberOfAccountsToAdd; i++) {
+                    onAccountAdded?.();
+                }
+            }
+            // Second step: compare account names
+            // Get the internal accounts list again since new accounts might have been added in the previous step
+            const refreshedInternalAccountsList = await (0, sync_utils_1.getInternalAccountsList)(options, entropySourceId);
+            const newlyAddedAccounts = refreshedInternalAccountsList.filter((account) => !internalAccountsList.find((a) => a.address === account.address));
+            for (const internalAccount of refreshedInternalAccountsList) {
+                const userStorageAccount = userStorageAccountsList.find((account) => account.a === internalAccount.address);
+                // If the account is not present in user storage
+                // istanbul ignore next
+                if (!userStorageAccount) {
+                    // If the account was just added in the previous step, skip saving it, it's likely to be a bogus account
+                    if (newlyAddedAccounts.includes(internalAccount)) {
+                        erroneousSituationsFound = true;
+                        onAccountSyncErroneousSituation?.('An account was added to the internal accounts list but was not present in the user storage accounts list', {
+                            internalAccount,
+                            userStorageAccount,
+                            newlyAddedAccounts,
+                            userStorageAccountsList,
+                            internalAccountsList,
+                            refreshedInternalAccountsList,
+                            internalAccountsToBeSavedToUserStorage,
+                        });
+                        continue;
+                    }
+                    // Otherwise, it means that this internal account was present before the sync, and needs to be saved to the user storage
+                    internalAccountsToBeSavedToUserStorage.push(internalAccount);
+                    continue;
+                }
+                // From this point on, we know that the account is present in
+                // both the internal accounts list and the user storage accounts list
+                // One or both accounts have default names
+                const isInternalAccountNameDefault = (0, utils_1.isNameDefaultAccountName)(internalAccount.metadata.name);
+                const isUserStorageAccountNameDefault = (0, utils_1.isNameDefaultAccountName)(userStorageAccount.n);
+                // Internal account has default name
+                if (isInternalAccountNameDefault) {
+                    if (!isUserStorageAccountNameDefault) {
+                        getMessenger().call('AccountsController:updateAccountMetadata', internalAccount.id, {
+                            name: userStorageAccount.n,
+                        });
+                        onAccountNameUpdated?.();
+                    }
+                    continue;
+                }
+                // Internal account has custom name but user storage account has default name
+                if (isUserStorageAccountNameDefault) {
+                    internalAccountsToBeSavedToUserStorage.push(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) {
+                            internalAccountsToBeSavedToUserStorage.push(internalAccount);
+                            continue;
+                        }
+                    }
+                    getMessenger().call('AccountsController:updateAccountMetadata', internalAccount.id, {
+                        name: userStorageAccount.n,
+                        nameLastUpdatedAt: userStorageAccount.nlu,
+                    });
+                    const areInternalAndUserStorageAccountNamesEqual = internalAccount.metadata.name === userStorageAccount.n;
+                    if (!areInternalAndUserStorageAccountNamesEqual) {
+                        onAccountNameUpdated?.();
+                    }
+                    continue;
+                }
+                else if (internalAccount.metadata.nameLastUpdatedAt !== undefined) {
+                    internalAccountsToBeSavedToUserStorage.push(internalAccount);
+                    continue;
+                }
+            }
+            // Save the internal accounts list to the user storage
+            if (internalAccountsToBeSavedToUserStorage.length) {
+                if (!getUserStorageControllerInstance().getIsMultichainAccountSyncingEnabled()) {
+                    // If multichain account syncing is enabled, we do not push account syncing V1 data anymore.
+                    // AccountTreeController handles proper multichain account syncing
+                    await getUserStorageControllerInstance().performBatchSetStorage(storage_schema_1.USER_STORAGE_FEATURE_NAMES.accounts, internalAccountsToBeSavedToUserStorage.map((account) => [
+                        account.address,
+                        JSON.stringify((0, utils_1.mapInternalAccountToUserStorageAccount)(account)),
+                    ]), entropySourceId);
+                }
+            }
+            // In case we have corrupted user storage with accounts that don't exist in the internal accounts list
+            // Delete those accounts from the user storage
+            const userStorageAccountsToBeDeleted = userStorageAccountsList.filter((account) => !refreshedInternalAccountsList.find((a) => a.address === account.a));
+            if (userStorageAccountsToBeDeleted.length) {
+                if (!getUserStorageControllerInstance().getIsMultichainAccountSyncingEnabled()) {
+                    // If multichain account syncing is enabled, we do not push account syncing V1 data anymore.
+                    // AccountTreeController handles proper multichain account syncing
+                    await getUserStorageControllerInstance().performBatchDeleteStorage(storage_schema_1.USER_STORAGE_FEATURE_NAMES.accounts, userStorageAccountsToBeDeleted.map((account) => account.a), entropySourceId);
+                    erroneousSituationsFound = true;
+                    onAccountSyncErroneousSituation?.('An account was present in the user storage accounts list but was not found in the internal accounts list after the sync', {
+                        userStorageAccountsToBeDeleted,
+                        internalAccountsList,
+                        refreshedInternalAccountsList,
+                        internalAccountsToBeSavedToUserStorage,
+                        userStorageAccountsList,
+                    });
+                }
+            }
+            if (erroneousSituationsFound) {
+                const [finalUserStorageAccountsList, finalInternalAccountsList] = await Promise.all([
+                    (0, sync_utils_1.getUserStorageAccountsList)(options, entropySourceId),
+                    (0, sync_utils_1.getInternalAccountsList)(options, entropySourceId),
+                ]);
+                const doesEveryAccountInInternalAccountsListExistInUserStorageAccountsList = finalInternalAccountsList.every((account) => finalUserStorageAccountsList?.some((userStorageAccount) => userStorageAccount.a === account.address));
+                // istanbul ignore next
+                const doesEveryAccountInUserStorageAccountsListExistInInternalAccountsList = (finalUserStorageAccountsList?.length || 0) > maxNumberOfAccountsToAdd
+                    ? true
+                    : finalUserStorageAccountsList?.every((account) => finalInternalAccountsList.some((internalAccount) => internalAccount.address === account.a));
+                const doFinalListsMatch = doesEveryAccountInInternalAccountsListExistInUserStorageAccountsList &&
+                    doesEveryAccountInUserStorageAccountsListExistInInternalAccountsList;
+                const context = {
+                    finalUserStorageAccountsList,
+                    finalInternalAccountsList,
+                };
+                if (doFinalListsMatch) {
+                    onAccountSyncErroneousSituation?.('Erroneous situations were found during the sync, but final state matches the expected state', context);
+                }
+                else {
+                    onAccountSyncErroneousSituation?.('Erroneous situations were found during the sync, and final state does not match the expected state', context);
+                }
+            }
+        }
+        catch (e) {
+            // istanbul ignore next
+            const errorMessage = e instanceof Error ? e.message : JSON.stringify(e);
+            throw new Error(`UserStorageController - failed to sync user storage accounts list - ${errorMessage}`);
+        }
+        finally {
+            await getUserStorageControllerInstance().setIsAccountSyncingInProgress(false);
+        }
+    };
+    if (trace) {
+        return await trace({ name: constants_1.TraceName.AccountSyncFull }, performAccountSync);
+    }
+    return await performAccountSync();
+}
+exports.syncInternalAccountsWithUserStorage = syncInternalAccountsWithUserStorage;
+//# sourceMappingURL=controller-integration.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"controller-integration.cjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/controller-integration.ts"],"names":[],"mappings":";;;AAAA,qEAA4D;AAG5D,iDAIsB;AAEtB,uCAGiB;AACjB,uEAA4E;AAC5E,gDAAyC;AAEzC;;;;;;GAMG;AACI,KAAK,UAAU,gCAAgC,CACpD,eAAgC,EAChC,OAA8B;IAE9B,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IAE1B,MAAM,WAAW,GAAG,KAAK,IAAI,EAAE;QAC7B,MAAM,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC;QAErD,IACE,gCAAgC,EAAE,CAAC,oCAAoC,EAAE,EACzE;YACA,4FAA4F;YAC5F,kEAAkE;YAClE,OAAO;SACR;QAED,IACE,CAAC,IAAA,qCAAwB,EAAC,OAAO,CAAC;YAClC,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAK,MAAM,CAAC,iCAAY,CAAC,EAAE,CAAC,CAAC,8DAA8D;UAChI;YACA,OAAO;SACR;QAED,+IAA+I;QAC/I,0DAA0D;QAC1D,MAAM,eAAe,GAAG,eAAe,CAAC,OAAO,EAAE,aAEpC,CAAC;QAEd,IAAI;YACF,8DAA8D;YAC9D,MAAM,aAAa,GACjB,IAAA,8CAAsC,EAAC,eAAe,CAAC,CAAC;YAE1D,MAAM,gCAAgC,EAAE,CAAC,iBAAiB,CACxD,GAAG,2CAA0B,CAAC,QAAQ,IAAI,eAAe,CAAC,OAAO,EAAE,EACnE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,EAC7B,eAAe,CAChB,CAAC;SACH;QAAC,OAAO,CAAC,EAAE;YACV,uBAAuB;YACvB,MAAM,YAAY,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACxE,MAAM,IAAI,KAAK,CACb,oEAAoE,YAAY,EAAE,CACnF,CAAC;SACH;IACH,CAAC,CAAC;IAEF,IAAI,KAAK,EAAE;QACT,OAAO,MAAM,KAAK,CAChB,EAAE,IAAI,EAAE,qBAAS,CAAC,yBAAyB,EAAE,EAC7C,WAAW,CACZ,CAAC;KACH;IAED,OAAO,MAAM,WAAW,EAAE,CAAC;AAC7B,CAAC;AAzDD,4EAyDC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,qCAAqC,CACzD,OAA8B,EAC9B,eAAuB;IAEvB,MAAM,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC;IACrD,IACE,gCAAgC,EAAE,CAAC,oCAAoC,EAAE,EACzE;QACA,4FAA4F;QAC5F,kEAAkE;QAClE,OAAO;KACR;IAED,MAAM,oBAAoB,GAAG,MAAM,IAAA,oCAAuB,EACxD,OAAO,EACP,eAAe,CAChB,CAAC;IAEF,IAAI,CAAC,oBAAoB,EAAE,MAAM,EAAE;QACjC,OAAO;KACR;IAED,MAAM,2CAA2C,GAAG,oBAAoB,CAAC,GAAG,CAC1E,8CAAsC,CACvC,CAAC;IAEF,MAAM,gCAAgC,EAAE,CAAC,sBAAsB,CAC7D,2CAA0B,CAAC,QAAQ,EACnC,2CAA2C,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;QAC3D,OAAO,CAAC,CAAC;QACT,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;KACxB,CAAC,EACF,eAAe,CAChB,CAAC;AACJ,CAAC;AAlCD,sFAkCC;AAYD;;;;;;;;;GASG;AACI,KAAK,UAAU,mCAAmC,CACvD,MAAiD,EACjD,OAA8B,EAC9B,eAAuB;IAEvB,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IAE1B,MAAM,kBAAkB,GAAG,KAAK,IAAI,EAAE;QACpC,IAAI,CAAC,IAAA,qCAAwB,EAAC,OAAO,CAAC,EAAE;YACtC,OAAO;SACR;QAED,MAAM,EACJ,wBAAwB,GAAG,QAAQ,EACnC,cAAc,EACd,oBAAoB,EACpB,+BAA+B,GAChC,GAAG,MAAM,CAAC;QACX,MAAM,EAAE,YAAY,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC;QAEnE,IAAI;YACF,MAAM,gCAAgC,EAAE,CAAC,6BAA6B,CACpE,IAAI,CACL,CAAC;YAEF,MAAM,uBAAuB,GAAG,MAAM,IAAA,uCAA0B,EAC9D,OAAO,EACP,eAAe,CAChB,CAAC;YAEF,IAAI,CAAC,uBAAuB,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE;gBAC/D,MAAM,qCAAqC,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;gBACtE,OAAO;aACR;YACD,kEAAkE;YAClE,sFAAsF;YACtF,IAAI,wBAAwB,GAAG,KAAK,CAAC;YAErC,wEAAwE;YACxE,MAAM,sCAAsC,GAAsB,EAAE,CAAC;YAErE,iEAAiE;YACjE,8BAA8B;YAC9B,MAAM,oBAAoB,GAAG,MAAM,IAAA,oCAAuB,EACxD,OAAO,EACP,eAAe,CAChB,CAAC;YAEF,IAAI,CAAC,oBAAoB,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE;gBACzD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;aACzD;YAED,MAAM,8CAA8C,GAClD,uBAAuB,CAAC,MAAM,GAAG,oBAAoB,CAAC,MAAM,CAAC;YAE/D,uDAAuD;YACvD,mGAAmG;YACnG,IAAI,8CAA8C,EAAE;gBAClD,MAAM,qBAAqB,GACzB,IAAI,CAAC,GAAG,CAAC,uBAAuB,CAAC,MAAM,EAAE,wBAAwB,CAAC;oBAClE,oBAAoB,CAAC,MAAM,CAAC;gBAE9B,8DAA8D;gBAC9D,MAAM,YAAY,EAAE,CAAC,IAAI,CACvB,+BAA+B,EAC/B;oBACE,EAAE,EAAE,eAAe;iBACpB,EACD,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;oBACpB,MAAM,OAAO,CAAC,WAAW,CAAC,qBAAqB,CAAC,CAAC;gBACnD,CAAC,CACF,CAAC;gBAEF,2EAA2E;gBAC3E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,qBAAqB,EAAE,CAAC,EAAE,EAAE;oBAC9C,cAAc,EAAE,EAAE,CAAC;iBACpB;aACF;YAED,qCAAqC;YACrC,qGAAqG;YACrG,MAAM,6BAA6B,GAAG,MAAM,IAAA,oCAAuB,EACjE,OAAO,EACP,eAAe,CAChB,CAAC;YAEF,MAAM,kBAAkB,GAAG,6BAA6B,CAAC,MAAM,CAC7D,CAAC,OAAO,EAAE,EAAE,CACV,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CACnE,CAAC;YAEF,KAAK,MAAM,eAAe,IAAI,6BAA6B,EAAE;gBAC3D,MAAM,kBAAkB,GAAG,uBAAuB,CAAC,IAAI,CACrD,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,KAAK,eAAe,CAAC,OAAO,CACnD,CAAC;gBAEF,gDAAgD;gBAChD,uBAAuB;gBACvB,IAAI,CAAC,kBAAkB,EAAE;oBACvB,wGAAwG;oBACxG,IAAI,kBAAkB,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE;wBAChD,wBAAwB,GAAG,IAAI,CAAC;wBAChC,+BAA+B,EAAE,CAC/B,0GAA0G,EAC1G;4BACE,eAAe;4BACf,kBAAkB;4BAClB,kBAAkB;4BAClB,uBAAuB;4BACvB,oBAAoB;4BACpB,6BAA6B;4BAC7B,sCAAsC;yBACvC,CACF,CAAC;wBACF,SAAS;qBACV;oBACD,wHAAwH;oBACxH,sCAAsC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;oBAC7D,SAAS;iBACV;gBAED,6DAA6D;gBAC7D,qEAAqE;gBAErE,0CAA0C;gBAC1C,MAAM,4BAA4B,GAAG,IAAA,gCAAwB,EAC3D,eAAe,CAAC,QAAQ,CAAC,IAAI,CAC9B,CAAC;gBACF,MAAM,+BAA+B,GAAG,IAAA,gCAAwB,EAC9D,kBAAkB,CAAC,CAAC,CACrB,CAAC;gBAEF,oCAAoC;gBACpC,IAAI,4BAA4B,EAAE;oBAChC,IAAI,CAAC,+BAA+B,EAAE;wBACpC,YAAY,EAAE,CAAC,IAAI,CACjB,0CAA0C,EAC1C,eAAe,CAAC,EAAE,EAClB;4BACE,IAAI,EAAE,kBAAkB,CAAC,CAAC;yBAC3B,CACF,CAAC;wBAEF,oBAAoB,EAAE,EAAE,CAAC;qBAC1B;oBACD,SAAS;iBACV;gBAED,6EAA6E;gBAC7E,IAAI,+BAA+B,EAAE;oBACnC,sCAAsC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;oBAC7D,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,sCAAsC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;4BAC7D,SAAS;yBACV;qBACF;oBAED,YAAY,EAAE,CAAC,IAAI,CACjB,0CAA0C,EAC1C,eAAe,CAAC,EAAE,EAClB;wBACE,IAAI,EAAE,kBAAkB,CAAC,CAAC;wBAC1B,iBAAiB,EAAE,kBAAkB,CAAC,GAAG;qBAC1C,CACF,CAAC;oBAEF,MAAM,0CAA0C,GAC9C,eAAe,CAAC,QAAQ,CAAC,IAAI,KAAK,kBAAkB,CAAC,CAAC,CAAC;oBAEzD,IAAI,CAAC,0CAA0C,EAAE;wBAC/C,oBAAoB,EAAE,EAAE,CAAC;qBAC1B;oBAED,SAAS;iBACV;qBAAM,IAAI,eAAe,CAAC,QAAQ,CAAC,iBAAiB,KAAK,SAAS,EAAE;oBACnE,sCAAsC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;oBAC7D,SAAS;iBACV;aACF;YAED,sDAAsD;YACtD,IAAI,sCAAsC,CAAC,MAAM,EAAE;gBACjD,IACE,CAAC,gCAAgC,EAAE,CAAC,oCAAoC,EAAE,EAC1E;oBACA,4FAA4F;oBAC5F,kEAAkE;oBAClE,MAAM,gCAAgC,EAAE,CAAC,sBAAsB,CAC7D,2CAA0B,CAAC,QAAQ,EACnC,sCAAsC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;wBACtD,OAAO,CAAC,OAAO;wBACf,IAAI,CAAC,SAAS,CAAC,IAAA,8CAAsC,EAAC,OAAO,CAAC,CAAC;qBAChE,CAAC,EACF,eAAe,CAChB,CAAC;iBACH;aACF;YAED,sGAAsG;YACtG,8CAA8C;YAC9C,MAAM,8BAA8B,GAAG,uBAAuB,CAAC,MAAM,CACnE,CAAC,OAAO,EAAE,EAAE,CACV,CAAC,6BAA6B,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CACtE,CAAC;YAEF,IAAI,8BAA8B,CAAC,MAAM,EAAE;gBACzC,IACE,CAAC,gCAAgC,EAAE,CAAC,oCAAoC,EAAE,EAC1E;oBACA,4FAA4F;oBAC5F,kEAAkE;oBAClE,MAAM,gCAAgC,EAAE,CAAC,yBAAyB,CAChE,2CAA0B,CAAC,QAAQ,EACnC,8BAA8B,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,EAC1D,eAAe,CAChB,CAAC;oBACF,wBAAwB,GAAG,IAAI,CAAC;oBAChC,+BAA+B,EAAE,CAC/B,yHAAyH,EACzH;wBACE,8BAA8B;wBAC9B,oBAAoB;wBACpB,6BAA6B;wBAC7B,sCAAsC;wBACtC,uBAAuB;qBACxB,CACF,CAAC;iBACH;aACF;YAED,IAAI,wBAAwB,EAAE;gBAC5B,MAAM,CAAC,4BAA4B,EAAE,yBAAyB,CAAC,GAC7D,MAAM,OAAO,CAAC,GAAG,CAAC;oBAChB,IAAA,uCAA0B,EAAC,OAAO,EAAE,eAAe,CAAC;oBACpD,IAAA,oCAAuB,EAAC,OAAO,EAAE,eAAe,CAAC;iBAClD,CAAC,CAAC;gBAEL,MAAM,oEAAoE,GACxE,yBAAyB,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE,CAC1C,4BAA4B,EAAE,IAAI,CAChC,CAAC,kBAAkB,EAAE,EAAE,CAAC,kBAAkB,CAAC,CAAC,KAAK,OAAO,CAAC,OAAO,CACjE,CACF,CAAC;gBAEJ,uBAAuB;gBACvB,MAAM,oEAAoE,GACxE,CAAC,4BAA4B,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,wBAAwB;oBACpE,CAAC,CAAC,IAAI;oBACN,CAAC,CAAC,4BAA4B,EAAE,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE,CAC9C,yBAAyB,CAAC,IAAI,CAC5B,CAAC,eAAe,EAAE,EAAE,CAAC,eAAe,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC,CAC3D,CACF,CAAC;gBAER,MAAM,iBAAiB,GACrB,oEAAoE;oBACpE,oEAAoE,CAAC;gBAEvE,MAAM,OAAO,GAAG;oBACd,4BAA4B;oBAC5B,yBAAyB;iBAC1B,CAAC;gBACF,IAAI,iBAAiB,EAAE;oBACrB,+BAA+B,EAAE,CAC/B,6FAA6F,EAC7F,OAAO,CACR,CAAC;iBACH;qBAAM;oBACL,+BAA+B,EAAE,CAC/B,oGAAoG,EACpG,OAAO,CACR,CAAC;iBACH;aACF;SACF;QAAC,OAAO,CAAC,EAAE;YACV,uBAAuB;YACvB,MAAM,YAAY,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACxE,MAAM,IAAI,KAAK,CACb,uEAAuE,YAAY,EAAE,CACtF,CAAC;SACH;gBAAS;YACR,MAAM,gCAAgC,EAAE,CAAC,6BAA6B,CACpE,KAAK,CACN,CAAC;SACH;IACH,CAAC,CAAC;IAEF,IAAI,KAAK,EAAE;QACT,OAAO,MAAM,KAAK,CAAC,EAAE,IAAI,EAAE,qBAAS,CAAC,eAAe,EAAE,EAAE,kBAAkB,CAAC,CAAC;KAC7E;IAED,OAAO,MAAM,kBAAkB,EAAE,CAAC;AACpC,CAAC;AAjTD,kFAiTC","sourcesContent":["import { KeyringTypes } from '@metamask/keyring-controller';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\n\nimport {\n  canPerformAccountSyncing,\n  getInternalAccountsList,\n  getUserStorageAccountsList,\n} from './sync-utils';\nimport type { AccountSyncingOptions } from './types';\nimport {\n  isNameDefaultAccountName,\n  mapInternalAccountToUserStorageAccount,\n} from './utils';\nimport { USER_STORAGE_FEATURE_NAMES } from '../../../shared/storage-schema';\nimport { TraceName } from '../constants';\n\n/**\n * Saves an individual internal account to the user storage.\n *\n * @param internalAccount - The internal account to save\n * @param options - parameters used for saving the internal account\n * @returns Promise that resolves when the account is saved\n */\nexport async function saveInternalAccountToUserStorage(\n  internalAccount: InternalAccount,\n  options: AccountSyncingOptions,\n): Promise<void> {\n  const { trace } = options;\n\n  const saveAccount = async () => {\n    const { getUserStorageControllerInstance } = options;\n\n    if (\n      getUserStorageControllerInstance().getIsMultichainAccountSyncingEnabled()\n    ) {\n      // If multichain account syncing is enabled, we do not push account syncing V1 data anymore.\n      // AccountTreeController handles proper multichain account syncing\n      return;\n    }\n\n    if (\n      !canPerformAccountSyncing(options) ||\n      internalAccount.metadata.keyring.type !== String(KeyringTypes.hd) // sync only EVM accounts until we support multichain accounts\n    ) {\n      return;\n    }\n\n    // properties of `options` are (wrongly?) typed as `Json` and eslint crashes if we try to interpret it as such and call a `?.toString()` on it.\n    // but we know this is a string?, so we can safely cast it\n    const entropySourceId = internalAccount.options?.entropySource as\n      | string\n      | undefined;\n\n    try {\n      // Map the internal account to the user storage account schema\n      const mappedAccount =\n        mapInternalAccountToUserStorageAccount(internalAccount);\n\n      await getUserStorageControllerInstance().performSetStorage(\n        `${USER_STORAGE_FEATURE_NAMES.accounts}.${internalAccount.address}`,\n        JSON.stringify(mappedAccount),\n        entropySourceId,\n      );\n    } catch (e) {\n      // istanbul ignore next\n      const errorMessage = e instanceof Error ? e.message : JSON.stringify(e);\n      throw new Error(\n        `UserStorageController - failed to save account to user storage - ${errorMessage}`,\n      );\n    }\n  };\n\n  if (trace) {\n    return await trace(\n      { name: TraceName.AccountSyncSaveIndividual },\n      saveAccount,\n    );\n  }\n\n  return await saveAccount();\n}\n\n/**\n * Saves the list of internal accounts to the user storage.\n *\n * @param options - parameters used for saving the list of internal accounts\n * @param entropySourceId - The entropy source ID used to derive the key,\n * when multiple sources are available (Multi-SRP).\n * @returns Promise that resolves when all accounts are saved\n */\nexport async function saveInternalAccountsListToUserStorage(\n  options: AccountSyncingOptions,\n  entropySourceId: string,\n): Promise<void> {\n  const { getUserStorageControllerInstance } = options;\n  if (\n    getUserStorageControllerInstance().getIsMultichainAccountSyncingEnabled()\n  ) {\n    // If multichain account syncing is enabled, we do not push account syncing V1 data anymore.\n    // AccountTreeController handles proper multichain account syncing\n    return;\n  }\n\n  const internalAccountsList = await getInternalAccountsList(\n    options,\n    entropySourceId,\n  );\n\n  if (!internalAccountsList?.length) {\n    return;\n  }\n\n  const internalAccountsListFormattedForUserStorage = internalAccountsList.map(\n    mapInternalAccountToUserStorageAccount,\n  );\n\n  await getUserStorageControllerInstance().performBatchSetStorage(\n    USER_STORAGE_FEATURE_NAMES.accounts,\n    internalAccountsListFormattedForUserStorage.map((account) => [\n      account.a,\n      JSON.stringify(account),\n    ]),\n    entropySourceId,\n  );\n}\n\ntype SyncInternalAccountsWithUserStorageConfig = {\n  maxNumberOfAccountsToAdd?: number;\n  onAccountAdded?: () => void;\n  onAccountNameUpdated?: () => void;\n  onAccountSyncErroneousSituation?: (\n    errorMessage: string,\n    sentryContext?: Record<string, unknown>,\n  ) => void;\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 * @param config - parameters used for syncing the internal accounts list with the user storage accounts list\n * @param options - parameters used for syncing the internal accounts list with the user storage accounts list\n * @param entropySourceId - The entropy source ID used to derive the key,\n * @returns Promise that resolves when synchronization is complete\n */\nexport async function syncInternalAccountsWithUserStorage(\n  config: SyncInternalAccountsWithUserStorageConfig,\n  options: AccountSyncingOptions,\n  entropySourceId: string,\n): Promise<void> {\n  const { trace } = options;\n\n  const performAccountSync = async () => {\n    if (!canPerformAccountSyncing(options)) {\n      return;\n    }\n\n    const {\n      maxNumberOfAccountsToAdd = Infinity,\n      onAccountAdded,\n      onAccountNameUpdated,\n      onAccountSyncErroneousSituation,\n    } = config;\n    const { getMessenger, getUserStorageControllerInstance } = options;\n\n    try {\n      await getUserStorageControllerInstance().setIsAccountSyncingInProgress(\n        true,\n      );\n\n      const userStorageAccountsList = await getUserStorageAccountsList(\n        options,\n        entropySourceId,\n      );\n\n      if (!userStorageAccountsList || !userStorageAccountsList.length) {\n        await saveInternalAccountsListToUserStorage(options, entropySourceId);\n        return;\n      }\n      // Keep a record if erroneous situations are found during the sync\n      // This is done so we can send the context to Sentry in case of an erroneous situation\n      let erroneousSituationsFound = false;\n\n      // Prepare an array of internal accounts to be saved to the user storage\n      const internalAccountsToBeSavedToUserStorage: InternalAccount[] = [];\n\n      // Compare internal accounts list with user storage accounts list\n      // First step: compare lengths\n      const internalAccountsList = await getInternalAccountsList(\n        options,\n        entropySourceId,\n      );\n\n      if (!internalAccountsList || !internalAccountsList.length) {\n        throw new Error(`Failed to get internal accounts list`);\n      }\n\n      const hasMoreUserStorageAccountsThanInternalAccounts =\n        userStorageAccountsList.length > internalAccountsList.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 in user storage than internal accounts\n      if (hasMoreUserStorageAccountsThanInternalAccounts) {\n        const numberOfAccountsToAdd =\n          Math.min(userStorageAccountsList.length, maxNumberOfAccountsToAdd) -\n          internalAccountsList.length;\n\n        // Create new accounts to match the user storage accounts list\n        await getMessenger().call(\n          'KeyringController:withKeyring',\n          {\n            id: entropySourceId,\n          },\n          async ({ keyring }) => {\n            await keyring.addAccounts(numberOfAccountsToAdd);\n          },\n        );\n\n        // TODO: below code is kept for analytics but should probably be re-thought\n        for (let i = 0; i < numberOfAccountsToAdd; i++) {\n          onAccountAdded?.();\n        }\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      const refreshedInternalAccountsList = await getInternalAccountsList(\n        options,\n        entropySourceId,\n      );\n\n      const newlyAddedAccounts = refreshedInternalAccountsList.filter(\n        (account) =>\n          !internalAccountsList.find((a) => a.address === account.address),\n      );\n\n      for (const internalAccount of refreshedInternalAccountsList) {\n        const userStorageAccount = userStorageAccountsList.find(\n          (account) => account.a === internalAccount.address,\n        );\n\n        // If the account is not present in user storage\n        // istanbul ignore next\n        if (!userStorageAccount) {\n          // If the account was just added in the previous step, skip saving it, it's likely to be a bogus account\n          if (newlyAddedAccounts.includes(internalAccount)) {\n            erroneousSituationsFound = true;\n            onAccountSyncErroneousSituation?.(\n              'An account was added to the internal accounts list but was not present in the user storage accounts list',\n              {\n                internalAccount,\n                userStorageAccount,\n                newlyAddedAccounts,\n                userStorageAccountsList,\n                internalAccountsList,\n                refreshedInternalAccountsList,\n                internalAccountsToBeSavedToUserStorage,\n              },\n            );\n            continue;\n          }\n          // Otherwise, it means that this internal account was present before the sync, and needs to be saved to the user storage\n          internalAccountsToBeSavedToUserStorage.push(internalAccount);\n          continue;\n        }\n\n        // From this point on, we know that the account is present in\n        // both the internal accounts list and the user storage accounts list\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            getMessenger().call(\n              'AccountsController:updateAccountMetadata',\n              internalAccount.id,\n              {\n                name: userStorageAccount.n,\n              },\n            );\n\n            onAccountNameUpdated?.();\n          }\n          continue;\n        }\n\n        // Internal account has custom name but user storage account has default name\n        if (isUserStorageAccountNameDefault) {\n          internalAccountsToBeSavedToUserStorage.push(internalAccount);\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              internalAccountsToBeSavedToUserStorage.push(internalAccount);\n              continue;\n            }\n          }\n\n          getMessenger().call(\n            'AccountsController:updateAccountMetadata',\n            internalAccount.id,\n            {\n              name: userStorageAccount.n,\n              nameLastUpdatedAt: userStorageAccount.nlu,\n            },\n          );\n\n          const areInternalAndUserStorageAccountNamesEqual =\n            internalAccount.metadata.name === userStorageAccount.n;\n\n          if (!areInternalAndUserStorageAccountNamesEqual) {\n            onAccountNameUpdated?.();\n          }\n\n          continue;\n        } else if (internalAccount.metadata.nameLastUpdatedAt !== undefined) {\n          internalAccountsToBeSavedToUserStorage.push(internalAccount);\n          continue;\n        }\n      }\n\n      // Save the internal accounts list to the user storage\n      if (internalAccountsToBeSavedToUserStorage.length) {\n        if (\n          !getUserStorageControllerInstance().getIsMultichainAccountSyncingEnabled()\n        ) {\n          // If multichain account syncing is enabled, we do not push account syncing V1 data anymore.\n          // AccountTreeController handles proper multichain account syncing\n          await getUserStorageControllerInstance().performBatchSetStorage(\n            USER_STORAGE_FEATURE_NAMES.accounts,\n            internalAccountsToBeSavedToUserStorage.map((account) => [\n              account.address,\n              JSON.stringify(mapInternalAccountToUserStorageAccount(account)),\n            ]),\n            entropySourceId,\n          );\n        }\n      }\n\n      // In case we have corrupted user storage with accounts that don't exist in the internal accounts list\n      // Delete those accounts from the user storage\n      const userStorageAccountsToBeDeleted = userStorageAccountsList.filter(\n        (account) =>\n          !refreshedInternalAccountsList.find((a) => a.address === account.a),\n      );\n\n      if (userStorageAccountsToBeDeleted.length) {\n        if (\n          !getUserStorageControllerInstance().getIsMultichainAccountSyncingEnabled()\n        ) {\n          // If multichain account syncing is enabled, we do not push account syncing V1 data anymore.\n          // AccountTreeController handles proper multichain account syncing\n          await getUserStorageControllerInstance().performBatchDeleteStorage(\n            USER_STORAGE_FEATURE_NAMES.accounts,\n            userStorageAccountsToBeDeleted.map((account) => account.a),\n            entropySourceId,\n          );\n          erroneousSituationsFound = true;\n          onAccountSyncErroneousSituation?.(\n            'An account was present in the user storage accounts list but was not found in the internal accounts list after the sync',\n            {\n              userStorageAccountsToBeDeleted,\n              internalAccountsList,\n              refreshedInternalAccountsList,\n              internalAccountsToBeSavedToUserStorage,\n              userStorageAccountsList,\n            },\n          );\n        }\n      }\n\n      if (erroneousSituationsFound) {\n        const [finalUserStorageAccountsList, finalInternalAccountsList] =\n          await Promise.all([\n            getUserStorageAccountsList(options, entropySourceId),\n            getInternalAccountsList(options, entropySourceId),\n          ]);\n\n        const doesEveryAccountInInternalAccountsListExistInUserStorageAccountsList =\n          finalInternalAccountsList.every((account) =>\n            finalUserStorageAccountsList?.some(\n              (userStorageAccount) => userStorageAccount.a === account.address,\n            ),\n          );\n\n        // istanbul ignore next\n        const doesEveryAccountInUserStorageAccountsListExistInInternalAccountsList =\n          (finalUserStorageAccountsList?.length || 0) > maxNumberOfAccountsToAdd\n            ? true\n            : finalUserStorageAccountsList?.every((account) =>\n                finalInternalAccountsList.some(\n                  (internalAccount) => internalAccount.address === account.a,\n                ),\n              );\n\n        const doFinalListsMatch =\n          doesEveryAccountInInternalAccountsListExistInUserStorageAccountsList &&\n          doesEveryAccountInUserStorageAccountsListExistInInternalAccountsList;\n\n        const context = {\n          finalUserStorageAccountsList,\n          finalInternalAccountsList,\n        };\n        if (doFinalListsMatch) {\n          onAccountSyncErroneousSituation?.(\n            'Erroneous situations were found during the sync, but final state matches the expected state',\n            context,\n          );\n        } else {\n          onAccountSyncErroneousSituation?.(\n            'Erroneous situations were found during the sync, and final state does not match the expected state',\n            context,\n          );\n        }\n      }\n    } catch (e) {\n      // istanbul ignore next\n      const errorMessage = e instanceof Error ? e.message : JSON.stringify(e);\n      throw new Error(\n        `UserStorageController - failed to sync user storage accounts list - ${errorMessage}`,\n      );\n    } finally {\n      await getUserStorageControllerInstance().setIsAccountSyncingInProgress(\n        false,\n      );\n    }\n  };\n\n  if (trace) {\n    return await trace({ name: TraceName.AccountSyncFull }, performAccountSync);\n  }\n\n  return await performAccountSync();\n}\n"]}

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

@@ -0,0 +1,38 @@
+import type { InternalAccount } from "@metamask/keyring-internal-api";
+import type { AccountSyncingOptions } from "./types.cjs";
+/**
+ * Saves an individual internal account to the user storage.
+ *
+ * @param internalAccount - The internal account to save
+ * @param options - parameters used for saving the internal account
+ * @returns Promise that resolves when the account is saved
+ */
+export declare function saveInternalAccountToUserStorage(internalAccount: InternalAccount, options: AccountSyncingOptions): Promise<void>;
+/**
+ * Saves the list of internal accounts to the user storage.
+ *
+ * @param options - parameters used for saving the list of internal accounts
+ * @param entropySourceId - The entropy source ID used to derive the key,
+ * when multiple sources are available (Multi-SRP).
+ * @returns Promise that resolves when all accounts are saved
+ */
+export declare function saveInternalAccountsListToUserStorage(options: AccountSyncingOptions, entropySourceId: string): Promise<void>;
+type SyncInternalAccountsWithUserStorageConfig = {
+    maxNumberOfAccountsToAdd?: number;
+    onAccountAdded?: () => void;
+    onAccountNameUpdated?: () => void;
+    onAccountSyncErroneousSituation?: (errorMessage: string, sentryContext?: Record<string, unknown>) => void;
+};
+/**
+ * Syncs the internal accounts list with the user storage accounts list.
+ * This method is used to make sure that the internal accounts list is up-to-date with the user storage accounts list and vice-versa.
+ * 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.
+ *
+ * @param config - parameters used for syncing the internal accounts list with the user storage accounts list
+ * @param options - parameters used for syncing the internal accounts list with the user storage accounts list
+ * @param entropySourceId - The entropy source ID used to derive the key,
+ * @returns Promise that resolves when synchronization is complete
+ */
+export declare function syncInternalAccountsWithUserStorage(config: SyncInternalAccountsWithUserStorageConfig, options: AccountSyncingOptions, entropySourceId: string): Promise<void>;
+export {};
+//# sourceMappingURL=controller-integration.d.cts.map

package/dist/controllers/user-storage/account-syncing/controller-integration.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"controller-integration.d.cts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/controller-integration.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AAOtE,OAAO,KAAK,EAAE,qBAAqB,EAAE,oBAAgB;AAQrD;;;;;;GAMG;AACH,wBAAsB,gCAAgC,CACpD,eAAe,EAAE,eAAe,EAChC,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,IAAI,CAAC,CAsDf;AAED;;;;;;;GAOG;AACH,wBAAsB,qCAAqC,CACzD,OAAO,EAAE,qBAAqB,EAC9B,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,IAAI,CAAC,CA+Bf;AAED,KAAK,yCAAyC,GAAG;IAC/C,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,cAAc,CAAC,EAAE,MAAM,IAAI,CAAC;IAC5B,oBAAoB,CAAC,EAAE,MAAM,IAAI,CAAC;IAClC,+BAA+B,CAAC,EAAE,CAChC,YAAY,EAAE,MAAM,EACpB,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KACpC,IAAI,CAAC;CACX,CAAC;AAEF;;;;;;;;;GASG;AACH,wBAAsB,mCAAmC,CACvD,MAAM,EAAE,yCAAyC,EACjD,OAAO,EAAE,qBAAqB,EAC9B,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,IAAI,CAAC,CA6Sf"}

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

@@ -0,0 +1,38 @@
+import type { InternalAccount } from "@metamask/keyring-internal-api";
+import type { AccountSyncingOptions } from "./types.mjs";
+/**
+ * Saves an individual internal account to the user storage.
+ *
+ * @param internalAccount - The internal account to save
+ * @param options - parameters used for saving the internal account
+ * @returns Promise that resolves when the account is saved
+ */
+export declare function saveInternalAccountToUserStorage(internalAccount: InternalAccount, options: AccountSyncingOptions): Promise<void>;
+/**
+ * Saves the list of internal accounts to the user storage.
+ *
+ * @param options - parameters used for saving the list of internal accounts
+ * @param entropySourceId - The entropy source ID used to derive the key,
+ * when multiple sources are available (Multi-SRP).
+ * @returns Promise that resolves when all accounts are saved
+ */
+export declare function saveInternalAccountsListToUserStorage(options: AccountSyncingOptions, entropySourceId: string): Promise<void>;
+type SyncInternalAccountsWithUserStorageConfig = {
+    maxNumberOfAccountsToAdd?: number;
+    onAccountAdded?: () => void;
+    onAccountNameUpdated?: () => void;
+    onAccountSyncErroneousSituation?: (errorMessage: string, sentryContext?: Record<string, unknown>) => void;
+};
+/**
+ * Syncs the internal accounts list with the user storage accounts list.
+ * This method is used to make sure that the internal accounts list is up-to-date with the user storage accounts list and vice-versa.
+ * 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.
+ *
+ * @param config - parameters used for syncing the internal accounts list with the user storage accounts list
+ * @param options - parameters used for syncing the internal accounts list with the user storage accounts list
+ * @param entropySourceId - The entropy source ID used to derive the key,
+ * @returns Promise that resolves when synchronization is complete
+ */
+export declare function syncInternalAccountsWithUserStorage(config: SyncInternalAccountsWithUserStorageConfig, options: AccountSyncingOptions, entropySourceId: string): Promise<void>;
+export {};
+//# sourceMappingURL=controller-integration.d.mts.map

package/dist/controllers/user-storage/account-syncing/controller-integration.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"controller-integration.d.mts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/controller-integration.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AAOtE,OAAO,KAAK,EAAE,qBAAqB,EAAE,oBAAgB;AAQrD;;;;;;GAMG;AACH,wBAAsB,gCAAgC,CACpD,eAAe,EAAE,eAAe,EAChC,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,IAAI,CAAC,CAsDf;AAED;;;;;;;GAOG;AACH,wBAAsB,qCAAqC,CACzD,OAAO,EAAE,qBAAqB,EAC9B,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,IAAI,CAAC,CA+Bf;AAED,KAAK,yCAAyC,GAAG;IAC/C,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,cAAc,CAAC,EAAE,MAAM,IAAI,CAAC;IAC5B,oBAAoB,CAAC,EAAE,MAAM,IAAI,CAAC;IAClC,+BAA+B,CAAC,EAAE,CAChC,YAAY,EAAE,MAAM,EACpB,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KACpC,IAAI,CAAC;CACX,CAAC;AAEF;;;;;;;;;GASG;AACH,wBAAsB,mCAAmC,CACvD,MAAM,EAAE,yCAAyC,EACjD,OAAO,EAAE,qBAAqB,EAC9B,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,IAAI,CAAC,CA6Sf"}