chore: Update accounts controller to v23 and related packages (transaction controller etc) #13436

owencraston · 2025-02-11T17:31:55Z

Description

This PR updates the AccountsController and the TransactionController. These are the two major updates however there are a few smaller peer dep updates as well. Here is a description of the changes...

"@metamask/accounts-controller": "^21.0.0" -> 23.1.0"

changelog
Breaking changes:
- BREAKING: Now requires SnapKeyring:account{AssetList,Balances,Transactions}Updated events to be registered on the messenger (feat(accounts-controller): re-publish Snap keyring events core#5190)
- BREAKING: Bump @metamask/snaps-controllers peer dependency from ^9.7.0 to ^9.19.0 (chore: bump @metamask/snaps-{sdk,utils,controllers} core#5265)
- Bump @metamask/base-controller from ^7.1.1 to ^8.0.0
Non breaking changes:
- Bump @metamask/keyring-api" from ^16.1.0 to ^17.0.0 (chore: bump @metamask/{keyring-api,eth-snap-keyring} core#5280)
- Bump @metamask/eth-snap-keyring from ^9.1.1 to ^10.0.0 (chore: bump @metamask/{keyring-api,eth-snap-keyring} core#5280)
- Bump @metamask/snaps-sdk from ^6.7.0 to ^6.17.1 (feat: bump snaps-sdk to v6.16.0 core#5220), (chore: bump @metamask/snaps-{sdk,utils,controllers} core#5265)
- Bump @metamask/snaps-utils from ^8.9.0 to ^8.10.0 (chore: bump @metamask/snaps-{sdk,utils,controllers} core#5265)

"@metamask/transaction-controller": "^43.0.0" -> 45.1.0

changelog
Breaking changes:
- BREAKING: Bump @metamask/accounts-controller peer dependency from ^22.0.0 to ^23.0.0

"@metamask/keyring-api": "^13.0.0" -> 17.0.0

changelog
Breaking changes:
- BREAKING: Make CaipAssetType type more restritive (refactor!: use better CAIP types + add generic type in definePattern accounts#150) It used to be a string but it has been restricted with a template literal type that matches CAIP-19 asset type.
- BREAKING: Make specific *AccountStruct.scopes more strict (fix!: make scopes more restrictive accounts#159)
- BREAKING: Remove CAIP redefinitions (refactor!: remove CAIP redefinitions accounts#167) We now rely on CAIP definitions coming @metamask/utils.
- BREAKING: Enforce that scopes contains CAIP-2 chain IDs (refactor!: enforce that scopes contains CAIP-2 chain IDs accounts#165) Initially scopes accepted CAIP-2 namespaces as well to address the EVM EOA accounts that supports all EVM chains. This has been dropped in favor of eip155:0 scope.
- BREAKING: Rename *Scopes enums to *Scope (refactor!: enforce that scopes contains CAIP-2 chain IDs accounts#165)
- BREAKING: Use CaipAccountId for ResolvedAccountAddress.address (fix(keyring-api)!: use CaipAccountId for ResolveAccountAddress.address accounts#186) This was missing from SIP-26, but we expect this address to be CAIP-10 compliant.

"@metamask/keyring-internal-api": "^2.0.0" -> 4.0.2

changelog
Breaking changes
- BREAKING: Bump @metamask/keyring-api from ^14.0.0 to ^15.0.0 (release: 23.0.0 accounts#160) The scopes from each AccountStruct types is now more strict which impact all InternalAccountStruct types.
- BREAKING: Bump @metamask/keyring-api from ^15.0.0 to ^16.0.0 (release: 24.0.0 accounts#172)
  The scopes from each AccountStruct types is now more strict (remove support of CAIP-2 namespaces) which impact all InternalAccountStruct types.
Bump @metamask/keyring-api from ^16.1.0 to ^17.0.0 (release: 26.0.0 accounts#192)

"@metamask/eth-snap-keyring": "^7.1.0" -> 10.0.0

changelog
Breaking changes:
- BREAKING: Bump @metamask/keyring-api from ^12.0.0 to ^13.0.0 (feat(keyring-api)!: add scopes field to KeyringAccount accounts#101)
  This change was not properly reported as breaking on the 7.1.0.
  KeyringAccount and InternalAccount have a new required field (scopes) and are part of the public API.
- BREAKING: Bump @metamask/keyring-internal-api from ^1.0.0 to ^2.0.0 (release: 18.0.0 accounts#135)
  This change was not properly reported as breaking on the 7.1.0.
  InternalAccount extends KeyringAccount which has a new required field (scopes) and is part of the public API.
- BREAKING: Bump @metamask/keyring-snap-internal-client from ^1.0.0 to ^2.0.0 (release: 18.0.0 accounts#135)
  This change was not properly reported as breaking on the 7.1.0.
  KeyringAccount has a new required field (scopes) and is part of the public API.
- BREAKING: Use Messenger instead of SnapsController (feat!: use Messenger instead of SnapsController accounts#152)
  This allows to break the runtime dependency we had with some snaps-* pacakges.
- BREAKING: Make scopes more strict (fix!: make scopes more restrictive accounts#159)
  We now use specific *AccountStucts when checking created/updated accounts to make the scopes sent by the Snap are valid regarding their account type definition.
- BREAKING: Use CaipAccountId for ResolvedAccountAddress.address (fix(keyring-api)!: use CaipAccountId for ResolveAccountAddress.address accounts#186)
  This was missing from SIP-26, but we expect this address to be CAIP-10 compliant.

"@metamask/snaps-sdk": "^6.13.0" -> 6.17.1

changelog
no breaking changes

"@metamask/snaps-utils": "^8.6.1" -> ^8.10.0

changelog
no breaking changes

Related issues

Fixes: #13374
Fixes: #13377

Manual testing steps

Testing snap accounts

ensure you are building metamask flask by setting the value of METAMASK_BUILD_TYPE to flask in your .js.env
source .js.env
yarn setup
yarn start:ios
create/import a wallet
click on the selected account at the top of the home page
click on the Add account button
then click the Add Solana account (Beta) button
a popup with a suggested name should appeaer
click OK, the account should now be added to your account list. if you have a balance on this address then it should show in the portfolio view.
repeat the above steps with the Bitcoin and Bitcoin testnet account

Testing transactions

ensure you are NOT building flask by setting the value of METAMASK_BUILD_TYPE to main in your .js.env
source .js.env
yarn setup
yarn start:ios
import an account that has funds
click on the selected account at the top of the screen and the account list should open
then click on the add account button, then click add account
a new eth account should appear in your wallet
click on main bottom tab navigator icon which should open a list of actions, select Send.
the Send flow should open.
set your from account to the account that has funds and the to account to your newly created account.
type in a valid amount then go through the rest of the send flow
in the end the transaction should go through.
the account balances on the home page should be updated

Screenshots/Recordings

Before

After

On-boarding and Account Creation Flow

Screen.Recording.2025-02-12.at.9.11.39.PM.mov

Send flow

Screen.Recording.2025-02-12.at.9.30.18.PM.mov

Pre-merge author checklist

I’ve followed MetaMask Contributor Docs and MetaMask Mobile Coding Standards.
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 format if applicable
I’ve applied the right labels on the PR (see labeling guidelines). 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.

github-actions · 2025-02-11T17:32:08Z

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

socket-security · 2025-02-11T17:33:06Z

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

Package	New capabilities	Transitives	Size	Publisher
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`0`	289 kB	metamaskbot
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`0`	144 kB	danfinlay, gudahtt, kumavis, ...6 more
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`+1`	488 kB	metamaskbot
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`0`	948 kB	metamaskbot
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`0`	544 kB	metamaskbot
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`0`	35.7 kB	metamaskbot
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`0`	66.2 kB	metamaskbot
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`0`	119 kB	metamaskbot
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`0`	54.8 kB	metamaskbot
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`0`	1.52 MB	metamaskbot
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`0`	1.39 MB	metamaskbot
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`0`	2.21 MB	metamaskbot
npm/@noble/[email protected] 🔁 npm/@noble/[email protected], npm/@noble/[email protected]	None	`0`	1.5 MB	paulmillr
npm/@scure/[email protected] 🔁 npm/@scure/[email protected]	None	`0`	133 kB	paulmillr
npm/@scure/[email protected] 🔁 npm/@scure/[email protected]	None	`0`	58.7 kB	paulmillr
npm/@scure/[email protected] 🔁 npm/@scure/[email protected]	None	`0`	374 kB	paulmillr
npm/[email protected] 🔁 npm/[email protected]	None	`0`	83.7 kB	paulmillr

View full report↗︎

patches/@metamask+keyring-controller+19.0.1.patch

github-actions · 2025-02-13T02:35:36Z

Bitrise

❌❌❌ pr_smoke_e2e_pipeline failed on Bitrise! ❌❌❌

Commit hash: 0b6e757
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/7c2fda5e-d7b1-4151-8212-0fb2ee86a5f6

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

Tip

Check the documentation if you have any doubts on how to understand the failure on bitrise

app/store/migrations/066.test.ts

app/store/migrations/066.ts

app/store/migrations/067.test.ts

github-actions · 2025-02-13T17:59:54Z

Bitrise

❌❌❌ pr_smoke_e2e_pipeline failed on Bitrise! ❌❌❌

Commit hash: 0cb9202
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/4b8c4af0-549c-4a00-9f07-b6c7a8231ed9

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

Tip

Check the documentation if you have any doubts on how to understand the failure on bitrise

github-actions · 2025-02-13T18:44:22Z

Bitrise

🔄🔄🔄 pr_smoke_e2e_pipeline started on Bitrise...🔄🔄🔄

Commit hash: d5e19ab
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/39101d34-04bf-463a-bedf-6ecfd3a9a530

Note

This comment will auto-update when build completes
You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

codecov-commenter · 2025-02-13T19:06:10Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.83%. Comparing base (351a276) to head (d121b01).

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #13436   +/-   ##
=======================================
  Coverage   61.83%   61.83%           
=======================================
  Files        1975     1977    +2     
  Lines       43847    43854    +7     
  Branches     5926     5928    +2     
=======================================
+ Hits        27111    27118    +7     
  Misses      14935    14935           
  Partials     1801     1801

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

github-actions · 2025-02-13T19:16:19Z

Bitrise

❌❌❌ pr_smoke_e2e_pipeline failed on Bitrise! ❌❌❌

Commit hash: d121b01
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/9e662c0f-d1f2-4cff-b813-4efdc2722236

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

Tip

Check the documentation if you have any doubts on how to understand the failure on bitrise

scripts/setup.mjs

app/store/migrations/067.ts

github-actions · 2025-02-13T20:19:33Z

Bitrise

🔄🔄🔄 pr_smoke_e2e_pipeline started on Bitrise...🔄🔄🔄

Commit hash: 0e35bd9
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/2a151230-6709-453b-b6cf-9e7c5f59ae48

Note

This comment will auto-update when build completes
You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

sonarqubecloud · 2025-02-13T20:28:31Z

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

owencraston force-pushed the chore/accounts-controller-23 branch 2 times, most recently from f787633 to e1a6c36 Compare February 12, 2025 01:48

owencraston mentioned this pull request Feb 12, 2025

chore: bump @metamask/base-controller to ^8.0.0 #13460

Merged

7 tasks

owencraston force-pushed the chore/accounts-controller-23 branch 2 times, most recently from 48a5ca2 to 4292b49 Compare February 12, 2025 20:23

owencraston added the team-accounts label Feb 12, 2025

owencraston commented Feb 12, 2025

View reviewed changes

patches/@metamask+keyring-controller+19.0.1.patch Outdated Show resolved Hide resolved

owencraston added the Run Smoke E2E Triggers smoke e2e on Bitrise label Feb 13, 2025

owencraston changed the title ~~chore: Update accounts controller to v23 and related packages (transaction controller)~~ chore: Update accounts controller to v23 and related packages (transaction controller etc) Feb 13, 2025

owencraston marked this pull request as ready for review February 13, 2025 05:46

owencraston requested review from a team as code owners February 13, 2025 05:46

ccharly reviewed Feb 13, 2025

View reviewed changes

owencraston force-pushed the chore/accounts-controller-23 branch 2 times, most recently from 2667656 to b04ed3b Compare February 13, 2025 17:16

owencraston added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Feb 13, 2025

tommasini previously approved these changes Feb 13, 2025

View reviewed changes

gantunesr reviewed Feb 13, 2025

View reviewed changes

scripts/setup.mjs Show resolved Hide resolved

gantunesr reviewed Feb 13, 2025

View reviewed changes

app/store/migrations/067.ts Outdated Show resolved Hide resolved

owencraston dismissed tommasini’s stale review via e8df17a February 13, 2025 20:17

owencraston added 20 commits February 13, 2025 13:18

update packages

9a3c9e2

update types

4829713

update keyring-internal-api

8af7f42

add resolution

c5d5069

remove resolution

b075cc2

use controller messenger

736fe66

fix type errors

c218268

remove keyring controller patch

b5219c6

erro on fail for patch package

67abfce

add new snapkeyring events

1093097

migration 67

bb4561a

run migration 66/67 for old scope values

aed460d

add missing actions to snap keyring

b0c9b9a

fix snapkeyring builder types

04d9606

update migration logic

0e028b4

remove keyring controller update

e6c6968

fix lint

49db370

fix account controller tests

8f06ca7

update snapshot

4f4fb9c

add more detail to comment

0e35bd9

owencraston force-pushed the chore/accounts-controller-23 branch from e8df17a to 0e35bd9 Compare February 13, 2025 20:18

owencraston added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Feb 13, 2025

gantunesr approved these changes Feb 13, 2025

View reviewed changes

tommasini approved these changes Feb 13, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Update accounts controller to v23 and related packages (transaction controller etc) #13436

chore: Update accounts controller to v23 and related packages (transaction controller etc) #13436

owencraston commented Feb 11, 2025 •

edited

Loading

github-actions bot commented Feb 11, 2025

socket-security bot commented Feb 11, 2025 •

edited

Loading

github-actions bot commented Feb 13, 2025 •

edited by metamaskbot

Loading

github-actions bot commented Feb 13, 2025 •

edited by metamaskbot

Loading

github-actions bot commented Feb 13, 2025

codecov-commenter commented Feb 13, 2025

github-actions bot commented Feb 13, 2025 •

edited by metamaskbot

Loading

github-actions bot commented Feb 13, 2025

sonarqubecloud bot commented Feb 13, 2025

chore: Update accounts controller to v23 and related packages (transaction controller etc) #13436

Are you sure you want to change the base?

chore: Update accounts controller to v23 and related packages (transaction controller etc) #13436

Conversation

owencraston commented Feb 11, 2025 • edited Loading

Description

"@metamask/accounts-controller": "^21.0.0" -> 23.1.0"

"@metamask/transaction-controller": "^43.0.0" -> 45.1.0

"@metamask/keyring-api": "^13.0.0" -> 17.0.0

"@metamask/keyring-internal-api": "^2.0.0" -> 4.0.2

"@metamask/eth-snap-keyring": "^7.1.0" -> 10.0.0

"@metamask/snaps-sdk": "^6.13.0" -> 6.17.1

"@metamask/snaps-utils": "^8.6.1" -> ^8.10.0

Related issues

Manual testing steps

Testing snap accounts

Testing transactions

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Feb 11, 2025

socket-security bot commented Feb 11, 2025 • edited Loading

github-actions bot commented Feb 13, 2025 • edited by metamaskbot Loading

Bitrise

github-actions bot commented Feb 13, 2025 • edited by metamaskbot Loading

Bitrise

github-actions bot commented Feb 13, 2025

Bitrise

codecov-commenter commented Feb 13, 2025

Codecov Report

github-actions bot commented Feb 13, 2025 • edited by metamaskbot Loading

Bitrise

github-actions bot commented Feb 13, 2025

Bitrise

sonarqubecloud bot commented Feb 13, 2025

Quality Gate passed

owencraston commented Feb 11, 2025 •

edited

Loading

socket-security bot commented Feb 11, 2025 •

edited

Loading

github-actions bot commented Feb 13, 2025 •

edited by metamaskbot

Loading

github-actions bot commented Feb 13, 2025 •

edited by metamaskbot

Loading

github-actions bot commented Feb 13, 2025 •

edited by metamaskbot

Loading