Conversation
…at when no scopes are requested
jiexi
reviewed
Mar 25, 2025
jiexi
previously approved these changes
Mar 25, 2025
Co-authored-by: jiexi <jiexiluan@gmail.com>
jiexi
reviewed
Mar 25, 2025
| }); | ||
| }).toThrow( | ||
| new Error( | ||
| `${Caip25EndowmentPermissionName} error: Received no scopes requested for caveat of type "${Caip25CaveatType}".`, |
Member
There was a problem hiding this comment.
Suggested change
| `${Caip25EndowmentPermissionName} error: Received no scopes requested for caveat of type "${Caip25CaveatType}".`, | |
| `${Caip25EndowmentPermissionName} error: Received no scopes for caveat of type "${Caip25CaveatType}".`, |
jiexi
approved these changes
Mar 25, 2025
Merged
adonesky1
added a commit
that referenced
this pull request
Mar 25, 2025
## @metamask/chain-agnostic-permission ## [0.3.0] ### Added - Export `KnownSessionProperties` enum ([#5522](#5522)) - Add more chain agnostic utility functions for interfacing w/ caip25 permission ([#5536](#5536)) - New `setPermittedAccounts` function that allows setting accounts for any CAIP namespace, not just EVM scopes. - New `addPermittedChainId` and `setPermittedChainIds` functions for managing permitted chains across any CAIP namespace. - New `generateCaip25Caveat` function to generate a valid `endowment:caip25` permission caveat from given accounts and chains of any CAIP namespace. - New `isWalletScope` utility function to detect wallet-related scopes. ### Changed - **BREAKING:** An error is now thrown in the caveat validator when a `caip25:endowment` permission caveat has no scopes in either `requiredScopes` or `optionalScopes` ([#5548](#5548))
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
3 participants
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.
Explanation
We need to add further caveat validation to throw when no scopes are requested in either
requiredScopesoroptionalScopesReferences
See this thread: https://consensys.slack.com/archives/C089Q8CQZHT/p1742825693477409
Changelog
@metamask/chain-agnostic-permissionADDED: BREAKING Validation check in
caip25CaveatBuilderto prevent creating permission requests with no scopes. This ensures that all CAIP-25 permission requests must specify at least one scope in eitherrequiredScopesoroptionalScopes.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 highlighted breaking changes using the "BREAKING" category above as appropriate
I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes