@metamask/profile-sync-controller 3.1.0 → 3.2.0

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"constants.cjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,oBAAoB,GAAG,GAAG,CAAC;AAExC,4FAA4F;AAC/E,QAAA,wBAAwB,GAAkB,GAAY,CAAC;AAEpE,qGAAqG;AACxF,QAAA,+BAA+B,GAAG;IAC7C,SAAS;IACT,KAAK;IACL,QAAQ;IACR,QAAQ;IACR,YAAY;IACZ,QAAQ;IACR,MAAM;IACN,OAAO;IACP,aAAa;IACb,QAAQ;IACR,MAAM;IACN,MAAM;IACN,SAAS;IACT,OAAO;IACP,QAAQ;IACR,MAAM;IACN,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;IACN,IAAI;IACJ,SAAS;IACT,OAAO;IACP,WAAW;IACX,MAAM;IACN,OAAO;IACP,OAAO;IACP,MAAM;IACN,MAAM;IACN,OAAO;IACP,SAAS;IACT,QAAQ;IACR,MAAM;IACN,OAAO;IACP,OAAO;IACP,iBAAiB;IACjB,WAAW;IACX,IAAI;IACJ,IAAI;CACI,CAAC","sourcesContent":["export const USER_STORAGE_VERSION = '1';\n\n// Force cast. We don't really care about the type here since we treat it as a unique symbol\nexport const USER_STORAGE_VERSION_KEY: unique symbol = 'v' as never;\n\n// We need this in order to know if an account is a default account or not when we do account syncing\nexport const LOCALIZED_DEFAULT_ACCOUNT_NAMES = [\n  'Account',\n  'መለያ',\n  'الحساب',\n  'Профил',\n  'অ্যাকাউন্ট',\n  'Compte',\n  'Účet',\n  'Konto',\n  'Λογαριασμός',\n  'Cuenta',\n  'حساب',\n  'Tili',\n  'એકાઉન્ટ',\n  'חשבון',\n  'अकाउंट',\n  'खाता',\n  'Račun',\n  'Kont',\n  'Fiók',\n  'Akun',\n  'アカウント',\n  'ಖಾತೆ',\n  '계정',\n  'Paskyra',\n  'Konts',\n  'അക്കൗണ്ട്',\n  'खाते',\n  'Akaun',\n  'Conta',\n  'Cont',\n  'Счет',\n  'налог',\n  'Akaunti',\n  'கணக்கு',\n  'ఖాతా',\n  'บัญชี',\n  'Hesap',\n  'Обліковий запис',\n  'Tài khoản',\n  '账户',\n  '帳戶',\n] as const;\n"]}

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

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.cts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,oBAAoB,MAAM,CAAC;AAGxC,eAAO,MAAM,wBAAwB,EAAE,OAAO,MAAqB,CAAC;AAGpE,eAAO,MAAM,+BAA+B,gZA0ClC,CAAC"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.mts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,oBAAoB,MAAM,CAAC;AAGxC,eAAO,MAAM,wBAAwB,EAAE,OAAO,MAAqB,CAAC;AAGpE,eAAO,MAAM,+BAA+B,gZA0ClC,CAAC"}

package/dist/controllers/user-storage/account-syncing/constants.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.mjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAG,CAAC;AAExC,4FAA4F;AAC5F,MAAM,CAAC,MAAM,wBAAwB,GAAkB,GAAY,CAAC;AAEpE,qGAAqG;AACrG,MAAM,CAAC,MAAM,+BAA+B,GAAG;IAC7C,SAAS;IACT,KAAK;IACL,QAAQ;IACR,QAAQ;IACR,YAAY;IACZ,QAAQ;IACR,MAAM;IACN,OAAO;IACP,aAAa;IACb,QAAQ;IACR,MAAM;IACN,MAAM;IACN,SAAS;IACT,OAAO;IACP,QAAQ;IACR,MAAM;IACN,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;IACN,IAAI;IACJ,SAAS;IACT,OAAO;IACP,WAAW;IACX,MAAM;IACN,OAAO;IACP,OAAO;IACP,MAAM;IACN,MAAM;IACN,OAAO;IACP,SAAS;IACT,QAAQ;IACR,MAAM;IACN,OAAO;IACP,OAAO;IACP,iBAAiB;IACjB,WAAW;IACX,IAAI;IACJ,IAAI;CACI,CAAC","sourcesContent":["export const USER_STORAGE_VERSION = '1';\n\n// Force cast. We don't really care about the type here since we treat it as a unique symbol\nexport const USER_STORAGE_VERSION_KEY: unique symbol = 'v' as never;\n\n// We need this in order to know if an account is a default account or not when we do account syncing\nexport const LOCALIZED_DEFAULT_ACCOUNT_NAMES = [\n  'Account',\n  'መለያ',\n  'الحساب',\n  'Профил',\n  'অ্যাকাউন্ট',\n  'Compte',\n  'Účet',\n  'Konto',\n  'Λογαριασμός',\n  'Cuenta',\n  'حساب',\n  'Tili',\n  'એકાઉન્ટ',\n  'חשבון',\n  'अकाउंट',\n  'खाता',\n  'Račun',\n  'Kont',\n  'Fiók',\n  'Akun',\n  'アカウント',\n  'ಖಾತೆ',\n  '계정',\n  'Paskyra',\n  'Konts',\n  'അക്കൗണ്ട്',\n  'खाते',\n  'Akaun',\n  'Conta',\n  'Cont',\n  'Счет',\n  'налог',\n  'Akaunti',\n  'கணக்கு',\n  'ఖాతా',\n  'บัญชี',\n  'Hesap',\n  'Обліковий запис',\n  'Tài khoản',\n  '账户',\n  '帳戶',\n] as const;\n"]}

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

