feat: MultichainBalanceController #12599

owencraston · 2024-12-06T22:12:32Z

Description

Builds off of the work done in this PR.

This PR adds the ability to see your non EVM token balance and the fiat token rates (Solana and Bitcoin accounts)
This is achieved by using the RatesController and the MultichainBalanceController
This PR also extract the balance logic from the PortfolioBalance PR into the useMultichainBalances hook
creates the selectors for multichain non evm

This PR DOES NOT...

show the correct native token balance in the account picker. This will be done in a following PR that builds off of this work.
enable token details for these non evm assets. (for now it will simply show no data)

Related issues

Fixes: https://github.com/MetaMask/accounts-planning/issues/696

Manual testing steps

checkout this branch
open .js.env
set export METAMASK_BUILD_TYPE="flask" // flask
source .js.env
yarn setup
yarn start:ios
create/import a wallet
open the account menu actions
you should see that you can add a BTC and BTC Testnet account
click Add a new Bitcoin account (Beta)
a popup with a suggested name should appear click confirm
the newly selected account should be your Bitcoin account and the network picker should show the Bitcoin logo the network should not be clickable
Optionally, create a testnet account and fund it with this faucet: https://bitcoinfaucet.uo1.net/
If you have a balance, you should see the fiat balance rendered on the wallet
if not you have a balance, then you should see a 0 fiat balance.
If you change your selected currency (settings/general) and then return to the main wallet view, the balance should update based on the new fiat currency.
The token list should also list your account balance in both fiat and and the native token balance.
the token displayed should be the BTC logo and not have any network badge above it (like the eth account does)
now add a bitcoin TestNet account.
the portfolio balance should show the native token balance not the fiat balance.
repeat the above steps but this time add a new Solana account. If your Solana account has a balance, it should be rendered on the home page in fiat. If not you should see a 0 balance.
we do not currently support Solana testnet accounts.

Screenshots/Recordings

Before

After

Screen.Recording.2025-01-28.at.10.10.54.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 · 2024-12-06T22:12:46Z

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.

sonarqubecloud · 2024-12-12T01:55:20Z

Quality Gate failed

Failed conditions
26.8% Coverage on New Code (required ≥ 60%)

See analysis details on SonarQube Cloud

@ccharly

