Merge pull request #1898 from AmbireTech/feature/add-jpyc-to-main

Feature / Add JPYC as a fee token in the extension

Author: superKalo

src/consts/gasTankFeeTokens.ts

@@ -184,6 +184,13 @@ export default [
     decimals: 18,
     icon: 'https://assets.coingecko.com/coins/images/2518/small/weth.png?1628852295'
   },
+  {
+    address: '0xE7C3D8C9a439feDe00D2600032D5dB0Be71C3c29',
+    symbol: 'jpyc',
+    chainId: 1n,
+    decimals: 18,
+    icon: 'https://assets.coingecko.com/coins/images/70314/standard/JPYC_400x400.jpg'
+  },
   {
     address: '0x1abaea1f7c830bd89acc67ec4af516284b1bc33c',
     symbol: 'eurc',
@@ -337,6 +344,13 @@ export default [
     decimals: 18,
     icon: 'https://assets.coingecko.com/coins/images/14073/small/matic.png'
   },
+  {
+    address: '0xE7C3D8C9a439feDe00D2600032D5dB0Be71C3c29',
+    symbol: 'jpyc',
+    chainId: 137n,
+    decimals: 18,
+    icon: 'https://assets.coingecko.com/coins/images/70314/standard/JPYC_400x400.jpg'
+  },
   {
     address: '0x03b54a6e9a984069379fae1a4fc4dbae93b3bccd',
     symbol: 'wsteth',
@@ -531,6 +545,13 @@ export default [
     decimals: 18,
     icon: 'https://assets.coingecko.com/coins/images/15075/small/wrapped-avax.png'
   },
+  {
+    address: '0xE7C3D8C9a439feDe00D2600032D5dB0Be71C3c29',
+    symbol: 'jpyc',
+    chainId: 43114n,
+    decimals: 18,
+    icon: 'https://assets.coingecko.com/coins/images/70314/standard/JPYC_400x400.jpg'
+  },
   {
     address: '0xd586E7F844cEa2F87f50152665BCbc2C279D8d70',
     symbol: 'dai',

src/libs/swapAndBridge/swapAndBridge.ts

@@ -20,6 +20,7 @@ import { LIFI_EXPLORER_URL } from '../../services/lifi/consts'
 import {
   AMBIRE_WALLET_TOKEN_ON_BASE,
   AMBIRE_WALLET_TOKEN_ON_ETHEREUM,
+  JPYC_TOKEN,
   NULL_ADDRESS,
   SOCKET_EXPLORER_URL,
   ZERO_ADDRESS
@@ -31,11 +32,18 @@ import { TokenResult } from '../portfolio'
 import { getTokenBalanceInUSD } from '../portfolio/helpers'
 
 /**
- * Put a list of all the banned addresses (left side) with their
- * corresponding valid/correct address (right side).
- * This is fixing the case of token duplication like EURe. / CELO
- * where if the incorrect (outdated) address is used instead of the
- * new one in the swap, no routes will be found
+ * Maps banned (or outdated) token addresses to their "valid" replacements,
+ * "valid" meaning Swap & Bridge gives more relevant results with these replacements.
+ * There are two use cases:
+ *
+ * 1. Token replacement (e.g., EURe, GBP.e, CELO): Maps banned (or outdated) addresses
+ *    to the "valid" ones. When these banned addresses are used - we automatically
+ *    map them to the "valid" address (when selected) to ensure routes can be found.
+ *
+ * 2. Token filtering (e.g., JPYC variants): Uses identity mapping (same address on both sides).
+ *    These addresses are only used to filter them out from the "to" token list display.
+ *    The valid token is added separately via addCustomTokensIfNeeded(), so these banned
+ *    variants ensure duplication is avoided in the UI.
  */
 const getBannedToValidAddresses = (): {
   [chainId: string]: { [bannedAddr: string]: string }
@@ -64,16 +72,34 @@ const getBannedToValidAddresses = (): {
   const bannedGbpeGnosis = '0x8E34bfEC4f6Eb781f9743D9b4af99CD23F9b7053'
   const validGbpeGnosis = '0x5Cb9073902F2035222B9749F8fB0c9BFe5527108'
 
+  /** ****************************************************
+   *        MAKE SURE ADDRESSES ARE CHECKSUMMED
+   ****************************************************** */
+  const bannedJPYC = '0x431D5dfF03120AFA4bDf332c61A6e1766eF37BDB'
+  const bannedJPYCPos = '0x6AE7Dfc73E0dDE2aa99ac063DcF7e8A63265108c'
+  const bannedJPYCv1 = '0x2370f9d504c7a6E775bf6E14B3F12846b594cD53'
+  const bannedJPYsuper = '0xFBb291570DE4B87353B1e0f586Df97A1eD856470'
+
   return {
+    '1': {
+      [bannedJPYC]: bannedJPYC,
+      [bannedJPYCv1]: bannedJPYCv1
+    },
     '137': {
-      [bannedEurePolygon]: validEurePolygon
+      [bannedEurePolygon]: validEurePolygon,
+      [bannedJPYC]: bannedJPYC,
+      [bannedJPYCPos]: bannedJPYCPos,
+      [bannedJPYsuper]: bannedJPYsuper
     },
     '100': {
       [bannedEureGnosis]: validEureGnosis,
       [bannedGbpeGnosis]: validGbpeGnosis
     },
     '42220': {
       [bannedCelo]: validCelo
+    },
+    '43114': {
+      [bannedJPYC]: bannedJPYC
     }
   }
 }
@@ -402,6 +428,17 @@ const addCustomTokensIfNeeded = ({
       (t) => t.address !== AMBIRE_WALLET_TOKEN_ON_ETHEREUM.address
     )
     if (shouldAddAmbireWalletToken) newTokens.unshift(AMBIRE_WALLET_TOKEN_ON_ETHEREUM)
+
+    const shouldAddJPYCToken = newTokens.every((t) => t.address !== JPYC_TOKEN.address)
+    if (shouldAddJPYCToken) newTokens.unshift({ ...JPYC_TOKEN, chainId: 1 })
+  }
+  if (chainId === 137) {
+    const shouldAddJPYCToken = newTokens.every((t) => t.address !== JPYC_TOKEN.address)
+    if (shouldAddJPYCToken) newTokens.unshift({ ...JPYC_TOKEN, chainId: 137 })
+  }
+  if (chainId === 43114) {
+    const shouldAddJPYCToken = newTokens.every((t) => t.address !== JPYC_TOKEN.address)
+    if (shouldAddJPYCToken) newTokens.unshift({ ...JPYC_TOKEN, chainId: 43114 })
   }
   if (chainId === 8453) {
     const shouldAddAmbireWalletToken = newTokens.every(

src/services/socket/constants.ts

@@ -32,6 +32,14 @@ export const AMBIRE_WALLET_TOKEN_ON_BASE: SwapAndBridgeToToken = {
   ...AMBIRE_WALLET_TOKEN_COMMON_PROPS
 }
 
+export const JPYC_TOKEN = {
+  name: 'JPY Coin',
+  symbol: 'JPYC',
+  decimals: 18,
+  address: '0xE7C3D8C9a439feDe00D2600032D5dB0Be71C3c29',
+  icon: 'https://assets.coingecko.com/coins/images/70314/standard/JPYC_400x400.jpg'
+}
+
 export const AMBIRE_FEE_TAKER_ADDRESSES: { [chainId: number]: string } = {
   324: '0x942f9CE5D9a33a82F88D233AEb3292E680230348',
   1101: '0x942f9CE5D9a33a82F88D233AEb3292E680230348',