feat(seedless-onboarding): add dataType support for secret data items by huggingbot · Pull Request #7284 · MetaMask/core

huggingbot · 2025-12-02T08:17:21Z

Explanation

The metadata service now supports a dataType column for categorizing secret data (PrimarySrp, ImportedSrp, ImportedPrivateKey). This enables clients to distinguish between different types of backed-up secrets

Changes include:

Add dataType parameter to insert operations
Add updateSecretDataItem and batchUpdateSecretDataItems for updating existing items
Update fetchAllSecretData to return storage metadata (itemId, dataType) alongside secret data
Refactor SecretMetadata to separate local metadata from storage-level metadata

References

https://consensyssoftware.atlassian.net/browse/SL-350

Checklist

I've updated the test suite for new or updated code as appropriate
I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
I've communicated my changes to consumers by updating changelogs for packages I've changed
I've introduced breaking changes in this PR and have prepared draft pull requests for clients and consumer packages to resolve them

Note

Medium Risk
Introduces breaking API changes and new migration logic that updates remote secret metadata and changes secret ordering/validation, so regressions could affect backup/restore correctness for existing users.

Overview
Secret backups now carry a storage-level dataType (PrimarySrp/ImportedSrp/ImportedPrivateKey) via @metamask/toprf-secure-backup@^1.0.0, and addNewSecretData is breaking: it accepts dataType: EncAccountDataType (rejecting PrimarySrp) and persists that classification when adding items.

fetchAllSecretData now consumes the SDK’s richer FetchedSecretDataItem shape, returns SecretMetadata enriched with itemId/dataType/createdAt/storageVersion, and changes ordering/validation to use PrimarySrp-first sorting with TIMEUUID timestamp extraction (fixing previous lexicographic TIMEUUID sorting).

Adds migration plumbing: controller state gains persisted migrationVersion plus runMigrations/setMigrationVersion, with a #migrateDataTypes routine that updates legacy items’ dataType (single vs batch updates) and marks migration completion; SecretMetadata is refactored accordingly (removing old batch/parse/sort helpers and version in favor of storageVersion).

^{Written by Cursor Bugbot for commit 7141349. This will update automatically on new commits. Configure here.}

- Add dataType parameter to createToprfKeyAndBackupSeedPhrase and addNewSecretData - Add updateSecretDataItem and batchUpdateSecretDataItems methods - Update fetchAllSecretData to return SecretDataItemWithMetadata[]

packages/seedless-onboarding-controller/src/types.ts

packages/seedless-onboarding-controller/src/index.ts

packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts

…ckupSeedPhrase method

…gController

…legacy data

… PrimarySrp first, then createdAt

…etadata - Add itemId, dataType, createdAt properties to SecretMetadata class - Remove SecretDataItemWithMetadata wrapper type - Update fetchAllSecretData to return SecretMetadata[] directly - Add tests for storage metadata properties

…EUUID sorting TIMEUUID strings are not lexicographically sortable. Replace localeCompare with compareTimeuuid utility that extracts and compares actual timestamps.

packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts

packages/seedless-onboarding-controller/src/SecretMetadata.ts

packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts

…ting

packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts

packages/seedless-onboarding-controller/src/SecretMetadata.ts

…rsion type

packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts

packages/seedless-onboarding-controller/src/SecretMetadata.ts

packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts

socket-security · 2026-01-15T07:23:10Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	@metamask/toprf-secure-backup@0.11.0 ⏵ 1.0.0			⁺¹	^-1

View full report

packages/seedless-onboarding-controller/src/SecretMetadata.ts

packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts

fix: handle edge case in SecretMetadata.compare when both items are PrimarySrp fix: add tests for data corruption scenarios and inconsistent storageVersion

packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts

lwin-kyaw

LGTM!!! 🚀

huggingbot · 2026-01-23T06:25:20Z

@metamaskbot publish-preview

huggingbot · 2026-01-26T08:06:55Z

@metamaskbot publish-preview

github-actions · 2026-01-26T08:11:41Z

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.

