Skip to content

chore: bump keyring packages - #5405

Merged
mikesposito merged 7 commits into
mainfrom
mikesposito/bump-keyrings
Mar 3, 2025
Merged

mikesposito merged 7 commits into
mainfrom
mikesposito/bump-keyrings

Conversation

@mikesposito

@mikesposito mikesposito commented Feb 27, 2025 •

Copy link
Copy Markdown
Member

Explanation

This PR bumps these packages across the core controllers:

  • @metamask/eth-simple-keyring
  • @metamask/eth-hd-keyring
  • @metamask/keyring-internal-api

The package is being updated on Extension by this PR: MetaMask/metamask-extension#30637

References

Changelog

@metamask/keyring-controller

  • CHANGED: Bump @metamask/eth-simple-keyring from ^8.1.0 to ^9.0.0 (#5405)
  • CHANGED: Bump @metamask/eth-hd-keyring from ^10.0.0 to ^11.0.0 (#5405)
  • CHANGED: Bump @metamask/keyring-internal-api from ^4.0.3 to ^5.0.0 (#5405)

@metamask/accounts-controller

  • CHANGED: Bump @metamask/keyring-internal-api from ^4.0.3 to ^5.0.0 (#5405)

@metamask/profile-sync-controller

  • CHANGED: Bump @metamask/keyring-internal-api from ^4.0.3 to ^5.0.0 (#5405)

@metamask/assets-controller

  • CHANGED: Bump @metamask/keyring-internal-api from ^4.0.3 to ^5.0.0 (#5405)

@metamask/multichain-transaction-controller

  • CHANGED: Bump @metamask/keyring-internal-api from ^4.0.3 to ^5.0.0 (#5405)

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
  • I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

@socket-security

socket-security Bot commented Feb 27, 2025 •

Copy link
Copy Markdown

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

Package New capabilities Transitives Size Publisher
npm/@metamask/eth-hd-keyring@11.0.0 None 0 143 kB metamaskbot
npm/@metamask/eth-simple-keyring@9.0.0 None 0 79 kB metamaskbot
npm/@metamask/keyring-internal-api@5.0.0 None +1 829 kB metamaskbot

View full report↗︎

Have feedback? Participate in our User Experience Survey 📊

Comment thread eslint-warning-thresholds.json Resolved
@mikesposito

Copy link
Copy Markdown
Member Author

@metamaskbot publish-preview

@github-actions

Copy link
Copy Markdown
Contributor

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.
{
  "@metamask-previews/accounts-controller": "24.1.0-preview-b8f29301",
  "@metamask-previews/address-book-controller": "6.0.3-preview-b8f29301",
  "@metamask-previews/announcement-controller": "7.0.3-preview-b8f29301",
  "@metamask-previews/approval-controller": "7.1.3-preview-b8f29301",
  "@metamask-previews/assets-controllers": "51.0.2-preview-b8f29301",
  "@metamask-previews/base-controller": "8.0.0-preview-b8f29301",
  "@metamask-previews/bridge-controller": "1.0.0-preview-b8f29301",
  "@metamask-previews/bridge-status-controller": "1.0.0-preview-b8f29301",
  "@metamask-previews/build-utils": "3.0.3-preview-b8f29301",
  "@metamask-previews/composable-controller": "11.0.0-preview-b8f29301",
  "@metamask-previews/controller-utils": "11.5.0-preview-b8f29301",
  "@metamask-previews/earn-controller": "0.5.0-preview-b8f29301",
  "@metamask-previews/ens-controller": "15.0.2-preview-b8f29301",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-b8f29301",
  "@metamask-previews/gas-fee-controller": "22.0.3-preview-b8f29301",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-b8f29301",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-b8f29301",
  "@metamask-previews/keyring-controller": "19.2.1-preview-b8f29301",
  "@metamask-previews/logging-controller": "6.0.4-preview-b8f29301",
  "@metamask-previews/message-manager": "12.0.1-preview-b8f29301",
  "@metamask-previews/multichain": "3.0.0-preview-b8f29301",
  "@metamask-previews/multichain-network-controller": "0.1.2-preview-b8f29301",
  "@metamask-previews/multichain-transactions-controller": "0.5.0-preview-b8f29301",
  "@metamask-previews/name-controller": "8.0.3-preview-b8f29301",
  "@metamask-previews/network-controller": "22.2.1-preview-b8f29301",
  "@metamask-previews/notification-services-controller": "1.0.0-preview-b8f29301",
  "@metamask-previews/permission-controller": "11.0.6-preview-b8f29301",
  "@metamask-previews/permission-log-controller": "3.0.3-preview-b8f29301",
  "@metamask-previews/phishing-controller": "12.4.0-preview-b8f29301",
  "@metamask-previews/polling-controller": "12.0.3-preview-b8f29301",
  "@metamask-previews/preferences-controller": "15.0.2-preview-b8f29301",
  "@metamask-previews/profile-sync-controller": "8.1.1-preview-b8f29301",
  "@metamask-previews/queued-request-controller": "9.0.1-preview-b8f29301",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-b8f29301",
  "@metamask-previews/remote-feature-flag-controller": "1.5.0-preview-b8f29301",
  "@metamask-previews/selected-network-controller": "21.0.1-preview-b8f29301",
  "@metamask-previews/signature-controller": "23.2.1-preview-b8f29301",
  "@metamask-previews/token-search-discovery-controller": "2.1.0-preview-b8f29301",
  "@metamask-previews/transaction-controller": "46.0.0-preview-b8f29301",
  "@metamask-previews/user-operation-controller": "25.0.0-preview-b8f29301"
}


## [19.2.1]

### Changed

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

There are some changelog entries that have been misplaced: they are under 19.2.1 but they are actually unreleased

@mikesposito
mikesposito marked this pull request as ready for review March 3, 2025 10:01
@mikesposito
mikesposito requested review from a team as code owners March 3, 2025 10:01
Comment on lines -2462 to +2434
// @ts-expect-error Enforce data type after updating clients
await keyring.deserialize(data);
if (data) {
// @ts-expect-error Enforce data type after updating clients
await keyring.deserialize(data);
}

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Just want to make sure that this gets noticed: KeyringController now doesn't call keyring.deserialize if there's no data to pass

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I did saw it, and I think that actually make sense that way too. :)

@mikesposito
mikesposito enabled auto-merge (squash) March 3, 2025 14:23
@mikesposito
mikesposito merged commit ee1e79d into main Mar 3, 2025
@mikesposito
mikesposito deleted the mikesposito/bump-keyrings branch March 3, 2025 14:28
github-merge-queue Bot pushed a commit to MetaMask/metamask-extension that referenced this pull request Mar 7, 2025
<!--
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?
-->
These packages are being bumped to their latest version:
### `@metamask/keyring-controller`

- **BREAKING:** `addNewKeyring` method now returns
`Promise<KeyringMetadata>` instead of `Promise<unknown>`
([#5372](MetaMask/core#5372))
- Consumers can use the returned `KeyringMetadata.id` to access the
created keyring instance via `withKeyring`.
- **BREAKING:** `withKeyring` method now requires a callback argument of
type `({ keyring: SelectedKeyring; metadata: KeyringMetadata }) =>
Promise<CallbackResult>`
([#5372](MetaMask/core#5372))
- Bump `@metamask/keyring-internal-api` from `^4.0.3` to `^5.0.0`
([#5405](MetaMask/core#5405))
- Bump `@metamask/eth-hd-keyring` from `^10.0.0` to `^11.0.0`
([#5405](MetaMask/core#5405))
- Bump `@metamask/eth-simple-keyring` from `^8.1.0` to `^9.0.0`
([#5405](MetaMask/core#5405))

### `@metamask/profile-sync-controller`

- Bump `@metamask/keyring-internal-api` from `^4.0.3` to `^5.0.0`
([#5405](MetaMask/core#5405))

### `@metamask/eth-ledger-bridge-keyring`
- **BREAKING:** `LedgerKeyring` now implements the `Keyring` type
([#194](MetaMask/accounts#194))
    - The class does not extend `EventEmitter` anymore.
- The `LedgerKeyring.accounts` class variable is now a `readonly Hex[]`
array.
    - The `addAccounts` method signature has been changed:
- An `amount` number parameter is now required to specify the number of
accounts to add.
- The method now returns a promise resolving to an array of `Hex`
addresses.
    - The `unlock` method now returns `Promise<Hex>`.
    - The `getAccounts` method now returns `Promise<Hex[]>`.
- The `deserialize` method now requires a `LedgerKeyringSerializedState`
typed parameter.
- The `signTransaction` method now accepts an `Hex` typed value as the
`address` parameter.
- The `signMessage` method now accepts an `Hex` typed value as the
`withAccount` parameter.
- The `signPersonalMessage` method now accepts an `Hex` typed value as
the `withAccount` parameter.
- The `signTypedData` method now accepts an `Hex` typed value as the
`withAccount` parameter.
- The `unlockAccountByAddress` method now accepts an `Hex` typed value
as the `address` parameter.

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

## **Related issues**

Fixes:

## **Manual testing steps**

1. Go to this page...
2.
3.

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/main/.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/main/.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>
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.

5 participants