fix: improved currency detection

packages/currency/src/currencyManager.ts

@@ -59,6 +59,7 @@ export class CurrencyManager<TMeta = unknown> implements ICurrencyManager<TMeta>
    *
    * @param currencyIdentifier e.g. 'DAI', 'FAU', 'FAU-rinkeby', 'ETH-rinkeby-rinkeby' or '0xFab46E002BbF0b4509813474841E0716E6730136'
    * @param network e.g. rinkeby, mainnet
+   * @deprecated Use fromSymbol, fromAddress, fromId or fromHash to avoid ambiguity
    */
   from(
     currencyIdentifier: string | undefined,
@@ -71,17 +72,21 @@ export class CurrencyManager<TMeta = unknown> implements ICurrencyManager<TMeta>
       return this.fromAddress(currencyIdentifier, network);
     }
 
+    if (network && currencyIdentifier.indexOf(network) === -1) {
+      currencyIdentifier = CurrencyManager.currencyId({ symbol: currencyIdentifier, network });
+    }
+
+    const currencyFromId = this.fromId(currencyIdentifier);
+
+    if (currencyFromId) return currencyFromId;
+
     const parts = currencyIdentifier.split('-');
     const currencyFromSymbol =
       this.fromSymbol(parts[0], network || (parts[1] as CurrencyTypes.ChainName)) ||
       // try without splitting the symbol to support currencies like ETH-rinkeby
       this.fromSymbol(currencyIdentifier, network);
 
-    if (currencyFromSymbol) {
-      return currencyFromSymbol;
-    }
-
-    return this.fromId(currencyIdentifier);
+    return currencyFromSymbol;
   }
 
   /**
@@ -218,7 +223,7 @@ export class CurrencyManager<TMeta = unknown> implements ICurrencyManager<TMeta>
   /**
    * Utility function to compute the unique identifier
    */
-  static currencyId(currency: CurrencyInput): string {
+  static currencyId(currency: { symbol: string; network?: string }): string {
     return 'network' in currency ? `${currency.symbol}-${currency.network}` : currency.symbol;
   }
 

packages/currency/src/erc20/index.ts

@@ -17,6 +17,7 @@ export function getSupportedERC20Tokens(): ERC20Currency[] {
           network: networkName,
           decimals: token.decimals,
           symbol: token.symbol,
+          id: token.id,
         })),
       ];
     },

packages/currency/src/types.ts

@@ -4,7 +4,7 @@ import { CurrencyTypes, RequestLogicTypes } from '@requestnetwork/types';
  * Common types used in token configuration files
  */
 type TokenAddress = string;
-type TokenDefinition = { name: string; symbol: string; decimals: number };
+type TokenDefinition = { name: string; symbol: string; decimals: number; id?: string };
 export type TokenMap = Record<TokenAddress, TokenDefinition>;
 
 /**

packages/currency/test/currencyManager.test.ts

@@ -709,4 +709,54 @@ describe('CurrencyManager', () => {
       expect(path).toMatchObject([eur.hash, dai.hash.toLowerCase()]);
     });
   });
+
+  /**
+   * In order to respond to the recent changes in the USDC token where
+   * Circle introduced native USDC on chains Arbitrum, Polygon and Optimism, and renamed the bridged USDC to USDCe.
+   * We wanted to support both the native USDC and the bridged USDCe on the same network,
+   * while staying backwards compatible.
+   * That is why we kept the original USDC-network id for the bridged USDC, while changing the symbol to USDCe.
+   * Then we added the new native USDC with symbol USDC but id of USDCn-network.
+   */
+  describe('Currency Manager correctly detects native USDC and bridged USDCe on polygon', () => {
+    const USDC_LIST = [
+      {
+        address: '0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174',
+        name: 'USD Coin (PoS)',
+        symbol: 'USDCe',
+        network: 'matic',
+        id: 'USDC-matic',
+        decimals: 6,
+        type: RequestLogicTypes.CURRENCY.ERC20,
+      } as CurrencyInput,
+      {
+        address: '0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359',
+        name: 'USD Coin',
+        symbol: 'USDC',
+        network: 'matic',
+        id: 'USDCn-matic',
+        decimals: 6,
+        type: RequestLogicTypes.CURRENCY.ERC20,
+      } as CurrencyInput,
+    ];
+    const currencyManager = new CurrencyManager(USDC_LIST);
+    it('Detects USDCe matic by USDC-matic id', () => {
+      expect(currencyManager.from('USDC-matic')).toMatchObject({
+        type: RequestLogicTypes.CURRENCY.ERC20,
+        network: 'matic',
+        symbol: 'USDCe',
+        id: 'USDC-matic',
+        address: '0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174',
+      });
+    });
+    it('Detects native USDC matic by USDCn-matic id', () => {
+      expect(currencyManager.from('USDCn-matic')).toMatchObject({
+        type: RequestLogicTypes.CURRENCY.ERC20,
+        network: 'matic',
+        symbol: 'USDC',
+        id: 'USDCn-matic',
+        address: '0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359',
+      });
+    });
+  });
 });