{
  "@metamask-previews/account-tree-controller": "4.0.0-preview-6ae8a59c",
  "@metamask-previews/accounts-controller": "35.0.2-preview-6ae8a59c",
  "@metamask-previews/address-book-controller": "7.0.1-preview-6ae8a59c",
  "@metamask-previews/ai-controllers": "0.0.0-preview-6ae8a59c",
  "@metamask-previews/analytics-controller": "1.0.0-preview-6ae8a59c",
  "@metamask-previews/announcement-controller": "8.0.0-preview-6ae8a59c",
  "@metamask-previews/app-metadata-controller": "2.0.0-preview-6ae8a59c",
  "@metamask-previews/approval-controller": "8.0.0-preview-6ae8a59c",
  "@metamask-previews/assets-controller": "0.0.0-preview-6ae8a59c",
  "@metamask-previews/assets-controllers": "96.0.0-preview-6ae8a59c",
  "@metamask-previews/base-controller": "9.0.0-preview-6ae8a59c",
  "@metamask-previews/bridge-controller": "64.8.1-preview-6ae8a59c",
  "@metamask-previews/bridge-status-controller": "64.4.4-preview-6ae8a59c",
  "@metamask-previews/build-utils": "3.0.4-preview-6ae8a59c",
  "@metamask-previews/chain-agnostic-permission": "1.4.0-preview-6ae8a59c",
  "@metamask-previews/claims-controller": "0.4.1-preview-6ae8a59c",
  "@metamask-previews/composable-controller": "12.0.0-preview-6ae8a59c",
  "@metamask-previews/connectivity-controller": "0.1.0-preview-6ae8a59c",
  "@metamask-previews/controller-utils": "11.18.0-preview-6ae8a59c",
  "@metamask-previews/core-backend": "5.0.0-preview-6ae8a59c",
  "@metamask-previews/delegation-controller": "2.0.0-preview-6ae8a59c",
  "@metamask-previews/earn-controller": "11.1.0-preview-6ae8a59c",
  "@metamask-previews/eip-5792-middleware": "2.1.0-preview-6ae8a59c",
  "@metamask-previews/eip-7702-internal-rpc-middleware": "0.1.0-preview-6ae8a59c",
  "@metamask-previews/eip1193-permission-middleware": "1.0.3-preview-6ae8a59c",
  "@metamask-previews/ens-controller": "19.0.2-preview-6ae8a59c",
  "@metamask-previews/error-reporting-service": "3.0.1-preview-6ae8a59c",
  "@metamask-previews/eth-block-tracker": "15.0.1-preview-6ae8a59c",
  "@metamask-previews/eth-json-rpc-middleware": "23.0.0-preview-6ae8a59c",
  "@metamask-previews/eth-json-rpc-provider": "6.0.0-preview-6ae8a59c",
  "@metamask-previews/foundryup": "1.0.1-preview-6ae8a59c",
  "@metamask-previews/gas-fee-controller": "26.0.2-preview-6ae8a59c",
  "@metamask-previews/gator-permissions-controller": "1.1.0-preview-6ae8a59c",
  "@metamask-previews/json-rpc-engine": "10.2.1-preview-6ae8a59c",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.8-preview-6ae8a59c",
  "@metamask-previews/keyring-controller": "25.1.0-preview-6ae8a59c",
  "@metamask-previews/logging-controller": "7.0.1-preview-6ae8a59c",
  "@metamask-previews/message-manager": "14.1.0-preview-6ae8a59c",
  "@metamask-previews/messenger": "0.3.0-preview-6ae8a59c",
  "@metamask-previews/multichain-account-service": "5.1.0-preview-6ae8a59c",
  "@metamask-previews/multichain-api-middleware": "1.2.6-preview-6ae8a59c",
  "@metamask-previews/multichain-network-controller": "3.0.2-preview-6ae8a59c",
  "@metamask-previews/multichain-transactions-controller": "7.0.0-preview-6ae8a59c",
  "@metamask-previews/name-controller": "9.0.0-preview-6ae8a59c",
  "@metamask-previews/network-controller": "29.0.0-preview-6ae8a59c",
  "@metamask-previews/network-enablement-controller": "4.1.0-preview-6ae8a59c",
  "@metamask-previews/notification-services-controller": "21.0.0-preview-6ae8a59c",
  "@metamask-previews/permission-controller": "12.2.0-preview-6ae8a59c",
  "@metamask-previews/permission-log-controller": "5.0.0-preview-6ae8a59c",
  "@metamask-previews/perps-controller": "0.0.0-preview-6ae8a59c",
  "@metamask-previews/phishing-controller": "16.1.0-preview-6ae8a59c",
  "@metamask-previews/polling-controller": "16.0.2-preview-6ae8a59c",
  "@metamask-previews/preferences-controller": "22.0.0-preview-6ae8a59c",
  "@metamask-previews/profile-metrics-controller": "3.0.0-preview-6ae8a59c",
  "@metamask-previews/profile-sync-controller": "27.0.0-preview-6ae8a59c",
  "@metamask-previews/ramps-controller": "4.1.0-preview-6ae8a59c",
  "@metamask-previews/rate-limit-controller": "7.0.0-preview-6ae8a59c",
  "@metamask-previews/remote-feature-flag-controller": "4.0.0-preview-6ae8a59c",
  "@metamask-previews/sample-controllers": "4.0.2-preview-6ae8a59c",
  "@metamask-previews/seedless-onboarding-controller": "7.1.0-preview-6ae8a59c",
  "@metamask-previews/selected-network-controller": "26.0.2-preview-6ae8a59c",
  "@metamask-previews/shield-controller": "5.0.0-preview-6ae8a59c",
  "@metamask-previews/signature-controller": "39.0.1-preview-6ae8a59c",
  "@metamask-previews/storage-service": "0.0.1-preview-6ae8a59c",
  "@metamask-previews/subscription-controller": "5.4.0-preview-6ae8a59c",
  "@metamask-previews/token-search-discovery-controller": "4.0.0-preview-6ae8a59c",
  "@metamask-previews/transaction-controller": "62.9.2-preview-6ae8a59c",
  "@metamask-previews/transaction-pay-controller": "11.1.0-preview-6ae8a59c",
  "@metamask-previews/user-operation-controller": "41.0.2-preview-6ae8a59c"
}

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

