fix: preserve staked balances on Accounts API updates - #9753
Merged
Conversation
salimtb
added a commit
that referenced
this pull request
Aug 3, 2026
…eased The entry was mistakenly placed in the released 11.3.0 section; move it under Unreleased and add the PR link (#9753). Co-authored-by: Cursor <cursoragent@cursor.com>
salimtb
added a commit
that referenced
this pull request
Aug 3, 2026
…eased The entry was mistakenly placed in the released 11.3.0 section; move it under Unreleased and add the PR link (#9753). Co-authored-by: Cursor <cursoragent@cursor.com>
salimtb
force-pushed
the
fix/preserve-staked-balance-accounts-api
branch
from
August 3, 2026 08:14
866dfb4 to
6a9595c
Compare
10 tasks
salimtb
marked this pull request as ready for review
August 5, 2026 17:10
bergarces
previously approved these changes
Aug 5, 2026
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
Aug 5, 2026
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
Aug 6, 2026
Exclude staking vault asset IDs from Accounts API v5/v6 balance processing and keep prior staked amounts when replaceCoveredChainBalances would drop them, so network switches no longer reset pooled staking to missing/0. Co-authored-by: Cursor <cursoragent@cursor.com>
…eased The entry was mistakenly placed in the released 11.3.0 section; move it under Unreleased and add the PR link (#9753). Co-authored-by: Cursor <cursoragent@cursor.com>
…ource test Co-authored-by: Cursor <cursoragent@cursor.com>
…eased after rebase Co-authored-by: Cursor <cursoragent@cursor.com>
salimtb
force-pushed
the
fix/preserve-staked-balance-accounts-api
branch
from
August 6, 2026 11:46
f2f73c1 to
949c836
Compare
salimtb
enabled auto-merge
August 6, 2026 11:50
Prithpal-Sooriya
approved these changes
Aug 6, 2026
pull Bot
pushed a commit
to Reality2byte/metamask-mobile
that referenced
this pull request
Aug 11, 2026
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until this PR meets the canonical
Definition of Ready For Review in `docs/readme/ready-for-review.md`.
In short: the template must be materially complete (not just section
titles
present), all status checks must be currently passing, and the only
expected
follow-up commits must be reviewer-driven.
-->
<!--
mms-check directive vocabulary — read by
.github/scripts/shared/pr-template-checks.ts
at module load to build the validation plan. Directives are invisible in
rendered
markdown and must NOT be removed or edited without updating the
validator registry.
type=text Section must contain non-placeholder prose.
type=changelog Section must have a valid CHANGELOG entry: line.
type=issue-link Section must have a Fixes:/Closes:/Refs: line with a
value.
type=manual-testing Section must have real testing steps or an explicit
N/A.
type=screenshot Section must have evidence (image/URL) or an explicit
N/A.
type=checklist Section must have all checkboxes consciously checked.
required=true|false Whether a missing/invalid section runs the validator
at all.
blocking=true|false Whether a failure of this check fails the CI
workflow.
Default: false — failures are shown as warnings in the sticky
comment but do not block the PR.
Sections without a directive are checked for structural presence only.
-->
## **Description**
core PR:
MetaMask/core#9753
<!-- mms-check: type=text required=true -->
<!--
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?
-->
## **Changelog**
<!-- mms-check: type=changelog required=true blocking=true -->
<!--
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 staking balance issue
## **Related issues**
<!-- mms-check: type=issue-link required=true -->
Fixes: MetaMask#33443
## **Manual testing steps**
<!-- mms-check: type=manual-testing required=true -->
```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]
```
## **Screenshots/Recordings**
<!-- mms-check: type=screenshot required=true -->
<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->
### **Before**
<!-- [screenshots/recordings] -->
https://github.com/user-attachments/assets/b54fa86f-9019-4729-bf5d-1de068894c62
### **After**
<!-- [screenshots/recordings] -->
https://github.com/user-attachments/assets/8a2dd8db-7e33-4a9d-a7f4-42b50df0aa43
## **Pre-merge author checklist**
<!-- mms-check: type=checklist required=true -->
<!--
Every checklist item must be consciously assessed before marking this PR
as
"Ready for review". A checked box means you deliberately considered that
responsibility, not that you literally performed every action listed.
Unchecked boxes are ambiguous: they are not an implicit "N/A" and they
are not
a silent "skip". See `docs/readme/ready-for-review.md` for the full
checklist
semantics.
-->
- [ ] 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.
#### Performance checks (if applicable)
- [ ] I've tested on Android
- Ideally on a mid-range device; emulator is acceptable
- [ ] I've tested with a power user scenario
- Use these [power-user
SRPs](https://consensyssoftware.atlassian.net/wiki/spaces/TL1/pages/edit-v2/401401446401?draftShareId=9d77e1e1-4bdc-4be1-9ebb-ccd916988d93)
to import wallets with many accounts and tokens
- [ ] I've instrumented key operations with Sentry traces for production
performance metrics
- See [`trace()`](/app/util/trace.ts) for usage and
[`addToken`](/app/components/Views/AddAsset/components/AddCustomToken/AddCustomToken.tsx#L274)
for an example
For performance guidelines and tooling, see the [Performance
Guide](https://consensyssoftware.atlassian.net/wiki/spaces/TL1/pages/400085549067/Performance+Guide+for+Engineers).
## **Pre-merge reviewer checklist**
<!--
Reviewer checklist items follow the same semantics as the author
checklist: an
unchecked box is ambiguous, a checked box means the reviewer consciously
assessed that responsibility. See `docs/readme/ready-for-review.md`.
-->
- [ ] 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]
> **Medium Risk**
> Changes balance merge behavior for a specific asset class in a core
wallet dependency; incorrect `isStakingContractAssetId` matching could
hide stale API data or retain outdated staked amounts, but scope is
limited to staking vault IDs.
>
> **Overview**
> Ships a **Yarn patch** on `@metamask/assets-controller@13.1.1`
(aligned with
[MetaMask/core#9753](MetaMask/core#9753)) so
staked vault balances are no longer cleared or overwritten by Accounts
API data.
>
> **Accounts API ingestion** now skips balances whose asset IDs are
staking vault contracts (`isStakingContractAssetId`), so vault share
tokens returned as ordinary ERC-20s (often `0` or stale) are not merged
into state.
>
> **Balance merge** (`mergeAccountBalances`) now carries forward any
existing staking-contract balances when a chain-slice update from
Accounts API (or similar) omits them, instead of dropping them to
missing/zero. Staked amounts remain owned by `StakedBalanceDataSource`.
>
> `package.json` resolutions and the direct dependency point at the new
patch file; `yarn.lock` reflects the patched package checksum.
>
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
040fd29. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
10 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Exclude staking vault asset IDs from Accounts API v5/v6 balance processing and keep prior staked amounts when replaceCoveredChainBalances would drop them, so network switches no longer reset pooled staking to missing/0.
UI PR: MetaMask/metamask-mobile#34178
Explanation
References
Checklist
Note
Medium Risk
Changes balance merge behavior for staking contract assets across Accounts API and covered-chain replacement; scope is narrow but affects displayed staked ETH totals users rely on.
Overview
Fixes pooled staking balances disappearing when Accounts API refreshes chain slices (e.g. network switch or
replaceCoveredChainBalances).Accounts API path: v5 and v6 balance parsing now skips staking vault contract asset IDs via
isStakingContractAssetId, so API rows that treat the vault share token as a normal ERC-20 (often0or stale) no longer merge intoassetsBalanceand overwrite StakedBalanceDataSource amounts.Merge replace path: When a merge update uses
replaceCoveredChainBalancesand the payload omits staking contract assets, AssetsController copies prior staked balances from state instead of clearing them with other covered-chain tokens.Tests cover API exclusion (v5/v6) and preservation on Accounts API merge replace.
Reviewed by Cursor Bugbot for commit 949c836. Bugbot is set up for automated code reviews on this repo. Configure here.