feat: accounts controller by montelaidev · Pull Request #1637 · MetaMask/core

montelaidev · 2023-08-28T12:27:50Z

Explanation

Adds a new controller, accounts-controller that introduces the InternalAccount model. The InternalAccount will be used to represent accounts instead of an ethereum address.

`@metamask/accounts-controller`

ADDED: Initial release

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

socket-security · 2023-08-28T12:30:43Z

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

Packages	Version	New capabilities	Transitives	Size	Publisher
@metamask/snaps-controllers	1.0.1	None	`+0`	669 kB	metamaskbot
@metamask/snaps-utils	1.0.1	filesystem, environment	`+0`	355 kB	metamaskbot
@metamask/keyring-api	0.2.5	eval, network, filesystem	`+108`	27.9 MB	metamaskbot
@types/readable-stream	2.3.15	None	`+0`	24.6 kB	types

socket-security · 2023-08-28T12:30:46Z

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

Ignoring: @metamask/object-multiplex@1.2.0, extension-port-stream@2.1.1, validate-npm-package-name@5.0.0, string_decoder@1.0.3, webextension-polyfill-ts@0.25.0, readable-web-to-node-stream@3.0.2, detect-browser@5.3.0, pump@2.0.1, pump@3.0.0, webextension-polyfill@0.10.0, webextension-polyfill@0.7.0, is-gzip@1.0.0, rfdc@1.3.0, pumpify@1.5.1, peek-stream@1.1.3, duplexify@3.7.1, stream-shift@1.0.1, browserify-zlib@0.1.4, strnum@1.0.5, @metamask/types@1.1.0, stream-browserify@3.0.0, end-of-stream@1.4.4, gunzip-maybe@1.4.2, is-deflate@1.0.0, fs-constants@1.0.0, concat-stream@2.0.0, @metamask/snaps-execution-environments@1.0.1

Next steps

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of package-name@version specifiers. e.g. @SocketSecurity ignore foo@1.0.0 bar@* or ignore all packages with @SocketSecurity ignore-all

montelaidev · 2023-08-30T14:37:22Z

@metamaskbot publish-preview

montelaidev · 2023-09-19T16:25:15Z

@metamaskbot publish-preview

github-actions · 2023-09-19T16:32:06Z

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": "1.0.0-preview.c5136a4",
"@metamask-previews/address-book-controller": "3.1.1-preview.c5136a4",
"@metamask-previews/announcement-controller": "4.0.1-preview.c5136a4",
"@metamask-previews/approval-controller": "3.5.1-preview.c5136a4",
"@metamask-previews/assets-controllers": "11.1.0-preview.c5136a4",
"@metamask-previews/base-controller": "3.2.1-preview.c5136a4",
"@metamask-previews/composable-controller": "3.0.1-preview.c5136a4",
"@metamask-previews/controller-utils": "4.3.2-preview.c5136a4",
"@metamask-previews/ens-controller": "4.1.1-preview.c5136a4",
"@metamask-previews/gas-fee-controller": "6.1.2-preview.c5136a4",
"@metamask-previews/keyring-controller": "7.4.0-preview.c5136a4",
"@metamask-previews/logging-controller": "1.0.1-preview.c5136a4",
"@metamask-previews/message-manager": "7.3.1-preview.c5136a4",
"@metamask-previews/name-controller": "1.0.0-preview.c5136a4",
"@metamask-previews/network-controller": "12.1.2-preview.c5136a4",
"@metamask-previews/notification-controller": "3.1.1-preview.c5136a4",
"@metamask-previews/permission-controller": "4.1.1-preview.c5136a4",
"@metamask-previews/phishing-controller": "6.0.1-preview.c5136a4",
"@metamask-previews/preferences-controller": "4.4.0-preview.c5136a4",
"@metamask-previews/rate-limit-controller": "3.0.1-preview.c5136a4",
"@metamask-previews/selected-network-controller": "1.0.0-preview.c5136a4",
"@metamask-previews/signature-controller": "5.3.1-preview.c5136a4",
"@metamask-previews/transaction-controller": "10.0.0-preview.c5136a4"
}