@@ -0,0 +1,194 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.syncInternalAccountsWithUserStorage = exports.saveInternalAccountsListToUserStorage = exports.saveInternalAccountToUserStorage = void 0;
+const keyring_api_1 = require("@metamask/keyring-api");
+const storage_schema_1 = require("../../../shared/storage-schema.cjs");
+const sync_utils_1 = require("./sync-utils.cjs");
+const utils_1 = require("./utils.cjs");
+/**
+ * Saves an individual internal account to the user storage.
+ * @param internalAccount - The internal account to save
+ * @param config - parameters used for saving the internal account
+ * @param options - parameters used for saving the internal account
+ */
+async function saveInternalAccountToUserStorage(internalAccount, config, options) {
+    const { isAccountSyncingEnabled } = config;
+    const { getUserStorageControllerInstance } = options;
+    if (!isAccountSyncingEnabled ||
+        !(0, sync_utils_1.canPerformAccountSyncing)(config, options) ||
+        !(0, keyring_api_1.isEvmAccountType)(internalAccount.type) ||
+        !(0, utils_1.doesInternalAccountHaveCorrectKeyringType)(internalAccount)) {
+        return;
+    }
+    try {
+        // Map the internal account to the user storage account schema
+        const mappedAccount = (0, utils_1.mapInternalAccountToUserStorageAccount)(internalAccount);
+        await getUserStorageControllerInstance().performSetStorage(
+        // ESLint is confused here.
+        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+        `${storage_schema_1.USER_STORAGE_FEATURE_NAMES.accounts}.${internalAccount.address}`, JSON.stringify(mappedAccount));
+    }
+    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}`);
+    }
+}
+exports.saveInternalAccountToUserStorage = saveInternalAccountToUserStorage;
+/**
+ * Saves the list of internal accounts to the user storage.
+ * @param config - parameters used for saving the list of internal accounts
+ * @param options - parameters used for saving the list of internal accounts
+ */
+async function saveInternalAccountsListToUserStorage(config, options) {
+    const { isAccountSyncingEnabled } = config;
+    const { getUserStorageControllerInstance } = options;
+    if (!isAccountSyncingEnabled) {
+        return;
+    }
+    const internalAccountsList = await (0, sync_utils_1.getInternalAccountsList)(options);
+    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),
+    ]));
+}
+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
+ */
+async function syncInternalAccountsWithUserStorage(config, options) {
+    const { isAccountSyncingEnabled } = config;
+    if (!(0, sync_utils_1.canPerformAccountSyncing)(config, options) || !isAccountSyncingEnabled) {
+        return;
+    }
+    const { maxNumberOfAccountsToAdd = 100, onAccountAdded, onAccountNameUpdated, onAccountSyncErroneousSituation, } = config;
+    const { getMessenger, getUserStorageControllerInstance } = options;
+    try {
+        await getUserStorageControllerInstance().setIsAccountSyncingInProgress(true);
+        const userStorageAccountsList = await (0, sync_utils_1.getUserStorageAccountsList)(options);
+        if (!userStorageAccountsList || !userStorageAccountsList.length) {
+            await saveInternalAccountsListToUserStorage({ isAccountSyncingEnabled }, options);
+            await getUserStorageControllerInstance().setHasAccountSyncingSyncedAtLeastOnce(true);
+            return;
+        }
+        // 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);
+        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
+            for (let i = 0; i < numberOfAccountsToAdd; i++) {
+                await getMessenger().call('KeyringController:addNewAccount');
+                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);
+        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)) {
+                    onAccountSyncErroneousSituation?.('An account was added to the internal accounts list but was not present in the user storage accounts list');
+                    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) {
+            await getUserStorageControllerInstance().performBatchSetStorage(storage_schema_1.USER_STORAGE_FEATURE_NAMES.accounts, internalAccountsToBeSavedToUserStorage.map((account) => [
+                account.address,
+                JSON.stringify((0, utils_1.mapInternalAccountToUserStorageAccount)(account)),
+            ]));
+        }
+        // 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) {
+            await getUserStorageControllerInstance().performBatchDeleteStorage(storage_schema_1.USER_STORAGE_FEATURE_NAMES.accounts, userStorageAccountsToBeDeleted.map((account) => account.a));
+            onAccountSyncErroneousSituation?.('An account was present in the user storage accounts list but was not found in the internal accounts list after the sync');
+        }
+        // We do this here and not in the finally statement because we want to make sure that
+        // the accounts are saved / updated / deleted at least once before we set this flag
+        await getUserStorageControllerInstance().setHasAccountSyncingSyncedAtLeastOnce(true);
+    }
+    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);
+    }
+}
+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,uDAAyD;AAGzD,uEAA4E;AAC5E,iDAIsB;AAEtB,uCAIiB;AAEjB;;;;;GAKG;AACI,KAAK,UAAU,gCAAgC,CACpD,eAAgC,EAChC,MAA4B,EAC5B,OAA8B;IAE9B,MAAM,EAAE,uBAAuB,EAAE,GAAG,MAAM,CAAC;IAC3C,MAAM,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC;IAErD,IACE,CAAC,uBAAuB;QACxB,CAAC,IAAA,qCAAwB,EAAC,MAAM,EAAE,OAAO,CAAC;QAC1C,CAAC,IAAA,8BAAgB,EAAC,eAAe,CAAC,IAAI,CAAC;QACvC,CAAC,IAAA,iDAAyC,EAAC,eAAe,CAAC,EAC3D;QACA,OAAO;KACR;IAED,IAAI;QACF,8DAA8D;QAC9D,MAAM,aAAa,GACjB,IAAA,8CAAsC,EAAC,eAAe,CAAC,CAAC;QAE1D,MAAM,gCAAgC,EAAE,CAAC,iBAAiB;QACxD,2BAA2B;QAC3B,4EAA4E;QAC5E,GAAG,2CAA0B,CAAC,QAAQ,IAAI,eAAe,CAAC,OAAO,EAAE,EACnE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAC9B,CAAC;KACH;IAAC,OAAO,CAAC,EAAE;QACV,uBAAuB;QACvB,MAAM,YAAY,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QACxE,MAAM,IAAI,KAAK,CACb,oEAAoE,YAAY,EAAE,CACnF,CAAC;KACH;AACH,CAAC;AAnCD,4EAmCC;AAED;;;;GAIG;AACI,KAAK,UAAU,qCAAqC,CACzD,MAA4B,EAC5B,OAA8B;IAE9B,MAAM,EAAE,uBAAuB,EAAE,GAAG,MAAM,CAAC;IAC3C,MAAM,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC;IAErD,IAAI,CAAC,uBAAuB,EAAE;QAC5B,OAAO;KACR;IAED,MAAM,oBAAoB,GAAG,MAAM,IAAA,oCAAuB,EAAC,OAAO,CAAC,CAAC;IAEpE,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,CACH,CAAC;AACJ,CAAC;AA5BD,sFA4BC;AASD;;;;;;GAMG;AACI,KAAK,UAAU,mCAAmC,CACvD,MAAiD,EACjD,OAA8B;IAE9B,MAAM,EAAE,uBAAuB,EAAE,GAAG,MAAM,CAAC;IAE3C,IAAI,CAAC,IAAA,qCAAwB,EAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE;QAC1E,OAAO;KACR;IAED,MAAM,EACJ,wBAAwB,GAAG,GAAG,EAC9B,cAAc,EACd,oBAAoB,EACpB,+BAA+B,GAChC,GAAG,MAAM,CAAC;IACX,MAAM,EAAE,YAAY,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC;IAEnE,IAAI;QACF,MAAM,gCAAgC,EAAE,CAAC,6BAA6B,CACpE,IAAI,CACL,CAAC;QAEF,MAAM,uBAAuB,GAAG,MAAM,IAAA,uCAA0B,EAAC,OAAO,CAAC,CAAC;QAE1E,IAAI,CAAC,uBAAuB,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE;YAC/D,MAAM,qCAAqC,CACzC,EAAE,uBAAuB,EAAE,EAC3B,OAAO,CACR,CAAC;YACF,MAAM,gCAAgC,EAAE,CAAC,qCAAqC,CAC5E,IAAI,CACL,CAAC;YACF,OAAO;SACR;QAED,wEAAwE;QACxE,MAAM,sCAAsC,GAAsB,EAAE,CAAC;QAErE,iEAAiE;QACjE,8BAA8B;QAC9B,MAAM,oBAAoB,GAAG,MAAM,IAAA,oCAAuB,EAAC,OAAO,CAAC,CAAC;QAEpE,IAAI,CAAC,oBAAoB,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE;YACzD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;SACzD;QAED,MAAM,8CAA8C,GAClD,uBAAuB,CAAC,MAAM,GAAG,oBAAoB,CAAC,MAAM,CAAC;QAE/D,uDAAuD;QACvD,mGAAmG;QACnG,IAAI,8CAA8C,EAAE;YAClD,MAAM,qBAAqB,GACzB,IAAI,CAAC,GAAG,CAAC,uBAAuB,CAAC,MAAM,EAAE,wBAAwB,CAAC;gBAClE,oBAAoB,CAAC,MAAM,CAAC;YAE9B,8DAA8D;YAC9D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,qBAAqB,EAAE,CAAC,EAAE,EAAE;gBAC9C,MAAM,YAAY,EAAE,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;gBAC7D,cAAc,EAAE,EAAE,CAAC;aACpB;SACF;QAED,qCAAqC;QACrC,qGAAqG;QACrG,MAAM,6BAA6B,GAAG,MAAM,IAAA,oCAAuB,EACjE,OAAO,CACR,CAAC;QAEF,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;QAEF,KAAK,MAAM,eAAe,IAAI,6BAA6B,EAAE;YAC3D,MAAM,kBAAkB,GAAG,uBAAuB,CAAC,IAAI,CACrD,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,KAAK,eAAe,CAAC,OAAO,CACnD,CAAC;YAEF,gDAAgD;YAChD,uBAAuB;YACvB,IAAI,CAAC,kBAAkB,EAAE;gBACvB,wGAAwG;gBACxG,IAAI,kBAAkB,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE;oBAChD,+BAA+B,EAAE,CAC/B,0GAA0G,CAC3G,CAAC;oBACF,SAAS;iBACV;gBACD,wHAAwH;gBACxH,sCAAsC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;gBAC7D,SAAS;aACV;YAED,6DAA6D;YAC7D,qEAAqE;YAErE,0CAA0C;YAC1C,MAAM,4BAA4B,GAAG,IAAA,gCAAwB,EAC3D,eAAe,CAAC,QAAQ,CAAC,IAAI,CAC9B,CAAC;YACF,MAAM,+BAA+B,GAAG,IAAA,gCAAwB,EAC9D,kBAAkB,CAAC,CAAC,CACrB,CAAC;YAEF,oCAAoC;YACpC,IAAI,4BAA4B,EAAE;gBAChC,IAAI,CAAC,+BAA+B,EAAE;oBACpC,YAAY,EAAE,CAAC,IAAI,CACjB,0CAA0C,EAC1C,eAAe,CAAC,EAAE,EAClB;wBACE,IAAI,EAAE,kBAAkB,CAAC,CAAC;qBAC3B,CACF,CAAC;oBAEF,oBAAoB,EAAE,EAAE,CAAC;iBAC1B;gBACD,SAAS;aACV;YAED,6EAA6E;YAC7E,IAAI,+BAA+B,EAAE;gBACnC,sCAAsC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;gBAC7D,SAAS;aACV;YAED,kCAAkC;YAElC,yDAAyD;YACzD,6EAA6E;YAC7E,IAAI,kBAAkB,CAAC,GAAG,KAAK,SAAS,EAAE;gBACxC,IAAI,eAAe,CAAC,QAAQ,CAAC,iBAAiB,KAAK,SAAS,EAAE;oBAC5D,MAAM,0BAA0B,GAC9B,eAAe,CAAC,QAAQ,CAAC,iBAAiB,GAAG,kBAAkB,CAAC,GAAG,CAAC;oBAEtE,IAAI,0BAA0B,EAAE;wBAC9B,sCAAsC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;wBAC7D,SAAS;qBACV;iBACF;gBAED,YAAY,EAAE,CAAC,IAAI,CACjB,0CAA0C,EAC1C,eAAe,CAAC,EAAE,EAClB;oBACE,IAAI,EAAE,kBAAkB,CAAC,CAAC;oBAC1B,iBAAiB,EAAE,kBAAkB,CAAC,GAAG;iBAC1C,CACF,CAAC;gBAEF,MAAM,0CAA0C,GAC9C,eAAe,CAAC,QAAQ,CAAC,IAAI,KAAK,kBAAkB,CAAC,CAAC,CAAC;gBAEzD,IAAI,CAAC,0CAA0C,EAAE;oBAC/C,oBAAoB,EAAE,EAAE,CAAC;iBAC1B;gBAED,SAAS;aACV;iBAAM,IAAI,eAAe,CAAC,QAAQ,CAAC,iBAAiB,KAAK,SAAS,EAAE;gBACnE,sCAAsC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;gBAC7D,SAAS;aACV;SACF;QAED,sDAAsD;QACtD,IAAI,sCAAsC,CAAC,MAAM,EAAE;YACjD,MAAM,gCAAgC,EAAE,CAAC,sBAAsB,CAC7D,2CAA0B,CAAC,QAAQ,EACnC,sCAAsC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;gBACtD,OAAO,CAAC,OAAO;gBACf,IAAI,CAAC,SAAS,CAAC,IAAA,8CAAsC,EAAC,OAAO,CAAC,CAAC;aAChE,CAAC,CACH,CAAC;SACH;QAED,sGAAsG;QACtG,8CAA8C;QAC9C,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;QAEF,IAAI,8BAA8B,CAAC,MAAM,EAAE;YACzC,MAAM,gCAAgC,EAAE,CAAC,yBAAyB,CAChE,2CAA0B,CAAC,QAAQ,EACnC,8BAA8B,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAC3D,CAAC;YACF,+BAA+B,EAAE,CAC/B,yHAAyH,CAC1H,CAAC;SACH;QAED,qFAAqF;QACrF,mFAAmF;QACnF,MAAM,gCAAgC,EAAE,CAAC,qCAAqC,CAC5E,IAAI,CACL,CAAC;KACH;IAAC,OAAO,CAAC,EAAE;QACV,uBAAuB;QACvB,MAAM,YAAY,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QACxE,MAAM,IAAI,KAAK,CACb,uEAAuE,YAAY,EAAE,CACtF,CAAC;KACH;YAAS;QACR,MAAM,gCAAgC,EAAE,CAAC,6BAA6B,CACpE,KAAK,CACN,CAAC;KACH;AACH,CAAC;AAlND,kFAkNC","sourcesContent":["import { isEvmAccountType } from '@metamask/keyring-api';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\n\nimport { USER_STORAGE_FEATURE_NAMES } from '../../../shared/storage-schema';\nimport {\n  canPerformAccountSyncing,\n  getInternalAccountsList,\n  getUserStorageAccountsList,\n} from './sync-utils';\nimport type { AccountSyncingConfig, AccountSyncingOptions } from './types';\nimport {\n  doesInternalAccountHaveCorrectKeyringType,\n  isNameDefaultAccountName,\n  mapInternalAccountToUserStorageAccount,\n} from './utils';\n\n/**\n * Saves an individual internal account to the user storage.\n * @param internalAccount - The internal account to save\n * @param config - parameters used for saving the internal account\n * @param options - parameters used for saving the internal account\n */\nexport async function saveInternalAccountToUserStorage(\n  internalAccount: InternalAccount,\n  config: AccountSyncingConfig,\n  options: AccountSyncingOptions,\n): Promise<void> {\n  const { isAccountSyncingEnabled } = config;\n  const { getUserStorageControllerInstance } = options;\n\n  if (\n    !isAccountSyncingEnabled ||\n    !canPerformAccountSyncing(config, options) ||\n    !isEvmAccountType(internalAccount.type) ||\n    !doesInternalAccountHaveCorrectKeyringType(internalAccount)\n  ) {\n    return;\n  }\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      // ESLint is confused here.\n      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions\n      `${USER_STORAGE_FEATURE_NAMES.accounts}.${internalAccount.address}`,\n      JSON.stringify(mappedAccount),\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/**\n * Saves the list of internal accounts to the user storage.\n * @param config - parameters used for saving the list of internal accounts\n * @param options - parameters used for saving the list of internal accounts\n */\nexport async function saveInternalAccountsListToUserStorage(\n  config: AccountSyncingConfig,\n  options: AccountSyncingOptions,\n): Promise<void> {\n  const { isAccountSyncingEnabled } = config;\n  const { getUserStorageControllerInstance } = options;\n\n  if (!isAccountSyncingEnabled) {\n    return;\n  }\n\n  const internalAccountsList = await getInternalAccountsList(options);\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  );\n}\n\ntype SyncInternalAccountsWithUserStorageConfig = AccountSyncingConfig & {\n  maxNumberOfAccountsToAdd?: number;\n  onAccountAdded?: () => void;\n  onAccountNameUpdated?: () => void;\n  onAccountSyncErroneousSituation?: (errorMessage: string) => 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 * @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 */\nexport async function syncInternalAccountsWithUserStorage(\n  config: SyncInternalAccountsWithUserStorageConfig,\n  options: AccountSyncingOptions,\n): Promise<void> {\n  const { isAccountSyncingEnabled } = config;\n\n  if (!canPerformAccountSyncing(config, options) || !isAccountSyncingEnabled) {\n    return;\n  }\n\n  const {\n    maxNumberOfAccountsToAdd = 100,\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(options);\n\n    if (!userStorageAccountsList || !userStorageAccountsList.length) {\n      await saveInternalAccountsListToUserStorage(\n        { isAccountSyncingEnabled },\n        options,\n      );\n      await getUserStorageControllerInstance().setHasAccountSyncingSyncedAtLeastOnce(\n        true,\n      );\n      return;\n    }\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(options);\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      for (let i = 0; i < numberOfAccountsToAdd; i++) {\n        await getMessenger().call('KeyringController:addNewAccount');\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    );\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          onAccountSyncErroneousSituation?.(\n            'An account was added to the internal accounts list but was not present in the user storage accounts list',\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 > 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      await getUserStorageControllerInstance().performBatchSetStorage(\n        USER_STORAGE_FEATURE_NAMES.accounts,\n        internalAccountsToBeSavedToUserStorage.map((account) => [\n          account.address,\n          JSON.stringify(mapInternalAccountToUserStorageAccount(account)),\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      await getUserStorageControllerInstance().performBatchDeleteStorage(\n        USER_STORAGE_FEATURE_NAMES.accounts,\n        userStorageAccountsToBeDeleted.map((account) => account.a),\n      );\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    }\n\n    // We do this here and not in the finally statement because we want to make sure that\n    // the accounts are saved / updated / deleted at least once before we set this flag\n    await getUserStorageControllerInstance().setHasAccountSyncingSyncedAtLeastOnce(\n      true,\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"]}

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

@@ -0,0 +1,31 @@
+import type { InternalAccount } from "@metamask/keyring-internal-api";
+import type { AccountSyncingConfig, AccountSyncingOptions } from "./types.cjs";
+/**
+ * Saves an individual internal account to the user storage.
+ * @param internalAccount - The internal account to save
+ * @param config - parameters used for saving the internal account
+ * @param options - parameters used for saving the internal account
+ */
+export declare function saveInternalAccountToUserStorage(internalAccount: InternalAccount, config: AccountSyncingConfig, options: AccountSyncingOptions): Promise<void>;
+/**
+ * Saves the list of internal accounts to the user storage.
+ * @param config - parameters used for saving the list of internal accounts
+ * @param options - parameters used for saving the list of internal accounts
+ */
+export declare function saveInternalAccountsListToUserStorage(config: AccountSyncingConfig, options: AccountSyncingOptions): Promise<void>;
+type SyncInternalAccountsWithUserStorageConfig = AccountSyncingConfig & {
+    maxNumberOfAccountsToAdd?: number;
+    onAccountAdded?: () => void;
+    onAccountNameUpdated?: () => void;
+    onAccountSyncErroneousSituation?: (errorMessage: string) => 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
+ */
+export declare function syncInternalAccountsWithUserStorage(config: SyncInternalAccountsWithUserStorageConfig, options: AccountSyncingOptions): 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;AAQtE,OAAO,KAAK,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,oBAAgB;AAO3E;;;;;GAKG;AACH,wBAAsB,gCAAgC,CACpD,eAAe,EAAE,eAAe,EAChC,MAAM,EAAE,oBAAoB,EAC5B,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,IAAI,CAAC,CA+Bf;AAED;;;;GAIG;AACH,wBAAsB,qCAAqC,CACzD,MAAM,EAAE,oBAAoB,EAC5B,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,IAAI,CAAC,CAyBf;AAED,KAAK,yCAAyC,GAAG,oBAAoB,GAAG;IACtE,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,cAAc,CAAC,EAAE,MAAM,IAAI,CAAC;IAC5B,oBAAoB,CAAC,EAAE,MAAM,IAAI,CAAC;IAClC,+BAA+B,CAAC,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,CAAC;CAClE,CAAC;AAEF;;;;;;GAMG;AACH,wBAAsB,mCAAmC,CACvD,MAAM,EAAE,yCAAyC,EACjD,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,IAAI,CAAC,CA+Mf"}

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

@@ -0,0 +1,31 @@
+import type { InternalAccount } from "@metamask/keyring-internal-api";
+import type { AccountSyncingConfig, AccountSyncingOptions } from "./types.mjs";
+/**
+ * Saves an individual internal account to the user storage.
+ * @param internalAccount - The internal account to save
+ * @param config - parameters used for saving the internal account
+ * @param options - parameters used for saving the internal account
+ */
+export declare function saveInternalAccountToUserStorage(internalAccount: InternalAccount, config: AccountSyncingConfig, options: AccountSyncingOptions): Promise<void>;
+/**
+ * Saves the list of internal accounts to the user storage.
+ * @param config - parameters used for saving the list of internal accounts
+ * @param options - parameters used for saving the list of internal accounts
+ */
+export declare function saveInternalAccountsListToUserStorage(config: AccountSyncingConfig, options: AccountSyncingOptions): Promise<void>;
+type SyncInternalAccountsWithUserStorageConfig = AccountSyncingConfig & {
+    maxNumberOfAccountsToAdd?: number;
+    onAccountAdded?: () => void;
+    onAccountNameUpdated?: () => void;
+    onAccountSyncErroneousSituation?: (errorMessage: string) => 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
+ */
+export declare function syncInternalAccountsWithUserStorage(config: SyncInternalAccountsWithUserStorageConfig, options: AccountSyncingOptions): 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;AAQtE,OAAO,KAAK,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,oBAAgB;AAO3E;;;;;GAKG;AACH,wBAAsB,gCAAgC,CACpD,eAAe,EAAE,eAAe,EAChC,MAAM,EAAE,oBAAoB,EAC5B,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,IAAI,CAAC,CA+Bf;AAED;;;;GAIG;AACH,wBAAsB,qCAAqC,CACzD,MAAM,EAAE,oBAAoB,EAC5B,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,IAAI,CAAC,CAyBf;AAED,KAAK,yCAAyC,GAAG,oBAAoB,GAAG;IACtE,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,cAAc,CAAC,EAAE,MAAM,IAAI,CAAC;IAC5B,oBAAoB,CAAC,EAAE,MAAM,IAAI,CAAC;IAClC,+BAA+B,CAAC,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,CAAC;CAClE,CAAC;AAEF;;;;;;GAMG;AACH,wBAAsB,mCAAmC,CACvD,MAAM,EAAE,yCAAyC,EACjD,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,IAAI,CAAC,CA+Mf"}

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

@@ -0,0 +1,188 @@
+import { isEvmAccountType } from "@metamask/keyring-api";
+import { USER_STORAGE_FEATURE_NAMES } from "../../../shared/storage-schema.mjs";
+import { canPerformAccountSyncing, getInternalAccountsList, getUserStorageAccountsList } from "./sync-utils.mjs";
+import { doesInternalAccountHaveCorrectKeyringType, isNameDefaultAccountName, mapInternalAccountToUserStorageAccount } from "./utils.mjs";
+/**
+ * Saves an individual internal account to the user storage.
+ * @param internalAccount - The internal account to save
+ * @param config - parameters used for saving the internal account
+ * @param options - parameters used for saving the internal account
+ */
+export async function saveInternalAccountToUserStorage(internalAccount, config, options) {
+    const { isAccountSyncingEnabled } = config;
+    const { getUserStorageControllerInstance } = options;
+    if (!isAccountSyncingEnabled ||
+        !canPerformAccountSyncing(config, options) ||
+        !isEvmAccountType(internalAccount.type) ||
+        !doesInternalAccountHaveCorrectKeyringType(internalAccount)) {
+        return;
+    }
+    try {
+        // Map the internal account to the user storage account schema
+        const mappedAccount = mapInternalAccountToUserStorageAccount(internalAccount);
+        await getUserStorageControllerInstance().performSetStorage(
+        // ESLint is confused here.
+        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+        `${USER_STORAGE_FEATURE_NAMES.accounts}.${internalAccount.address}`, JSON.stringify(mappedAccount));
+    }
+    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}`);
+    }
+}
+/**
+ * Saves the list of internal accounts to the user storage.
+ * @param config - parameters used for saving the list of internal accounts
+ * @param options - parameters used for saving the list of internal accounts
+ */
+export async function saveInternalAccountsListToUserStorage(config, options) {
+    const { isAccountSyncingEnabled } = config;
+    const { getUserStorageControllerInstance } = options;
+    if (!isAccountSyncingEnabled) {
+        return;
+    }
+    const internalAccountsList = await getInternalAccountsList(options);
+    if (!internalAccountsList?.length) {
+        return;
+    }
+    const internalAccountsListFormattedForUserStorage = internalAccountsList.map(mapInternalAccountToUserStorageAccount);
+    await getUserStorageControllerInstance().performBatchSetStorage(USER_STORAGE_FEATURE_NAMES.accounts, internalAccountsListFormattedForUserStorage.map((account) => [
+        account.a,
+        JSON.stringify(account),
+    ]));
+}
+/**
+ * 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
+ */
+export async function syncInternalAccountsWithUserStorage(config, options) {
+    const { isAccountSyncingEnabled } = config;
+    if (!canPerformAccountSyncing(config, options) || !isAccountSyncingEnabled) {
+        return;
+    }
+    const { maxNumberOfAccountsToAdd = 100, onAccountAdded, onAccountNameUpdated, onAccountSyncErroneousSituation, } = config;
+    const { getMessenger, getUserStorageControllerInstance } = options;
+    try {
+        await getUserStorageControllerInstance().setIsAccountSyncingInProgress(true);
+        const userStorageAccountsList = await getUserStorageAccountsList(options);
+        if (!userStorageAccountsList || !userStorageAccountsList.length) {
+            await saveInternalAccountsListToUserStorage({ isAccountSyncingEnabled }, options);
+            await getUserStorageControllerInstance().setHasAccountSyncingSyncedAtLeastOnce(true);
+            return;
+        }
+        // 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 getInternalAccountsList(options);
+        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
+            for (let i = 0; i < numberOfAccountsToAdd; i++) {
+                await getMessenger().call('KeyringController:addNewAccount');
+                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 getInternalAccountsList(options);
+        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)) {
+                    onAccountSyncErroneousSituation?.('An account was added to the internal accounts list but was not present in the user storage accounts list');
+                    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 = isNameDefaultAccountName(internalAccount.metadata.name);
+            const isUserStorageAccountNameDefault = 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) {
+            await getUserStorageControllerInstance().performBatchSetStorage(USER_STORAGE_FEATURE_NAMES.accounts, internalAccountsToBeSavedToUserStorage.map((account) => [
+                account.address,
+                JSON.stringify(mapInternalAccountToUserStorageAccount(account)),
+            ]));
+        }
+        // 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) {
+            await getUserStorageControllerInstance().performBatchDeleteStorage(USER_STORAGE_FEATURE_NAMES.accounts, userStorageAccountsToBeDeleted.map((account) => account.a));
+            onAccountSyncErroneousSituation?.('An account was present in the user storage accounts list but was not found in the internal accounts list after the sync');
+        }
+        // We do this here and not in the finally statement because we want to make sure that
+        // the accounts are saved / updated / deleted at least once before we set this flag
+        await getUserStorageControllerInstance().setHasAccountSyncingSyncedAtLeastOnce(true);
+    }
+    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);
+    }
+}
+//# sourceMappingURL=controller-integration.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"controller-integration.mjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/controller-integration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,8BAA8B;AAGzD,OAAO,EAAE,0BAA0B,EAAE,2CAAuC;AAC5E,OAAO,EACL,wBAAwB,EACxB,uBAAuB,EACvB,0BAA0B,EAC3B,yBAAqB;AAEtB,OAAO,EACL,yCAAyC,EACzC,wBAAwB,EACxB,sCAAsC,EACvC,oBAAgB;AAEjB;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,gCAAgC,CACpD,eAAgC,EAChC,MAA4B,EAC5B,OAA8B;IAE9B,MAAM,EAAE,uBAAuB,EAAE,GAAG,MAAM,CAAC;IAC3C,MAAM,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC;IAErD,IACE,CAAC,uBAAuB;QACxB,CAAC,wBAAwB,CAAC,MAAM,EAAE,OAAO,CAAC;QAC1C,CAAC,gBAAgB,CAAC,eAAe,CAAC,IAAI,CAAC;QACvC,CAAC,yCAAyC,CAAC,eAAe,CAAC,EAC3D;QACA,OAAO;KACR;IAED,IAAI;QACF,8DAA8D;QAC9D,MAAM,aAAa,GACjB,sCAAsC,CAAC,eAAe,CAAC,CAAC;QAE1D,MAAM,gCAAgC,EAAE,CAAC,iBAAiB;QACxD,2BAA2B;QAC3B,4EAA4E;QAC5E,GAAG,0BAA0B,CAAC,QAAQ,IAAI,eAAe,CAAC,OAAO,EAAE,EACnE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAC9B,CAAC;KACH;IAAC,OAAO,CAAC,EAAE;QACV,uBAAuB;QACvB,MAAM,YAAY,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QACxE,MAAM,IAAI,KAAK,CACb,oEAAoE,YAAY,EAAE,CACnF,CAAC;KACH;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,qCAAqC,CACzD,MAA4B,EAC5B,OAA8B;IAE9B,MAAM,EAAE,uBAAuB,EAAE,GAAG,MAAM,CAAC;IAC3C,MAAM,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC;IAErD,IAAI,CAAC,uBAAuB,EAAE;QAC5B,OAAO;KACR;IAED,MAAM,oBAAoB,GAAG,MAAM,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAEpE,IAAI,CAAC,oBAAoB,EAAE,MAAM,EAAE;QACjC,OAAO;KACR;IAED,MAAM,2CAA2C,GAAG,oBAAoB,CAAC,GAAG,CAC1E,sCAAsC,CACvC,CAAC;IAEF,MAAM,gCAAgC,EAAE,CAAC,sBAAsB,CAC7D,0BAA0B,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,CACH,CAAC;AACJ,CAAC;AASD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,mCAAmC,CACvD,MAAiD,EACjD,OAA8B;IAE9B,MAAM,EAAE,uBAAuB,EAAE,GAAG,MAAM,CAAC;IAE3C,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE;QAC1E,OAAO;KACR;IAED,MAAM,EACJ,wBAAwB,GAAG,GAAG,EAC9B,cAAc,EACd,oBAAoB,EACpB,+BAA+B,GAChC,GAAG,MAAM,CAAC;IACX,MAAM,EAAE,YAAY,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC;IAEnE,IAAI;QACF,MAAM,gCAAgC,EAAE,CAAC,6BAA6B,CACpE,IAAI,CACL,CAAC;QAEF,MAAM,uBAAuB,GAAG,MAAM,0BAA0B,CAAC,OAAO,CAAC,CAAC;QAE1E,IAAI,CAAC,uBAAuB,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE;YAC/D,MAAM,qCAAqC,CACzC,EAAE,uBAAuB,EAAE,EAC3B,OAAO,CACR,CAAC;YACF,MAAM,gCAAgC,EAAE,CAAC,qCAAqC,CAC5E,IAAI,CACL,CAAC;YACF,OAAO;SACR;QAED,wEAAwE;QACxE,MAAM,sCAAsC,GAAsB,EAAE,CAAC;QAErE,iEAAiE;QACjE,8BAA8B;QAC9B,MAAM,oBAAoB,GAAG,MAAM,uBAAuB,CAAC,OAAO,CAAC,CAAC;QAEpE,IAAI,CAAC,oBAAoB,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE;YACzD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;SACzD;QAED,MAAM,8CAA8C,GAClD,uBAAuB,CAAC,MAAM,GAAG,oBAAoB,CAAC,MAAM,CAAC;QAE/D,uDAAuD;QACvD,mGAAmG;QACnG,IAAI,8CAA8C,EAAE;YAClD,MAAM,qBAAqB,GACzB,IAAI,CAAC,GAAG,CAAC,uBAAuB,CAAC,MAAM,EAAE,wBAAwB,CAAC;gBAClE,oBAAoB,CAAC,MAAM,CAAC;YAE9B,8DAA8D;YAC9D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,qBAAqB,EAAE,CAAC,EAAE,EAAE;gBAC9C,MAAM,YAAY,EAAE,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;gBAC7D,cAAc,EAAE,EAAE,CAAC;aACpB;SACF;QAED,qCAAqC;QACrC,qGAAqG;QACrG,MAAM,6BAA6B,GAAG,MAAM,uBAAuB,CACjE,OAAO,CACR,CAAC;QAEF,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;QAEF,KAAK,MAAM,eAAe,IAAI,6BAA6B,EAAE;YAC3D,MAAM,kBAAkB,GAAG,uBAAuB,CAAC,IAAI,CACrD,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,KAAK,eAAe,CAAC,OAAO,CACnD,CAAC;YAEF,gDAAgD;YAChD,uBAAuB;YACvB,IAAI,CAAC,kBAAkB,EAAE;gBACvB,wGAAwG;gBACxG,IAAI,kBAAkB,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE;oBAChD,+BAA+B,EAAE,CAC/B,0GAA0G,CAC3G,CAAC;oBACF,SAAS;iBACV;gBACD,wHAAwH;gBACxH,sCAAsC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;gBAC7D,SAAS;aACV;YAED,6DAA6D;YAC7D,qEAAqE;YAErE,0CAA0C;YAC1C,MAAM,4BAA4B,GAAG,wBAAwB,CAC3D,eAAe,CAAC,QAAQ,CAAC,IAAI,CAC9B,CAAC;YACF,MAAM,+BAA+B,GAAG,wBAAwB,CAC9D,kBAAkB,CAAC,CAAC,CACrB,CAAC;YAEF,oCAAoC;YACpC,IAAI,4BAA4B,EAAE;gBAChC,IAAI,CAAC,+BAA+B,EAAE;oBACpC,YAAY,EAAE,CAAC,IAAI,CACjB,0CAA0C,EAC1C,eAAe,CAAC,EAAE,EAClB;wBACE,IAAI,EAAE,kBAAkB,CAAC,CAAC;qBAC3B,CACF,CAAC;oBAEF,oBAAoB,EAAE,EAAE,CAAC;iBAC1B;gBACD,SAAS;aACV;YAED,6EAA6E;YAC7E,IAAI,+BAA+B,EAAE;gBACnC,sCAAsC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;gBAC7D,SAAS;aACV;YAED,kCAAkC;YAElC,yDAAyD;YACzD,6EAA6E;YAC7E,IAAI,kBAAkB,CAAC,GAAG,KAAK,SAAS,EAAE;gBACxC,IAAI,eAAe,CAAC,QAAQ,CAAC,iBAAiB,KAAK,SAAS,EAAE;oBAC5D,MAAM,0BAA0B,GAC9B,eAAe,CAAC,QAAQ,CAAC,iBAAiB,GAAG,kBAAkB,CAAC,GAAG,CAAC;oBAEtE,IAAI,0BAA0B,EAAE;wBAC9B,sCAAsC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;wBAC7D,SAAS;qBACV;iBACF;gBAED,YAAY,EAAE,CAAC,IAAI,CACjB,0CAA0C,EAC1C,eAAe,CAAC,EAAE,EAClB;oBACE,IAAI,EAAE,kBAAkB,CAAC,CAAC;oBAC1B,iBAAiB,EAAE,kBAAkB,CAAC,GAAG;iBAC1C,CACF,CAAC;gBAEF,MAAM,0CAA0C,GAC9C,eAAe,CAAC,QAAQ,CAAC,IAAI,KAAK,kBAAkB,CAAC,CAAC,CAAC;gBAEzD,IAAI,CAAC,0CAA0C,EAAE;oBAC/C,oBAAoB,EAAE,EAAE,CAAC;iBAC1B;gBAED,SAAS;aACV;iBAAM,IAAI,eAAe,CAAC,QAAQ,CAAC,iBAAiB,KAAK,SAAS,EAAE;gBACnE,sCAAsC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;gBAC7D,SAAS;aACV;SACF;QAED,sDAAsD;QACtD,IAAI,sCAAsC,CAAC,MAAM,EAAE;YACjD,MAAM,gCAAgC,EAAE,CAAC,sBAAsB,CAC7D,0BAA0B,CAAC,QAAQ,EACnC,sCAAsC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;gBACtD,OAAO,CAAC,OAAO;gBACf,IAAI,CAAC,SAAS,CAAC,sCAAsC,CAAC,OAAO,CAAC,CAAC;aAChE,CAAC,CACH,CAAC;SACH;QAED,sGAAsG;QACtG,8CAA8C;QAC9C,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;QAEF,IAAI,8BAA8B,CAAC,MAAM,EAAE;YACzC,MAAM,gCAAgC,EAAE,CAAC,yBAAyB,CAChE,0BAA0B,CAAC,QAAQ,EACnC,8BAA8B,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAC3D,CAAC;YACF,+BAA+B,EAAE,CAC/B,yHAAyH,CAC1H,CAAC;SACH;QAED,qFAAqF;QACrF,mFAAmF;QACnF,MAAM,gCAAgC,EAAE,CAAC,qCAAqC,CAC5E,IAAI,CACL,CAAC;KACH;IAAC,OAAO,CAAC,EAAE;QACV,uBAAuB;QACvB,MAAM,YAAY,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QACxE,MAAM,IAAI,KAAK,CACb,uEAAuE,YAAY,EAAE,CACtF,CAAC;KACH;YAAS;QACR,MAAM,gCAAgC,EAAE,CAAC,6BAA6B,CACpE,KAAK,CACN,CAAC;KACH;AACH,CAAC","sourcesContent":["import { isEvmAccountType } from '@metamask/keyring-api';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\n\nimport { USER_STORAGE_FEATURE_NAMES } from '../../../shared/storage-schema';\nimport {\n  canPerformAccountSyncing,\n  getInternalAccountsList,\n  getUserStorageAccountsList,\n} from './sync-utils';\nimport type { AccountSyncingConfig, AccountSyncingOptions } from './types';\nimport {\n  doesInternalAccountHaveCorrectKeyringType,\n  isNameDefaultAccountName,\n  mapInternalAccountToUserStorageAccount,\n} from './utils';\n\n/**\n * Saves an individual internal account to the user storage.\n * @param internalAccount - The internal account to save\n * @param config - parameters used for saving the internal account\n * @param options - parameters used for saving the internal account\n */\nexport async function saveInternalAccountToUserStorage(\n  internalAccount: InternalAccount,\n  config: AccountSyncingConfig,\n  options: AccountSyncingOptions,\n): Promise<void> {\n  const { isAccountSyncingEnabled } = config;\n  const { getUserStorageControllerInstance } = options;\n\n  if (\n    !isAccountSyncingEnabled ||\n    !canPerformAccountSyncing(config, options) ||\n    !isEvmAccountType(internalAccount.type) ||\n    !doesInternalAccountHaveCorrectKeyringType(internalAccount)\n  ) {\n    return;\n  }\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      // ESLint is confused here.\n      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions\n      `${USER_STORAGE_FEATURE_NAMES.accounts}.${internalAccount.address}`,\n      JSON.stringify(mappedAccount),\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/**\n * Saves the list of internal accounts to the user storage.\n * @param config - parameters used for saving the list of internal accounts\n * @param options - parameters used for saving the list of internal accounts\n */\nexport async function saveInternalAccountsListToUserStorage(\n  config: AccountSyncingConfig,\n  options: AccountSyncingOptions,\n): Promise<void> {\n  const { isAccountSyncingEnabled } = config;\n  const { getUserStorageControllerInstance } = options;\n\n  if (!isAccountSyncingEnabled) {\n    return;\n  }\n\n  const internalAccountsList = await getInternalAccountsList(options);\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  );\n}\n\ntype SyncInternalAccountsWithUserStorageConfig = AccountSyncingConfig & {\n  maxNumberOfAccountsToAdd?: number;\n  onAccountAdded?: () => void;\n  onAccountNameUpdated?: () => void;\n  onAccountSyncErroneousSituation?: (errorMessage: string) => 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 * @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 */\nexport async function syncInternalAccountsWithUserStorage(\n  config: SyncInternalAccountsWithUserStorageConfig,\n  options: AccountSyncingOptions,\n): Promise<void> {\n  const { isAccountSyncingEnabled } = config;\n\n  if (!canPerformAccountSyncing(config, options) || !isAccountSyncingEnabled) {\n    return;\n  }\n\n  const {\n    maxNumberOfAccountsToAdd = 100,\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(options);\n\n    if (!userStorageAccountsList || !userStorageAccountsList.length) {\n      await saveInternalAccountsListToUserStorage(\n        { isAccountSyncingEnabled },\n        options,\n      );\n      await getUserStorageControllerInstance().setHasAccountSyncingSyncedAtLeastOnce(\n        true,\n      );\n      return;\n    }\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(options);\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      for (let i = 0; i < numberOfAccountsToAdd; i++) {\n        await getMessenger().call('KeyringController:addNewAccount');\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    );\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          onAccountSyncErroneousSituation?.(\n            'An account was added to the internal accounts list but was not present in the user storage accounts list',\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 > 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      await getUserStorageControllerInstance().performBatchSetStorage(\n        USER_STORAGE_FEATURE_NAMES.accounts,\n        internalAccountsToBeSavedToUserStorage.map((account) => [\n          account.address,\n          JSON.stringify(mapInternalAccountToUserStorageAccount(account)),\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      await getUserStorageControllerInstance().performBatchDeleteStorage(\n        USER_STORAGE_FEATURE_NAMES.accounts,\n        userStorageAccountsToBeDeleted.map((account) => account.a),\n      );\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    }\n\n    // We do this here and not in the finally statement because we want to make sure that\n    // the accounts are saved / updated / deleted at least once before we set this flag\n    await getUserStorageControllerInstance().setHasAccountSyncingSyncedAtLeastOnce(\n      true,\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"]}

