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.

Sign up for GitHub

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

Jump to bottom

Bring all controller packages up to date with (at least) core release 125.0.0 #24140

Open
11 of 24 tasks
mcmire opened this issue Apr 19, 2024 · 0 comments
Open
11 of 24 tasks

Bring all controller packages up to date with (at least) core release 125.0.0 #24140

mcmire opened this issue Apr 19, 2024 · 0 comments
Assignees
@mikesposito
Labels
team-wallet-framework

Comments

@mcmire
Copy link
Contributor

mcmire commented Apr 19, 2024 •
edited by legobeat

What is this about?

Release 125.0.0 of the core monorepo included new versions for all packages. We want to make sure that the extension is using at least these versions for the controllers it's using so that we know everything is using the latest version of base-controller, and also that all packages have a package.json with the correct types field.

Scenario

No response

Design

No response

Technical Details

Outdated packages:

  • @metamask/accounts-controller ^11.0.0 -> ^12.0.1 (latest: ^13.0.0)
  • @metamask/address-book-controller ^3.1.7 -> ^4.0.1
  • @metamask/approval-controller ^6.0.0 -> ^6.0.1
  • @metamask/assets-controllers ^26.0.0 (patched) -> ^27.0.1 (latest: ^28.0.0)
  • @metamask/base-controller ^4.1.0 -> ^5.0.1
  • @metamask/ens-controller ^9.0.0 -> ^10.0.1
  • @metamask/eth-keyring-controller ^16.0.0 -> remove
  • @metamask/gas-fee-controller ^14.0.0 -> ^14.0.1 (latest: ^15.0.0)
  • @metamask/keyring-controller ^13.0.0 (patched) -> ^14.0.1 (latest: ^15.0.0)
  • @metamask/logging-controller ^2.0.2 -> ^3.0.1
  • @metamask/name-controller ^4.2.0 -> ^6.0.1
  • @metamask/notification-controller ^3.0.0 -> ^5.0.1
  • @metamask/permission-log-controller ^1.0.0 -> ^2.0.1
  • @metamask/phishing-controller ^8.0.2 -> ^9.0.1
  • @metamask/rate-limit-controller ^3.0.0 -> ^5.0.1
  • @metamask/signature-controller ^12.0.0 -> ^14.0.1 (latest: ^15.0.0)
  • @metamask/user-operation-controller ^6.0.0 -> ^6.0.1 (latest: ^8.0.0)

Here is the order of how we should address these:

Threat Modeling Framework

No response

Acceptance Criteria

No response

Stakeholder review needed before the work gets merged

  • Engineering (needed in most cases)
  • Design
  • Product
  • QA (automation tests are required to pass before merging PRs but not all changes are covered by automation tests - please review if QA is needed beyond automation tests)
  • Security
  • Legal
  • Marketing
  • Management (please specify)
  • Other (please specify)

References

No response
This was referenced Apr 19, 2024
Merged
Merged
@mcmire mcmire changed the title Bring all controller packages up to date Bring all controller packages up to date with (at least) core release 124.0.0 Apr 23, 2024
@mcmire mcmire changed the title Bring all controller packages up to date with (at least) core release 124.0.0 Bring all controller packages up to date with (at least) core release 125.0.0 Apr 23, 2024
This was referenced Apr 23, 2024
Merged
Merged
Open
@mcmire mcmire self-assigned this Apr 23, 2024
@mcmire mcmire mentioned this issue Apr 24, 2024
Merged
7 tasks
mikesposito added a commit that referenced this issue May 8, 2024
@mcmire @legobeat @mikesposito
chore: Bump approval-controller to 6.0.1 (#24141)
86148a1 
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

Bumping to this version doesn't give us any changes that we need but is
merely done to ensure that we're using the latest version of this
package.

See changelog:
<https://github.com/MetaMask/core/blob/main/packages/approval-controller/CHANGELOG.md#601>

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/24141?quickstart=1)

## **Related issues**

Progresses #24140.

## **Manual testing steps**

This PR should contain no functional changes, but approvals should still
work as designed.

## **Screenshots/Recordings**

(N/A)

## **Pre-merge author checklist**