mikesposito · 2023-09-21T08:19:03Z

+ "typescript": "~4.6.3"
+ },
+ "peerDependencies": {
+ "@metamask/keyring-controller": "^7.4.0"


We can probably remove this and leave it in devDependencies

yes, we can remove the peerDependencies. Changed in 2c2fa52

I might have given a wrong suggestion here:
Seeing how we use messenger events/actions types in other packages, we usually include the package they come from in dependencies and peerDependencies, probably to ensure that we use the same versions of that package across the dep tree
@Gudahtt might have more insights on this, but I think we should rollback these changes - sorry about that.

no problem, the change has been rolled back in d5e3b8e

Co-authored-by: Michele Esposito <34438276+mikesposito@users.noreply.github.com>

montelaidev · 2023-09-21T09:41:22Z

@metamaskbot publish-preview

github-actions · 2023-09-21T09:50:25Z

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": "0.0.0-preview.d5e3b8e",
"@metamask-previews/address-book-controller": "3.1.1-preview.d5e3b8e",
"@metamask-previews/announcement-controller": "4.0.1-preview.d5e3b8e",
"@metamask-previews/approval-controller": "3.5.1-preview.d5e3b8e",
"@metamask-previews/assets-controllers": "11.1.0-preview.d5e3b8e",
"@metamask-previews/base-controller": "3.2.1-preview.d5e3b8e",
"@metamask-previews/composable-controller": "3.0.1-preview.d5e3b8e",
"@metamask-previews/controller-utils": "4.3.2-preview.d5e3b8e",
"@metamask-previews/ens-controller": "4.1.1-preview.d5e3b8e",
"@metamask-previews/gas-fee-controller": "6.1.2-preview.d5e3b8e",
"@metamask-previews/keyring-controller": "7.4.0-preview.d5e3b8e",
"@metamask-previews/logging-controller": "1.0.1-preview.d5e3b8e",
"@metamask-previews/message-manager": "7.3.1-preview.d5e3b8e",
"@metamask-previews/name-controller": "1.0.0-preview.d5e3b8e",
"@metamask-previews/network-controller": "12.1.2-preview.d5e3b8e",
"@metamask-previews/notification-controller": "3.1.1-preview.d5e3b8e",
"@metamask-previews/permission-controller": "4.1.1-preview.d5e3b8e",
"@metamask-previews/phishing-controller": "6.0.1-preview.d5e3b8e",
"@metamask-previews/preferences-controller": "4.4.0-preview.d5e3b8e",
"@metamask-previews/rate-limit-controller": "3.0.1-preview.d5e3b8e",
"@metamask-previews/selected-network-controller": "1.0.0-preview.d5e3b8e",
"@metamask-previews/signature-controller": "5.3.1-preview.d5e3b8e",
"@metamask-previews/transaction-controller": "10.0.0-preview.d5e3b8e"
}

mikesposito

Just one more question
Other than that, looks good!

mikesposito

LGTM!

legobeat · 2023-09-22T02:06:11Z

@montelaidev What do you think about moving repos for this package for the time being? 🤔

#1699

montelaidev added 2 commits August 28, 2023 20:26

feat: initial accounts controller commit
30ed126

fix: add eth-snap-keyring dep
2b66b11

montelaidevand others added 17 commits August 28, 2023 21:22

fix: double negative in legacy account filter
a03745e

fix: fix linting warning
8f86aa7

chore: run yarn dedupe
7fccb78

fix: add missing types package
a4aa0af

Merge remote-tracking branch 'origin/main' into feat/accounts-controller
e104cf5

chore: update CHANGELOG
14c98e4

fix: changelog:validate to accounts-controller
d3eda70

fix: update accounts controller to not use code fences
7c64ed8

feat: add initial test file
223b38d

feat: add setSelectedAccount, getSelectedAccount, setAccountName tests
5472cce

fix: lower coverage temporarily
78115a7

feat: tests for getAccountExpect, listAccounts, getAccount
b518f7f

