@metamask-previews/profile-sync-controller 19.0.0-preview-29bd474 → 19.0.0-preview-6fc9506d

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

@@ -1 +1 @@
-{"version":3,"file":"controller-integration.mjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/controller-integration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,qCAAqC;AAG5D,OAAO,EACL,wBAAwB,EACxB,uBAAuB,EACvB,0BAA0B,EAC3B,yBAAqB;AAEtB,OAAO,EACL,wBAAwB,EACxB,sCAAsC,EACvC,oBAAgB;AACjB,OAAO,EAAE,0BAA0B,EAAE,2CAAuC;AAE5E;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,gCAAgC,CACpD,eAAgC,EAChC,OAA8B;IAE9B,MAAM,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC;IAErD,IACE,CAAC,wBAAwB,CAAC,OAAO,CAAC;QAClC,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAK,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,8DAA8D;MAChI;QACA,OAAO;KACR;IAED,+IAA+I;IAC/I,0DAA0D;IAC1D,MAAM,eAAe,GAAG,eAAe,CAAC,OAAO,CAAC,aAEnC,CAAC;IAEd,IAAI;QACF,8DAA8D;QAC9D,MAAM,aAAa,GACjB,sCAAsC,CAAC,eAAe,CAAC,CAAC;QAE1D,MAAM,gCAAgC,EAAE,CAAC,iBAAiB,CACxD,GAAG,0BAA0B,CAAC,QAAQ,IAAI,eAAe,CAAC,OAAO,EAAE,EACnE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,EAC7B,eAAe,CAChB,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;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,qCAAqC,CACzD,OAA8B,EAC9B,eAAuB;IAEvB,MAAM,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC;IAErD,MAAM,oBAAoB,GAAG,MAAM,uBAAuB,CACxD,OAAO,EACP,eAAe,CAChB,CAAC;IAEF,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,EACF,eAAe,CAChB,CAAC;AACJ,CAAC;AAYD;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,mCAAmC,CACvD,MAAiD,EACjD,OAA8B,EAC9B,eAAuB;IAEvB,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,EAAE;QACtC,OAAO;KACR;IAED,MAAM,EACJ,wBAAwB,GAAG,QAAQ,EACnC,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,CAC9D,OAAO,EACP,eAAe,CAChB,CAAC;QAEF,IAAI,CAAC,uBAAuB,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE;YAC/D,MAAM,qCAAqC,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;YACtE,OAAO;SACR;QACD,kEAAkE;QAClE,sFAAsF;QACtF,IAAI,wBAAwB,GAAG,KAAK,CAAC;QAErC,wEAAwE;QACxE,MAAM,sCAAsC,GAAsB,EAAE,CAAC;QAErE,iEAAiE;QACjE,8BAA8B;QAC9B,MAAM,oBAAoB,GAAG,MAAM,uBAAuB,CACxD,OAAO,EACP,eAAe,CAChB,CAAC;QAEF,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,MAAM,YAAY,EAAE,CAAC,IAAI,CACvB,+BAA+B,EAC/B;gBACE,EAAE,EAAE,eAAe;aACpB,EACD,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;gBACpB,MAAM,OAAO,CAAC,WAAW,CAAC,qBAAqB,CAAC,CAAC;YACnD,CAAC,CACF,CAAC;YAEF,2EAA2E;YAC3E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,qBAAqB,EAAE,CAAC,EAAE,EAAE;gBAC9C,cAAc,EAAE,EAAE,CAAC;aACpB;SACF;QAED,qCAAqC;QACrC,qGAAqG;QACrG,MAAM,6BAA6B,GAAG,MAAM,uBAAuB,CACjE,OAAO,EACP,eAAe,CAChB,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,wBAAwB,GAAG,IAAI,CAAC;oBAChC,+BAA+B,EAAE,CAC/B,0GAA0G,EAC1G;wBACE,eAAe;wBACf,kBAAkB;wBAClB,kBAAkB;wBAClB,uBAAuB;wBACvB,oBAAoB;wBACpB,6BAA6B;wBAC7B,sCAAsC;qBACvC,CACF,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,EACF,eAAe,CAChB,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,EAC1D,eAAe,CAChB,CAAC;YACF,wBAAwB,GAAG,IAAI,CAAC;YAChC,+BAA+B,EAAE,CAC/B,yHAAyH,EACzH;gBACE,8BAA8B;gBAC9B,oBAAoB;gBACpB,6BAA6B;gBAC7B,sCAAsC;gBACtC,uBAAuB;aACxB,CACF,CAAC;SACH;QAED,IAAI,wBAAwB,EAAE;YAC5B,MAAM,CAAC,4BAA4B,EAAE,yBAAyB,CAAC,GAC7D,MAAM,OAAO,CAAC,GAAG,CAAC;gBAChB,0BAA0B,CAAC,OAAO,EAAE,eAAe,CAAC;gBACpD,uBAAuB,CAAC,OAAO,EAAE,eAAe,CAAC;aAClD,CAAC,CAAC;YAEL,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;YAEJ,uBAAuB;YACvB,MAAM,oEAAoE,GACxE,CAAC,4BAA4B,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,wBAAwB;gBACpE,CAAC,CAAC,IAAI;gBACN,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;YAER,MAAM,iBAAiB,GACrB,oEAAoE;gBACpE,oEAAoE,CAAC;YAEvE,MAAM,OAAO,GAAG;gBACd,4BAA4B;gBAC5B,yBAAyB;aAC1B,CAAC;YACF,IAAI,iBAAiB,EAAE;gBACrB,+BAA+B,EAAE,CAC/B,6FAA6F,EAC7F,OAAO,CACR,CAAC;aACH;iBAAM;gBACL,+BAA+B,EAAE,CAC/B,oGAAoG,EACpG,OAAO,CACR,CAAC;aACH;SACF;KACF;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 { 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';\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 */\nexport async function saveInternalAccountToUserStorage(\n  internalAccount: InternalAccount,\n  options: AccountSyncingOptions,\n): Promise<void> {\n  const { getUserStorageControllerInstance } = options;\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/**\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 */\nexport async function saveInternalAccountsListToUserStorage(\n  options: AccountSyncingOptions,\n  entropySourceId: string,\n): Promise<void> {\n  const { getUserStorageControllerInstance } = options;\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 */\nexport async function syncInternalAccountsWithUserStorage(\n  config: SyncInternalAccountsWithUserStorageConfig,\n  options: AccountSyncingOptions,\n  entropySourceId: string,\n): Promise<void> {\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 > 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        entropySourceId,\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        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    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"]}
+{"version":3,"file":"controller-integration.mjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/controller-integration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,qCAAqC;AAG5D,OAAO,EACL,wBAAwB,EACxB,uBAAuB,EACvB,0BAA0B,EAC3B,yBAAqB;AAEtB,OAAO,EACL,wBAAwB,EACxB,sCAAsC,EACvC,oBAAgB;AACjB,OAAO,EAAE,0BAA0B,EAAE,2CAAuC;AAE5E;;;;;;GAMG;AACH,MAAM,CAAC,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,CAAC,wBAAwB,CAAC,OAAO,CAAC;YAClC,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAK,MAAM,CAAC,YAAY,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,sCAAsC,CAAC,eAAe,CAAC,CAAC;YAE1D,MAAM,gCAAgC,EAAE,CAAC,iBAAiB,CACxD,GAAG,0BAA0B,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,OAAO,KAAK;QACV,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,IAAI,EAAE,8BAA8B,EAAE,EAAE,WAAW,CAAC;QACpE,CAAC,CAAC,MAAM,WAAW,EAAE,CAAC;AAC1B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,qCAAqC,CACzD,OAA8B,EAC9B,eAAuB;IAEvB,MAAM,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC;IAErD,MAAM,oBAAoB,GAAG,MAAM,uBAAuB,CACxD,OAAO,EACP,eAAe,CAChB,CAAC;IAEF,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,EACF,eAAe,CAChB,CAAC;AACJ,CAAC;AAYD;;;;;;;;;GASG;AACH,MAAM,CAAC,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,wBAAwB,CAAC,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,0BAA0B,CAC9D,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,uBAAuB,CACxD,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,uBAAuB,CACjE,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,wBAAwB,CAC3D,eAAe,CAAC,QAAQ,CAAC,IAAI,CAC9B,CAAC;gBACF,MAAM,+BAA+B,GAAG,wBAAwB,CAC9D,kBAAkB,CAAC,CAAC,CACrB,CAAC;gBAEF,oCAAoC;gBACpC,IAAI,4BAA4B,EAAE;oBAChC,IAAI,CAAC,+BAA+B,EAAE;wBACpC,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,MAAM,gCAAgC,EAAE,CAAC,sBAAsB,CAC7D,0BAA0B,CAAC,QAAQ,EACnC,sCAAsC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;oBACtD,OAAO,CAAC,OAAO;oBACf,IAAI,CAAC,SAAS,CAAC,sCAAsC,CAAC,OAAO,CAAC,CAAC;iBAChE,CAAC,EACF,eAAe,CAChB,CAAC;aACH;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,MAAM,gCAAgC,EAAE,CAAC,yBAAyB,CAChE,0BAA0B,CAAC,QAAQ,EACnC,8BAA8B,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,EAC1D,eAAe,CAChB,CAAC;gBACF,wBAAwB,GAAG,IAAI,CAAC;gBAChC,+BAA+B,EAAE,CAC/B,yHAAyH,EACzH;oBACE,8BAA8B;oBAC9B,oBAAoB;oBACpB,6BAA6B;oBAC7B,sCAAsC;oBACtC,uBAAuB;iBACxB,CACF,CAAC;aACH;YAED,IAAI,wBAAwB,EAAE;gBAC5B,MAAM,CAAC,4BAA4B,EAAE,yBAAyB,CAAC,GAC7D,MAAM,OAAO,CAAC,GAAG,CAAC;oBAChB,0BAA0B,CAAC,OAAO,EAAE,eAAe,CAAC;oBACpD,uBAAuB,CAAC,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,OAAO,KAAK;QACV,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,EAAE,kBAAkB,CAAC;QAChE,CAAC,CAAC,MAAM,kBAAkB,EAAE,CAAC;AACjC,CAAC","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';\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      !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  return trace\n    ? await trace({ name: 'Account Sync Save Individual' }, saveAccount)\n    : 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\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        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      // 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          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      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  return trace\n    ? await trace({ name: 'Account Sync Full' }, performAccountSync)\n    : await performAccountSync();\n}\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/types.ts"],"names":[],"mappings":"","sourcesContent":["import type {\n  USER_STORAGE_VERSION_KEY,\n  USER_STORAGE_VERSION,\n} from './constants';\nimport type { UserStorageControllerMessenger } from '../UserStorageController';\nimport type UserStorageController from '../UserStorageController';\n\nexport type UserStorageAccount = {\n  /**\n   * The Version 'v' of the User Storage.\n   * NOTE - will allow us to support upgrade/downgrades in the future\n   */\n  [USER_STORAGE_VERSION_KEY]: typeof USER_STORAGE_VERSION;\n  /** the id 'i' of the account */\n  i: string;\n  /** the address 'a' of the account */\n  a: string;\n  /** the name 'n' of the account */\n  n: string;\n  /** the nameLastUpdatedAt timestamp 'nlu' of the account */\n  nlu?: number;\n};\n\nexport type AccountSyncingOptions = {\n  getUserStorageControllerInstance: () => UserStorageController;\n  getMessenger: () => UserStorageControllerMessenger;\n};\n"]}
+{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { TraceCallback } from '@metamask/controller-utils';\n\nimport type {\n  USER_STORAGE_VERSION_KEY,\n  USER_STORAGE_VERSION,\n} from './constants';\nimport type { UserStorageControllerMessenger } from '../UserStorageController';\nimport type UserStorageController from '../UserStorageController';\n\nexport type UserStorageAccount = {\n  /**\n   * The Version 'v' of the User Storage.\n   * NOTE - will allow us to support upgrade/downgrades in the future\n   */\n  [USER_STORAGE_VERSION_KEY]: typeof USER_STORAGE_VERSION;\n  /** the id 'i' of the account */\n  i: string;\n  /** the address 'a' of the account */\n  a: string;\n  /** the name 'n' of the account */\n  n: string;\n  /** the nameLastUpdatedAt timestamp 'nlu' of the account */\n  nlu?: number;\n};\n\nexport type AccountSyncingOptions = {\n  getUserStorageControllerInstance: () => UserStorageController;\n  getMessenger: () => UserStorageControllerMessenger;\n  trace?: TraceCallback;\n};\n"]}

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

@@ -1,3 +1,4 @@
+import type { TraceCallback } from "@metamask/controller-utils";
 import type { USER_STORAGE_VERSION_KEY, USER_STORAGE_VERSION } from "./constants.cjs";
 import type { UserStorageControllerMessenger } from "../UserStorageController.cjs";
 import type UserStorageController from "../UserStorageController.cjs";
@@ -19,5 +20,6 @@ export type UserStorageAccount = {
 export type AccountSyncingOptions = {
     getUserStorageControllerInstance: () => UserStorageController;
     getMessenger: () => UserStorageControllerMessenger;
+    trace?: TraceCallback;
 };
 //# sourceMappingURL=types.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,oBAAoB,EACrB,wBAAoB;AACrB,OAAO,KAAK,EAAE,8BAA8B,EAAE,qCAAiC;AAC/E,OAAO,KAAK,qBAAqB,qCAAiC;AAElE,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;OAGG;IACH,CAAC,wBAAwB,CAAC,EAAE,OAAO,oBAAoB,CAAC;IACxD,gCAAgC;IAChC,CAAC,EAAE,MAAM,CAAC;IACV,qCAAqC;IACrC,CAAC,EAAE,MAAM,CAAC;IACV,kCAAkC;IAClC,CAAC,EAAE,MAAM,CAAC;IACV,2DAA2D;IAC3D,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,gCAAgC,EAAE,MAAM,qBAAqB,CAAC;IAC9D,YAAY,EAAE,MAAM,8BAA8B,CAAC;CACpD,CAAC"}
+{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,mCAAmC;AAEhE,OAAO,KAAK,EACV,wBAAwB,EACxB,oBAAoB,EACrB,wBAAoB;AACrB,OAAO,KAAK,EAAE,8BAA8B,EAAE,qCAAiC;AAC/E,OAAO,KAAK,qBAAqB,qCAAiC;AAElE,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;OAGG;IACH,CAAC,wBAAwB,CAAC,EAAE,OAAO,oBAAoB,CAAC;IACxD,gCAAgC;IAChC,CAAC,EAAE,MAAM,CAAC;IACV,qCAAqC;IACrC,CAAC,EAAE,MAAM,CAAC;IACV,kCAAkC;IAClC,CAAC,EAAE,MAAM,CAAC;IACV,2DAA2D;IAC3D,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,gCAAgC,EAAE,MAAM,qBAAqB,CAAC;IAC9D,YAAY,EAAE,MAAM,8BAA8B,CAAC;IACnD,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB,CAAC"}

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

@@ -1,3 +1,4 @@
+import type { TraceCallback } from "@metamask/controller-utils";
 import type { USER_STORAGE_VERSION_KEY, USER_STORAGE_VERSION } from "./constants.mjs";
 import type { UserStorageControllerMessenger } from "../UserStorageController.mjs";
 import type UserStorageController from "../UserStorageController.mjs";
@@ -19,5 +20,6 @@ export type UserStorageAccount = {
 export type AccountSyncingOptions = {
     getUserStorageControllerInstance: () => UserStorageController;
     getMessenger: () => UserStorageControllerMessenger;
+    trace?: TraceCallback;
 };
 //# sourceMappingURL=types.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,oBAAoB,EACrB,wBAAoB;AACrB,OAAO,KAAK,EAAE,8BAA8B,EAAE,qCAAiC;AAC/E,OAAO,KAAK,qBAAqB,qCAAiC;AAElE,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;OAGG;IACH,CAAC,wBAAwB,CAAC,EAAE,OAAO,oBAAoB,CAAC;IACxD,gCAAgC;IAChC,CAAC,EAAE,MAAM,CAAC;IACV,qCAAqC;IACrC,CAAC,EAAE,MAAM,CAAC;IACV,kCAAkC;IAClC,CAAC,EAAE,MAAM,CAAC;IACV,2DAA2D;IAC3D,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,gCAAgC,EAAE,MAAM,qBAAqB,CAAC;IAC9D,YAAY,EAAE,MAAM,8BAA8B,CAAC;CACpD,CAAC"}
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,mCAAmC;AAEhE,OAAO,KAAK,EACV,wBAAwB,EACxB,oBAAoB,EACrB,wBAAoB;AACrB,OAAO,KAAK,EAAE,8BAA8B,EAAE,qCAAiC;AAC/E,OAAO,KAAK,qBAAqB,qCAAiC;AAElE,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;OAGG;IACH,CAAC,wBAAwB,CAAC,EAAE,OAAO,oBAAoB,CAAC;IACxD,gCAAgC;IAChC,CAAC,EAAE,MAAM,CAAC;IACV,qCAAqC;IACrC,CAAC,EAAE,MAAM,CAAC;IACV,kCAAkC;IAClC,CAAC,EAAE,MAAM,CAAC;IACV,2DAA2D;IAC3D,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,gCAAgC,EAAE,MAAM,qBAAqB,CAAC;IAC9D,YAAY,EAAE,MAAM,8BAA8B,CAAC;IACnD,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/types.ts"],"names":[],"mappings":"","sourcesContent":["import type {\n  USER_STORAGE_VERSION_KEY,\n  USER_STORAGE_VERSION,\n} from './constants';\nimport type { UserStorageControllerMessenger } from '../UserStorageController';\nimport type UserStorageController from '../UserStorageController';\n\nexport type UserStorageAccount = {\n  /**\n   * The Version 'v' of the User Storage.\n   * NOTE - will allow us to support upgrade/downgrades in the future\n   */\n  [USER_STORAGE_VERSION_KEY]: typeof USER_STORAGE_VERSION;\n  /** the id 'i' of the account */\n  i: string;\n  /** the address 'a' of the account */\n  a: string;\n  /** the name 'n' of the account */\n  n: string;\n  /** the nameLastUpdatedAt timestamp 'nlu' of the account */\n  nlu?: number;\n};\n\nexport type AccountSyncingOptions = {\n  getUserStorageControllerInstance: () => UserStorageController;\n  getMessenger: () => UserStorageControllerMessenger;\n};\n"]}
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { TraceCallback } from '@metamask/controller-utils';\n\nimport type {\n  USER_STORAGE_VERSION_KEY,\n  USER_STORAGE_VERSION,\n} from './constants';\nimport type { UserStorageControllerMessenger } from '../UserStorageController';\nimport type UserStorageController from '../UserStorageController';\n\nexport type UserStorageAccount = {\n  /**\n   * The Version 'v' of the User Storage.\n   * NOTE - will allow us to support upgrade/downgrades in the future\n   */\n  [USER_STORAGE_VERSION_KEY]: typeof USER_STORAGE_VERSION;\n  /** the id 'i' of the account */\n  i: string;\n  /** the address 'a' of the account */\n  a: string;\n  /** the name 'n' of the account */\n  n: string;\n  /** the nameLastUpdatedAt timestamp 'nlu' of the account */\n  nlu?: number;\n};\n\nexport type AccountSyncingOptions = {\n  getUserStorageControllerInstance: () => UserStorageController;\n  getMessenger: () => UserStorageControllerMessenger;\n  trace?: TraceCallback;\n};\n"]}

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

@@ -35,138 +35,167 @@ function createContactKey(contact) {
  *
  * @param config - Parameters used for syncing callbacks
  * @param options - Parameters used for syncing operations
+ * @returns Promise that resolves when contact synchronization is complete
  */
 async function syncContactsWithUserStorage(config, options) {
-    const { getMessenger, getUserStorageControllerInstance } = options;
+    const { getMessenger, getUserStorageControllerInstance, trace } = options;
     const { onContactSyncErroneousSituation, onContactUpdated, onContactDeleted, } = config;
-    try {
-        // Cannot perform sync, conditions not met
-        if (!(0, sync_utils_1.canPerformContactSyncing)(options)) {
-            return;
-        }
-        // Activate sync semaphore to prevent event loops
-        await getUserStorageControllerInstance().setIsContactSyncingInProgress(true);
-        // Get all local contacts from AddressBookController (exclude chain "*" contacts)
-        const localVisibleContacts = getMessenger()
-            .call('AddressBookController:list')
-            .filter((contact) => !(0, utils_2.isContactBridgedFromAccounts)(contact))
-            .filter((contact) => contact.address && contact.chainId && contact.name?.trim()) || [];
-        // Get remote contacts from user storage API
-        const remoteContacts = await getRemoteContacts(options);
-        // Filter remote contacts to exclude invalid ones (or empty array if no remote contacts)
-        const validRemoteContacts = remoteContacts?.filter((contact) => contact.address && contact.chainId && contact.name?.trim()) || [];
-        // Prepare maps for efficient lookup
-        const localContactsMap = new Map();
-        const remoteContactsMap = new Map();
-        localVisibleContacts.forEach((contact) => {
-            const key = createContactKey(contact);
-            localContactsMap.set(key, contact);
-        });
-        validRemoteContacts.forEach((contact) => {
-            const key = createContactKey(contact);
-            remoteContactsMap.set(key, contact);
-        });
-        // Lists to track contacts that need to be synced
-        const contactsToAddOrUpdateLocally = [];
-        const contactsToDeleteLocally = [];
-        const contactsToUpdateRemotely = [];
-        // SCENARIO 2 & 6: Process remote contacts - handle new device sync and remote updates
-        for (const remoteContact of validRemoteContacts) {
-            const key = createContactKey(remoteContact);
-            const localContact = localContactsMap.get(key);
-            // Handle remote contact based on its status and local existence
-            if (remoteContact.deletedAt) {
-                // SCENARIO 8: Remote deletion - should be applied locally if contact exists locally
-                if (localContact) {
-                    contactsToDeleteLocally.push(remoteContact);
-                }
+    let localVisibleContacts = [];
+    let validRemoteContacts = [];
+    const performSync = async () => {
+        try {
+            // Cannot perform sync, conditions not met
+            if (!(0, sync_utils_1.canPerformContactSyncing)(options)) {
+                return;
             }
-            else if (!localContact) {
-                // SCENARIO 2: New contact from remote - import to local
-                contactsToAddOrUpdateLocally.push(remoteContact);
-            }
-            else {
-                // SCENARIO 4 & 6: Contact exists on both sides - check for conflicts
-                const hasContentDifference = localContact.name !== remoteContact.name ||
-                    localContact.memo !== remoteContact.memo;
-                if (hasContentDifference) {
-                    // Check timestamps to determine which version to keep
-                    const localTimestamp = localContact.lastUpdatedAt || 0;
-                    const remoteTimestamp = remoteContact.lastUpdatedAt || 0;
-                    if (localTimestamp >= remoteTimestamp) {
-                        // Local is newer (or same age) - use local version
-                        contactsToUpdateRemotely.push(localContact);
+            // Activate sync semaphore to prevent event loops
+            await getUserStorageControllerInstance().setIsContactSyncingInProgress(true);
+            // Get all local contacts from AddressBookController (exclude chain "*" contacts)
+            localVisibleContacts =
+                getMessenger()
+                    .call('AddressBookController:list')
+                    .filter((contact) => !(0, utils_2.isContactBridgedFromAccounts)(contact))
+                    .filter((contact) => contact.address && contact.chainId && contact.name?.trim()) || [];
+            // Get remote contacts from user storage API
+            const remoteContacts = await getRemoteContacts(options);
+            // Filter remote contacts to exclude invalid ones (or empty array if no remote contacts)
+            validRemoteContacts =
+                remoteContacts?.filter((contact) => contact.address && contact.chainId && contact.name?.trim()) || [];
+            // Prepare maps for efficient lookup
+            const localContactsMap = new Map();
+            const remoteContactsMap = new Map();
+            localVisibleContacts.forEach((contact) => {
+                const key = createContactKey(contact);
+                localContactsMap.set(key, contact);
+            });
+            validRemoteContacts.forEach((contact) => {
+                const key = createContactKey(contact);
+                remoteContactsMap.set(key, contact);
+            });
+            // Lists to track contacts that need to be synced
+            const contactsToAddOrUpdateLocally = [];
+            const contactsToDeleteLocally = [];
+            const contactsToUpdateRemotely = [];
+            // SCENARIO 2 & 6: Process remote contacts - handle new device sync and remote updates
+            for (const remoteContact of validRemoteContacts) {
+                const key = createContactKey(remoteContact);
+                const localContact = localContactsMap.get(key);
+                // Handle remote contact based on its status and local existence
+                if (remoteContact.deletedAt) {
+                    // SCENARIO 8: Remote deletion - should be applied locally if contact exists locally
+                    if (localContact) {
+                        contactsToDeleteLocally.push(remoteContact);
                     }
-                    else {
-                        // Remote is newer - use remote version
-                        contactsToAddOrUpdateLocally.push(remoteContact);
+                }
+                else if (!localContact) {
+                    // SCENARIO 2: New contact from remote - import to local
+                    contactsToAddOrUpdateLocally.push(remoteContact);
+                }
+                else {
+                    // SCENARIO 4 & 6: Contact exists on both sides - check for conflicts
+                    const hasContentDifference = localContact.name !== remoteContact.name ||
+                        localContact.memo !== remoteContact.memo;
+                    if (hasContentDifference) {
+                        // Check timestamps to determine which version to keep
+                        const localTimestamp = localContact.lastUpdatedAt || 0;
+                        const remoteTimestamp = remoteContact.lastUpdatedAt || 0;
+                        if (localTimestamp >= remoteTimestamp) {
+                            // Local is newer (or same age) - use local version
+                            contactsToUpdateRemotely.push(localContact);
+                        }
+                        else {
+                            // Remote is newer - use remote version
+                            contactsToAddOrUpdateLocally.push(remoteContact);
+                        }
                     }
+                    // Else: content is identical, no action needed
                 }
-                // Else: content is identical, no action needed
-            }
-        }
-        // SCENARIO 1, 3 & 5: Process local contacts not in remote - handles first sync and new local contacts
-        for (const localContact of localVisibleContacts) {
-            const key = createContactKey(localContact);
-            const remoteContact = remoteContactsMap.get(key);
-            if (!remoteContact) {
-                // New local contact or first sync - add to remote
-                contactsToUpdateRemotely.push(localContact);
             }
-        }
-        // Apply local deletions
-        for (const contact of contactsToDeleteLocally) {
-            try {
-                getMessenger().call('AddressBookController:delete', contact.chainId, contact.address);
-                if (onContactDeleted) {
-                    onContactDeleted();
+            // SCENARIO 1, 3 & 5: Process local contacts not in remote - handles first sync and new local contacts
+            for (const localContact of localVisibleContacts) {
+                const key = createContactKey(localContact);
+                const remoteContact = remoteContactsMap.get(key);
+                if (!remoteContact) {
+                    // New local contact or first sync - add to remote
+                    contactsToUpdateRemotely.push(localContact);
                 }
             }
-            catch (error) {
-                console.error('Error deleting contact:', error);
-            }
-        }
-        // Apply local additions/updates
-        for (const contact of contactsToAddOrUpdateLocally) {
-            if (!contact.deletedAt) {
+            // Apply local deletions
+            for (const contact of contactsToDeleteLocally) {
                 try {
-                    getMessenger().call('AddressBookController:set', contact.address, contact.name || '', contact.chainId, contact.memo || '', contact.addressType);
-                    if (onContactUpdated) {
-                        onContactUpdated();
+                    getMessenger().call('AddressBookController:delete', contact.chainId, contact.address);
+                    if (onContactDeleted) {
+                        onContactDeleted();
                     }
                 }
                 catch (error) {
-                    console.error('Error updating contact:', error);
+                    console.error('Error deleting contact:', error);
+                }
+            }
+            // Apply local additions/updates
+            for (const contact of contactsToAddOrUpdateLocally) {
+                if (!contact.deletedAt) {
+                    try {
+                        getMessenger().call('AddressBookController:set', contact.address, contact.name || '', contact.chainId, contact.memo || '', contact.addressType);
+                        if (onContactUpdated) {
+                            onContactUpdated();
+                        }
+                    }
+                    catch (error) {
+                        console.error('Error updating contact:', error);
+                    }
+                }
+            }
+            // Apply changes to remote storage
+            if (contactsToUpdateRemotely.length > 0) {
+                const updatedRemoteContacts = {};
+                for (const localContact of contactsToUpdateRemotely) {
+                    const key = createContactKey(localContact);
+                    updatedRemoteContacts[key] = {
+                        ...remoteContactsMap.get(key),
+                        ...localContact,
+                        lastUpdatedAt: Date.now(), // mark as updated
+                    };
                 }
+                // Save updated contacts to remote storage
+                await saveContactsToUserStorage(Object.values(updatedRemoteContacts), options);
             }
         }
-        // Apply changes to remote storage
-        if (contactsToUpdateRemotely.length > 0) {
-            const updatedRemoteContacts = {};
-            for (const localContact of contactsToUpdateRemotely) {
-                const key = createContactKey(localContact);
-                updatedRemoteContacts[key] = {
-                    ...remoteContactsMap.get(key),
-                    ...localContact,
-                    lastUpdatedAt: Date.now(), // mark as updated
-                };
+        catch (error) {
+            if (onContactSyncErroneousSituation) {
+                onContactSyncErroneousSituation('Error synchronizing contacts', {
+                    error,
+                });
+                // Re-throw the error to be handled by the caller
+                throw error;
             }
-            // Save updated contacts to remote storage
-            await saveContactsToUserStorage(Object.values(updatedRemoteContacts), options);
         }
-    }
-    catch (error) {
-        if (onContactSyncErroneousSituation) {
-            onContactSyncErroneousSituation('Error synchronizing contacts', {
-                error,
-            });
-            // Re-throw the error to be handled by the caller
-            throw error;
+        finally {
+            await getUserStorageControllerInstance().setIsContactSyncingInProgress(false);
         }
+    };
+    if (trace) {
+        // Gather pre-sync metrics for performance analysis
+        const initialLocalContacts = localVisibleContacts;
+        const initialValidRemoteContacts = validRemoteContacts;
+        return await trace({
+            name: 'Contact Sync Full',
+            data: {
+                localContactCount: initialLocalContacts.length,
+                remoteContactCount: initialValidRemoteContacts.length,
+                isFirstSync: initialValidRemoteContacts.length === 0 &&
+                    initialLocalContacts.length > 0,
+                isNewDeviceSync: initialLocalContacts.length === 0 &&
+                    initialValidRemoteContacts.length > 0,
+                isRegularSync: initialLocalContacts.length > 0 &&
+                    initialValidRemoteContacts.length > 0,
+                hasDataToSync: initialLocalContacts.length > 0 ||
+                    initialValidRemoteContacts.length > 0,
+                expectedWorkload: initialLocalContacts.length + initialValidRemoteContacts.length,
+            },
+        }, performSync);
     }
-    finally {
-        await getUserStorageControllerInstance().setIsContactSyncingInProgress(false);
-    }
+    return await performSync();
 }
 exports.syncContactsWithUserStorage = syncContactsWithUserStorage;
 /**
@@ -198,19 +227,34 @@ async function getRemoteContacts(options) {
  *
  * @param contacts - The contacts to save to user storage
  * @param options - Parameters used for saving contacts
+ * @returns Promise that resolves when contacts are saved
  */
 async function saveContactsToUserStorage(contacts, options) {
-    const { getUserStorageControllerInstance } = options;
-    if (!contacts || contacts.length === 0) {
-        return;
-    }
-    // Convert each AddressBookEntry to UserStorageContactEntry format and create key-value pairs
-    const storageEntries = contacts.map((contact) => {
-        const key = createContactKey(contact);
-        const storageEntry = (0, utils_1.mapAddressBookEntryToUserStorageEntry)(contact);
-        return [key, JSON.stringify(storageEntry)];
-    });
-    await getUserStorageControllerInstance().performBatchSetStorage(storage_schema_1.USER_STORAGE_FEATURE_NAMES.addressBook, storageEntries);
+    const { getUserStorageControllerInstance, trace } = options;
+    const saveContacts = async () => {
+        if (!contacts || contacts.length === 0) {
+            return;
+        }
+        // Convert each AddressBookEntry to UserStorageContactEntry format and create key-value pairs
+        const storageEntries = contacts.map((contact) => {
+            const key = createContactKey(contact);
+            const storageEntry = (0, utils_1.mapAddressBookEntryToUserStorageEntry)(contact);
+            return [key, JSON.stringify(storageEntry)];
+        });
+        await getUserStorageControllerInstance().performBatchSetStorage(storage_schema_1.USER_STORAGE_FEATURE_NAMES.addressBook, storageEntries);
+    };
+    return trace
+        ? await trace({
+            name: 'Contact Sync Save Batch',
+            data: {
+                contactCount: contacts.length,
+                // Performance scaling indicators
+                hasBatchOperations: contacts.length > 1,
+                chainCount: new Set(contacts.map((c) => c.chainId)).size,
+                hasMemosCount: contacts.filter((c) => c.memo?.length).length,
+            },
+        }, saveContacts)
+        : await saveContacts();
 }
 /**
  * Updates a single contact in remote storage without performing a full sync
@@ -218,24 +262,40 @@ async function saveContactsToUserStorage(contacts, options) {
  *
  * @param contact - The contact that was updated locally
  * @param options - Parameters used for syncing operations
+ * @returns Promise that resolves when the contact is updated
  */
 async function updateContactInRemoteStorage(contact, options) {
-    if (!(0, sync_utils_1.canPerformContactSyncing)(options) ||
-        !contact.address ||
-        !contact.chainId ||
-        !contact.name?.trim()) {
-        return;
-    }
-    const { getUserStorageControllerInstance } = options;
-    // Create an updated entry with timestamp
-    const updatedEntry = {
-        ...contact,
-        lastUpdatedAt: contact.lastUpdatedAt || Date.now(),
+    const { trace } = options;
+    const updateContact = async () => {
+        if (!(0, sync_utils_1.canPerformContactSyncing)(options) ||
+            !contact.address ||
+            !contact.chainId ||
+            !contact.name?.trim()) {
+            return;
+        }
+        const { getUserStorageControllerInstance } = options;
+        // Create an updated entry with timestamp
+        const updatedEntry = {
+            ...contact,
+            lastUpdatedAt: contact.lastUpdatedAt || Date.now(),
+        };
+        const key = createContactKey(contact);
+        const storageEntry = (0, utils_1.mapAddressBookEntryToUserStorageEntry)(updatedEntry);
+        // Save individual contact to remote storage
+        await getUserStorageControllerInstance().performSetStorage(`${storage_schema_1.USER_STORAGE_FEATURE_NAMES.addressBook}.${key}`, JSON.stringify(storageEntry));
     };
-    const key = createContactKey(contact);
-    const storageEntry = (0, utils_1.mapAddressBookEntryToUserStorageEntry)(updatedEntry);
-    // Save individual contact to remote storage
-    await getUserStorageControllerInstance().performSetStorage(`${storage_schema_1.USER_STORAGE_FEATURE_NAMES.addressBook}.${key}`, JSON.stringify(storageEntry));
+    return trace
+        ? await trace({
+            name: 'Contact Sync Update Remote',
+            data: {
+                chainId: contact.chainId,
+                // Performance indicators
+                hasTimestamp: Boolean(contact.lastUpdatedAt),
+                hasMemo: Boolean(contact.memo?.length),
+                isUpdate: Boolean(contact.lastUpdatedAt), // vs new contact
+            },
+        }, updateContact)
+        : await updateContact();
 }
 exports.updateContactInRemoteStorage = updateContactInRemoteStorage;
 /**
@@ -244,38 +304,45 @@ exports.updateContactInRemoteStorage = updateContactInRemoteStorage;
  *
  * @param contact - The contact that was deleted locally (contains at least address and chainId)
  * @param options - Parameters used for syncing operations
+ * @returns Promise that resolves when the contact is marked as deleted
  */
 async function deleteContactInRemoteStorage(contact, options) {
-    if (!(0, sync_utils_1.canPerformContactSyncing)(options) ||
-        !contact.address ||
-        !contact.chainId ||
-        !contact.name?.trim()) {
-        return;
-    }
-    const { getUserStorageControllerInstance } = options;
-    const key = createContactKey(contact);
-    try {
-        // Try to get the existing contact first
-        const existingContactJson = await getUserStorageControllerInstance().performGetStorage(`${storage_schema_1.USER_STORAGE_FEATURE_NAMES.addressBook}.${key}`);
-        if (existingContactJson) {
-            // Mark the existing contact as deleted
-            const existingStorageEntry = JSON.parse(existingContactJson);
-            const existingContact = (0, utils_1.mapUserStorageEntryToAddressBookEntry)(existingStorageEntry);
-            const now = Date.now();
-            const deletedContact = {
-                ...existingContact,
-                deletedAt: now,
-                lastUpdatedAt: now,
-            };
-            const deletedStorageEntry = (0, utils_1.mapAddressBookEntryToUserStorageEntry)(deletedContact);
-            // Save the deleted contact back to storage
-            await getUserStorageControllerInstance().performSetStorage(`${storage_schema_1.USER_STORAGE_FEATURE_NAMES.addressBook}.${key}`, JSON.stringify(deletedStorageEntry));
+    const { trace } = options;
+    const deleteContact = async () => {
+        if (!(0, sync_utils_1.canPerformContactSyncing)(options) ||
+            !contact.address ||
+            !contact.chainId ||
+            !contact.name?.trim()) {
+            return;
         }
-    }
-    catch {
-        // If contact doesn't exist in remote storage, no need to mark as deleted
-        console.warn('Contact not found in remote storage for deletion:', key);
-    }
+        const { getUserStorageControllerInstance } = options;
+        const key = createContactKey(contact);
+        try {
+            // Try to get the existing contact first
+            const existingContactJson = await getUserStorageControllerInstance().performGetStorage(`${storage_schema_1.USER_STORAGE_FEATURE_NAMES.addressBook}.${key}`);
+            if (existingContactJson) {
+                // Mark the existing contact as deleted
+                const existingStorageEntry = JSON.parse(existingContactJson);
+                const existingContact = (0, utils_1.mapUserStorageEntryToAddressBookEntry)(existingStorageEntry);
+                const now = Date.now();
+                const deletedContact = {
+                    ...existingContact,
+                    deletedAt: now,
+                    lastUpdatedAt: now,
+                };
+                const deletedStorageEntry = (0, utils_1.mapAddressBookEntryToUserStorageEntry)(deletedContact);
+                // Save the deleted contact back to storage
+                await getUserStorageControllerInstance().performSetStorage(`${storage_schema_1.USER_STORAGE_FEATURE_NAMES.addressBook}.${key}`, JSON.stringify(deletedStorageEntry));
+            }
+        }
+        catch {
+            // If contact doesn't exist in remote storage, no need to mark as deleted
+            console.warn('Contact not found in remote storage for deletion:', key);
+        }
+    };
+    return trace
+        ? await trace({ name: 'Contact Sync Delete Remote' }, deleteContact)
+        : await deleteContact();
 }
 exports.deleteContactInRemoteStorage = deleteContactInRemoteStorage;
 //# sourceMappingURL=controller-integration.cjs.map