fix: use optional instead of exactOptional in KeyringCapabilitiesStruct#481
Open
fix: use optional instead of exactOptional in KeyringCapabilitiesStruct#481
optional instead of exactOptional in KeyringCapabilitiesStruct#481Conversation
optional instead of exactOptional in KeyringCapabilitiesStructoptional instead of exactOptional in KeyringCapabilitiesStruct
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.
Change
KeyringCapabilitiesStructto useoptionalinstead ofexactOptionalfor nested fieldsexactOptionalrejects explicitundefinedvalues whileoptionalaccepts them. The distinction is meaningless for this struct because capabilities data is always JSON-sourced (from Snap manifests and JSON-RPC messages), andundefinedcannot exist in JSON.JSON.parsenever produces it, andJSON.stringifysilently drops keys withundefinedvalues.The practical motivation:
@metamask/snaps-utilsmirrors this struct for manifest validation, wherePermissionsStructis annotated asDescribe<InitialPermissions>. Superstruct'sDescribe<T>maps TypeScript'sprop?: Tto a struct whose refiner acceptsT | undefined, butexactOptional(T)produces a refiner that only acceptsT. These are incompatible at the type level, forcing consumers to maintain a duplicate struct withoptionaljust to satisfyDescribe. Switching the canonical struct tooptionaleliminates this duplication with no change in runtime behavior for JSON data.Note
Low Risk
Low risk: schema validation is loosened only to accept explicit
undefinedfor nested capability fields; behavior for JSON-derived data should be unchanged.Overview
Updates
KeyringCapabilitiesStructto use superstructoptional()(instead ofexactOptional()) for nested capability objects and their fields (bip44,privateKey,custom).Adds a changelog entry documenting this as a fix, primarily improving TypeScript
Describe<>compatibility while keeping effective JSON validation the same.Written by Cursor Bugbot for commit ba24cd8. This will update automatically on new commits. Configure here.