fix(checkout): GFI-98: Fix token mismatch errors (#2554)

Author: keithbro-imx

packages/internal/dex/sdk/src/lib/utils.test.ts

@@ -1,6 +1,18 @@
 import { TransactionRequest, ZeroAddress } from 'ethers';
-import { TEST_FROM_ADDRESS, USDC_TEST_TOKEN, nativeTokenService } from '../test/utils';
-import { decimalsFunctionSig, getTokenDecimals, isValidNonZeroAddress } from './utils';
+import {
+  TEST_FROM_ADDRESS,
+  USDC_TEST_TOKEN,
+  WETH_TEST_TOKEN,
+  nativeTokenService,
+} from '../test/utils';
+import {
+  addAmount,
+  decimalsFunctionSig,
+  getTokenDecimals,
+  isValidNonZeroAddress,
+  newAmount,
+  subtractAmount,
+} from './utils';
 
 jest.mock('ethers', () => ({
   ...jest.requireActual('ethers'),
@@ -37,7 +49,11 @@ describe('utils', () => {
   describe('getTokenDecimals', () => {
     describe('when token is native', () => {
       it('should return default native token decimals', async () => {
-        const decimals = await getTokenDecimals('native', provider as any, nativeTokenService.nativeToken);
+        const decimals = await getTokenDecimals(
+          'native',
+          provider as any,
+          nativeTokenService.nativeToken,
+        );
         expect(decimals).toEqual(18);
       });
     });
@@ -53,4 +69,72 @@ describe('utils', () => {
       });
     });
   });
+
+  describe('addAmount', () => {
+    it('adds ERC20 amounts', () => {
+      const amount1 = newAmount(100n, USDC_TEST_TOKEN);
+      const amount2 = newAmount(200n, USDC_TEST_TOKEN);
+      const result = addAmount(amount1, amount2);
+      expect(result).toEqual({ value: 300n, token: USDC_TEST_TOKEN });
+    });
+
+    it('throws when adding different ERC20 tokens', () => {
+      const amount1 = newAmount(100n, USDC_TEST_TOKEN);
+      const amount2 = newAmount(200n, WETH_TEST_TOKEN);
+      expect(() => addAmount(amount1, amount2)).toThrow();
+    });
+
+    it('adds amounts when the addresses differ only by case', () => {
+      const amount1 = newAmount(100n, {
+        ...USDC_TEST_TOKEN,
+        address: USDC_TEST_TOKEN.address.toUpperCase(),
+      });
+      const amount2 = newAmount(200n, {
+        ...USDC_TEST_TOKEN,
+        address: USDC_TEST_TOKEN.address.toLowerCase(),
+      });
+      const result = addAmount(amount1, amount2);
+      expect(result).toEqual({
+        value: 300n,
+        token: {
+          ...USDC_TEST_TOKEN,
+          address: USDC_TEST_TOKEN.address.toUpperCase(),
+        },
+      });
+    });
+  });
+
+  describe('subtractAmount', () => {
+    it('subtracts ERC20 amounts', () => {
+      const amount1 = newAmount(200n, USDC_TEST_TOKEN);
+      const amount2 = newAmount(100n, USDC_TEST_TOKEN);
+      const result = subtractAmount(amount1, amount2);
+      expect(result).toEqual({ value: 100n, token: USDC_TEST_TOKEN });
+    });
+
+    it('throws when subtracting different ERC20 tokens', () => {
+      const amount1 = newAmount(200n, USDC_TEST_TOKEN);
+      const amount2 = newAmount(100n, WETH_TEST_TOKEN);
+      expect(() => subtractAmount(amount1, amount2)).toThrow();
+    });
+
+    it('subtracts amounts when the addresses differ only by case', () => {
+      const amount1 = newAmount(200n, {
+        ...USDC_TEST_TOKEN,
+        address: USDC_TEST_TOKEN.address.toUpperCase(),
+      });
+      const amount2 = newAmount(100n, {
+        ...USDC_TEST_TOKEN,
+        address: USDC_TEST_TOKEN.address.toLowerCase(),
+      });
+      const result = subtractAmount(amount1, amount2);
+      expect(result).toEqual({
+        value: 100n,
+        token: {
+          ...USDC_TEST_TOKEN,
+          address: USDC_TEST_TOKEN.address.toUpperCase(),
+        },
+      });
+    });
+  });
 });

packages/internal/dex/sdk/src/lib/utils.ts

@@ -109,9 +109,11 @@ export const isNativeAmount = (amount: CoinAmount<Coin>): amount is CoinAmount<N
 
 export const isNative = (token: Coin): token is Native => token.type === 'native';
 
-export const addERC20Amount = (a: CoinAmount<ERC20>, b: CoinAmount<ERC20>) => {
+const addERC20Amount = (a: CoinAmount<ERC20>, b: CoinAmount<ERC20>) => {
   // Make sure the ERC20s have the same address
-  if (a.token.address !== b.token.address) throw new Error('Token mismatch: token addresses must be the same');
+  if (a.token.address.toLowerCase() !== b.token.address.toLowerCase()) {
+    throw new Error('Token mismatch: token addresses must be the same');
+  }
   return { value: a.value + b.value, token: a.token };
 };
 
@@ -132,9 +134,11 @@ export const addAmount = <T extends Coin>(a: CoinAmount<T>, b: CoinAmount<T>) =>
   throw new Error('Token mismatch: token types must be the same');
 };
 
-export const subtractERC20Amount = (a: CoinAmount<ERC20>, b: CoinAmount<ERC20>) => {
+const subtractERC20Amount = (a: CoinAmount<ERC20>, b: CoinAmount<ERC20>) => {
   // Make sure the ERC20s have the same address
-  if (a.token.address !== b.token.address) throw new Error('Token mismatch: token addresses must be the same');
+  if (a.token.address.toLowerCase() !== b.token.address.toLowerCase()) {
+    throw new Error('Token mismatch: token addresses must be the same');
+  }
   return { value: a.value - b.value, token: a.token };
 };