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

Release 158.0.0 #4342

Merged
merged 21 commits into from
May 31, 2024
Merged

Release 158.0.0 #4342

merged 21 commits into from
May 31, 2024

Conversation

mcmire
Copy link
Contributor

@mcmire mcmire commented May 30, 2024

Explanation

The goal of this PR is to release any changes in packages that have not yet been released. This is a prerequisite to merging #3611.

Hence, this PR includes releases for most packages.

References

As stated above, this is a prerequisite to #3611.

Changelog

(N/A)

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 highlighted breaking changes using the "BREAKING" category above as appropriate

@mcmire mcmire force-pushed the release/158.0.0 branch 4 times, most recently from 4e7680c to 55504ed Compare May 30, 2024 19:42
@mcmire mcmire marked this pull request as ready for review May 30, 2024 19:42
@mcmire mcmire requested review from a team as code owners May 30, 2024 19:42
@mcmire
Copy link
Contributor Author

mcmire commented May 30, 2024

Pinging relevant parties that have code ownership over or have made direct changes to the packages being released here:

Please look over the changelog entries for the packages mentioned above, cross-reference them against the PRs mentioned in the changelog entries, and let me know if there are any discrepancies.

@mcmire mcmire mentioned this pull request May 30, 2024
3 tasks
@mcmire
Copy link
Contributor Author

mcmire commented May 30, 2024

Looks like #4310 was just merged. I'll try to incorporate those changes into the changelog tonight.

Co-authored-by: Jongsun Suh <jongsun.suh@icloud.com>
@mcmire
Copy link
Contributor Author

mcmire commented May 30, 2024

#4319 was also merged and I will work on incorporating this as well.

@legobeat
Copy link
Contributor

Do you think we could consider #4335 for this as well?

@mcmire
Copy link
Contributor Author

mcmire commented May 30, 2024

@legobeat Yeah, those changes seem pretty easy to add.

legobeat
legobeat previously approved these changes May 31, 2024
Copy link
Contributor

@legobeat legobeat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@dbrans
Copy link
Contributor

dbrans commented May 31, 2024

@mcmire would you be willing to include #4343 which I just merged?

Co-authored-by: Jongsun Suh <jongsun.suh@icloud.com>
montelaidev and others added 8 commits May 31, 2024 09:23
)

## Explanation

This pull request adds two new methods `getSelectedMultichainAccount`,
`listMultichainAccounts` and `selectedEvmAccountChange` event. The
optional arguments are to make the changes backwards compatible when
used with evm specific controllers.

## References

Related to:
- [381](MetaMask/accounts-planning#381)
- [419](MetaMask/accounts-planning#419)

## Changelog

### `@metamask/accounts-controller`

- **<CHANGED>**: Adds two new methods `getSelectedMultichainAccount`,
`listMultichainAccounts`, and `selectedEvmAccountChange` event

## 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

---------

Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>
… the transaction (#4343)

> [!NOTE]
> This change is intended to be cherry-picked into MetaMask/extension
v11.17.0 via an upgrade to the @metamask/transaction-controller package.
## Explanation
**Issue:**
A recent update to the transaction-controller has made the
TransactionMeta object passed to the `afterSign` hook frozen. This
change prevents adding new properties, leading to the error: “Cannot add
property custodyId, object is not extensible.” This bug is breaking all
transactions for MMI as the original txMeta cannot store required
properties like custodyId.

**Fix:**
We deep clone the transaction meta before passing it to the hook. A deep
clone is used because transactionMeta is recursively frozen by immer.
This fix was intended to minimize the change for the cherry-pick going
into v11.17.0. A longer term solution might involve using immer more
throughout the TransactionController.ts file to make it clearer when a
transactionMeta is being mutated and how.

**Testing:**
This fix was applied to and verified with the MMI extension.

<!--
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?
-->

## 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?

For example:

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

## 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/transaction-controller`

- **FIXED**: afterSign hook is now able to modify the transaction

## 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 highlighted breaking changes using the "BREAKING" category
above as appropriate
## Explanation

Adds 2 query parameters when fetching token lists:
- `includeERC20Permit=false`
- `includeStorage=false`

The best I can tell, neither field is used by extension or mobile. So
we'll instead take the reduction in network usage (~5KB on mainnet) and
controller state.

## References

https://consensyssoftware.atlassian.net/browse/API-1186

## Changelog

### `@metamask/assets-controllers`

- **BREAKING**: `TokenListController` no longer includes the fields
`storage` and `erc20Permit` in its state.

## 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 highlighted breaking changes using the "BREAKING" category
above as appropriate
dbrans
dbrans previously approved these changes May 31, 2024
@mcmire mcmire dismissed stale reviews from FrederikBolding and dbrans via f45ee7f May 31, 2024 15:57
@mcmire
Copy link
Contributor Author

mcmire commented May 31, 2024

Okay I think we're up to date with main! Ready for final approval again.

Copy link
Contributor

@cryptodev-2s cryptodev-2s left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@mcmire
Copy link
Contributor Author

mcmire commented May 31, 2024

I'm gonna pull the trigger on this before any other changes get added :)

@mcmire mcmire merged commit c2e6752 into main May 31, 2024
147 checks passed
@mcmire mcmire deleted the release/158.0.0 branch May 31, 2024 16:12
mcmire added a commit that referenced this pull request May 31, 2024
mcmire added a commit that referenced this pull request May 31, 2024
This reverts commit c2e6752.

We need to redo this release because the version set in `package.json`
was wrong and therefore the release did not go out. 🤦🏻
mcmire added a commit that referenced this pull request May 31, 2024
This is a redo of commit c2e6752, and
was already previously approved.

The goal of this PR is to release any changes in packages that have not
yet been released. This is a prerequisite to upgrading all packages to
Node 18. Hence, this PR includes releases for most packages.

See updates to changelogs for more.

---------

Co-authored-by: Jongsun Suh <jongsun.suh@icloud.com>
Co-authored-by: Monte Lai <monte.lai@consensys.net>
Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>
Co-authored-by: Derek Brans <dbrans@gmail.com>
Co-authored-by: Brian Bergeron <brian.e.bergeron@gmail.com>
mcmire added a commit that referenced this pull request May 31, 2024
This is a redo of commit c2e6752, which
did not result in a release because it did not update the version of the
root package. This commit fixes that.

The remainder of this description was copied from that commit:

The goal of this PR is to release any changes in packages that have not
yet been released. This is a prerequisite to upgrading all packages to
Node 18. Hence, this PR includes releases for most packages.

See updates to changelogs for more.

---------

Co-authored-by: Jongsun Suh <jongsun.suh@icloud.com>
Co-authored-by: Monte Lai <monte.lai@consensys.net>
Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>
Co-authored-by: Derek Brans <dbrans@gmail.com>
Co-authored-by: Brian Bergeron <brian.e.bergeron@gmail.com>
mcmire added a commit that referenced this pull request May 31, 2024
This is a redo of commit c2e6752, which
did not result in a release because it did not update the version of the
root package. This commit fixes that.

The remainder of this description was copied from that commit:

The goal of this PR is to release any changes in packages that have not
yet been released. This is a prerequisite to upgrading all packages to
Node 18. Hence, this PR includes releases for most packages.

See updates to changelogs for more.

---------

Co-authored-by: Jongsun Suh <jongsun.suh@icloud.com>
Co-authored-by: Monte Lai <monte.lai@consensys.net>
Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>
Co-authored-by: Derek Brans <dbrans@gmail.com>
Co-authored-by: Brian Bergeron <brian.e.bergeron@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants