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

feat: add MultichainBalancesController #4965

Open
wants to merge 63 commits into
base: main
Choose a base branch
from
Open

feat: add MultichainBalancesController #4965

wants to merge 63 commits into from
+1,506 −16

Conversation

gantunesr
Copy link
Member

@gantunesr gantunesr commented Nov 22, 2024 •
edited
Loading

Explanation

This PR adds a new controller to track the balance from non-EVM accounts by using the snaps as the data source.

References

Related to https://github.com/MetaMask/accounts-planning/issues/723

Changelog

@metamask/assets-controller

  • ADDED: New MultichainBalancesController to track the balance from non-EVM accounts by using the snaps as the data source

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

@gantunesr
chore: add dependencies
950a2eb
@gantunesr
feat: add MultichainBalancesController, BalancesTracker, and Poller
12a233a
@gantunesr
test: add unit test to MultichainBalancesController, BalancesTracker,…
c9b707c 
… and Poller
@gantunesr
Merge branch 'main' of https://github.com/MetaMask/core into feat/add…
b80a2da 
…-multichain-balances
@gantunesr
fix: dependencies version consistency
0c15e21
@gantunesr
test: update BtcMethod
27e2d6c
@gantunesr
test: update BtcMethod
1890789
@gantunesr
chore: add utils and constants
c07cadc
@gantunesr
refactor: construction and accounts tracking
0afee9f
@gantunesr
chore: add comments
9d6d4ec
@gantunesr
Merge branch 'main' of https://github.com/MetaMask/core into feat/add…
eca2402 
…-multichain-balances
@gantunesr
chore: small refactor to trackAccount
84a029c
@gantunesr
test: fix address validation mock
b9192af
@gantunesr
test: add utils unit test
614d072
@gantunesr
test: improve BalancesTracker unit test
2d31d3c
@gantunesr
test: improve Poller unit test
425d18a
@gantunesr
test: improve MultichainBalancesController unit test
c8e3065
@gantunesr
refactor: BalancesTracker constructor
e59a99b
@gantunesr
test: add test to updateBalance
890d317
@gantunesr gantunesr marked this pull request as ready for review December 2, 2024 03:39
@gantunesr gantunesr requested a review from a team as a code owner December 2, 2024 03:39
@gantunesr
Copy link
Member Author

@metamaskbot publish-previews

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 2, 2024

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": "20.0.0-preview-890d317c",
  "@metamask-previews/address-book-controller": "6.0.1-preview-890d317c",
  "@metamask-previews/announcement-controller": "7.0.1-preview-890d317c",
  "@metamask-previews/approval-controller": "7.1.1-preview-890d317c",
  "@metamask-previews/assets-controllers": "45.1.0-preview-890d317c",
  "@metamask-previews/base-controller": "7.0.2-preview-890d317c",
  "@metamask-previews/build-utils": "3.0.1-preview-890d317c",
  "@metamask-previews/chain-controller": "0.2.0-preview-890d317c",
  "@metamask-previews/composable-controller": "9.0.1-preview-890d317c",
  "@metamask-previews/controller-utils": "11.4.3-preview-890d317c",
  "@metamask-previews/ens-controller": "15.0.0-preview-890d317c",
  "@metamask-previews/eth-json-rpc-provider": "4.1.6-preview-890d317c",
  "@metamask-previews/gas-fee-controller": "22.0.1-preview-890d317c",
  "@metamask-previews/json-rpc-engine": "10.0.1-preview-890d317c",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.5-preview-890d317c",
  "@metamask-previews/keyring-controller": "19.0.0-preview-890d317c",
  "@metamask-previews/logging-controller": "6.0.2-preview-890d317c",
  "@metamask-previews/message-manager": "11.0.1-preview-890d317c",
  "@metamask-previews/multichain": "1.1.0-preview-890d317c",
  "@metamask-previews/name-controller": "8.0.1-preview-890d317c",
  "@metamask-previews/network-controller": "22.0.2-preview-890d317c",
  "@metamask-previews/notification-services-controller": "0.14.0-preview-890d317c",
  "@metamask-previews/permission-controller": "11.0.3-preview-890d317c",
  "@metamask-previews/permission-log-controller": "3.0.1-preview-890d317c",
  "@metamask-previews/phishing-controller": "12.3.0-preview-890d317c",
  "@metamask-previews/polling-controller": "12.0.1-preview-890d317c",
  "@metamask-previews/preferences-controller": "15.0.0-preview-890d317c",
  "@metamask-previews/profile-sync-controller": "2.0.0-preview-890d317c",
  "@metamask-previews/queued-request-controller": "8.0.0-preview-890d317c",
  "@metamask-previews/rate-limit-controller": "6.0.1-preview-890d317c",
  "@metamask-previews/remote-feature-flag-controller": "1.0.0-preview-890d317c",
  "@metamask-previews/selected-network-controller": "20.0.0-preview-890d317c",
  "@metamask-previews/signature-controller": "23.0.0-preview-890d317c",
  "@metamask-previews/transaction-controller": "41.0.0-preview-890d317c",
  "@metamask-previews/user-operation-controller": "20.0.0-preview-890d317c"
}