packages/seedless-onboarding-controller/src/utils.ts

huggingbot · 2026-02-23T06:17:28Z

@metamaskbot publish-preview

github-actions · 2026-02-23T06:22:37Z

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.

{
  "@metamask-previews/account-tree-controller": "4.1.1-preview-71413498f",
  "@metamask-previews/accounts-controller": "36.0.1-preview-71413498f",
  "@metamask-previews/address-book-controller": "7.0.1-preview-71413498f",
  "@metamask-previews/ai-controllers": "0.1.0-preview-71413498f",
  "@metamask-previews/analytics-controller": "1.0.0-preview-71413498f",
  "@metamask-previews/analytics-data-regulation-controller": "0.0.0-preview-71413498f",
  "@metamask-previews/announcement-controller": "8.0.0-preview-71413498f",
  "@metamask-previews/app-metadata-controller": "2.0.0-preview-71413498f",
  "@metamask-previews/approval-controller": "8.0.0-preview-71413498f",
  "@metamask-previews/assets-controller": "2.0.2-preview-71413498f",
  "@metamask-previews/assets-controllers": "100.0.2-preview-71413498f",
  "@metamask-previews/base-controller": "9.0.0-preview-71413498f",
  "@metamask-previews/bridge-controller": "67.1.1-preview-71413498f",
  "@metamask-previews/bridge-status-controller": "67.0.1-preview-71413498f",
  "@metamask-previews/build-utils": "3.0.4-preview-71413498f",
  "@metamask-previews/chain-agnostic-permission": "1.4.0-preview-71413498f",
  "@metamask-previews/claims-controller": "0.4.2-preview-71413498f",
  "@metamask-previews/client-controller": "1.0.0-preview-71413498f",
  "@metamask-previews/compliance-controller": "1.0.0-preview-71413498f",
  "@metamask-previews/composable-controller": "12.0.0-preview-71413498f",
  "@metamask-previews/connectivity-controller": "0.1.0-preview-71413498f",
  "@metamask-previews/controller-utils": "11.19.0-preview-71413498f",
  "@metamask-previews/core-backend": "6.0.0-preview-71413498f",
  "@metamask-previews/delegation-controller": "2.0.1-preview-71413498f",
  "@metamask-previews/earn-controller": "11.1.1-preview-71413498f",
  "@metamask-previews/eip-5792-middleware": "2.1.0-preview-71413498f",
  "@metamask-previews/eip-7702-internal-rpc-middleware": "0.1.0-preview-71413498f",
  "@metamask-previews/eip1193-permission-middleware": "1.0.3-preview-71413498f",
  "@metamask-previews/ens-controller": "19.0.3-preview-71413498f",
  "@metamask-previews/error-reporting-service": "3.0.1-preview-71413498f",
  "@metamask-previews/eth-block-tracker": "15.0.1-preview-71413498f",
  "@metamask-previews/eth-json-rpc-middleware": "23.1.0-preview-71413498f",
  "@metamask-previews/eth-json-rpc-provider": "6.0.0-preview-71413498f",
  "@metamask-previews/foundryup": "1.0.1-preview-71413498f",
  "@metamask-previews/gas-fee-controller": "26.0.3-preview-71413498f",
  "@metamask-previews/gator-permissions-controller": "2.0.0-preview-71413498f",
  "@metamask-previews/json-rpc-engine": "10.2.2-preview-71413498f",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.8-preview-71413498f",
  "@metamask-previews/keyring-controller": "25.1.0-preview-71413498f",
  "@metamask-previews/logging-controller": "7.0.1-preview-71413498f",
  "@metamask-previews/message-manager": "14.1.0-preview-71413498f",
  "@metamask-previews/messenger": "0.3.0-preview-71413498f",
  "@metamask-previews/multichain-account-service": "7.0.0-preview-71413498f",
  "@metamask-previews/multichain-api-middleware": "1.2.7-preview-71413498f",
  "@metamask-previews/multichain-network-controller": "3.0.4-preview-71413498f",
  "@metamask-previews/multichain-transactions-controller": "7.0.1-preview-71413498f",
  "@metamask-previews/name-controller": "9.0.0-preview-71413498f",
  "@metamask-previews/network-controller": "30.0.0-preview-71413498f",
  "@metamask-previews/network-enablement-controller": "4.1.2-preview-71413498f",
  "@metamask-previews/notification-services-controller": "22.0.0-preview-71413498f",
  "@metamask-previews/permission-controller": "12.2.0-preview-71413498f",
  "@metamask-previews/permission-log-controller": "5.0.0-preview-71413498f",
  "@metamask-previews/perps-controller": "0.0.0-preview-71413498f",
  "@metamask-previews/phishing-controller": "16.3.0-preview-71413498f",
  "@metamask-previews/polling-controller": "16.0.3-preview-71413498f",
  "@metamask-previews/preferences-controller": "22.1.0-preview-71413498f",
  "@metamask-previews/profile-metrics-controller": "3.0.1-preview-71413498f",
  "@metamask-previews/profile-sync-controller": "27.1.0-preview-71413498f",
  "@metamask-previews/ramps-controller": "9.0.0-preview-71413498f",
  "@metamask-previews/rate-limit-controller": "7.0.0-preview-71413498f",
  "@metamask-previews/remote-feature-flag-controller": "4.0.0-preview-71413498f",
  "@metamask-previews/sample-controllers": "4.0.3-preview-71413498f",
  "@metamask-previews/seedless-onboarding-controller": "8.0.0-preview-71413498f",
  "@metamask-previews/selected-network-controller": "26.0.3-preview-71413498f",
  "@metamask-previews/shield-controller": "5.0.1-preview-71413498f",
  "@metamask-previews/signature-controller": "39.0.4-preview-71413498f",
  "@metamask-previews/storage-service": "1.0.0-preview-71413498f",
  "@metamask-previews/subscription-controller": "6.0.0-preview-71413498f",
  "@metamask-previews/transaction-controller": "62.18.0-preview-71413498f",
  "@metamask-previews/transaction-pay-controller": "16.0.0-preview-71413498f",
  "@metamask-previews/user-operation-controller": "41.0.3-preview-71413498f"
}

