feat: update asset endpoints to include RWA data (#7548)

This is a PR to add RWA data to asset endpoints.

## Explanation

<!--
Thanks for your contribution! Take a moment to answer these questions so
that reviewers have the information they need to properly understand
your changes:

* What is the current state of things and why does it need to change?
* What is the solution your changes offer and how does it work?
* Are there any changes whose purpose might not obvious to those
unfamiliar with the domain?
* If your primary goal was to update one package but you found you had
to update another one along the way, why did you do so?
* If you had to upgrade a dependency, why did you do so?
-->
CHANGELOG entry: fetch the rwaData from token API endpoints and then
pass to frontend to render.

## References

<!--
Are there any issues that this pull request is tied to?
Are there other links that reviewers should consult to understand these
changes better?
Are there client or consumer pull requests to adopt any breaking
changes?

For example:

* Fixes #12345
* Related to #67890
-->

## Checklist

- [x] I've updated the test suite for new or updated code as appropriate
- [x] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [x] I've communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs)
- [x] I've introduced [breaking
changes](https://github.com/MetaMask/core/tree/main/docs/breaking-changes.md)
in this PR and have prepared draft pull requests for clients and
consumer packages to resolve them



<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Adds RWA metadata end-to-end in asset flows.
> 
> - Fetches RWA via `includeRwaData=true` on `token`, `tokens`,
`tokens/search`, and `v3/tokens/trending` endpoints; defaults
`includeRwaData` to true in `searchTokens` and `getTrendingTokens`
> - Extends `Token` and asset item shapes to include optional `rwaData`;
propagates through `TokensController`, `TokenDetectionController`,
`TokenRatesController`, and `token-selectors`
> - Updates tests to expect RWA inclusion and adds Linea token filtering
case; updates CHANGELOG
> - Minor: adds explicit return types in `TokenListController` methods
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
3891eeb. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

---------

Co-authored-by: Oscar Roche <[email protected]>
Co-authored-by: Prithpal Sooriya <[email protected]>

Author: 3 people

eslint-suppressions.json

@@ -359,7 +359,7 @@
   },
   "packages/assets-controllers/src/TokenListController.ts": {
     "@typescript-eslint/explicit-function-return-type": {
-      "count": 6
+      "count": 1
     },
     "no-restricted-syntax": {
       "count": 7

packages/assets-controllers/CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Add RWA data to asset fetching endpoints ([#7548](https://github.com/MetaMask/core/pull/7548))
 - Add Rootstock (0x1e) mapping to eip155:30/erc20:0x542fda317318ebf1d3deaf76e0b632741a7e677d for RBTC ([#7601](https://github.com/MetaMask/core/pull/7601))
 
 ### Changed

packages/assets-controllers/src/TokenDetectionController.ts

@@ -752,7 +752,7 @@ export class TokenDetectionController extends StaticIntervalPollingController<To
       const tokensWithBalance: Token[] = [];
       const eventTokensDetails: string[] = [];
       for (const nonZeroTokenAddress of Object.keys(balances)) {
-        const { decimals, symbol, aggregators, iconUrl, name } =
+        const { decimals, symbol, aggregators, iconUrl, name, rwaData } =
           this.#tokensChainsCache[chainId].data[nonZeroTokenAddress];
         eventTokensDetails.push(`${symbol} - ${nonZeroTokenAddress}`);
         tokensWithBalance.push({
@@ -763,6 +763,7 @@ export class TokenDetectionController extends StaticIntervalPollingController<To
           image: iconUrl,
           isERC721: false,
           name,
+          ...(rwaData && { rwaData }),
         });
       }
 
@@ -843,7 +844,8 @@ export class TokenDetectionController extends StaticIntervalPollingController<To
         continue;
       }
 
-      const { decimals, symbol, aggregators, iconUrl, name } = tokenData;
+      const { decimals, symbol, aggregators, iconUrl, name, rwaData } =
+        tokenData;
 
       // Push to lists with checksummed address (for allTokens storage)
       eventTokensDetails.push(`${symbol} - ${checksummedTokenAddress}`);
@@ -855,6 +857,7 @@ export class TokenDetectionController extends StaticIntervalPollingController<To
         image: iconUrl,
         isERC721: false,
         name,
+        ...(rwaData && { rwaData }),
       });
     }
 
@@ -964,7 +967,8 @@ export class TokenDetectionController extends StaticIntervalPollingController<To
         continue;
       }
 
-      const { decimals, symbol, aggregators, iconUrl, name } = tokenData;
+      const { decimals, symbol, aggregators, iconUrl, name, rwaData } =
+        tokenData;
 
       eventTokensDetails.push(`${symbol} - ${checksummedTokenAddress}`);
       tokensWithBalance.push({
@@ -975,6 +979,7 @@ export class TokenDetectionController extends StaticIntervalPollingController<To
         image: iconUrl,
         isERC721: false,
         name,
+        ...(rwaData && { rwaData }),
       });
     }
 

packages/assets-controllers/src/TokenListController.ts

@@ -191,7 +191,9 @@ export class TokenListController extends StaticIntervalPollingController<TokenLi
    *
    * @param networkControllerState - The updated network controller state.
    */
-  async #onNetworkControllerStateChange(networkControllerState: NetworkState) {
+  async #onNetworkControllerStateChange(
+    networkControllerState: NetworkState,
+  ): Promise<void> {
     const selectedNetworkClient = this.messenger.call(
       'NetworkController:getNetworkClientById',
       networkControllerState.selectedNetworkClientId,
@@ -216,7 +218,7 @@ export class TokenListController extends StaticIntervalPollingController<TokenLi
    * @deprecated This method is deprecated and will be removed in the future.
    * Consider using the new polling approach instead
    */
-  async start() {
+  async start(): Promise<void> {
     if (!isTokenListSupportedForNetwork(this.chainId)) {
       return;
     }
@@ -229,7 +231,7 @@ export class TokenListController extends StaticIntervalPollingController<TokenLi
    * @deprecated This method is deprecated and will be removed in the future.
    * Consider using the new polling approach instead
    */
-  async restart() {
+  async restart(): Promise<void> {
     this.stopPolling();
     await this.#startDeprecatedPolling();
   }
@@ -240,7 +242,7 @@ export class TokenListController extends StaticIntervalPollingController<TokenLi
    * @deprecated This method is deprecated and will be removed in the future.
    * Consider using the new polling approach instead
    */
-  stop() {
+  stop(): void {
     this.stopPolling();
   }
 
@@ -250,7 +252,7 @@ export class TokenListController extends StaticIntervalPollingController<TokenLi
    * @deprecated This method is deprecated and will be removed in the future.
    * Consider using the new polling approach instead
    */
-  override destroy() {
+  override destroy(): void {
     super.destroy();
     this.stopPolling();
   }

packages/assets-controllers/src/TokenRatesController.ts

@@ -16,6 +16,7 @@ import { isEqual } from 'lodash';
 import { reduceInBatchesSerially, TOKEN_PRICES_BATCH_SIZE } from './assetsUtil';
 import type { AbstractTokenPricesService } from './token-prices-service/abstract-token-prices-service';
 import { getNativeTokenAddress } from './token-prices-service/codefi-v2';
+import { TokenRwaData } from './token-service';
 import type {
   TokensControllerGetStateAction,
   TokensControllerStateChangeEvent,
@@ -45,6 +46,7 @@ export type Token = {
   hasBalanceError?: boolean;
   isERC721?: boolean;
   name?: string;
+  rwaData?: TokenRwaData;
 };
 
 const DEFAULT_INTERVAL = 180000;

packages/assets-controllers/src/TokensController.test.ts

@@ -1621,7 +1621,7 @@ describe('TokensController', () => {
             .get(
               `/token/${convertHexToDecimal(
                 chainId,
-              )}?address=${dummyTokenAddress}`,
+              )}?address=${dummyTokenAddress}&includeRwaData=true`,
             )
             .reply(200, { error })
             .persist();

packages/assets-controllers/src/TokensController.ts

@@ -457,6 +457,7 @@ export class TokensController extends BaseController<
         isERC721,
         aggregators: formatAggregatorNames(tokenMetadata?.aggregators || []),
         name,
+        ...(tokenMetadata?.rwaData && { rwaData: tokenMetadata.rwaData }),
       };
       const previousIndex = newTokens.findIndex(
         (token) => token.address.toLowerCase() === address.toLowerCase(),
@@ -525,7 +526,7 @@ export class TokensController extends BaseController<
     }, {});
     try {
       tokensToImport.forEach((tokenToAdd) => {
-        const { address, symbol, decimals, image, aggregators, name } =
+        const { address, symbol, decimals, image, aggregators, name, rwaData } =
           tokenToAdd;
         const checksumAddress = toChecksumHexAddress(address);
         const formattedToken: Token = {
@@ -535,6 +536,7 @@ export class TokensController extends BaseController<
           image,
           aggregators,
           name,
+          ...(rwaData && { rwaData }),
         };
         newTokensMap[checksumAddress] = formattedToken;
         importedTokensMap[address.toLowerCase()] = true;
@@ -664,6 +666,7 @@ export class TokensController extends BaseController<
           aggregators,
           isERC721,
           name,
+          rwaData,
         } = tokenToAdd;
         const checksumAddress = toChecksumHexAddress(address);
         const newEntry: Token = {
@@ -674,6 +677,7 @@ export class TokensController extends BaseController<
           isERC721,
           aggregators,
           name,
+          ...(rwaData && { rwaData }),
         };
 
         const previousImportedIndex = newTokens.findIndex(

packages/assets-controllers/src/selectors/token-selectors.ts

@@ -8,6 +8,7 @@ import type { NetworkState } from '@metamask/network-controller';
 import { hexToBigInt, parseCaipAssetType } from '@metamask/utils';
 import type { Hex } from '@metamask/utils';
 import { createSelector, weakMapMemoize } from 'reselect';
+import { TokenRwaData } from 'src/token-service';
 
 import {
   parseBalanceWithDecimals,
@@ -84,6 +85,7 @@ export type Asset = (
         conversionRate: number;
       }
     | undefined;
+  rwaData?: TokenRwaData;
 };
 
 export type AssetListState = {
@@ -325,6 +327,7 @@ const selectAllEvmAssets = createAssetListSelector(
                 }
               : undefined,
             chainId,
+            ...(token.rwaData && { rwaData: token.rwaData }),
           });
         }
       }