package/dist/controllers/user-storage/account-syncing/setup-subscriptions.cjs

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupAccountSyncingSubscriptions = void 0;
+const controller_integration_1 = require("./controller-integration.cjs");
+const sync_utils_1 = require("./sync-utils.cjs");
+/**
+ * Initialize and setup events to listen to for account syncing
+ * @param config - configuration parameters
+ * @param options - parameters used for initializing and enabling account syncing
+ */
+function setupAccountSyncingSubscriptions(config, options) {
+    const { getMessenger, getUserStorageControllerInstance } = options;
+    getMessenger().subscribe('AccountsController:accountAdded', 
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
+    async (account) => {
+        if (!(0, sync_utils_1.canPerformAccountSyncing)(config, options) ||
+            !getUserStorageControllerInstance().state
+                .hasAccountSyncingSyncedAtLeastOnce) {
+            return;
+        }
+        await (0, controller_integration_1.saveInternalAccountToUserStorage)(account, config, options);
+    });
+    getMessenger().subscribe('AccountsController:accountRenamed', 
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
+    async (account) => {
+        if (!(0, sync_utils_1.canPerformAccountSyncing)(config, options) ||
+            !getUserStorageControllerInstance().state
+                .hasAccountSyncingSyncedAtLeastOnce) {
+            return;
+        }
+        await (0, controller_integration_1.saveInternalAccountToUserStorage)(account, config, options);
+    });
+}
+exports.setupAccountSyncingSubscriptions = setupAccountSyncingSubscriptions;
+//# sourceMappingURL=setup-subscriptions.cjs.map