feat(seedless-onboarding): add dataType support for secret data items

611556b

- Add dataType parameter to createToprfKeyAndBackupSeedPhrase and addNewSecretData - Add updateSecretDataItem and batchUpdateSecretDataItems methods - Update fetchAllSecretData to return SecretDataItemWithMetadata[]

lwin-kyaw requested changes Dec 2, 2025

View reviewed changes

huggingbot added 7 commits December 2, 2025 20:09

refactor: Removed default dataType parameter from createToprfKeyAndBa…

85275f5

…ckupSeedPhrase method

refactor: update documentation for secret data item methods

fc73107

refactor: enhance primary secret data validation in SeedlessOnboardin…

3afa879

…gController

fix: Update sorting mechanism to prioritize PrimarySrp dataType over …

90d642b

…legacy data

feat(seedless-onboarding-controller): add createdAt field and sort by…

ac52a76

… PrimarySrp first, then createdAt

fix(seedless-onboarding-controller): use timestamp extraction for TIM…

2885314

…EUUID sorting TIMEUUID strings are not lexicographically sortable. Replace localeCompare with compareTimeuuid utility that extracts and compares actual timestamps.

huggingbot commented Dec 8, 2025

View reviewed changes

packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts Outdated Show resolved Hide resolved

huggingbot added 3 commits December 16, 2025 12:41

chore: Update version

3e2b477

Merge branch 'main' into feat/data-type

f0b9638

chore: Update CHANGELOG and remove deprecated methods in SecretMetadata

ebcc4e0

lwin-kyaw added team-onboarding area-onboarding labels Dec 17, 2025

lwin-kyaw reviewed Dec 17, 2025