- [x] I’ve followed [MetaMask Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I’ve included tests if applicable
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

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

Co-authored-by: legobeat <109787230+legobeat@users.noreply.github.com>
Co-authored-by: Michele Esposito <34438276+mikesposito@users.noreply.github.com>
Co-authored-by: legobt <6wbvkn0j@anonaddy.me>
This was referenced May 8, 2024
Open
Merged
Merged
mikesposito added a commit that referenced this issue May 14, 2024
@mcmire @metamaskbot
@legobeat @mikesposito
chore(deps): Bump ens-controller to ^10.0.1 (#24207)
33ca43f 
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

The primary purpose for upgrading this package is to ensure that we are
using a version which relies on `@metamask/base-controller` v4, which
protects state from being mutated accidentally and includes more type
safety for messengers, among other improvements.

However, this upgrade also includes theoretical support for Sepolia and
Holesky ENS registries. I have not gotten ENS lookups to work on
anything but Mainnet (perhaps we are explicitly targeting Mainnet
somehow), but support is there should we need it.

See changelog:

https://github.com/MetaMask/core/blob/%40metamask/ens-controller%4010.0.1/packages/ens-controller/CHANGELOG.md

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/24207?quickstart=1)

## **Related issues**

Progresses #24140

## **Manual testing steps**

There should be no functional changes in this PR, but we may want to
double-check that ENS lookups still work (e.g. add an ENS name to
address book or try to send a transaction to an ENS name).

## **Screenshots/Recordings**

(None)

## **Pre-merge author checklist**

- [x] I’ve followed [MetaMask Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I’ve included tests if applicable
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

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

---------

Co-authored-by: MetaMask Bot <metamaskbot@users.noreply.github.com>
Co-authored-by: legobeat <109787230+legobeat@users.noreply.github.com>
Co-authored-by: Michele Esposito <34438276+mikesposito@users.noreply.github.com>
mikesposito added a commit that referenced this issue May 16, 2024
@mikesposito @metamaskbot @legobeat
chore(deps): Bump permission-log-controller to ^2.0.1 (#24432)
1a3de5f 
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

The primary purpose for upgrading this package is to ensure that we are
using a version that relies on `@metamask/base-controller` v4, which
protects the state from being mutated accidentally and includes more
type safety for messengers, among other improvements.

See changelog:

https://github.com/MetaMask/core/blob/%40metamask/permission-log-controller%402.0.1/packages/permission-log-controller/CHANGELOG.md

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/24432?quickstart=1)

## **Related issues**

Progresses #24140

## **Manual testing steps**

There should be no functional changes in this PR

## **Screenshots/Recordings**

None

## **Pre-merge author checklist**

- [ ] I’ve followed [MetaMask Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [ ] I've completed the PR template to the best of my ability
- [ ] I’ve included tests if applicable
- [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [ ] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

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

---------

Co-authored-by: MetaMask Bot <metamaskbot@users.noreply.github.com>
Co-authored-by: legobeat <109787230+legobeat@users.noreply.github.com>
@mcmire mcmire removed their assignment May 16, 2024
mikesposito added a commit that referenced this issue May 21, 2024
@mcmire @metamaskbot
@legobeat @mikesposito
chore: Bump logging-controller to 3.0.1 and signature-controller to 1…
4cb28a3 
…4.0.1 (#24143)

<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

Specifically, `@metamask/logging-controller` 3.0.0 relies on a new
version of `@metamask/base-controller` which protects state from being
mutated accidentally and includes more type safety for messengers, among
other improvements.

EDIT @mikesposito: Since `@metamask/signature-controller@<^14` relies on
`@metamask/logging-controller@^2`, the two packages are being updated
atomically

See changelogs: 
-
https://github.com/MetaMask/core/blob/main/packages/logging-controller/CHANGELOG.md
-
https://github.com/MetaMask/core/blob/main/packages/signature-controller/CHANGELOG.md

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/24143?quickstart=1)

## **Related issues**

Progresses #24140.

## **Manual testing steps**

This upgrade contains no functional changes.

## **Screenshots/Recordings**

(N/A)

## **Pre-merge author checklist**

- [x] I’ve followed [MetaMask Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I’ve included tests if applicable
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

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

---------

Co-authored-by: MetaMask Bot <metamaskbot@users.noreply.github.com>
Co-authored-by: legobeat <109787230+legobeat@users.noreply.github.com>
Co-authored-by: Michele Esposito <michele@esposito.codes>
Co-authored-by: Michele Esposito <34438276+mikesposito@users.noreply.github.com>
Co-authored-by: legobt <6wbvkn0j@anonaddy.me>
mikesposito added a commit that referenced this issue May 21, 2024
@mcmire @mikesposito
@metamaskbot @legobeat
chore(deps): Bump name-controller to ^6.0.1 (#24229)
1dfe07e 
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

There are a few notable changes between 4.2.0 and 6.0.1:

- Support for fetching proposed nicknames via Etherscan on Optimism
Goerli has been removed in favor of Optimism Sepolia
- Support for fetching proposed nicknames via Etherscan on Linea Sepolia
has been added
- Proposed nicknames now get automatically removed from state after 24
hours

See the changelog for more:


<https://github.com/MetaMask/core/blob/%40metamask/name-controller%406.0.1/packages/name-controller/CHANGELOG.md>

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/24229?quickstart=1)

## **Related issues**

Progresses #24140.

## **Manual testing steps**

This PR should not introduce any functional changes; the petnames
feature should continue to work as designed.

## **Screenshots/Recordings**

(None)

## **Pre-merge author checklist**

- [x] I’ve followed [MetaMask Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I’ve included tests if applicable
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

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

---------

Co-authored-by: Michele Esposito <34438276+mikesposito@users.noreply.github.com>
Co-authored-by: MetaMask Bot <metamaskbot@users.noreply.github.com>
Co-authored-by: legobeat <109787230+legobeat@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mikesposito mikesposito

Labels
team-wallet-framework
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mcmire @mikesposito