Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Update signature-controller package to latest #28916

Closed
wants to merge 1 commit into from

Conversation

OGPoyraz
Copy link
Member

@OGPoyraz OGPoyraz commented Dec 4, 2024

Description

This PR updates signature-controller and eth-sig-util to latest versions.

Open in GitHub Codespaces

Related issues

Fixes: https://github.com/MetaMask/MetaMask-planning/issues/3582

Manual testing steps

To test this you need to be able to adjust signTypedV4 parameters in test-dapp.

Screenshots/Recordings

permit.schema.validation.mov

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

  • I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
  • I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

@OGPoyraz OGPoyraz requested a review from a team as a code owner December 4, 2024 09:21
@metamaskbot metamaskbot added the team-confirmations Push issues to confirmations team label Dec 4, 2024
Copy link

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/@metamask/signature-controller@23.0.1 network +4 912 kB metamaskbot

🚮 Removed packages: npm/@metamask/signature-controller@23.0.0

View full report↗︎

OGPoyraz added a commit to MetaMask/core that referenced this pull request Dec 5, 2024
## Explanation

<!--
Thanks for your contribution! Take a moment to answer these questions so
that reviewers have the information they need to properly understand
your changes:

* What is the current state of things and why does it need to change?
* What is the solution your changes offer and how does it work?
* Are there any changes whose purpose might not obvious to those
unfamiliar with the domain?
* If your primary goal was to update one package but you found you had
to update another one along the way, why did you do so?
* If you had to upgrade a dependency, why did you do so?
-->

This PR aims to update two packages 
- `jsonschema@1.4.1`
New version allows us to use `if` `else` clauses in the schemas
properly. By doing local tests previous versions were just letting it
pass.

- `eth-sig-util@8.1.0`
Extends `Permit` signature schema into exported `TYPED_MESSAGE_SCHEMA`,
controller already importing and validating with that schema hence no
code change is needed.

## References

<!--
Are there any issues that this pull request is tied to?
Are there other links that reviewers should consult to understand these
changes better?
Are there client or consumer pull requests to adopt any breaking
changes?

For example: 

* Fixes #12345
* Related to #67890
-->

* Fixes: MetaMask/MetaMask-planning#3582
* Extension PR:
MetaMask/metamask-extension#28916

## Recordings


https://github.com/user-attachments/assets/ac998fea-930d-4069-ae62-1f6aefff1465

## Changelog

<!--
If you're making any consumer-facing changes, list those changes here as
if you were updating a changelog, using the template below as a guide.

(CATEGORY is one of BREAKING, ADDED, CHANGED, DEPRECATED, REMOVED, or
FIXED. For security-related issues, follow the Security Advisory
process.)

Please take care to name the exact pieces of the API you've added or
changed (e.g. types, interfaces, functions, or methods).

If there are any breaking changes, make sure to offer a solution for
consumers to follow once they upgrade to the changes.

Finally, if you're only making changes to development scripts or tests,
you may replace the template below with "None".
-->

### `@metamask/signature-controller`

- **Fixed**: Extends missing `Permit` signature schema validation

## Checklist

- [X] I've updated the test suite for new or updated code as appropriate
- [X] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [X] I've highlighted breaking changes using the "BREAKING" category
above as appropriate
- [X] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes
@OGPoyraz OGPoyraz closed this Dec 9, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Dec 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
team-confirmations Push issues to confirmations team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants