chore: filter out Tron staking special assets (#26360)

## **Description**

As part of Tron's staking experience improvements we will be sending
more special assets from the Snap to the Extension. These special assets
are not tradeable tokens and should be filtered out from selectors like
we already do for Staked TRX for example.

This PR:
- Adds the new special assets that should be ignored by the selectors
- Renames the variables that deal with this logic to be more inclusive
of assets that are not resources (only Energy and Bandwidth are
resources)

## **Changelog**

CHANGELOG entry: null

## **Related issues**

Closes:
[NEB-582](https://consensyssoftware.atlassian.net/browse/NEB-582),
[NEB-584](https://consensyssoftware.atlassian.net/browse/NEB-584),
[NEB-586](https://consensyssoftware.atlassian.net/browse/NEB-586)

## **Manual testing steps**

All existing Tron functionality should remain unchanged

## **Screenshots/Recordings**

As you can see, the new assets being loaded from the preview build of
MetaMask/snap-tron-wallet#226 are not being
shown here.

### **Before**

n/a

### **After**

n/a

## **Pre-merge author checklist**

- [x] I've followed MetaMask Contributor Docs and MetaMask Mobile Coding
Standards.
- [x] I've completed the PR template to the best of my ability
- [x] I've included tests if applicable
- [x] I've documented my code using JSDoc format if applicable
- [x] I've applied the right labels on the PR

[NEB-582]:
https://consensyssoftware.atlassian.net/browse/NEB-582?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
[NEB-584]:
https://consensyssoftware.atlassian.net/browse/NEB-584?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
[NEB-586]:
https://consensyssoftware.atlassian.net/browse/NEB-586?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Medium Risk**
> Changes token/asset filtering for Tron by excluding additional
Snap-provided “special assets” from sorted asset lists and unified
multichain token lists, which could inadvertently hide tokens if symbols
collide or filtering is misapplied. Scope is contained to Tron
selectors/utilities and related UI consumers, with broad test updates.
> 
> **Overview**
> Introduces a broader Tron *“special assets”* concept (resources +
staking lifecycle assets) and filters these virtual tokens out of
user-facing asset/token lists.
> 
> Renames and expands the Tron selector from
`selectTronResourcesBySelectedAccountGroup` to
`selectTronSpecialAssetsBySelectedAccountGroup` (and `TronResourcesMap`
to `TronSpecialAssetsMap`), adding mappings for `trxReadyForWithdrawal`,
`trxStakingRewards`, and `trxInLockPeriod` while preserving
`totalStakedTrx` computation.
> 
> Centralizes special-asset detection in `core/Multichain/utils` via
`isTronSpecialAsset` and reuses it in
`selectSortedAssetsBySelectedAccountGroup`,
`selectAccountTokensAcrossChainsUnified`, and Bridge `isTradableToken`;
updates related Earn/TokenDetails/AssetOverview hooks and tests
accordingly.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
893e98a. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Author: ulissesferreira

app/components/UI/AssetOverview/TronEnergyBandwidthDetail/TronEnergyBandwidthDetail.test.tsx

@@ -6,8 +6,8 @@ import ResourceRing from './ResourceRing';
 import renderWithProvider from '../../../../util/test/renderWithProvider';
 import { backgroundState } from '../../../../util/test/initial-root-state';
 import {
-  selectTronResourcesBySelectedAccountGroup,
-  TronResourcesMap,
+  selectTronSpecialAssetsBySelectedAccountGroup,
+  TronSpecialAssetsMap,
 } from '../../../../selectors/assets/assets-list';
 
 jest.mock('./ResourceRing', () => ({
@@ -33,21 +33,24 @@ jest.mock('../../../../../locales/i18n', () => ({
 }));
 
 jest.mock('../../../../selectors/assets/assets-list', () => ({
-  selectTronResourcesBySelectedAccountGroup: jest.fn(),
+  selectTronSpecialAssetsBySelectedAccountGroup: jest.fn(),
 }));
 
 type SelectorReturn = ReturnType<
-  typeof selectTronResourcesBySelectedAccountGroup
+  typeof selectTronSpecialAssetsBySelectedAccountGroup
 >;
 
-const createEmptyResourcesMap = (): TronResourcesMap => ({
+const createEmptySpecialAssetsMap = (): TronSpecialAssetsMap => ({
   energy: undefined,
   bandwidth: undefined,
   maxEnergy: undefined,
   maxBandwidth: undefined,
   stakedTrxForEnergy: undefined,
   stakedTrxForBandwidth: undefined,
   totalStakedTrx: 0,
+  trxReadyForWithdrawal: undefined,
+  trxStakingRewards: undefined,
+  trxInLockPeriod: undefined,
 });
 
 interface Resource {
@@ -78,7 +81,7 @@ describe('TronEnergyBandwidthDetail', () => {
   });
 
   it('renders values, coverage counts, and passes correct progress to ResourceRing', () => {
-    jest.mocked(selectTronResourcesBySelectedAccountGroup).mockReturnValue({
+    jest.mocked(selectTronSpecialAssetsBySelectedAccountGroup).mockReturnValue({
       energy: res('energy', 130000),
       bandwidth: res('bandwidth', 560),
       maxEnergy: res('max-energy', 200000),
@@ -110,7 +113,7 @@ describe('TronEnergyBandwidthDetail', () => {
   });
 
   it('parses balances and caps progress', () => {
-    jest.mocked(selectTronResourcesBySelectedAccountGroup).mockReturnValue({
+    jest.mocked(selectTronSpecialAssetsBySelectedAccountGroup).mockReturnValue({
       energy: res('energy', '1000'),
       bandwidth: res('bandwidth', '2000'),
       maxEnergy: res('max-energy', '400'),
@@ -136,8 +139,8 @@ describe('TronEnergyBandwidthDetail', () => {
 
   it('handles missing resources by showing zeros and 0 progress', () => {
     jest
-      .mocked(selectTronResourcesBySelectedAccountGroup)
-      .mockReturnValue(createEmptyResourcesMap());
+      .mocked(selectTronSpecialAssetsBySelectedAccountGroup)
+      .mockReturnValue(createEmptySpecialAssetsMap());
 
     const { getAllByText, getByText } = renderWithProvider(
       <TronEnergyBandwidthDetail />,

app/components/UI/AssetOverview/TronEnergyBandwidthDetail/useTronResources.test.ts

@@ -4,8 +4,8 @@ import { useSelector } from 'react-redux';
 
 import { useTronResources } from './useTronResources';
 import {
-  selectTronResourcesBySelectedAccountGroup,
-  TronResourcesMap,
+  selectTronSpecialAssetsBySelectedAccountGroup,
+  TronSpecialAssetsMap,
 } from '../../../../selectors/assets/assets-list';
 
 jest.mock('react-redux', () => ({
@@ -15,28 +15,31 @@ jest.mock('react-redux', () => ({
 jest.mock('../../../../selectors/assets/assets-list', () => ({
   __esModule: true,
   ...jest.requireActual('../../../../selectors/assets/assets-list'),
-  selectTronResourcesBySelectedAccountGroup: jest.fn(),
+  selectTronSpecialAssetsBySelectedAccountGroup: jest.fn(),
 }));
 
 const mockUseSelector = useSelector as jest.MockedFunction<typeof useSelector>;
-const mockSelectTronResourcesBySelectedAccountGroup =
-  selectTronResourcesBySelectedAccountGroup as jest.MockedFunction<
-    typeof selectTronResourcesBySelectedAccountGroup
+const mockSelectTronSpecialAssetsBySelectedAccountGroup =
+  selectTronSpecialAssetsBySelectedAccountGroup as jest.MockedFunction<
+    typeof selectTronSpecialAssetsBySelectedAccountGroup
   >;
 
 interface MockTronAsset {
   symbol?: string;
   balance?: string | number;
 }
 
-const createEmptyResourcesMap = (): TronResourcesMap => ({
+const createEmptySpecialAssetsMap = (): TronSpecialAssetsMap => ({
   energy: undefined,
   bandwidth: undefined,
   maxEnergy: undefined,
   maxBandwidth: undefined,
   stakedTrxForEnergy: undefined,
   stakedTrxForBandwidth: undefined,
   totalStakedTrx: 0,
+  trxReadyForWithdrawal: undefined,
+  trxStakingRewards: undefined,
+  trxInLockPeriod: undefined,
 });
 
 const createTronAsset = (
@@ -52,24 +55,27 @@ describe('useTronResources', () => {
     jest.clearAllMocks();
 
     mockUseSelector.mockImplementation((selector: any) => selector());
-    mockSelectTronResourcesBySelectedAccountGroup.mockReturnValue(
-      createEmptyResourcesMap(),
+    mockSelectTronSpecialAssetsBySelectedAccountGroup.mockReturnValue(
+      createEmptySpecialAssetsMap(),
     );
   });
 
   it('builds energy and bandwidth resources from base max capacity', () => {
-    const tronResourcesMap: TronResourcesMap = {
+    const tronSpecialAssetsMap: TronSpecialAssetsMap = {
       energy: createTronAsset('energy', '500') as any,
       bandwidth: createTronAsset('bandwidth', '300') as any,
       maxEnergy: createTronAsset('max-energy', '1000') as any,
       maxBandwidth: createTronAsset('max-bandwidth', '600') as any,
       stakedTrxForEnergy: createTronAsset('strx-energy', '500') as any,
       stakedTrxForBandwidth: createTronAsset('strx-bandwidth', 0) as any,
       totalStakedTrx: 500,
+      trxReadyForWithdrawal: undefined,
+      trxStakingRewards: undefined,
+      trxInLockPeriod: undefined,
     };
 
-    mockSelectTronResourcesBySelectedAccountGroup.mockReturnValue(
-      tronResourcesMap,
+    mockSelectTronSpecialAssetsBySelectedAccountGroup.mockReturnValue(
+      tronSpecialAssetsMap,
     );
 
     const { result } = renderHook(() => useTronResources());
@@ -84,8 +90,8 @@ describe('useTronResources', () => {
   });
 
   it('returns zeroed resources when no Tron resources exist', () => {
-    mockSelectTronResourcesBySelectedAccountGroup.mockReturnValue(
-      createEmptyResourcesMap(),
+    mockSelectTronSpecialAssetsBySelectedAccountGroup.mockReturnValue(
+      createEmptySpecialAssetsMap(),
     );
 
     const { result } = renderHook(() => useTronResources());
@@ -106,14 +112,14 @@ describe('useTronResources', () => {
   });
 
   it('parses balances with comma separators', () => {
-    const tronResourcesMap: TronResourcesMap = {
-      ...createEmptyResourcesMap(),
+    const tronSpecialAssetsMap: TronSpecialAssetsMap = {
+      ...createEmptySpecialAssetsMap(),
       energy: createTronAsset('energy', '1,000') as any,
       maxEnergy: createTronAsset('max-energy', '2,000') as any,
     };
 
-    mockSelectTronResourcesBySelectedAccountGroup.mockReturnValue(
-      tronResourcesMap,
+    mockSelectTronSpecialAssetsBySelectedAccountGroup.mockReturnValue(
+      tronSpecialAssetsMap,
     );
 
     const { result } = renderHook(() => useTronResources());
@@ -124,14 +130,14 @@ describe('useTronResources', () => {
   });
 
   it('caps percentage at one hundred when current exceeds max', () => {
-    const tronResourcesMap: TronResourcesMap = {
-      ...createEmptyResourcesMap(),
+    const tronSpecialAssetsMap: TronSpecialAssetsMap = {
+      ...createEmptySpecialAssetsMap(),
       energy: createTronAsset('energy', 200) as any,
       maxEnergy: createTronAsset('max-energy', 100) as any,
     };
 
-    mockSelectTronResourcesBySelectedAccountGroup.mockReturnValue(
-      tronResourcesMap,
+    mockSelectTronSpecialAssetsBySelectedAccountGroup.mockReturnValue(
+      tronSpecialAssetsMap,
     );
 
     const { result } = renderHook(() => useTronResources());
@@ -141,14 +147,14 @@ describe('useTronResources', () => {
   });
 
   it('sets percentage to zero when balances cannot be parsed', () => {
-    const tronResourcesMap: TronResourcesMap = {
-      ...createEmptyResourcesMap(),
+    const tronSpecialAssetsMap: TronSpecialAssetsMap = {
+      ...createEmptySpecialAssetsMap(),
       energy: createTronAsset('energy', 'invalid') as any,
       maxEnergy: createTronAsset('max-energy', '1000') as any,
     };
 
-    mockSelectTronResourcesBySelectedAccountGroup.mockReturnValue(
-      tronResourcesMap,
+    mockSelectTronSpecialAssetsBySelectedAccountGroup.mockReturnValue(
+      tronSpecialAssetsMap,
     );
 
     const { result } = renderHook(() => useTronResources());

app/components/UI/AssetOverview/TronEnergyBandwidthDetail/useTronResources.ts

@@ -2,7 +2,7 @@ import { useMemo } from 'react';
 import { useSelector } from 'react-redux';
 import BigNumber from 'bignumber.js';
 
-import { selectTronResourcesBySelectedAccountGroup } from '../../../../selectors/assets/assets-list';
+import { selectTronSpecialAssetsBySelectedAccountGroup } from '../../../../selectors/assets/assets-list';
 import { safeParseBigNumber } from '../../../../util/number/bignumber';
 
 export interface TronResource {
@@ -49,7 +49,7 @@ export const useTronResources = (): {
   bandwidth: TronResource;
 } => {
   const { energy, bandwidth, maxEnergy, maxBandwidth } = useSelector(
-    selectTronResourcesBySelectedAccountGroup,
+    selectTronSpecialAssetsBySelectedAccountGroup,
   );
 
   return useMemo(() => {

app/components/UI/Bridge/utils/isTradableToken/index.test.ts

@@ -238,5 +238,38 @@ describe('isTradableToken', () => {
 
       expect(result).toBe(false);
     });
+
+    it('returns false for Tron Ready for Withdrawal token', () => {
+      const token = createTestToken({
+        chainId: TrxScope.Mainnet,
+        symbol: 'TRX-READY-FOR-WITHDRAWAL',
+      });
+
+      const result = isTradableToken(token);
+
+      expect(result).toBe(false);
+    });
+
+    it('returns false for Tron Staking Rewards token', () => {
+      const token = createTestToken({
+        chainId: TrxScope.Mainnet,
+        symbol: 'TRX-STAKING-REWARDS',
+      });
+
+      const result = isTradableToken(token);
+
+      expect(result).toBe(false);
+    });
+
+    it('returns false for Tron In Lock Period token', () => {
+      const token = createTestToken({
+        chainId: TrxScope.Mainnet,
+        symbol: 'TRX-IN-LOCK-PERIOD',
+      });
+
+      const result = isTradableToken(token);
+
+      expect(result).toBe(false);
+    });
   });
 });

app/components/UI/Bridge/utils/isTradableToken/index.ts

@@ -1,16 +1,8 @@
 import { TrxScope } from '@metamask/keyring-api';
 import { BridgeToken } from '../../types';
-import {
-  TRON_RESOURCE_SYMBOLS,
-  TronResourceSymbol,
-} from '../../../../../core/Multichain/constants';
+import { isTronSpecialAsset } from '../../../../../core/Multichain/utils';
 import { TokenI } from '../../../Tokens/types';
 
-export const isTradableToken = (token: BridgeToken | TokenI) => {
-  if (token.chainId === TrxScope.Mainnet) {
-    return !TRON_RESOURCE_SYMBOLS.includes(
-      token.symbol?.toLowerCase() as TronResourceSymbol,
-    );
-  }
-  return true;
-};
+export const isTradableToken = (token: BridgeToken | TokenI) =>
+  token.chainId !== TrxScope.Mainnet ||
+  !isTronSpecialAsset(token.chainId, token.symbol);

app/components/UI/Earn/components/EarnBalance/EarnBalance.test.tsx

@@ -5,7 +5,7 @@ import StakingBalance from '../../../Stake/components/StakingBalance/StakingBala
 import { TokenI } from '../../../Tokens/types';
 import EarnLendingBalance from '../EarnLendingBalance';
 import { selectTrxStakingEnabled } from '../../../../../selectors/featureFlagController/trxStakingEnabled';
-import { selectTronResourcesBySelectedAccountGroup } from '../../../../../selectors/assets/assets-list';
+import { selectTronSpecialAssetsBySelectedAccountGroup } from '../../../../../selectors/assets/assets-list';
 import TronStakingButtons from '../Tron/TronStakingButtons';
 import { selectIsMusdConversionFlowEnabledFlag } from '../../selectors/featureFlags';
 
@@ -27,7 +27,7 @@ jest.mock(
 
 jest.mock('../../../../../selectors/assets/assets-list', () => ({
   ...jest.requireActual('../../../../../selectors/assets/assets-list'),
-  selectTronResourcesBySelectedAccountGroup: jest.fn(),
+  selectTronSpecialAssetsBySelectedAccountGroup: jest.fn(),
 }));
 
 jest.mock('../Tron/TronStakingButtons', () => ({
@@ -137,23 +137,26 @@ jest.mock('../../hooks/useTronStakeApy', () => ({
   }),
 }));
 
-const createEmptyResourcesMap = () => ({
+const createEmptySpecialAssetsMap = () => ({
   energy: undefined,
   bandwidth: undefined,
   maxEnergy: undefined,
   maxBandwidth: undefined,
   stakedTrxForEnergy: undefined,
   stakedTrxForBandwidth: undefined,
   totalStakedTrx: 0,
+  trxReadyForWithdrawal: undefined,
+  trxStakingRewards: undefined,
+  trxInLockPeriod: undefined,
 });
 
 describe('EarnBalance', () => {
   beforeEach(() => {
     jest.clearAllMocks();
     (jest.mocked(selectTrxStakingEnabled) as jest.Mock).mockReturnValue(false);
     (
-      jest.mocked(selectTronResourcesBySelectedAccountGroup) as jest.Mock
-    ).mockReturnValue(createEmptyResourcesMap());
+      jest.mocked(selectTronSpecialAssetsBySelectedAccountGroup) as jest.Mock
+    ).mockReturnValue(createEmptySpecialAssetsMap());
   });
 
   describe('Ethereum Mainnet', () => {
@@ -251,7 +254,7 @@ describe('EarnBalance', () => {
   describe('TRON', () => {
     const mockFlag = selectTrxStakingEnabled as unknown as jest.Mock;
     const mockTronResources =
-      selectTronResourcesBySelectedAccountGroup as unknown as jest.Mock;
+      selectTronSpecialAssetsBySelectedAccountGroup as unknown as jest.Mock;
 
     it('renders TRON stake button with aprText for TRX without staked positions', () => {
       const trx: Partial<TokenI> = {
@@ -261,7 +264,7 @@ describe('EarnBalance', () => {
       };
 
       mockFlag.mockReturnValue(true);
-      mockTronResources.mockReturnValue(createEmptyResourcesMap());
+      mockTronResources.mockReturnValue(createEmptySpecialAssetsMap());
 
       renderWithProvider(<EarnBalance asset={trx as TokenI} />);
 
@@ -283,7 +286,7 @@ describe('EarnBalance', () => {
 
       mockFlag.mockReturnValue(true);
       mockTronResources.mockReturnValue({
-        ...createEmptyResourcesMap(),
+        ...createEmptySpecialAssetsMap(),
         stakedTrxForEnergy: { symbol: 'strx-energy', balance: '1' },
         stakedTrxForBandwidth: { symbol: 'strx-bandwidth', balance: '2' },
         totalStakedTrx: 3,

app/components/UI/Earn/components/EarnBalance/index.tsx

@@ -8,7 +8,7 @@ import EarnLendingBalance from '../EarnLendingBalance';
 import { selectIsStakeableToken } from '../../../Stake/selectors/stakeableTokens';
 ///: BEGIN:ONLY_INCLUDE_IF(tron)
 import TronStakingButtons from '../Tron/TronStakingButtons';
-import { selectTronResourcesBySelectedAccountGroup } from '../../../../../selectors/assets/assets-list';
+import { selectTronSpecialAssetsBySelectedAccountGroup } from '../../../../../selectors/assets/assets-list';
 import { selectTrxStakingEnabled } from '../../../../../selectors/featureFlagController/trxStakingEnabled';
 import { hasStakedTrxPositions as hasStakedTrxPositionsUtil } from '../../utils/tron';
 import useTronStakeApy from '../../hooks/useTronStakeApy';
@@ -47,10 +47,12 @@ const EarnBalance = ({ asset }: EarnBalanceProps) => {
   const isStakedTrxAsset =
     isTron && (asset?.ticker === 'sTRX' || asset?.symbol === 'sTRX');
 
-  const tronResources = useSelector(selectTronResourcesBySelectedAccountGroup);
+  const tronSpecialAssets = useSelector(
+    selectTronSpecialAssetsBySelectedAccountGroup,
+  );
   const hasStakedTrxPositions = React.useMemo(
-    () => hasStakedTrxPositionsUtil(tronResources),
-    [tronResources],
+    () => hasStakedTrxPositionsUtil(tronSpecialAssets),
+    [tronSpecialAssets],
   );
 
   const { apyPercent: tronApyPercent } = useTronStakeApy();