@avalabs/bridge-unified 2.1.0 → 2.1.2

package/src/bridges/cctp/factory.test.ts

@@ -1,73 +0,0 @@
-import {
-  BridgeType,
-  type BridgeService,
-  type FeeParams,
-  type TransferParams,
-  type TrackingParams,
-} from '../../types/bridge';
-import { Environment } from '../../types/environment';
-import { ensureHasConfig } from '../../utils/ensure-config';
-import { CCTP_CONFIG } from './__mocks__/config.mock';
-import { cctpBridgeFactory } from './factory';
-import { getAssets } from './handlers/get-assets';
-import { getFees } from './handlers/get-fees';
-import { trackTransfer } from './handlers/track-transfer';
-import { transferAsset } from './handlers/transfer-asset';
-import { getConfig } from './utils/config';
-
-jest.mock('./utils/config');
-jest.mock('../../utils/ensure-config');
-jest.mock('./handlers/get-assets');
-jest.mock('./handlers/get-fees');
-jest.mock('./handlers/transfer-asset');
-jest.mock('./handlers/track-transfer');
-
-describe('CCTP factory', () => {
-  let service: BridgeService;
-  const environment = Environment.TEST;
-
-  beforeEach(() => {
-    jest.resetAllMocks();
-    service = cctpBridgeFactory(environment);
-    (getConfig as jest.Mock).mockResolvedValue(CCTP_CONFIG);
-  });
-
-  it('contains the correct properties', async () => {
-    expect(service.type).toEqual(BridgeType.CCTP);
-    expect(service.config).toBeNull();
-
-    await service.updateConfig();
-    expect(getConfig).toHaveBeenCalledWith(environment);
-    expect(service.config).toStrictEqual(CCTP_CONFIG);
-  });
-
-  describe('handlers', () => {
-    it('calls ensureHasConfig correctly', async () => {
-      await service.ensureHasConfig();
-      expect(ensureHasConfig).toHaveBeenCalledWith(service);
-    });
-
-    it('calls ensureHasConfig correctly', async () => {
-      await service.getAssets();
-      expect(getAssets).toHaveBeenCalledWith(service);
-    });
-
-    it('calls getFees correctly', async () => {
-      const feeParams = { foo: 'bar' } as unknown as FeeParams;
-      await service.getFees(feeParams);
-      expect(getFees).toHaveBeenCalledWith(service, feeParams);
-    });
-
-    it('calls transferAsset correctly', async () => {
-      const transferAssetParams = { foo: 'bar' } as unknown as TransferParams;
-      await service.transferAsset(transferAssetParams);
-      expect(transferAsset).toHaveBeenCalledWith(service, transferAssetParams, environment);
-    });
-
-    it('calls trackTransfer correctly', () => {
-      const trackTransferParams = { foo: 'bar' } as unknown as TrackingParams;
-      service.trackTransfer(trackTransferParams);
-      expect(trackTransfer).toHaveBeenCalledWith(service, trackTransferParams);
-    });
-  });
-});

package/src/bridges/cctp/factory.ts

@@ -1,36 +0,0 @@
-import { type BridgeServiceFactory, BridgeType } from '../../types/bridge';
-import { getConfig } from './utils/config';
-import { getAssets } from './handlers/get-assets';
-import { getFees } from './handlers/get-fees';
-import { transferAsset } from './handlers/transfer-asset';
-import { ensureHasConfig } from '../../utils/ensure-config';
-import { trackTransfer } from './handlers/track-transfer';
-import { estimateGas } from './handlers/estimate-gas';
-
-export const cctpBridgeFactory: BridgeServiceFactory = (environment) => {
-  return {
-    type: BridgeType.CCTP,
-    config: null,
-    updateConfig: async function () {
-      this.config = await getConfig(environment);
-    },
-    ensureHasConfig: async function () {
-      return ensureHasConfig(this);
-    },
-    estimateGas: function (params) {
-      return estimateGas(this, params);
-    },
-    getAssets: async function () {
-      return getAssets(this);
-    },
-    getFees: async function (params) {
-      return getFees(this, params);
-    },
-    transferAsset: async function (params) {
-      return transferAsset(this, params, environment);
-    },
-    trackTransfer: function (params) {
-      return trackTransfer(this, params);
-    },
-  };
-};

package/src/bridges/cctp/handlers/estimate-gas.test.ts