@gantunesr
Copy link
Member Author

@metamaskbot publish-previews

@owencraston
Copy link
Contributor

Resolves https://github.com/MetaMask/accounts-planning/issues/735

@gantunesr gantunesr requested a review from a team as a code owner December 13, 2024 21:17
@gantunesr
Copy link
Member Author

@metamaskbot publish-previews

@github-actions GitHub Actions
Copy link
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": "20.0.2-preview-80f42889",
  "@metamask-previews/address-book-controller": "6.0.2-preview-80f42889",
  "@metamask-previews/announcement-controller": "7.0.2-preview-80f42889",
  "@metamask-previews/approval-controller": "7.1.1-preview-80f42889",
  "@metamask-previews/assets-controllers": "45.1.2-preview-80f42889",
  "@metamask-previews/base-controller": "7.0.2-preview-80f42889",
  "@metamask-previews/build-utils": "3.0.2-preview-80f42889",
  "@metamask-previews/chain-controller": "0.2.2-preview-80f42889",
  "@metamask-previews/composable-controller": "10.0.0-preview-80f42889",
  "@metamask-previews/controller-utils": "11.4.4-preview-80f42889",
  "@metamask-previews/ens-controller": "15.0.1-preview-80f42889",
  "@metamask-previews/eth-json-rpc-provider": "4.1.6-preview-80f42889",
  "@metamask-previews/gas-fee-controller": "22.0.2-preview-80f42889",
  "@metamask-previews/json-rpc-engine": "10.0.1-preview-80f42889",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.5-preview-80f42889",
  "@metamask-previews/keyring-controller": "19.0.2-preview-80f42889",
  "@metamask-previews/logging-controller": "6.0.3-preview-80f42889",
  "@metamask-previews/message-manager": "11.0.3-preview-80f42889",
  "@metamask-previews/multichain": "1.1.2-preview-80f42889",
  "@metamask-previews/name-controller": "8.0.2-preview-80f42889",
  "@metamask-previews/network-controller": "22.1.1-preview-80f42889",
  "@metamask-previews/notification-services-controller": "0.15.0-preview-80f42889",
  "@metamask-previews/permission-controller": "11.0.4-preview-80f42889",
  "@metamask-previews/permission-log-controller": "3.0.2-preview-80f42889",
  "@metamask-previews/phishing-controller": "12.3.1-preview-80f42889",
  "@metamask-previews/polling-controller": "12.0.2-preview-80f42889",
  "@metamask-previews/preferences-controller": "15.0.1-preview-80f42889",
  "@metamask-previews/profile-sync-controller": "3.1.1-preview-80f42889",
  "@metamask-previews/queued-request-controller": "8.0.2-preview-80f42889",
  "@metamask-previews/rate-limit-controller": "6.0.2-preview-80f42889",
  "@metamask-previews/remote-feature-flag-controller": "1.2.0-preview-80f42889",
  "@metamask-previews/selected-network-controller": "20.0.2-preview-80f42889",
  "@metamask-previews/signature-controller": "23.1.0-preview-80f42889",
  "@metamask-previews/transaction-controller": "42.0.0-preview-80f42889",
  "@metamask-previews/user-operation-controller": "21.0.0-preview-80f42889"
}

owencraston
owencraston previously approved these changes Dec 14, 2024
View reviewed changes
cryptodev-2s
cryptodev-2s approved these changes Jan 10, 2025
View reviewed changes
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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cryptodev-2s cryptodev-2s cryptodev-2s approved these changes

@ccharly ccharly Awaiting requested review from ccharly

@bergeron bergeron Awaiting requested review from bergeron

@gambinish gambinish Awaiting requested review from gambinish

@owencraston owencraston Awaiting requested review from owencraston

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
PR review queue
Status: Needs dev review
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@gantunesr @owencraston @ccharly @bergeron @gambinish @cryptodev-2s