feat: add tests for updateAccounts, loadBackup
77b0595

feat: add onSnapStateChange tests
4fc9f9c

feat: add onKeyringStateChange tests
a59fab5

chore: lint
cbd11a4

chore: fix lint in package.json
4c272a7

montelaidev added 4 commits August 30, 2023 22:42

Merge branch 'main' into feat/accounts-controller
e5d9717

Merge branch 'main' into feat/accounts-controller
46bc273

chore: update yarn.lock
4b781ce

fix: change from default export and fix version
545dd17

montelaidev marked this pull request as ready for review September 5, 2023 16:31

montelaidev requested a review from a team as a code owner September 5, 2023 16:39

montelaidev added 2 commits September 6, 2023 09:44

fix: update tests and bump coverage
40e8144

chore: use keyring-api 0.2.2 and eth-snap-keyring 0.2
2c6baae

montelaidev requested review from danroc and mikesposito September 19, 2023 14:05

danroc reviewed Sep 19, 2023
View reviewed changes

Comment threadpackages/accounts-controller/src/AccountsController.ts Outdated

montelaidev added 2 commits September 19, 2023 22:59

fix: remove comment
c237821

chore: bump dep
c5136a4

montelaidev added 4 commits September 20, 2023 13:28

Merge branch 'main' into feat/accounts-controller
c5bf6b3

fix: rename legacyAccounts to normalAccounts
d6a4f88

fix: bump coverage to 100
ba6f5fe

Merge remote-tracking branch 'origin/main' into feat/accounts-controller
e743dfb

mikesposito reviewed Sep 21, 2023
View reviewed changes

montelaidevand others added 7 commits September 21, 2023 17:06

fix: bump jest coverage requirements, and update dependencies
2c2fa52

Update packages/accounts-controller/src/AccountsController.ts
bf9b101
Co-authored-by: Michele Esposito <34438276+mikesposito@users.noreply.github.com>

fix: remove unused ts-ignore and update legacy to normal
aaaa3ae

fix: add @metamask/util dep
834facc

fix: readd deepmerge
0414e45

chore: update yarn.lock
8c33bef

fix: roll back peerDep removal
d5e3b8e

mikesposito reviewed Sep 21, 2023
View reviewed changes

Comment threadpackages/accounts-controller/tsconfig.build.json Outdated
Comment threadpackages/accounts-controller/tsconfig.json Outdated

fix: remove controller-utils from tsconfig
27ae5f3

mikesposito approved these changes Sep 21, 2023
View reviewed changes

montelaidev merged commit 40f7890 into mainSep 21, 2023

montelaidev deleted the feat/accounts-controller branch September 21, 2023 11:33

legobeat mentioned this pull request Sep 22, 2023
Migrate accounts-controller to github.com/MetaMask/accounts #1699
Closed

Uh oh!

Uh oh!

Conversation

montelaidev commented Aug 28, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation

@metamask/accounts-controller

Checklist

Uh oh!

socket-securityBot commented Aug 28, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

socket-securityBot commented Aug 28, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Next steps

Uh oh!

montelaidev commented Aug 30, 2023

Uh oh!

Uh oh!

montelaidev commented Sep 19, 2023

Uh oh!

github-actionsBot commented Sep 19, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mikespositoSep 21, 2023

Choose a reason for hiding this comment

Uh oh!

montelaidevSep 21, 2023

Choose a reason for hiding this comment

Uh oh!

mikespositoSep 21, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

montelaidevSep 21, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

montelaidev commented Sep 21, 2023

Uh oh!

github-actionsBot commented Sep 21, 2023

Uh oh!

mikesposito left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mikesposito left a comment

Choose a reason for hiding this comment

Uh oh!

legobeat commented Sep 22, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

montelaidev commented Aug 28, 2023•
edited
Loading

`@metamask/accounts-controller`

socket-securityBot commented Aug 28, 2023•
edited
Loading

socket-securityBot commented Aug 28, 2023•
edited
Loading

mikespositoSep 21, 2023•
edited
Loading

montelaidevSep 21, 2023•
edited
Loading