@@ -1,110 +0,0 @@
-import { getClientForChain } from '../../../utils/client';
-import { BridgeType, type BridgeService, type TransferParams } from '../../../types';
-
-import { CCTP_CONFIG } from '../__mocks__/config.mock';
-import { BRIDGE_ASSET } from '../__mocks__/asset.mock';
-import { SOURCE_CHAIN, TARGET_CHAIN } from '../__mocks__/chain.mocks';
-
-import { estimateGas } from './estimate-gas';
-import { isAddress } from 'viem';
-
-jest.mock('viem');
-jest.mock('../../../utils/client');
-
-describe('CCTP estimateGas', () => {
-  const sourceProviderMock = {
-    request: jest.fn(),
-  };
-  const targetProviderMock = {
-    request: jest.fn(),
-  };
-  const bridgeMock = {
-    type: BridgeType.CCTP,
-    config: CCTP_CONFIG,
-    ensureHasConfig: jest.fn(),
-    estimateGas: jest.fn(),
-  } as unknown as BridgeService;
-
-  const getTransferParams = (props?: Partial<TransferParams>) =>
-    ({
-      asset: BRIDGE_ASSET,
-      amount: 1_000_000,
-      fromAddress: '0x787',
-      sourceChain: SOURCE_CHAIN,
-      targetChain: TARGET_CHAIN,
-      sourceProvider: sourceProviderMock,
-      targetProvider: targetProviderMock,
-      ...(props ?? {}),
-    }) as TransferParams;
-
-  const clientMock = {
-    readContract: jest.fn(),
-  };
-
-  beforeEach(() => {
-    jest.resetAllMocks();
-    (getClientForChain as jest.Mock).mockReturnValue(clientMock);
-    jest.mocked(isAddress).mockReturnValue(true);
-  });
-
-  it('calls ensureHasConfig', async () => {
-    const error = new Error('error');
-    const params = getTransferParams();
-    (bridgeMock.ensureHasConfig as jest.Mock).mockRejectedValueOnce(error);
-    await expect(estimateGas(bridgeMock, params)).rejects.toThrow(error);
-
-    expect(bridgeMock.ensureHasConfig).toHaveBeenCalled();
-    expect(getClientForChain).not.toHaveBeenCalled();
-    expect(clientMock.readContract).not.toHaveBeenCalled();
-  });
-
-  describe('when allowance approval is required', () => {
-    beforeEach(() => {
-      clientMock.readContract.mockResolvedValue(0);
-    });
-
-    describe('when onboarding', () => {
-      const params = getTransferParams();
-
-      it('returns the sum of approval and transfer gas estimates', async () => {
-        expect(await estimateGas(bridgeMock, params)).toEqual(235_000n);
-      });
-    });
-
-    describe('when offboarding', () => {
-      const params = getTransferParams({
-        sourceChain: TARGET_CHAIN,
-        targetChain: SOURCE_CHAIN,
-      });
-
-      it('returns the sum of approval and transfer gas estimates', async () => {
-        expect(await estimateGas(bridgeMock, params)).toEqual(275_000n);
-      });
-    });
-  });
-
-  describe('when allowance approval is NOT required', () => {
-    beforeEach(() => {
-      clientMock.readContract.mockResolvedValue(2_000_000n);
-    });
-
-    describe('when onboarding', () => {
-      const params = getTransferParams();
-
-      it('returns the gas estimate for transfer tx alone', async () => {
-        expect(await estimateGas(bridgeMock, params)).toEqual(175_000n);
-      });
-    });
-
-    describe('when offboarding', () => {
-      const params = getTransferParams({
-        sourceChain: TARGET_CHAIN,
-        targetChain: SOURCE_CHAIN,
-      });
-
-      it('returns the gas estimate for transfer tx alone', async () => {
-        expect(await estimateGas(bridgeMock, params)).toEqual(215_000n);
-      });
-    });
-  });
-});

package/src/bridges/cctp/handlers/estimate-gas.ts