# **Description** The primary purpose of this PR is to update the accounts controller and the assets-controller to the latest version. In doing that, there were several other package updates that were needed. Here is a summary of the updates... # 🔴 Major updates 🔴 ### "@metamask/accounts-controller": "^20.0.1" -> ^21.0.0 - [changelog](https://github.com/MetaMask/core/blob/main/packages/accounts-controller/CHANGELOG.md#2100) - Breaking changes - BREAKING: Add scopes field to KeyringAccount (MetaMask/core#5066), (MetaMask/core#5136) This field is now required and will be used to identify the supported chains (using CAIP-2 chain IDs) for every accounts. - Changes - Bump @metamask/base-controller from ^7.0.0 to ^7.1.1 (MetaMask/core#5079), (MetaMask/core#5135) - Bump @metamask/utils to ^11.0.1 (MetaMask/core#5080) - Bump @metamask/rpc-errors to ^7.0.2 (MetaMask/core#5080) - Use new @metamask/keyring-internal-api@^1.0.0 (MetaMask/core#4695) This package has been split out from the Keyring API. - Bump @metamask/keyring-api from ^10.1.0 to ^12.0.0 (MetaMask/core#4695) - Bump @metamask/eth-snap-keyring from ^5.0.1 to ^7.0.0 (MetaMask/core#4695) ESM/CommonJS support. ### "@metamask/assets-controllers": "^45.1.1", -> ^46.0.0", - [changelog](https://github.com/MetaMask/core/blob/main/packages/assets-controllers/CHANGELOG.md#4600) - Breaking changes - BREAKING: Bump @metamask/accounts-controller peer dependency from ^20.0.0 to ^21.0.0 (MetaMask/core#5140) - Changes - Remove use of @metamask/keyring-api (MetaMask/core#4695) @metamask/providers and webextension-polyfill peer dependencies are no longer required. - Use new @metamask/keyring-internal-api@^1.0.0 (MetaMask/core#4695) This package has been split out from the Keyring API. Its types are compatible with the @metamask/keyring-api package used previously. - Bump @metamask/base-controller from ^7.0.0 to ^7.1.1 (MetaMask/core#5079), (MetaMask/core#5135) - Bump @metamask/keyring-api from ^12.0.0 to ^13.0.0 (MetaMask/core#5066) - Bump @metamask/utils to ^11.0.1 (MetaMask/core#5080) - Bump @metamask/rpc-errors to ^7.0.2 (MetaMask/core#5080) - Added - Add new MultichainBalancesController (MetaMask/core#4965) This controller has been migrated from the MetaMask extension codebase. ### "@metamask/utils": "^10.0.1" -> ^11.0.1" - [changelog](https://github.com/MetaMask/utils/blob/main/CHANGELOG.md#1101) - breaking changes - BREAKING: generateRandomMnemonic now returns Promise<void> instead of void (MetaMask/utils#222) ### Added "@metamask/keyring-internal-api": "^2.0.0", - [changelog](https://github.com/MetaMask/accounts/blob/main/packages/keyring-internal-api/CHANGELOG.md#200) - This package was a peer dep on the latest accounts controller and assets controller. Given this I figured we should add it now anyway. - Changes needed - update imports from `@metamask/keyring-api` to `@metamask/keyring-internal-api` - add support for scopes in the InternalAccount object - added migration (066.ts) to backfill the scopes to existing accounts. - This change is based off a [similar change made in the extension](MetaMask/metamask-extension#29195) made by @ccharly ### Added @metamask/keyring-snap-client: "^2.0.0" - [changelog](https://github.com/MetaMask/accounts/blob/main/packages/keyring-snap-client/CHANGELOG.md#200) - Added because KeyringClient is now exported from `@metamask/keyring-snap-client` instead of `@metamask/keyring-api'`. See `app/components/Views/AddAccountActions/AddAccountActions.tsx` for changes. ### "@metamask/keyring-api": "^10.1.0", -> ^13.0.0" - [changelog](https://github.com/MetaMask/accounts/blob/main/packages/keyring-api/CHANGELOG.md#1300) - Breaking changes - BREAKING: Add scopes field to KeyringAccount (MetaMask/accounts#101) - BREAKING: Split into several smaller packages (MetaMask/accounts#24) - This should improve dependencies management. - Internal related types (internal to both clients) have been moved to keyring-internal-* packages. - Keyring API clients (mainly used by dapps) have been moved to keyring-snap-client package. - Common utils have been moevd to keyring-utils package. ### "@metamask/eth-snap-keyring": "^5.0.1" -> ^7.0.0" - [changelog](https://github.com/MetaMask/accounts/blob/main/packages/keyring-eth-simple/CHANGELOG.md#700) - breaking changes - BREAKING: Increase minimum Node.js version to 16 (MetaMask/eth-simple-keyring#152) - BREAKING: Bump @metamask/eth-sig-util from ^6.0.1 to ^7.0.0 (MetaMask/eth-simple-keyring#156) - Bump @metamask/utils from ^5.0.0 to ^8.1.0 (MetaMask/eth-simple-keyring#153) - Bump ethereum-cryptography from ^1.2.0 to ^2.1.2 (MetaMask/eth-simple-keyring#153) - BREAKING: Bump @metamask/eth-sig-util dependency from ^7.0.3 to ^8.0.0 (MetaMask/accounts#79) - signTypedData no longer support number for addresses, see [here](https://github.com/MetaMask/eth-sig-util/blob/main/CHANGELOG.md#800). ## 🟡 Minor updates 🟡 ### "@metamask/base-controller": "^7.0.1", -> ^7.1.1 - [changelog](https://github.com/MetaMask/core/blob/main/packages/base-controller/CHANGELOG.md#711) - Changes - Bump @metamask/utils from ^10.0.0 to ^11.0.1 - Rename ControllerMessenger to Messenger (MetaMask/core#5050) - ControllerMessenger has been renamed to Messenger - RestrictedControllerMessengerConstraint has been renamed to RestrictedMessengerConstraint - RestrictedControllerMessenger has been renamed to RestrictedMessenger - The RestrictedMessenger constructor parameter controllerMessenger has been renamed to messenger, though the old name is still accepted - The old names remain exported as deprecated aliases of the new names, so this is not a breaking change. ### "@metamask/providers": "^18.1.0" -> ^18.3.1" - [changelog](https://github.com/MetaMask/providers/blob/main/CHANGELOG.md#1831) - Changes - Bump @metamask/json-rpc-engine from ^10.0.1 to ^10.0.2 (MetaMask/providers#397) - Bump @metamask/json-rpc-middleware-stream from ^8.0.5 to ^8.0.6 (MetaMask/providers#397) - Bump @metamask/rpc-errors from ^7.0.1 to ^7.0.2 (MetaMask/providers#397) - Bump @metamask/utils from ^10.0.0 to ^11.0.1 (MetaMask/providers#397) ## 🟢 Patch updates 🟢 ### "@metamask/json-rpc-engine": "^10.0.0" -> ^10.0.2", - [changelog](https://github.com/MetaMask/core/blob/main/packages/json-rpc-engine/CHANGELOG.md#1002) ### "@metamask/json-rpc-middleware-stream": "^8.0.2" -> 8.0.6" - [changelog](https://github.com/MetaMask/core/blob/main/packages/json-rpc-middleware-stream/CHANGELOG.md#806) - changed - Bump @metamask/json-rpc-engine from ^10.0.1 to ^10.0.2 (MetaMask/core#5082) - Bump @metamask/utils from ^10.0.0 to ^11.0.1 (MetaMask/core#5080) ### "@metamask/rpc-errors": "^7.0.1" -> ^7.0.2" - [changelog](https://github.com/MetaMask/rpc-errors/blob/main/CHANGELOG.md#702) - changes - Bump @metamask/utils from ^10.0.0 to ^11.0.1 (MetaMask/rpc-errors#166) ## **Related issues** Fixes: #12967 Fixes: #12966 Fixes: MetaMask/accounts-planning#758 Unblocks: #12599 ## **Manual testing steps** #### Basic import account flow with tokens https://github.com/user-attachments/assets/1a8d3e59-34e4-413e-a3e8-7dbdc5f7424a ## **Screenshots/Recordings**  ### **Before**  ### **After**  ## **Pre-merge author checklist** - [ ] I’ve followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile Coding Standards](https://github.com/MetaMask/metamask-mobile/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-mobile/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.