package/dist/controllers/user-storage/account-syncing/setup-subscriptions.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup-subscriptions.cjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/setup-subscriptions.ts"],"names":[],"mappings":";;;AAAA,yEAA4E;AAC5E,iDAAwD;AAGxD;;;;GAIG;AACH,SAAgB,gCAAgC,CAC9C,MAA4B,EAC5B,OAA8B;IAE9B,MAAM,EAAE,YAAY,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC;IAEnE,YAAY,EAAE,CAAC,SAAS,CACtB,iCAAiC;IACjC,kEAAkE;IAClE,KAAK,EAAE,OAAO,EAAE,EAAE;QAChB,IACE,CAAC,IAAA,qCAAwB,EAAC,MAAM,EAAE,OAAO,CAAC;YAC1C,CAAC,gCAAgC,EAAE,CAAC,KAAK;iBACtC,kCAAkC,EACrC;YACA,OAAO;SACR;QAED,MAAM,IAAA,yDAAgC,EAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC,CACF,CAAC;IAEF,YAAY,EAAE,CAAC,SAAS,CACtB,mCAAmC;IACnC,kEAAkE;IAClE,KAAK,EAAE,OAAO,EAAE,EAAE;QAChB,IACE,CAAC,IAAA,qCAAwB,EAAC,MAAM,EAAE,OAAO,CAAC;YAC1C,CAAC,gCAAgC,EAAE,CAAC,KAAK;iBACtC,kCAAkC,EACrC;YACA,OAAO;SACR;QAED,MAAM,IAAA,yDAAgC,EAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC,CACF,CAAC;AACJ,CAAC;AArCD,4EAqCC","sourcesContent":["import { saveInternalAccountToUserStorage } from './controller-integration';\nimport { canPerformAccountSyncing } from './sync-utils';\nimport type { AccountSyncingConfig, AccountSyncingOptions } from './types';\n\n/**\n * Initialize and setup events to listen to for account syncing\n * @param config - configuration parameters\n * @param options - parameters used for initializing and enabling account syncing\n */\nexport function setupAccountSyncingSubscriptions(\n  config: AccountSyncingConfig,\n  options: AccountSyncingOptions,\n) {\n  const { getMessenger, getUserStorageControllerInstance } = options;\n\n  getMessenger().subscribe(\n    'AccountsController:accountAdded',\n    // eslint-disable-next-line @typescript-eslint/no-misused-promises\n    async (account) => {\n      if (\n        !canPerformAccountSyncing(config, options) ||\n        !getUserStorageControllerInstance().state\n          .hasAccountSyncingSyncedAtLeastOnce\n      ) {\n        return;\n      }\n\n      await saveInternalAccountToUserStorage(account, config, options);\n    },\n  );\n\n  getMessenger().subscribe(\n    'AccountsController:accountRenamed',\n    // eslint-disable-next-line @typescript-eslint/no-misused-promises\n    async (account) => {\n      if (\n        !canPerformAccountSyncing(config, options) ||\n        !getUserStorageControllerInstance().state\n          .hasAccountSyncingSyncedAtLeastOnce\n      ) {\n        return;\n      }\n\n      await saveInternalAccountToUserStorage(account, config, options);\n    },\n  );\n}\n"]}