@@ -1,58 +0,0 @@
-import { isAddress } from 'viem';
-
-import { InvalidParamsError } from '../../../errors';
-import { getClientForChain } from '../../../utils/client';
-import { ErrorReason, type BridgeService, type TransferParams } from '../../../types';
-
-import { ERC20_ABI } from '../abis/erc20';
-import { getTransferData } from '../utils/transfer-data';
-import { ChainDomain } from '../types/chain';
-
-const ETH_APPROVAL_TX_GAS_ESTIMATE = 60_000n; // 55.5k gas on average (+/- 200 units)
-const ETH_TRANSFER_TX_GAS_ESTIMATE = 175_000n; // 161.5k gas on average (+/- 200 units)
-const AVAX_APPROVAL_TX_GAS_ESTIMATE = 60_000n; // 55.5k gas on average (+/- 200 units)
-const AVAX_TRANSFER_TX_GAS_ESTIMATE = 215_000n; // 203k gas on average (+/- 200 units)
-/**
- * The CCTP bridging consists of up to two transactions:
- *
- *   1. Token spend approval (technically optional, but realistically performed basically every time)
- *   2. Token transfer (required)
- *
- * Since the 2nd one needs the first transaction to be complete, calling .estimateGas() is not possible.
- * The RPC call raises an error since it cannot execute the transfer transaction locally without
- * the allowance being set. For that reason, we're using hard-coded estimates here, with small buffers added.
- *
- * NOTE:  These estimates are only supposed to be used to approximate the network fees in the UI.
- *        DO NOT use them as `gasLimit` prop on the transactions!
- */
-export async function estimateGas(bridge: BridgeService, params: TransferParams): Promise<bigint> {
-  await bridge.ensureHasConfig();
-
-  const { sourceChain, targetChain, asset, amount, fromAddress, toAddress: maybeToAddress, sourceProvider } = params;
-  const toAddress = maybeToAddress ?? fromAddress;
-
-  if (!isAddress(fromAddress) || !isAddress(toAddress)) {
-    throw new InvalidParamsError(ErrorReason.INCORRECT_ADDRESS_PROVIDED);
-  }
-
-  const { sourceChainData, burnToken } = getTransferData({ sourceChain, targetChain, asset, amount }, bridge.config!);
-
-  const client = getClientForChain({ chain: sourceChain, provider: sourceProvider });
-
-  const allowance = await client.readContract({
-    address: burnToken.address,
-    abi: ERC20_ABI,
-    functionName: 'allowance',
-    args: [fromAddress, sourceChainData.tokenRouterAddress],
-  });
-
-  const isOffboarding = sourceChainData.domain === ChainDomain.Avalanche;
-
-  if (allowance >= amount) {
-    return isOffboarding ? AVAX_TRANSFER_TX_GAS_ESTIMATE : ETH_TRANSFER_TX_GAS_ESTIMATE;
-  }
-
-  return isOffboarding
-    ? AVAX_APPROVAL_TX_GAS_ESTIMATE + AVAX_TRANSFER_TX_GAS_ESTIMATE
-    : ETH_APPROVAL_TX_GAS_ESTIMATE + ETH_TRANSFER_TX_GAS_ESTIMATE;
-}

package/src/bridges/cctp/handlers/get-assets.test.ts

@@ -1,47 +0,0 @@
-import { TokenType, type BridgeService, BridgeType } from '../../../types';
-import { SOURCE_CHAIN, TARGET_CHAIN } from '../__mocks__/chain.mocks';
-import { CCTP_CONFIG, SOURCE_TOKEN_ADDRESS, TARGET_TOKEN_ADDRESS } from '../__mocks__/config.mock';
-import { getAssets } from './get-assets';
-
-describe('CCTP getAssets', () => {
-  const bridgeMock = {
-    ensureHasConfig: jest.fn(),
-    config: CCTP_CONFIG,
-  } as unknown as BridgeService;
-
-  it('calls ensureHasConfig', async () => {
-    await getAssets(bridgeMock);
-    expect(bridgeMock.ensureHasConfig).toHaveBeenCalled();
-  });
-
-  it('returns the correct assets', async () => {
-    const assets = await getAssets(bridgeMock);
-
-    expect(assets).toStrictEqual({
-      [SOURCE_CHAIN.chainId]: [
-        {
-          address: SOURCE_TOKEN_ADDRESS,
-          name: 'USD Coin',
-          symbol: 'USDC',
-          decimals: 6,
-          type: TokenType.ERC20,
-          destinations: {
-            [TARGET_CHAIN.chainId]: [BridgeType.CCTP],
-          },
-        },
-      ],
-      [TARGET_CHAIN.chainId]: [
-        {
-          address: TARGET_TOKEN_ADDRESS,
-          name: 'USD Coin',
-          symbol: 'USDC',
-          decimals: 6,
-          type: TokenType.ERC20,
-          destinations: {
-            [SOURCE_CHAIN.chainId]: [BridgeType.CCTP],
-          },
-        },
-      ],
-    });
-  });
-});

package/src/bridges/cctp/handlers/get-assets.ts