socket-security · 2025-01-16T23:56:00Z

No dependency changes detected. Learn more about Socket for GitHub ↗︎

👍 No dependency changes detected in pull request

app/reducers/multichain/index.ts

app/components/hooks/usePortfolioBalance/usePortfolioBalance.ts

app/core/Engine/controllers/RatesController/utils.ts

app/hooks/usePortfolioBalance/index.ts

gambinish

Thanks again for reminding me about this!

I mostly reviewed the logic in the usePortfolioBalance hooks, and left a few comments. Overall I think the approach makes sense. I do see a couple places where we might be able to simplify the business logic a bit, and also a question about some potential duplication of code.

owencraston · 2025-02-06T20:57:36Z

Noticing the following issue on the Account Picker component:
The amount showed suggests that my Bitcoin Account should have a balance of ETH, should this be BTC? It's also not reflecting my BTC balance that I see on the token list for my Testnet account I created:

@gambinish This change is out of scope for this PR. The next issue that I tackle will solve this problem as it will piggy back on the changes made in this PR. I am not doing this now since the changes for this PR are already massive and this is a flask only feature so none of this flawed Ux will make it into production.

owencraston · 2025-02-06T21:01:21Z

Also, we may want to considering piping in the balance from the token list item into the token detail page:
However, I'm not sure if this token details view is in scope, since it seems that we are still missing market data related to BTC token. Maybe we should consider deactivating the navigation on non-EVM assets. Has product weighed in at all here?
Sidenote that on the token details page, I'm still seeing the ETH mainnet network logo

@gambinish I would prefer to handle this in a separate PR in order to keep the changes minimal (or at least not let them grow beyond where they have now). This is a flask only feature so it will never make it into production, therefore I feel comfortable shipping this as it. The token details page handles this lack of data fairly gracefully already so the UX is not that bad IMO but I will defer to @gantunesr.

sonarqubecloud · 2025-02-06T21:05:37Z

Quality Gate passed

Issues
7 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

github-actions · 2025-02-06T21:11:35Z

Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: f04d4de
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/eeab7045-59bd-466b-af0f-baa3051d30f9

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

metamaskbot added the team-accounts label Dec 6, 2024

owencraston force-pushed the feat/multichain-balance-controller branch 4 times, most recently from a99e4bf to 31f3fec Compare December 12, 2024 01:43

owencraston force-pushed the feat/multichain-balance-controller branch 3 times, most recently from 6de9d8b to b382ed0 Compare December 16, 2024 18:47

owencraston force-pushed the feat/multichain-balance-controller branch from b382ed0 to 2daef89 Compare January 11, 2025 00:10

owencraston mentioned this pull request Jan 14, 2025

Update metamask/assets-controllers to version 46.0.0 #12967

Closed