View reviewed changes

huggingbot added 4 commits December 18, 2025 12:45

fix: improve sorting logic for secret data with mixed createdAt values

b279fa5

feat: add runMigrations for legacy dataType migration

074d8af

feat: add setMigrationVersion method for direct migration version set…

eb77007

…ting

Merge branch 'main' into feat/data-type

0bde969

huggingbot marked this pull request as ready for review January 5, 2026 09:53

huggingbot requested review from a team as code owners January 5, 2026 09:53

cursor bot reviewed Jan 5, 2026

View reviewed changes

packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts Outdated Show resolved Hide resolved

lwin-kyaw reviewed Jan 6, 2026

View reviewed changes

packages/seedless-onboarding-controller/src/SecretMetadata.ts Outdated Show resolved Hide resolved

lwin-kyaw reviewed Jan 6, 2026

View reviewed changes

packages/seedless-onboarding-controller/src/SecretMetadata.ts Outdated Show resolved Hide resolved

lwin-kyaw reviewed Jan 6, 2026

View reviewed changes

packages/seedless-onboarding-controller/src/SecretMetadata.ts Outdated Show resolved Hide resolved

feat: update SecretMetadata to use SecretDataItemOutput for storageVe…

7634383

…rsion type

cursor bot reviewed Jan 6, 2026

View reviewed changes

packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts Show resolved Hide resolved

lwin-kyaw reviewed Jan 6, 2026

View reviewed changes

cursor bot reviewed Jan 15, 2026

View reviewed changes

packages/seedless-onboarding-controller/src/SecretMetadata.ts Show resolved Hide resolved

packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts Show resolved Hide resolved

fix: preserve PrimarySrp designation during migrations

e0e6499

fix: handle edge case in SecretMetadata.compare when both items are PrimarySrp fix: add tests for data corruption scenarios and inconsistent storageVersion

huggingbot dismissed himanshuchawla009’s stale review via e0e6499 January 15, 2026 08:00

cursor bot reviewed Jan 15, 2026

View reviewed changes

packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts Show resolved Hide resolved

fix: filter skipped items in hasPrimarySrp check

7184599

lwin-kyaw reviewed Jan 20, 2026

View reviewed changes

packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts Show resolved Hide resolved

lwin-kyaw reviewed Jan 20, 2026

View reviewed changes

packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts Show resolved Hide resolved

huggingbot added 3 commits January 20, 2026 22:58

fix: prevent addition of PrimarySrp dataType in addNewSecretData method

614be60

feat: set migration version to V1 upon creating new backup format

c1e534c

fix: Use error constant

483d0cd

lwin-kyaw previously approved these changes Jan 21, 2026

View reviewed changes

Merge branch 'main' into feat/data-type

b59af15

huggingbot dismissed lwin-kyaw’s stale review via b59af15 January 26, 2026 07:09

refactor: update runMigrations to return boolean status

6ae8a59

himanshuchawla009 previously approved these changes Jan 26, 2026

View reviewed changes

This was referenced Feb 12, 2026

feat: Implement dataType migration for seedless onboarding secrets MetaMask/metamask-extension#38540

Open

feat: Implement dataType migration for seedless onboarding secrets MetaMask/metamask-mobile#23760

Open

Merge branch 'main' into feat/data-type

8d17f38

huggingbot dismissed himanshuchawla009’s stale review via 8d17f38 February 23, 2026 04:55

huggingbot force-pushed the feat/data-type branch from 3c5e311 to 600a2f0 Compare February 23, 2026 05:07

Merge branch 'main' into feat/data-type

7a5e77f

huggingbot force-pushed the feat/data-type branch from 600a2f0 to 7a5e77f Compare February 23, 2026 05:15

fix: Lint

7141349

cursor bot reviewed Feb 23, 2026

View reviewed changes

packages/seedless-onboarding-controller/src/utils.ts Show resolved Hide resolved

Uh oh!

Comments

Conversation

huggingbot commented Dec 2, 2025 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation

References

Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

socket-security bot commented Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lwin-kyaw left a comment

Choose a reason for hiding this comment

Uh oh!

huggingbot commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

huggingbot commented Jan 26, 2026

Uh oh!

github-actions bot commented Jan 26, 2026

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

huggingbot commented Feb 23, 2026

Uh oh!

github-actions bot commented Feb 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

huggingbot commented Dec 2, 2025 •

edited by cursor bot

Loading

socket-security bot commented Jan 15, 2026 •

edited

Loading

huggingbot commented Jan 23, 2026 •

edited

Loading