refactor(keyring-sdk)!: remove envelope from the migration framework - #619
Merged
Conversation
ccharly
marked this pull request as ready for review
August 7, 2026 15:38
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit ff1538c. Configure here.
mathieuartu
approved these changes
Aug 10, 2026
Contributor
Author
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions (from the Expand for full list of packages and versions. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Remove the use of the envelope for the migration's states. This allows more flexibility for systems/data that already uses a
versionfield with a flat shape, making it more natural too.Note
High Risk
Breaking API and on-disk/vault serialization shape for any consumer of
createMigrations; integrators must migrate deserialize/serialize and stored state from envelope to flat form.Overview
Breaking change: The keyring migration framework no longer wraps state in
{ version, data }. Serialized state is flat—versionsits next to keyring fields—andapply()returns{ version, state, migrated }instead of putting payload ondata.Migration steps still receive and return inner data without
version; the framework stripsversionbefore running steps and setsstate.versionto the chain version after (overriding anyversiona step returns).isVersionedStatenow means any plain object with an integerversion, not an envelope with requireddata.State must be a plain JSON object (
JsonObject): unversionednullor arrays throw, and default step validation usesJsonObjectStructrather than generic JSON. Typed chains and tests were updated for the new shapes.Reviewed by Cursor Bugbot for commit 00307a3. Bugbot is set up for automated code reviews on this repo. Configure here.