Skip to content

chore(runway): cherry-pick fix: fix api fetcher balances#21057

Merged
Cal-L merged 2 commits into
release/7.57.0from
cherry-pick-7-57-0-368c6ec
Oct 14, 2025
Merged

chore(runway): cherry-pick fix: fix api fetcher balances#21057
Cal-L merged 2 commits into
release/7.57.0from
cherry-pick-7-57-0-368c6ec

Conversation

@runway-github

@runway-github runway-github Bot commented Oct 10, 2025

Copy link
Copy Markdown
Contributor

Description

The AccountsApiBalanceFetcher had a bug caused by address format
incompatibility between controllers:

  • TokenBalancesController uses lowercase addresses for ERC20 tokens
  • AccountTrackerController uses checksum addresses for native tokens

The original code always checksummed all addresses, causing a wrong
token balances state

core PR: MetaMask/core#6812

Changelog

CHANGELOG entry: fix balances issue update when api fetcher is used

Related issues

Fixes: #21030

Manual testing steps

Feature: my feature name

  Scenario: user [verb for user action]
    Given [describe expected initial app state]

    When user [verb for user action]
    Then [describe expected outcome]

Screenshots/Recordings

Before

After

Pre-merge author checklist

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.

Note

Adjusts AccountsApiBalanceFetcher to use checksum addresses for native tokens and original casing for ERC-20, and adds a Yarn patch for @metamask/assets-controllers.

  • Assets Controllers (API balance fetcher):
    • In dist/multi-chain-accounts-service/api-balance-fetcher.cjs, emit account and track nativeBalancesFromAPI using finalAccount:
      • Use checksum address for native (token === ZERO_ADDRESS).
      • Use original addressPart for ERC-20.
  • Dependencies:
    • Adds Yarn patch for @metamask/assets-controllers@78.0.1 in package.json and updates yarn.lock to the patched resolution.

Written by Cursor Bugbot for commit 066a3d4. This will update automatically on new commits. Configure here.

368c6ec

@runway-github runway-github Bot requested a review from a team as a code owner October 10, 2025 17:38
@github-actions

Copy link
Copy Markdown
Contributor

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.

@metamaskbot metamaskbot added the team-runway-bot-deprecated DEPRECATED: please use "team-bots" instead label Oct 10, 2025
cursor[bot]

This comment was marked as outdated.

@weitingsun weitingsun force-pushed the cherry-pick-7-57-0-368c6ec branch from 0e30b38 to a44d091 Compare October 10, 2025 22:41
<!--
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.
-->

The `AccountsApiBalanceFetcher` had a bug caused by address format
incompatibility between controllers:
- `TokenBalancesController` uses lowercase addresses for ERC20 tokens
- `AccountTrackerController` uses checksum addresses for native tokens

The original code always checksummed all addresses, causing a wrong
token balances state

core PR: MetaMask/core#6812

<!--
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?
-->

<!--
If this PR is not End-User-Facing and should not show up in the
CHANGELOG, you can choose to either:
1. Write `CHANGELOG entry: null`
2. Label with `no-changelog`

If this PR is End-User-Facing, please write a short User-Facing
description in the past tense like:
`CHANGELOG entry: Added a new tab for users to see their NFTs`
`CHANGELOG entry: Fixed a bug that was causing some NFTs to flicker`

(This helps the Release Engineer do their job more quickly and
accurately)
-->

CHANGELOG entry: fix balances issue update when api fetcher is used

Fixes: #21030

```gherkin
Feature: my feature name

  Scenario: user [verb for user action]
    Given [describe expected initial app state]

    When user [verb for user action]
    Then [describe expected outcome]
```

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

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

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

- [ ] 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.

- [ ] 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.

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Adjusts `AccountsApiBalanceFetcher` to use the correct account address
format per token type and applies Yarn patches for
`@metamask/assets-controllers` v78/v79.
>
> - **Services**:
>   - `dist/multi-chain-accounts-service/api-balance-fetcher.cjs`:
> - Introduces `finalAccount` based on token type (zero address vs.
others).
> - Uses `finalAccount` for `nativeBalancesFromAPI` keys and returned
`account` field.
> - **Build/Tooling**:
> - Adds Yarn patches for `@metamask/assets-controllers` `^78.0.1` and
`^79.0.0` in `package.json` and `.yarn/patches/`.
> - Updates `yarn.lock` to reference patched
`@metamask/assets-controllers` 79.0.0.
>
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
3968057. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
@weitingsun weitingsun force-pushed the cherry-pick-7-57-0-368c6ec branch from a44d091 to 2bfdcb9 Compare October 10, 2025 23:11
@sonarqubecloud

Copy link
Copy Markdown

@Cal-L Cal-L merged commit b22d61b into release/7.57.0 Oct 14, 2025
153 of 157 checks passed
@Cal-L Cal-L deleted the cherry-pick-7-57-0-368c6ec branch October 14, 2025 22:29
@github-actions github-actions Bot locked and limited conversation to collaborators Oct 14, 2025
@metamaskbot metamaskbot added the release-7.57.0 Issue or pull request that will be included in release 7.57.0 label Oct 14, 2025
@metamaskbot

Copy link
Copy Markdown
Collaborator

No release label on PR. Adding release label release-7.57.0 on PR, as PR was cherry-picked in branch 7.57.0.

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

Labels

release-7.57.0 Issue or pull request that will be included in release 7.57.0 size-S team-runway-bot-deprecated DEPRECATED: please use "team-bots" instead

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants