chore: return native and solana tokens in fetchBridgeTokens

Author: micaelae

packages/bridge-controller/src/types.ts

@@ -99,6 +99,25 @@ export enum SortOrder {
   ETA_ASC = 'time_descending',
 }
 
+/**
+ * This is the interface for the asset object returned by the bridge-api
+ * This type is used in the QuoteResponse and in the fetchBridgeTokens response
+ */
+export type BridgeAsset = {
+  chainId: ChainId;
+  address: string;
+  symbol: string;
+  name: string;
+  decimals: number;
+  icon?: string;
+  iconUrl: string;
+  assetId: string;
+};
+
+/**
+ * This is the interface for the token object used in the extension client
+ * In addition to the {@link BridgeAsset} fields, it includes balance information
+ */
 export type BridgeToken = {
   address: string;
   symbol: string;
@@ -129,16 +148,6 @@ export type FeatureFlagResponse = {
   [BridgeFlag.MOBILE_CONFIG]: FeatureFlagResponsePlatformConfig;
 };
 
-export type BridgeAsset = {
-  chainId: ChainId;
-  address: string;
-  symbol: string;
-  name: string;
-  decimals: number;
-  icon?: string;
-  iconUrl: string;
-  assetId: string;
-};
 
 /**
  * This is the interface for the quote request sent to the bridge-api

packages/bridge-controller/src/utils/bridge.ts

@@ -59,7 +59,10 @@ export const sumHexes = (...hexStrings: string[]): Hex => {
  * @param chainId - The hex encoded chain ID of the default swaps token to check
  * @returns Whether the address is the provided chain's default token address
  */
-export const isSwapsDefaultTokenAddress = (address: string, chainId: Hex) => {
+export const isSwapsDefaultTokenAddress = (
+  address: string,
+  chainId: Hex | CaipChainId,
+) => {
   if (!address || !chainId) {
     return false;
   }
@@ -80,7 +83,10 @@ export const isSwapsDefaultTokenAddress = (address: string, chainId: Hex) => {
  * @param chainId - The hex encoded chain ID of the default swaps token to check
  * @returns Whether the symbol is the provided chain's default token symbol
  */
-export const isSwapsDefaultTokenSymbol = (symbol: string, chainId: Hex) => {
+export const isSwapsDefaultTokenSymbol = (
+  symbol: string,
+  chainId: Hex | CaipChainId,
+) => {
   if (!symbol || !chainId) {
     return false;
   }
@@ -103,6 +109,7 @@ export const isNativeAddress = (address?: string | null) =>
   address === AddressZero || // bridge and swap apis set the native asset address to zero
   address === '' || // assets controllers set the native asset address to an empty string
   !address ||
+  address.endsWith('11111111111111111111111111111111') ||
   [DEFAULT_SOLANA_TOKEN_ADDRESS].some(
     (assetId) => assetId.includes(address) && !isStrictHexString(address),
   ); // multichain native assets are represented in caip format

packages/bridge-controller/src/utils/fetch.ts

@@ -1,10 +1,6 @@
-import type { Hex } from '@metamask/utils';
-import { Duration, hexToNumber } from '@metamask/utils';
+import type { CaipChainId, Hex } from '@metamask/utils';
+import { Duration } from '@metamask/utils';
 
-import {
-  isSwapsDefaultTokenAddress,
-  isSwapsDefaultTokenSymbol,
-} from './bridge';
 import {
   formatAddressToString,
   formatChainIdToCaip,
@@ -16,15 +12,14 @@ import {
   validateSwapsTokenObject,
 } from './validators';
 import { DEFAULT_FEATURE_FLAG_CONFIG } from '../constants/bridge';
-import type { SwapsTokenObject } from '../constants/tokens';
-import { SWAPS_CHAINID_DEFAULT_TOKEN_MAP } from '../constants/tokens';
 import type {
   QuoteResponse,
   BridgeFeatureFlags,
   FetchFunction,
   ChainConfiguration,
   GenericQuoteRequest,
   QuoteRequest,
+  BridgeAsset,
 } from '../types';
 import { BridgeFlag, BridgeFeatureFlagsKey } from '../types';
 
@@ -94,13 +89,13 @@ export async function fetchBridgeFeatureFlags(
  * @returns A list of enabled (unblocked) tokens
  */
 export async function fetchBridgeTokens(
-  chainId: Hex,
+  chainId: Hex | CaipChainId,
   clientId: string,
   fetchFn: FetchFunction,
   bridgeApiBaseUrl: string,
-): Promise<Record<string, SwapsTokenObject>> {
+): Promise<Record<string, BridgeAsset>> {
   // TODO make token api v2 call
-  const url = `${bridgeApiBaseUrl}/getTokens?chainId=${hexToNumber(chainId)}`;
+  const url = `${bridgeApiBaseUrl}/getTokens?chainId=${formatChainIdToDec(chainId)}`;
 
   // TODO we will need to cache these. In Extension fetchWithCache is used. This is due to the following:
   // If we allow selecting dest networks which the user has not imported,
@@ -111,24 +106,9 @@ export async function fetchBridgeTokens(
     functionName: 'fetchBridgeTokens',
   });
 
-  const nativeToken =
-    SWAPS_CHAINID_DEFAULT_TOKEN_MAP[
-      chainId as keyof typeof SWAPS_CHAINID_DEFAULT_TOKEN_MAP
-    ];
-
-  const transformedTokens: Record<string, SwapsTokenObject> = {};
-  if (nativeToken) {
-    transformedTokens[nativeToken.address] = nativeToken;
-  }
-
+  const transformedTokens: Record<string, BridgeAsset> = {};
   tokens.forEach((token: unknown) => {
-    if (
-      validateSwapsTokenObject(token) &&
-      !(
-        isSwapsDefaultTokenSymbol(token.symbol, chainId) ||
-        isSwapsDefaultTokenAddress(token.address, chainId)
-      )
-    ) {
+    if (validateSwapsTokenObject(token)) {
       transformedTokens[token.address] = token;
     }
   });

packages/bridge-controller/src/utils/validators.ts

@@ -11,13 +11,11 @@ import {
   optional,
   enums,
   define,
-  size,
   union,
 } from '@metamask/superstruct';
 import { isStrictHexString } from '@metamask/utils';
 
-import type { SwapsTokenObject } from '../constants/tokens';
-import type { FeatureFlagResponse, QuoteResponse } from '../types';
+import type { BridgeAsset, FeatureFlagResponse, QuoteResponse } from '../types';
 import { ActionTypes, BridgeFlag, FeeType } from '../types';
 
 const HexAddressSchema = define('HexAddress', (v: unknown) =>
@@ -35,10 +33,16 @@ const TruthyDigitStringSchema = define(
     truthyString(v as string) && Boolean((v as string).match(/^\d+$/u)),
 );
 
-const SwapsTokenObjectSchema = type({
-  decimals: number(),
+const ChainIdSchema = number();
+
+const BridgeAssetSchema = type({
+  chainId: ChainIdSchema,
   address: string(),
-  symbol: size(string(), 1, 12),
+  assetId: string(),
+  symbol: string(),
+  name: string(),
+  decimals: number(),
+  icon: optional(string()),
 });
 
 export const validateFeatureFlagsResponse = (
@@ -67,23 +71,11 @@ export const validateFeatureFlagsResponse = (
 
 export const validateSwapsTokenObject = (
   data: unknown,
-): data is SwapsTokenObject => {
-  return is(data, SwapsTokenObjectSchema);
+): data is BridgeAsset => {
+  return is(data, BridgeAssetSchema);
 };
 
 export const validateQuoteResponse = (data: unknown): data is QuoteResponse => {
-  const ChainIdSchema = number();
-
-  const BridgeAssetSchema = type({
-    chainId: ChainIdSchema,
-    address: string(),
-    assetId: string(),
-    symbol: string(),
-    name: string(),
-    decimals: number(),
-    icon: optional(string()),
-  });
-
   const FeeDataSchema = type({
     amount: TruthyDigitStringSchema,
     asset: BridgeAssetSchema,
@@ -111,10 +103,10 @@ export const validateQuoteResponse = (data: unknown): data is QuoteResponse => {
   const QuoteSchema = type({
     requestId: string(),
     srcChainId: ChainIdSchema,
-    srcAsset: SwapsTokenObjectSchema,
+    srcAsset: BridgeAssetSchema,
     srcTokenAmount: string(),
     destChainId: ChainIdSchema,
-    destAsset: SwapsTokenObjectSchema,
+    destAsset: BridgeAssetSchema,
     destTokenAmount: string(),
     feeData: record(enums(Object.values(FeeType)), FeeDataSchema),
     bridgeId: string(),