feat: Fetch orbit chains data

.github/scripts/fetchOrbitChainsData.ts

@@ -0,0 +1,123 @@
+import * as fs from 'fs';
+import { L2Network, constants as arbConstants } from '@arbitrum/sdk';
+
+type OrbitChainData = {
+  chainId: number;
+  confirmPeriodBlocks: number;
+  ethBridge: {
+    bridge: string;
+    inbox: string;
+    outbox: string;
+    rollup: string;
+    sequencerInbox: string;
+  };
+  nativeToken: string;
+  explorerUrl: string;
+  rpcUrl: string;
+  isCustom: boolean;
+  isTestnet: boolean;
+  name: string;
+  slug: string;
+  parentChainId: number;
+  tokenBridge: {
+    parentCustomGateway: string;
+    parentErc20Gateway: string;
+    parentGatewayRouter: string;
+    parentMultiCall: string;
+    parentProxyAdmin: string;
+    parentWeth: string;
+    parentWethGateway: string;
+    childCustomGateway: string;
+    childErc20Gateway: string;
+    childGatewayRouter: string;
+    childMultiCall: string;
+    childProxyAdmin: string;
+    childWeth: string;
+    childWethGateway: string;
+  };
+  bridgeUiConfig: {
+    color: string;
+    network: {
+      name: string;
+      logo: string;
+      description: string;
+    };
+    nativeTokenData: {
+      name: string;
+      symbol: string;
+      logoUrl: string;
+    };
+  };
+};
+
+type OrbitChainDataResponse = {
+  mainnet: OrbitChainData[];
+  testnet: OrbitChainData[];
+};
+
+type L2NetworkWithRpc = L2Network & { rpcUrl: string };
+
+const fileName = './src/Assets/orbitChainsData.json';
+
+export async function fetchOrbitChainsData() {
+  const response = await fetch(
+    'https://raw.githubusercontent.com/OffchainLabs/arbitrum-token-bridge/refs/heads/master/packages/arb-token-bridge-ui/src/util/orbitChainsData.json',
+  );
+
+  const data: OrbitChainDataResponse = await response.json();
+  return data.mainnet.concat(data.testnet);
+}
+
+function parseChainToL2Network({
+  chainId,
+  nativeToken,
+  isTestnet,
+  slug,
+  bridgeUiConfig,
+  parentChainId,
+  tokenBridge,
+  ...chain
+}: OrbitChainData): L2NetworkWithRpc {
+  return {
+    chainID: chainId,
+    nitroGenesisBlock: 0,
+    nitroGenesisL1Block: 0,
+    isArbitrum: true,
+    partnerChainID: parentChainId,
+    partnerChainIDs: [],
+    retryableLifetimeSeconds: 604800,
+    depositTimeout: 1800000,
+    blockTime: arbConstants.ARB_MINIMUM_BLOCK_TIME_IN_SECONDS,
+    tokenBridge: {
+      l1CustomGateway: tokenBridge.parentCustomGateway,
+      l1ERC20Gateway: tokenBridge.parentErc20Gateway,
+      l1GatewayRouter: tokenBridge.parentGatewayRouter,
+      l1MultiCall: tokenBridge.parentMultiCall,
+      l1ProxyAdmin: tokenBridge.parentProxyAdmin,
+      l1Weth: tokenBridge.parentWeth,
+      l1WethGateway: tokenBridge.parentWethGateway,
+      l2CustomGateway: tokenBridge.childCustomGateway,
+      l2ERC20Gateway: tokenBridge.childErc20Gateway,
+      l2GatewayRouter: tokenBridge.childGatewayRouter,
+      l2Multicall: tokenBridge.childMultiCall,
+      l2ProxyAdmin: tokenBridge.childProxyAdmin,
+      l2Weth: tokenBridge.childWeth,
+      l2WethGateway: tokenBridge.childWethGateway,
+    },
+    ...chain,
+  };
+}
+
+(async () => {
+  const orbitChains = await fetchOrbitChainsData();
+  const result: L2NetworkWithRpc[] = orbitChains.map((orbitChain) =>
+    parseChainToL2Network(orbitChain),
+  );
+
+  fs.writeFileSync(
+    fileName,
+    JSON.stringify({
+      data: result,
+    }),
+  );
+})();

.github/scripts/generateMatrix.ts

