feat: [WT-1693] IMX address mapping to chainId loaded from remote config (#910)

Author: dreamoftrees

packages/checkout/sdk/src/smartCheckout/routing/bridge/bridgeRoute.test.ts

@@ -19,14 +19,15 @@ import { TokenBalanceResult } from '../types';
 import { createBlockchainDataInstance } from '../../../instance';
 import { estimateGasForBridgeApproval } from './estimateApprovalGas';
 import { bridgeGasEstimate } from './bridgeGasEstimate';
-import { INDEXER_ETH_ROOT_CONTRACT_ADDRESS } from './constants';
+import { getImxL1Representation, INDEXER_ETH_ROOT_CONTRACT_ADDRESS } from './constants';
 import { CheckoutErrorType } from '../../../errors';
 import { allowListCheckForBridge } from '../../allowList/allowListCheck';
 
 jest.mock('../../../gasEstimate');
 jest.mock('../../../instance');
 jest.mock('./estimateApprovalGas');
 jest.mock('./bridgeGasEstimate');
+jest.mock('./constants');
 jest.mock('../../allowList/allowListCheck');
 
 describe('bridgeRoute', () => {
@@ -947,7 +948,7 @@ describe('bridgeRoute', () => {
           },
         },
       };
-
+      (getImxL1Representation as jest.Mock).mockResolvedValue('0x2Fa06C6672dDCc066Ab04631192738799231dE4a');
       (createBlockchainDataInstance as jest.Mock).mockReturnValue({
         getToken: jest.fn().mockResolvedValue({}),
       });

packages/checkout/sdk/src/smartCheckout/routing/bridge/bridgeRoute.ts

@@ -50,7 +50,7 @@ export const fetchL1Representation = async (
   if (l2address === '') return '';
 
   if (l2address === IMX_ADDRESS_ZKEVM) {
-    return getImxL1Representation(getL1ChainId(config));
+    return await getImxL1Representation(getL1ChainId(config), config);
   }
 
   const chainName = getIndexerChainName(getL2ChainId(config));

packages/checkout/sdk/src/smartCheckout/routing/bridge/constants.test.ts

@@ -0,0 +1,28 @@
+import { getImxL1Representation } from './constants';
+import { ChainId } from '../../../types';
+
+describe('constants', () => {
+  it('should return the IMX address matching the chainId', async () => {
+    const config = {
+      remote: {
+        getConfig: jest.fn().mockResolvedValue({
+          [ChainId.SEPOLIA]: '0x123',
+        }),
+      },
+    } as any;
+
+    const result = await getImxL1Representation(ChainId.SEPOLIA, config);
+    expect(result).toBe('0x123');
+  });
+
+  it('should return empty when no matching chainId', async () => {
+    const config = {
+      remote: {
+        getConfig: jest.fn().mockResolvedValue({}),
+      },
+    } as any;
+
+    const result = await getImxL1Representation(ChainId.SEPOLIA, config);
+    expect(result).toBe('');
+  });
+});

packages/checkout/sdk/src/smartCheckout/routing/bridge/constants.ts

@@ -1,4 +1,5 @@
-import { ChainId } from '../../../types';
+import { ChainId, ImxAddressConfig } from '../../../types';
+import { CheckoutConfiguration } from '../../../config';
 
 // If the root address evaluates to this then its ETH
 export const INDEXER_ETH_ROOT_CONTRACT_ADDRESS = '0x0000000000000000000000000000000000000001';
@@ -9,9 +10,11 @@ export const getIndexerChainName = (chainId: ChainId): string => {
 };
 
 // Indexer ERC20 call does not support IMX so cannot get root chain mapping from this endpoint.
-// TODO: WT-1693 - Move mapping to remote config
-export const getImxL1Representation = (chainId: ChainId): string => {
-  if (chainId === ChainId.SEPOLIA) return '0x2Fa06C6672dDCc066Ab04631192738799231dE4a';
-  if (chainId === ChainId.ETHEREUM) return '0xF57e7e7C23978C3cAEC3C3548E3D615c346e79fF';
-  return '';
+// Use the remote config instead to find IMX address mapping.
+export const getImxL1Representation = async (chainId: ChainId, config: CheckoutConfiguration): Promise<string> => {
+  const imxMappingConfig = (await config.remote.getConfig(
+    'imxAddressMapping',
+  )) as ImxAddressConfig;
+
+  return imxMappingConfig[chainId] ?? '';
 };

packages/checkout/sdk/src/types/config.ts

@@ -24,6 +24,7 @@ export type RemoteConfiguration = {
   bridge: BridgeConfig;
   allowedNetworks: AllowedNetworkConfig[];
   gasEstimateTokens?: GasEstimateTokenConfig;
+  imxAddressMapping?: ImxAddressConfig;
 };
 
 /**
@@ -87,6 +88,14 @@ export type AllowedNetworkConfig = {
   chainId: number;
 };
 
+/**
+ * A type representing the IMX address mappings across available networks.
+ * @type {{ [chainId: string]: string }}
+ */
+export type ImxAddressConfig = {
+  [chainId: string]: string;
+};
+
 /**
  * A type representing the required information to estimate gas for a transaction.
  * @type {{ [key: string]: { bridgeToL2Addresses?: GasEstimateBridgeToL2TokenConfig, swapAddresses?: GasEstimateSwapTokenConfig } }}