refactor: set OFT token as the l2 token and canonical as the exception

Author: chrstph-dvx

packages/arb-token-bridge-ui/src/app/api/crosschain-transfers/utils.test.ts

@@ -183,7 +183,7 @@ describe('isValidLifiTransfer', () => {
 
     expect(
       isValidLifiTransfer({
-        fromToken: CommonAddress.Ethereum.PYUSD,
+        fromToken: CommonAddress.ArbitrumOne.PYUSDCanonical,
         sourceChainId: ChainId.ArbitrumOne,
         destinationChainId: ChainId.Ethereum,
         tokensFromLists,
@@ -194,7 +194,7 @@ describe('isValidLifiTransfer', () => {
   it('blocks canonical PYUSD withdrawals without tokensFromLists', () => {
     expect(
       isValidLifiTransfer({
-        fromToken: CommonAddress.Ethereum.PYUSD,
+        fromToken: CommonAddress.ArbitrumOne.PYUSDCanonical,
         sourceChainId: ChainId.ArbitrumOne,
         destinationChainId: ChainId.Ethereum,
       }),
@@ -210,6 +210,16 @@ describe('isValidLifiTransfer', () => {
       }),
     ).toBe(true);
   });
+
+  it('allows PYUSD OFT withdrawal through LiFi', () => {
+    expect(
+      isValidLifiTransfer({
+        fromToken: CommonAddress.Ethereum.PYUSD,
+        sourceChainId: ChainId.ArbitrumOne,
+        destinationChainId: ChainId.Ethereum,
+      }),
+    ).toBe(true);
+  });
 });
 
 describe('getTokenOverride', () => {

packages/arb-token-bridge-ui/src/app/api/crosschain-transfers/utils.ts

@@ -8,10 +8,9 @@ import { ChainId } from '../../../types/ChainId';
 import { addressesEqual } from '../../../util/AddressUtils';
 import { CommonAddress, bridgedUsdcToken, commonUsdcToken } from '../../../util/CommonAddressUtils';
 import {
-  getArbitrumOnePyusdOftToken,
-  getEthereumPyusdToken,
-  isTokenArbitrumOnePyusdOft,
-  isTokenEthereumPyusd,
+  getPyusdTokenOverride,
+  isPyusdOverrideFlow,
+  isTokenArbitrumOnePyusdCanonical,
 } from '../../../util/PyusdUtils';
 import { allowedLifiSourceChainIds, lifiDestinationChainIds } from './constants';
 
@@ -66,26 +65,15 @@ export function isValidLifiTransfer({
   }
 
   // Canonical PYUSD is only supported through canonical withdraw
-  if (
-    isTokenEthereumPyusd(fromToken) &&
-    sourceChainId === ChainId.ArbitrumOne &&
-    destinationChainId === ChainId.Ethereum
-  ) {
+  if (isTokenArbitrumOnePyusdCanonical(fromToken)) {
     return false;
   }
 
   if (
-    isTokenEthereumPyusd(fromToken) &&
-    sourceChainId === ChainId.Ethereum &&
-    destinationChainId === ChainId.ArbitrumOne
-  ) {
-    return true;
-  }
-
-  if (
-    isTokenArbitrumOnePyusdOft(fromToken) &&
-    sourceChainId === ChainId.ArbitrumOne &&
-    destinationChainId === ChainId.Ethereum
+    isPyusdOverrideFlow({
+      tokenAddress: fromToken,
+      isDepositMode: sourceChainId === ChainId.Ethereum,
+    })
   ) {
     return true;
   }
@@ -312,26 +300,13 @@ export function getTokenOverride({
     }
   }
 
-  if (
-    isTokenEthereumPyusd(fromToken) &&
-    sourceChainId === ChainId.Ethereum &&
-    destinationChainId === ChainId.ArbitrumOne
-  ) {
-    return {
-      source: getEthereumPyusdToken(),
-      destination: getArbitrumOnePyusdOftToken(),
-    };
-  }
+  const pyusdOverride = getPyusdTokenOverride({
+    tokenAddress: fromToken,
+    isDepositMode: sourceChainId === ChainId.Ethereum,
+  });
 
-  if (
-    isTokenArbitrumOnePyusdOft(fromToken) &&
-    sourceChainId === ChainId.ArbitrumOne &&
-    destinationChainId === ChainId.Ethereum
-  ) {
-    return {
-      source: getArbitrumOnePyusdOftToken(),
-      destination: getEthereumPyusdToken(),
-    };
+  if (pyusdOverride) {
+    return pyusdOverride;
   }
 
   return {

packages/arb-token-bridge-ui/src/components/TransferPanel/DestinationTokenButton.tsx

@@ -1,6 +1,6 @@
 import { ChevronDownIcon } from '@heroicons/react/24/outline';
 
-import { getTokenOverride, isValidLifiTransfer } from '@/bridge/app/api/crosschain-transfers/utils';
+import { isValidLifiTransfer } from '@/bridge/app/api/crosschain-transfers/utils';
 import { useSelectedToken } from '@/bridge/hooks/useSelectedToken';
 
 import { useDestinationToken } from '../../hooks/useDestinationToken';
@@ -32,30 +32,17 @@ export function DestinationTokenButton({
 
   const { childChainProvider } = useNetworksRelationship(networks);
   const nativeCurrency = useNativeCurrency({ provider: childChainProvider });
-  const tokenOverride = getTokenOverride({
-    destinationChainId: networks.destinationChain.id,
-    fromToken: destinationToken?.address,
-    sourceChainId: networks.sourceChain.id,
-  });
 
   const tokenSymbol =
     tokenInfo?.symbol ||
-    (tokenOverride.destination
-      ? sanitizeTokenSymbol(tokenOverride.destination.symbol, {
-          erc20L1Address: tokenOverride.destination.address,
+    (destinationToken
+      ? sanitizeTokenSymbol(destinationToken.symbol, {
+          erc20L1Address: destinationToken.address,
           chainId: networks.destinationChain.id,
         })
-      : destinationToken
-        ? destinationToken?.symbol
-        : nativeCurrency.symbol);
+      : nativeCurrency.symbol);
 
-  const tokenLogoSrc =
-    tokenInfo?.logoUrl ||
-    (tokenOverride.destination
-      ? tokenOverride.destination?.logoURI
-      : destinationToken
-        ? destinationToken?.logoURI
-        : nativeCurrency.logoUrl);
+  const tokenLogoSrc = tokenInfo?.logoUrl || destinationToken?.logoURI || nativeCurrency.logoUrl;
 
   return (
     <>

packages/arb-token-bridge-ui/src/components/TransferPanel/TokenSearch.tsx

@@ -154,7 +154,6 @@ function TokenListsPanel() {
 }
 
 const NATIVE_CURRENCY_IDENTIFIER = 'native_currency';
-const ETHEREUM_PYUSD_ADDRESS = CommonAddress.Ethereum.PYUSD.toLowerCase();
 
 function TokensPanel({
   onTokenSelected,
@@ -198,28 +197,20 @@ function TokensPanel({
 
   const getWithdrawalPyusdToken = useCallback(
     (address: string) => {
-      if (isDepositMode || !isArbitrumOneEthereumPair) {
+      if (isDepositMode) {
         return null;
       }
 
-      const pyusdListEntry = tokensFromLists[ETHEREUM_PYUSD_ADDRESS];
+      const pyusdListEntry = tokensFromLists[CommonAddress.Ethereum.PYUSD];
 
       return getPyusdTokenForTransfer({
         tokenAddress: address,
         isDepositMode,
-        sourceChainId: networks.sourceChain.id,
-        destinationChainId: networks.destinationChain.id,
         priceUSD: pyusdListEntry?.priceUSD,
         listIds: pyusdListEntry?.listIds,
       });
     },
-    [
-      isDepositMode,
-      isArbitrumOneEthereumPair,
-      networks.sourceChain.id,
-      networks.destinationChain.id,
-      tokensFromLists,
-    ],
+    [isDepositMode, tokensFromLists],
   );
 
   const getBalance = useCallback(
@@ -314,6 +305,7 @@ function TokensPanel({
         tokenAddresses.push(CommonAddress.ArbitrumOne.USDC);
         if (isArbitrumOneEthereumPair) {
           tokenAddresses.push(CommonAddress.ArbitrumOne.PYUSDOFT);
+          tokenAddresses.push(CommonAddress.ArbitrumOne.PYUSDCanonical);
         }
       }
       if (isArbitrumSepolia) {
@@ -352,6 +344,15 @@ function TokensPanel({
     return tokens
       .filter((address) => {
         const normalizedAddress = address.toLowerCase();
+
+        if (
+          !isDepositMode &&
+          isArbitrumOneEthereumPair &&
+          addressesEqual(address, CommonAddress.Ethereum.PYUSD)
+        ) {
+          return false;
+        }
+
         const pyusdToken = getWithdrawalPyusdToken(address);
 
         let token =

packages/arb-token-bridge-ui/src/components/TransferPanel/TokenSearchUtils.test.ts

@@ -54,11 +54,11 @@ describe('tokenListsToSearchableTokenStorage', () => {
       '42161',
     );
 
-    expect(tokens[CommonAddress.Ethereum.PYUSD.toLowerCase()]).toMatchObject({
-      address: CommonAddress.Ethereum.PYUSD.toLowerCase(),
+    expect(tokens[CommonAddress.Ethereum.PYUSD]).toMatchObject({
+      address: CommonAddress.Ethereum.PYUSD,
       name: 'PYUSD',
       logoURI: 'https://example.com/black.png',
-      l2Address: CommonAddress.ArbitrumOne.PYUSDOFT.toLowerCase(),
+      l2Address: CommonAddress.ArbitrumOne.PYUSDOFT,
     });
   });
 
@@ -125,11 +125,11 @@ describe('tokenListsToSearchableTokenStorage', () => {
       '42161',
     );
 
-    expect(tokens[CommonAddress.Ethereum.PYUSD.toLowerCase()]).toMatchObject({
-      address: CommonAddress.Ethereum.PYUSD.toLowerCase(),
+    expect(tokens[CommonAddress.Ethereum.PYUSD]).toMatchObject({
+      address: CommonAddress.Ethereum.PYUSD,
       name: 'PYUSD',
       logoURI: 'https://example.com/black.png',
-      l2Address: CommonAddress.ArbitrumOne.PYUSDOFT.toLowerCase(),
+      l2Address: CommonAddress.ArbitrumOne.PYUSDOFT,
     });
   });
 });

packages/arb-token-bridge-ui/src/components/TransferPanel/TransferDisabledDialog.tsx

@@ -10,7 +10,7 @@ import { useTokenLists } from '../../hooks/useTokenLists';
 import { getL2ConfigForTeleport } from '../../token-bridge-sdk/teleport';
 import { ChainId } from '../../types/ChainId';
 import { addressesEqual } from '../../util/AddressUtils';
-import { isTokenArbitrumOnePyusdOft, isTokenEthereumPyusd } from '../../util/PyusdUtils';
+import { isPyusdOverrideFlow } from '../../util/PyusdUtils';
 import { isTeleportEnabledToken } from '../../util/TokenTeleportEnabledUtils';
 import { isTransferDisabledToken } from '../../util/TokenTransferDisabledUtils';
 import { sanitizeTokenSymbol } from '../../util/TokenUtils';
@@ -63,19 +63,10 @@ export function isDisabledCanonicalTransfer({
   }
 
   if (
-    isDepositMode &&
-    isTokenEthereumPyusd(selectedToken.address) &&
-    parentChainId === ChainId.Ethereum &&
-    childChainId === ChainId.ArbitrumOne
-  ) {
-    return true;
-  }
-
-  if (
-    !isDepositMode &&
-    isTokenArbitrumOnePyusdOft(selectedToken.address) &&
-    childChainId === ChainId.ArbitrumOne &&
-    parentChainId === ChainId.Ethereum
+    isPyusdOverrideFlow({
+      tokenAddress: selectedToken.address,
+      isDepositMode,
+    })
   ) {
     return true;
   }

packages/arb-token-bridge-ui/src/components/TransferPanel/hooks/useIsSwapTransfer.test.ts

@@ -3,6 +3,7 @@ import { constants } from 'ethers';
 import { DecodedValueMap } from 'use-query-params';
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 
+import { ERC20BridgeToken, TokenType } from '../../../hooks/arbTokenBridge.types';
 import { queryParamProviderOptions, useArbQueryParams } from '../../../hooks/useArbQueryParams';
 import { useSelectedToken } from '../../../hooks/useSelectedToken';
 import { CommonAddress } from '../../../util/CommonAddressUtils';
@@ -42,28 +43,46 @@ vi.mock('../../../hooks/useSelectedToken', () => ({
 describe('useIsSwapTransfer', () => {
   const mockedUseArbQueryParams = vi.mocked(useArbQueryParams);
   const mockedUseSelectedToken = vi.mocked(useSelectedToken);
+  const defaultSelectedToken: ERC20BridgeToken = {
+    address: CommonAddress.Ethereum.WETH,
+    symbol: 'WETH',
+    name: 'Wrapped Ether',
+    decimals: 18,
+    logoURI: 'https://example.com/weth.png',
+    listIds: new Set(['1']),
+    type: TokenType.ERC20,
+  };
 
   beforeEach(() => {
     vi.clearAllMocks();
 
     mockedUseArbQueryParams.mockReturnValue([
       {
         ...defaultQueryParams,
-        destinationToken: CommonAddress.ArbitrumOne.PYUSDOFT,
+        destinationToken: CommonAddress.Ethereum.WETH,
       },
       vi.fn(),
     ]);
 
+    mockedUseSelectedToken.mockReturnValue([defaultSelectedToken, vi.fn()]);
+  });
+
+  it('does not treat PYUSD (OFT) to PYUSD (L1) as a swap', () => {
     mockedUseSelectedToken.mockReturnValue([
       getArbitrumOnePyusdOftToken({
         priceUSD: 1,
         listIds: new Set(['1']),
       }),
       vi.fn(),
     ]);
-  });
+    mockedUseArbQueryParams.mockReturnValue([
+      {
+        ...defaultQueryParams,
+        destinationToken: CommonAddress.Ethereum.PYUSD,
+      },
+      vi.fn(),
+    ]);
 
-  it('does not treat PYUSD (OFT) to PYUSD (L1) as a swap', () => {
     const { result } = renderHook(useIsSwapTransfer);
     expect(result.current).toBe(false);
   });
@@ -120,4 +139,31 @@ describe('useIsSwapTransfer', () => {
     const { result } = renderHook(useIsSwapTransfer);
     expect(result.current).toBe(true);
   });
+
+  it('returns false when destinationToken is undefined', () => {
+    mockedUseArbQueryParams.mockReturnValue([
+      {
+        ...defaultQueryParams,
+        destinationToken: undefined,
+      },
+      vi.fn(),
+    ]);
+
+    const { result } = renderHook(useIsSwapTransfer);
+    expect(result.current).toBe(false);
+  });
+
+  it('returns false when destinationToken is undefined and selectedToken is null', () => {
+    mockedUseArbQueryParams.mockReturnValue([
+      {
+        ...defaultQueryParams,
+        destinationToken: undefined,
+      },
+      vi.fn(),
+    ]);
+    mockedUseSelectedToken.mockReturnValue([null, vi.fn()]);
+
+    const { result } = renderHook(useIsSwapTransfer);
+    expect(result.current).toBe(false);
+  });
 });

packages/arb-token-bridge-ui/src/components/TransferPanel/hooks/useIsSwapTransfer.ts

@@ -6,9 +6,14 @@ export function useIsSwapTransfer() {
   const [selectedToken] = useSelectedToken();
   const [{ destinationToken }] = useArbQueryParams();
 
-  /**
-   * Destination token is using l1 address and not address on the destination chain
-   * We can compare both address to know if token is the same without checking l2 address
-   */
-  return !addressesEqual(destinationToken, selectedToken?.address);
+  if (
+    !destinationToken ||
+    addressesEqual(destinationToken, selectedToken?.address) ||
+    addressesEqual(destinationToken, selectedToken?.importLookupAddress) ||
+    addressesEqual(destinationToken, selectedToken?.l2Address)
+  ) {
+    return false;
+  }
+
+  return true;
 }