@@ -0,0 +1,165 @@
+import { customNetworks } from '../../src/customNetworks';
+
+type Command = {
+  name: string;
+  paths: string[];
+  version: boolean;
+  command: string;
+};
+
+const arbitrumCommands: Command[] = [
+  // Arb1
+  {
+    name: 'Arb1 FullList',
+    paths: ['ArbTokenLists/arbed_full.json'],
+    version: false,
+    command:
+      'yarn fullList --l2NetworkID 42161 --newArbifiedList ./src/ArbTokenLists/arbed_full.json --skipValidation',
+  },
+  {
+    name: 'Arb1 Arbify Uniswap',
+    paths: [
+      'ArbTokenLists/arbed_uniswap_labs.json',
+      'ArbTokenLists/arbed_uniswap_labs_default.json',
+    ],
+    version: true,
+    command:
+      'yarn arbify --l2NetworkID 42161 --prevArbifiedList https://tokenlist.arbitrum.io/ArbTokenLists/arbed_uniswap_labs.json --tokenList https://tokens.uniswap.org --newArbifiedList ./src/ArbTokenLists/arbed_uniswap_labs.json && cp ./src/ArbTokenLists/arbed_uniswap_labs.json ./src/ArbTokenLists/arbed_uniswap_labs_default.json',
+  },
+  {
+    name: 'Arb1 Sepolia Arbify Uniswap',
+    paths: ['ArbTokenLists/421614_arbed_uniswap_labs.json'],
+    version: true,
+    command:
+      'yarn arbify --l2NetworkID 421614 --prevArbifiedList https://tokenlist.arbitrum.io/ArbTokenLists/421614_arbed_uniswap_labs.json --tokenList https://tokens.uniswap.org --newArbifiedList ./src/ArbTokenLists/421614_arbed_uniswap_labs.json',
+  },
+  {
+    name: 'Arb1 Arbify CMC',
+    paths: ['ArbTokenLists/arbed_coinmarketcap.json'],
+    version: true,
+    command:
+      'yarn arbify --l2NetworkID 42161 --prevArbifiedList https://tokenlist.arbitrum.io/ArbTokenLists/arbed_coinmarketcap.json --tokenList https://api.coinmarketcap.com/data-api/v3/uniswap/all.json --newArbifiedList ./src/ArbTokenLists/arbed_coinmarketcap.json',
+  },
+  {
+    name: 'Arb1 Arbify CoinGecko',
+    paths: ['ArbTokenLists/arbed_coingecko.json'],
+    version: true,
+    command:
+      'yarn arbify --l2NetworkID 42161 --prevArbifiedList https://tokenlist.arbitrum.io/ArbTokenLists/arbed_coingecko.json --tokenList https://tokens.coingecko.com/uniswap/all.json --newArbifiedList ./src/ArbTokenLists/arbed_coingecko.json',
+  },
+  {
+    name: 'Arb1 Update Whitelist',
+    paths: ['ArbTokenLists/arbed_arb_whitelist_era.json'],
+    version: true,
+    command:
+      'yarn update --l2NetworkID 42161 --prevArbifiedList https://tokenlist.arbitrum.io/ArbTokenLists/arbed_arb_whitelist_era.json --tokenList https://tokenlist.arbitrum.io/ArbTokenLists/arbed_arb_whitelist_era.json --includeOldDataFields true --newArbifiedList ./src/ArbTokenLists/arbed_arb_whitelist_era.json',
+  },
+  // Arb Nova
+  {
+    name: 'ArbNova Arbify Uniswap',
+    paths: [
+      'ArbTokenLists/42170_arbed_uniswap_labs.json',
+      'ArbTokenLists/42170_arbed_uniswap_labs_default.json',
+    ],
+    version: true,
+    command:
+      'yarn arbify --l2NetworkID 42170 --prevArbifiedList https://tokenlist.arbitrum.io/ArbTokenLists/42170_arbed_uniswap_labs_default.json --newArbifiedList ./src/ArbTokenLists/42170_arbed_uniswap_labs.json --tokenList https://tokens.uniswap.org && cp ./src/ArbTokenLists/42170_arbed_uniswap_labs.json ./src/ArbTokenLists/42170_arbed_uniswap_labs_default.json',
+  },
+  {
+    name: 'ArbNova Arbify CMC',
+    paths: ['ArbTokenLists/42170_arbed_coinmarketcap.json'],
+    version: true,
+    command:
+      'yarn arbify --l2NetworkID 42170 --prevArbifiedList https://tokenlist.arbitrum.io/ArbTokenLists/42170_arbed_coinmarketcap.json --tokenList https://api.coinmarketcap.com/data-api/v3/uniswap/all.json --newArbifiedList ./src/ArbTokenLists/42170_arbed_coinmarketcap.json',
+  },
+  {
+    name: 'ArbNova Arbify CoinGecko',
+    paths: ['ArbTokenLists/42170_arbed_coingecko.json'],
+    version: true,
+    command:
+      'yarn arbify --l2NetworkID 42170 --prevArbifiedList https://tokenlist.arbitrum.io/ArbTokenLists/42170_arbed_coingecko.json --tokenList https://tokens.coingecko.com/uniswap/all.json --newArbifiedList ./src/ArbTokenLists/42170_arbed_coingecko.json',
+  },
+  // ArbSepolia
+  {
+    name: 'ArbSepolia Arbify Uniswap',
+    paths: ['ArbTokenLists/421614_arbed_uniswap_labs.json'],
+    version: true,
+    command:
+      'yarn arbify --l2NetworkID 421614 --prevArbifiedList https://tokenlist.arbitrum.io/ArbTokenLists/421614_arbed_uniswap_labs.json --tokenList https://tokens.uniswap.org --newArbifiedList ./src/ArbTokenLists/421614_arbed_uniswap_labs.json',
+  },
+  {
+    name: 'ArbSepolia Arbify CoinGecko',
+    paths: ['ArbTokenLists/421614_arbed_coingecko.json'],
+    version: true,
+    command:
+      'yarn arbify --l2NetworkID 421614 --prevArbifiedList https://tokenlist.arbitrum.io/ArbTokenLists/421614_arbed_coingecko.json  --tokenList https://tokens.coingecko.com/uniswap/all.json --newArbifiedList ./src/ArbTokenLists/421614_arbed_coingecko.json',
+  },
+];
+
+const orbitCommands: Command[] = [];
+
+async function addCommand({
+  chainID,
+  name,
+  path,
+  inputList,
+}: {
+  chainID: number;
+  name: string;
+  path: string;
+  inputList: string;
+}) {
+  const url = `https://tokenlist.arbitrum.io/${path}`;
+  const requiresFirstTimeGeneration = await fetch(url)
+    .then((response) => response.json())
+    .then(() => false)
+    .catch(() => true);
+
+  const previousListFlag = requiresFirstTimeGeneration
+    ? '--ignorePreviousList'
+    : `--prevArbifiedList ${url}`;
+
+  return {
+    name,
+    paths: [path],
+    version: true,
+    command: `yarn arbify --l2NetworkID ${chainID} ${previousListFlag} --tokenList ${inputList} --newArbifiedList ./src/${path}`,
+  };
+}
+
+const l1ChainIds = [1, 11155111, 17000]; // Mainnet, sepolia, holesky
+(async () => {
+  for (let { name, chainID, partnerChainID } of customNetworks) {
+    // For Orbit chain settling on L1, use uniswap as source. Otherwise use arbified token list
+    const inputUniswapTokenList = l1ChainIds.includes(partnerChainID)
+      ? 'https://tokens.uniswap.org'
+      : 'https://tokenlist.arbitrum.io/ArbTokenLists/arbed_uniswap_labs.json';
+
+    orbitCommands.push(
+      await addCommand({
+        name: `${name} Arbify Uniswap`,
+        chainID,
+        path: `ArbTokenLists/${chainID}_arbed_uniswap_labs.json`,
+        inputList: inputUniswapTokenList,
+      }),
+    );
+
+    // For L3, generate arbified native token list
+    if (!l1ChainIds.includes(partnerChainID)) {
+      orbitCommands.push(
+        await addCommand({
+          name: `${name} Arbify L2 native list`,
+          chainID,
+          path: `ArbTokenLists/${chainID}_arbed_native_list.json`,
+          inputList: './src/Assets/42161_arbitrum_native_token_list.json',
+        }),
+      );
+    }
+  }
+
+  const matrix: Record<'include', Command[]> = {
+    include: arbitrumCommands.concat(orbitCommands),
+  };
+
+  console.log(JSON.stringify(matrix, null, 0));
+})();

.github/workflows/generate-new-orbit-chain-token-list.yml

@@ -0,0 +1,14 @@
+name: Generate new orbit chain token list
+
+on:
+  schedule:
+    # Every day at 9:00
+    - cron: '0 9 * * *'
+
+jobs:
+  generate-token-lists:
+    uses: ./.github/workflows/generate-token-lists.yml
+    with:
+      environment: 'Test'
+      firstTimeGeneration: true
+    secrets: inherit