Skip to content

fix: Add account checks before performing balance zeroing #8095

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

Merged
Prithpal-Sooriya merged 4 commits into from
Mar 4, 2026
+192 −3
Merged

fix: Add account checks before performing balance zeroing #8095

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
12ea324
fix: avoid zeroing balances for excluded accounts
Prithpal-Sooriya Mar 3, 2026
45b6875
chore: add changelog entry for account zeroing fix
Prithpal-Sooriya Mar 3, 2026
b9ecfef
refactor: share account inclusion guard for zeroing
Prithpal-Sooriya Mar 3, 2026
71b63eb
Merge branch 'main' into cursor/account-balance-zeroing-7ca5
Prithpal-Sooriya Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/assets-controllers/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed

- Fix `AccountsApiBalanceFetcher` to apply stricter conditions when zeroing out token balances ([#8044](https://github.com/MetaMask/core/pull/8044))
- Fix `AccountsApiBalanceFetcher` ERC-20 zeroing to only apply to accounts included in the current request, preventing stale-account entries from being incorrectly reset to zero ([#8095](https://github.com/MetaMask/core/pull/8095))

## [100.0.3]

Expand Down
174 changes: 173 additions & 1 deletion packages/assets-controllers/src/multi-chain-accounts-service/api-balance-fetcher.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -756,6 +756,50 @@ describe('AccountsApiBalanceFetcher', () => {
expect(nativeAddr1?.value).toStrictEqual(new BN('1500000000000000000')); // 1.5 ETH
expect(nativeAddr2?.value).toStrictEqual(new BN('0')); // Zero balance (not returned by API)
});

it('should not zero out native balances for addresses excluded from selected-account requests', async () => {
const excludedAddress = '0x1111111111111111111111111111111111111111';

mockAccountAddressToCaipReference.mockReturnValue(
`eip155:1:${excludedAddress}`,
);
mockFetchMultiChainBalancesV4.mockResolvedValue({
count: 0,
balances: [],
unprocessedNetworks: [],
});

const result = await balanceFetcher.fetch({
chainIds: [MOCK_CHAIN_ID],
queryAllAccounts: false,
selectedAccount: MOCK_ADDRESS_1 as ChecksumAddress,
allAccounts: MOCK_INTERNAL_ACCOUNTS,
});

expect(result.balances).toStrictEqual([]);
});

it('should not zero out native balances for addresses excluded from all-accounts requests', async () => {
const excludedAddress = '0x1111111111111111111111111111111111111111';

mockAccountAddressToCaipReference.mockReturnValue(
`eip155:1:${excludedAddress}`,
);
mockFetchMultiChainBalancesV4.mockResolvedValue({
count: 0,
balances: [],
unprocessedNetworks: [],
});

const result = await balanceFetcher.fetch({
chainIds: [MOCK_CHAIN_ID],
queryAllAccounts: true,
selectedAccount: MOCK_ADDRESS_1 as ChecksumAddress,
allAccounts: MOCK_INTERNAL_ACCOUNTS,
});

expect(result.balances).toStrictEqual([]);
});
});

describe('erc20 token zero balance guarantee', () => {
Expand Down Expand Up @@ -803,6 +847,135 @@ describe('AccountsApiBalanceFetcher', () => {
expect(result.balances[1].value).toStrictEqual(new BN('0')); // balance is zero now since API did not return a value for this token
});

it('should not zero out erc20 balances for accounts excluded from selected-account requests', async () => {
const selectedAccountToken =
'0x0xaf88d065e77c8cC2239327C5EDb3A432268e5831';
const excludedAccountToken = '0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E';

mockFetchMultiChainBalancesV4.mockResolvedValue({
count: 1,
balances: [createMockNativeTokenBalance({ chainId: 1 })],
unprocessedNetworks: [],
});

balanceFetcher = new AccountsApiBalanceFetcher(
'extension',
undefined,
() => ({
[MOCK_ADDRESS_1]: {
'0x1': {
[ZERO_ADDRESS]: {},
[selectedAccountToken]: '0x814a20',
},
},
[MOCK_ADDRESS_2]: {
'0x1': {
[ZERO_ADDRESS]: {},
[excludedAccountToken]: '0x814a20',
},
},
}),
);

const result = await balanceFetcher.fetch({
chainIds: ['0x1'],
queryAllAccounts: false,
selectedAccount: MOCK_ADDRESS_1 as ChecksumAddress,
allAccounts: MOCK_INTERNAL_ACCOUNTS,
});

const zeroedSelectedAccountToken = result.balances.find(
(balance) =>
balance.account === MOCK_ADDRESS_1 &&
balance.token === selectedAccountToken.toLowerCase(),
);
expect(zeroedSelectedAccountToken).toStrictEqual(
expect.objectContaining({
success: true,
value: new BN('0'),
account: MOCK_ADDRESS_1,
token: selectedAccountToken.toLowerCase(),
chainId: '0x1',
}),
);

const zeroedExcludedAccountToken = result.balances.find(
(balance) =>
balance.account === MOCK_ADDRESS_2 &&
balance.token === excludedAccountToken.toLowerCase(),
);
expect(zeroedExcludedAccountToken).toBeUndefined();
});

it('should not zero out erc20 balances for accounts excluded from all-accounts requests', async () => {
const includedAccountToken =
'0x0xaf88d065e77c8cC2239327C5EDb3A432268e5831';
const excludedAccount = '0x1111111111111111111111111111111111111111';
const excludedAccountToken = '0xA0b86a33E6441c86c33E1C6B9cD964c0BA2A86B';

mockFetchMultiChainBalancesV4.mockResolvedValue({
count: 2,
balances: [
createMockNativeTokenBalance({
accountAddress: `eip155:1:${MOCK_ADDRESS_1}`,
}),
createMockNativeTokenBalance({
balance: '2.0',
accountAddress: `eip155:1:${MOCK_ADDRESS_2}`,
}),
],
unprocessedNetworks: [],
});

balanceFetcher = new AccountsApiBalanceFetcher(
'extension',
undefined,
() => ({
[MOCK_ADDRESS_1]: {
'0x1': {
[ZERO_ADDRESS]: {},
[includedAccountToken]: '0x814a20',
},
},
[excludedAccount]: {
'0x1': {
[ZERO_ADDRESS]: {},
[excludedAccountToken]: '0x814a20',
},
},
}),
);

const result = await balanceFetcher.fetch({
chainIds: ['0x1'],
queryAllAccounts: true,
selectedAccount: MOCK_ADDRESS_1 as ChecksumAddress,
allAccounts: MOCK_INTERNAL_ACCOUNTS,
});

const zeroedIncludedAccountToken = result.balances.find(
(balance) =>
balance.account === MOCK_ADDRESS_1 &&
balance.token === includedAccountToken.toLowerCase(),
);
expect(zeroedIncludedAccountToken).toStrictEqual(
expect.objectContaining({
success: true,
value: new BN('0'),
account: MOCK_ADDRESS_1,
token: includedAccountToken.toLowerCase(),
chainId: '0x1',
}),
);

const zeroedExcludedAccountToken = result.balances.find(
(balance) =>
balance.account === excludedAccount &&
balance.token === excludedAccountToken.toLowerCase(),
);
expect(zeroedExcludedAccountToken).toBeUndefined();
});

it('should not include erc20 token entry for chains that are not supported by account API', async () => {
balanceFetcher = arrangeBalanceFetcher();

Expand Down Expand Up @@ -830,7 +1003,6 @@ describe('AccountsApiBalanceFetcher', () => {
allAccounts: MOCK_INTERNAL_ACCOUNTS,
});

console.log(result.balances);
expect(result.balances).toHaveLength(1);
expect(result.balances[0]).toStrictEqual(
expect.objectContaining({
Expand Down
20 changes: 18 additions & 2 deletions packages/assets-controllers/src/multi-chain-accounts-service/api-balance-fetcher.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,15 +407,27 @@ export class AccountsApiBalanceFetcher implements BalanceFetcher {
results.push(...apiBalances);
}

const isAccountIncludedInRequest = (address: string): boolean =>
queryAllAccounts
? allAccounts.some(
(currentAccount) =>
currentAccount.address.toLowerCase() === address.toLowerCase(),
)
: selectedAccount.toLowerCase() === address.toLowerCase();

// Add zero native balance entries for addresses that API didn't return
addressChainMap.forEach((chains, address) => {
chains.forEach((chainId) => {
const key = `${address}-${chainId}`;
const existingBalance = nativeBalancesFromAPI.get(key);
const isChainIncludedInRequest = chainIds.includes(chainId);
const isChainSupported = this.supports(chainId);
const isAccountIncluded = isAccountIncludedInRequest(address);
const shouldZeroOutBalance =
!existingBalance && isChainIncludedInRequest && isChainSupported;
!existingBalance &&
isChainIncludedInRequest &&
isChainSupported &&
isAccountIncluded;

if (shouldZeroOutBalance) {
// Add zero native balance entry if API succeeded but didn't return one
Expand All @@ -442,8 +454,12 @@ export class AccountsApiBalanceFetcher implements BalanceFetcher {
const existingBalance = nonNativeBalancesFromAPI.get(key);
const isChainIncludedInRequest = chainIds.includes(chainId as Hex);
const isChainSupported = this.supports(chainId as Hex);
const isAccountIncluded = isAccountIncludedInRequest(account);
const shouldZeroOutBalance =
!existingBalance && isChainIncludedInRequest && isChainSupported;
!existingBalance &&
isChainIncludedInRequest &&
isChainSupported &&
isAccountIncluded;

if (isERC && shouldZeroOutBalance) {
results.push({
Expand Down
Loading