@@ -1,27 +0,0 @@
-import { TokenType, type BridgeService, type ChainAssetMap, type DestinationInfo, BridgeType } from '../../../types';
-
-export async function getAssets(bridge: BridgeService) {
-  await bridge.ensureHasConfig();
-
-  const chainIds = bridge.config!.map((chainData) => chainData.chainId);
-
-  return bridge.config!.reduce<ChainAssetMap>((assets, chainData) => {
-    assets[chainData.chainId] = chainData.tokens.map((asset) => ({
-      ...asset,
-      type: TokenType.ERC20,
-      destinations: chainIds.reduce<DestinationInfo>((destinations, chainId) => {
-        if (chainData.chainId !== chainId) {
-          if (!destinations[chainId]) {
-            destinations[chainId] = [];
-          }
-
-          destinations[chainId]?.push(BridgeType.CCTP);
-        }
-
-        return destinations;
-      }, {}),
-    }));
-
-    return assets;
-  }, {});
-}

package/src/bridges/cctp/handlers/get-fees.test.ts

@@ -1,61 +0,0 @@
-import type { BridgeService, FeeParams } from '../../../types';
-import { getClientForChain } from '../../../utils/client';
-import { BRIDGE_ASSET } from '../__mocks__/asset.mock';
-import { SOURCE_CHAIN, TARGET_CHAIN } from '../__mocks__/chain.mocks';
-import { CCTP_CONFIG, SOURCE_ROUTER_ADDRESS } from '../__mocks__/config.mock';
-import { TOKEN_ROUTER_ABI } from '../abis/token-router';
-import { getFees } from './get-fees';
-
-jest.mock('../../../utils/client');
-
-describe('CCTP getFees', () => {
-  const feeParams = {
-    sourceChain: SOURCE_CHAIN,
-    targetChain: TARGET_CHAIN,
-    asset: BRIDGE_ASSET,
-    amount: 1_000_000,
-  } as unknown as FeeParams;
-
-  const bridgeMock = {
-    ensureHasConfig: jest.fn(),
-    config: CCTP_CONFIG,
-  } as unknown as BridgeService;
-
-  const clientMock = {
-    readContract: jest.fn(),
-  };
-
-  beforeEach(() => {
-    jest.resetAllMocks();
-    (getClientForChain as jest.Mock).mockReturnValue(clientMock);
-  });
-
-  it('calls ensureHasConfig', async () => {
-    const error = new Error('error');
-    (bridgeMock.ensureHasConfig as jest.Mock).mockRejectedValueOnce(error);
-    await expect(getFees(bridgeMock, feeParams)).rejects.toThrow(error);
-
-    expect(bridgeMock.ensureHasConfig).toHaveBeenCalled();
-    expect(getClientForChain).not.toHaveBeenCalled();
-    expect(clientMock.readContract).not.toHaveBeenCalled();
-  });
-
-  it('returns the fee correctly', async () => {
-    const feeAmount = 2_000_000;
-    clientMock.readContract.mockResolvedValueOnce(feeAmount);
-
-    const fees = await getFees(bridgeMock, feeParams);
-
-    expect(fees).toStrictEqual({
-      [BRIDGE_ASSET.address!]: feeAmount,
-    });
-    expect(bridgeMock.ensureHasConfig).toHaveBeenCalled();
-    expect(getClientForChain).toHaveBeenCalledWith({ chain: feeParams.sourceChain, provider: undefined });
-    expect(clientMock.readContract).toHaveBeenCalledWith({
-      address: SOURCE_ROUTER_ADDRESS,
-      abi: TOKEN_ROUTER_ABI,
-      functionName: 'calculateFee',
-      args: [feeParams.amount, 1],
-    });
-  });
-});

package/src/bridges/cctp/handlers/get-fees.ts

@@ -1,26 +0,0 @@
-import type { AssetFeeMap, BridgeService, FeeParams } from '../../../types';
-import { getClientForChain } from '../../../utils/client';
-import { TOKEN_ROUTER_ABI } from '../abis/token-router';
-import { getTransferData } from '../utils/transfer-data';
-
-export async function getFees(bridge: BridgeService, params: FeeParams) {
-  await bridge.ensureHasConfig();
-
-  const { sourceChain, targetChain, asset, amount, provider } = params;
-  const { sourceChainData, targetChainData, burnToken } = getTransferData(
-    { sourceChain, targetChain, asset, amount },
-    bridge.config!,
-  );
-
-  const client = getClientForChain({ chain: sourceChain, provider });
-  const feeAmount = await client.readContract({
-    address: sourceChainData.tokenRouterAddress,
-    abi: TOKEN_ROUTER_ABI,
-    functionName: 'calculateFee',
-    args: [amount, targetChainData.domain],
-  });
-
-  return {
-    [burnToken.address]: feeAmount,
-  } as AssetFeeMap;
-}