feat(utils): utility to check if token is stablecoin (#969)

Signed-off-by: Gerhard Steenkamp <gerhard@umaproject.org>
Co-authored-by: bmzig <57361391+bmzig@users.noreply.github.com>

Author: gsteenkamp89

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@across-protocol/sdk",
   "author": "UMA Team",
-  "version": "4.1.43",
+  "version": "4.1.44",
   "license": "AGPL-3.0",
   "homepage": "https://docs.across.to/reference/sdk",
   "files": [

src/constants.ts

@@ -66,6 +66,19 @@ export const BRIDGED_USDC_SYMBOLS = [
   TOKEN_SYMBOLS_MAP.USDzC.symbol,
 ];
 
+export const STABLE_COIN_SYMBOLS = [
+  ...BRIDGED_USDC_SYMBOLS,
+  TOKEN_SYMBOLS_MAP.USDB.symbol,
+  TOKEN_SYMBOLS_MAP.USDC.symbol,
+  TOKEN_SYMBOLS_MAP.USDT.symbol,
+  TOKEN_SYMBOLS_MAP.DAI.symbol,
+  TOKEN_SYMBOLS_MAP["TATARA-USDC"].symbol,
+  TOKEN_SYMBOLS_MAP["TATARA-USDT"].symbol,
+  TOKEN_SYMBOLS_MAP["TATARA-USDS"].symbol,
+  TOKEN_SYMBOLS_MAP.GHO.symbol,
+  TOKEN_SYMBOLS_MAP.WGHO.symbol,
+];
+
 export const CUSTOM_GAS_TOKENS = {
   [CHAIN_IDs.POLYGON]: "MATIC",
   [CHAIN_IDs.POLYGON_AMOY]: "MATIC",

src/utils/TokenUtils.ts

@@ -109,6 +109,12 @@ export function isBridgedUsdc(tokenSymbol: string): boolean {
   );
 }
 
+export function isStablecoin(tokenSymbol: string): boolean {
+  return constants.STABLE_COIN_SYMBOLS.some(
+    (stablecoinSymbol) => stablecoinSymbol.toLowerCase() === tokenSymbol.toLowerCase()
+  );
+}
+
 export function getTokenInfo(l2TokenAddress: string, chainId: number): L1Token {
   // @dev This might give false positives if tokens on different networks have the same address. I'm not sure how
   // to get around this...