owencraston force-pushed the feat/multichain-balance-controller branch from 2daef89 to 569a930 Compare January 14, 2025 19:28

owencraston mentioned this pull request Jan 14, 2025

chore: Update assets and accounts packages #12984

Merged

7 tasks

owencraston force-pushed the feat/multichain-balance-controller branch 2 times, most recently from e3eefdb to f86998f Compare January 16, 2025 22:53

owencraston force-pushed the feat/multichain-balance-controller branch from 5de2584 to e3f517e Compare January 17, 2025 20:25

owencraston commented Jan 17, 2025

View reviewed changes

app/reducers/multichain/index.ts Outdated Show resolved Hide resolved

owencraston force-pushed the feat/multichain-balance-controller branch from 6b0f41b to c31b5de Compare January 20, 2025 21:58

Gedoxa approved these changes Jan 21, 2025

View reviewed changes

owencraston force-pushed the feat/multichain-balance-controller branch from b99918e to e47cae3 Compare January 22, 2025 00:07

gambinish reviewed Jan 22, 2025

View reviewed changes

app/components/hooks/usePortfolioBalance/usePortfolioBalance.ts Outdated Show resolved Hide resolved

gambinish reviewed Jan 22, 2025

View reviewed changes

app/components/hooks/usePortfolioBalance/usePortfolioBalance.ts Outdated Show resolved Hide resolved

gambinish reviewed Jan 22, 2025

View reviewed changes

app/core/Engine/controllers/RatesController/utils.ts Show resolved Hide resolved

gambinish reviewed Jan 22, 2025

View reviewed changes

app/hooks/usePortfolioBalance/index.ts Outdated Show resolved Hide resolved

gambinish requested changes Jan 22, 2025

View reviewed changes

owencraston force-pushed the feat/multichain-balance-controller branch 2 times, most recently from 3ac41d3 to 359f977 Compare January 22, 2025 22:42

owencraston added 2 commits February 6, 2025 12:52

rename selector files

508406d

throw early and remove console.warn

fba7158

owencraston force-pushed the feat/multichain-balance-controller branch from cc345f2 to fba7158 Compare February 6, 2025 20:38

owencraston added 2 commits February 6, 2025 13:44

cleanup token details render function

806b38d

get rid of hardcoded token defaults

f04d4de

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

gambinish self-requested a review February 6, 2025 21:18

gambinish approved these changes Feb 6, 2025

View reviewed changes

owencraston enabled auto-merge February 6, 2025 21:54

brianacnguyen approved these changes Feb 6, 2025

View reviewed changes

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

gantunesr approved these changes Feb 7, 2025

View reviewed changes

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

FrederikBolding approved these changes Feb 7, 2025

View reviewed changes

tommasini approved these changes Feb 7, 2025

View reviewed changes

owencraston added this pull request to the merge queue Feb 7, 2025

Merged via the queue into main with commit fb48175 Feb 7, 2025
57 checks passed

owencraston deleted the feat/multichain-balance-controller branch February 7, 2025 16:08

github-actions bot locked and limited conversation to collaborators Feb 7, 2025

metamaskbot added the release-7.41.0 Issue or pull request that will be included in release 7.41.0 label Feb 7, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: MultichainBalanceController #12599

feat: MultichainBalanceController #12599

owencraston commented Dec 6, 2024 •

edited

Loading

github-actions bot commented Dec 6, 2024

sonarqubecloud bot commented Dec 12, 2024

socket-security bot commented Jan 16, 2025 •

edited

Loading

gambinish left a comment

owencraston commented Feb 6, 2025

owencraston commented Feb 6, 2025

sonarqubecloud bot commented Feb 6, 2025

github-actions bot commented Feb 6, 2025 •

edited by metamaskbot

Loading

feat: MultichainBalanceController #12599

feat: MultichainBalanceController #12599

Conversation

owencraston commented Dec 6, 2024 • edited Loading

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Dec 6, 2024

sonarqubecloud bot commented Dec 12, 2024

Quality Gate failed

socket-security bot commented Jan 16, 2025 • edited Loading

gambinish left a comment

Choose a reason for hiding this comment

owencraston commented Feb 6, 2025

owencraston commented Feb 6, 2025

sonarqubecloud bot commented Feb 6, 2025

Quality Gate passed

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

Bitrise

owencraston commented Dec 6, 2024 •

edited

Loading

socket-security bot commented Jan 16, 2025 •

edited

Loading

github-actions bot commented Feb 6, 2025 •

edited by metamaskbot

Loading