@avalabs/bridge-unified 0.0.0-fix-dual-export-20240111234556 → 0.0.0-fix-address-comparison-20240119104940

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avalabs/bridge-unified",
-  "version": "0.0.0-fix-dual-export-20240111234556",
+  "version": "0.0.0-fix-address-comparison-20240119104940",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -17,7 +17,7 @@
     "ts-jest": "29.1.1",
     "tsup": "7.2.0",
     "@internal/tsup-config": "0.0.1",
-    "eslint-config-custom": "0.0.0-fix-dual-export-20240111234556"
+    "eslint-config-custom": "0.1.0"
   },
   "scripts": {
     "build": "tsup",

package/src/bridges/cctp/handlers/track-transfer.ts

@@ -135,7 +135,7 @@ export const trackSourceTx = async (config: BridgeConfig, params: TrackingParams
      * Get the `TransferTokens` event's log entry from the receipt
      */
     const transferEventLog = txReceipt.logs.find((log) => {
-      if (log.address === sourceChainData.tokenRouterAddress) {
+      if (log.address.toLowerCase() === sourceChainData.tokenRouterAddress.toLowerCase()) {
         const event = decodeEventLog({
           abi: TOKEN_ROUTER_ABI,
           ...log,

package/src/bridges/cctp/handlers/transfer-asset.test.ts

@@ -6,6 +6,7 @@ import {
   BridgeType,
   ErrorReason,
   type Signer,
+  BridgeSignatureReason,
 } from '../../../types';
 import { getClientForChain } from '../../../utils/client';
 import { BRIDGE_ASSET } from '../__mocks__/asset.mock';
@@ -49,6 +50,7 @@ describe('CCTP transferAsset', () => {
   const targetClientMock = {
     getBlockNumber: jest.fn(),
   };
+  const onStepChangeSpy = jest.fn();
 
   const getTransferParams = (props?: Partial<TransferParams>) =>
     ({
@@ -59,6 +61,7 @@ describe('CCTP transferAsset', () => {
       targetChain: TARGET_CHAIN,
       sourceProvider: sourceProviderMock,
       targetProvider: targetProviderMock,
+      onStepChange: onStepChangeSpy,
       ...(props ?? {}),
     }) as TransferParams;
 
@@ -182,6 +185,18 @@ describe('CCTP transferAsset', () => {
         hash: approvalTxHash,
         pollingInterval: 1_000,
       });
+
+      expect(onStepChangeSpy).toHaveBeenCalledTimes(2);
+      expect(onStepChangeSpy).toHaveBeenNthCalledWith(1, {
+        currentSignature: 1,
+        requiredSignatures: 2,
+        currentSignatureReason: BridgeSignatureReason.AllowanceApproval,
+      });
+      expect(onStepChangeSpy).toHaveBeenNthCalledWith(2, {
+        currentSignature: 2,
+        requiredSignatures: 2,
+        currentSignatureReason: BridgeSignatureReason.TokensTransfer,
+      });
     });
 
     it('works without provided signer', async () => {
@@ -255,6 +270,18 @@ describe('CCTP transferAsset', () => {
         hash: approvalTxHash,
         pollingInterval: 1_000,
       });
+
+      expect(onStepChangeSpy).toHaveBeenCalledTimes(2);
+      expect(onStepChangeSpy).toHaveBeenNthCalledWith(1, {
+        currentSignature: 1,
+        requiredSignatures: 2,
+        currentSignatureReason: BridgeSignatureReason.AllowanceApproval,
+      });
+      expect(onStepChangeSpy).toHaveBeenNthCalledWith(2, {
+        currentSignature: 2,
+        requiredSignatures: 2,
+        currentSignatureReason: BridgeSignatureReason.TokensTransfer,
+      });
     });
   });
 
@@ -327,6 +354,13 @@ describe('CCTP transferAsset', () => {
       expect(sourceClientMock.sendRawTransaction).toHaveBeenCalledWith({
         serializedTransaction: bridgeSignedHex,
       });
+
+      expect(onStepChangeSpy).toHaveBeenCalledTimes(1);
+      expect(onStepChangeSpy).toHaveBeenNthCalledWith(1, {
+        currentSignature: 1,
+        requiredSignatures: 1,
+        currentSignatureReason: BridgeSignatureReason.TokensTransfer,
+      });
     });
 
     it('works without provided signer', async () => {
@@ -383,6 +417,13 @@ describe('CCTP transferAsset', () => {
 
       expect(sourceClientMock.writeContract).toHaveBeenCalledTimes(1);
       expect(sourceClientMock.writeContract).toHaveBeenCalledWith(bridgeTxRequest);
+
+      expect(onStepChangeSpy).toHaveBeenCalledTimes(1);
+      expect(onStepChangeSpy).toHaveBeenNthCalledWith(1, {
+        currentSignature: 1,
+        requiredSignatures: 1,
+        currentSignatureReason: BridgeSignatureReason.TokensTransfer,
+      });
     });
   });
 });

package/src/bridges/cctp/handlers/transfer-asset.ts

@@ -6,6 +6,7 @@ import {
   type TransferParams,
   type Hex,
   type BridgeTransfer,
+  BridgeSignatureReason,
 } from '../../../types';
 import { getClientForChain } from '../../../utils/client';
 import { ERC20_ABI } from '../abis/erc20';
@@ -22,6 +23,7 @@ const approveAndTransfer = async (bridge: BridgeService, params: TransferParams)
     fromAddress,
     toAddress: maybeToAddress,
     sourceProvider,
+    onStepChange,
     sign,
   } = params;
   const toAddress = maybeToAddress ?? fromAddress;
@@ -43,7 +45,16 @@ const approveAndTransfer = async (bridge: BridgeService, params: TransferParams)
     args: [fromAddress, sourceChainData.tokenRouterAddress],
   });
 
-  if (allowance < amount) {
+  const isAllowanceApprovalRequired = allowance < amount;
+  const requiredSignatures = isAllowanceApprovalRequired ? 2 : 1; // if approval is required, we'll need 2 signatures
+
+  if (isAllowanceApprovalRequired) {
+    onStepChange?.({
+      currentSignature: 1,
+      currentSignatureReason: BridgeSignatureReason.AllowanceApproval,
+      requiredSignatures,
+    });
+
     if (sign) {
       const data = encodeFunctionData({
         abi: ERC20_ABI,
@@ -75,6 +86,12 @@ const approveAndTransfer = async (bridge: BridgeService, params: TransferParams)
     }
   }
 
+  onStepChange?.({
+    currentSignature: isAllowanceApprovalRequired ? 2 : 1,
+    currentSignatureReason: BridgeSignatureReason.TokensTransfer,
+    requiredSignatures,
+  });
+
   if (sign) {
     const data = encodeFunctionData({
       abi: TOKEN_ROUTER_ABI,

package/src/types/bridge.ts

@@ -18,6 +18,17 @@ export type FeeParams = {
   provider?: Provider;
 };
 
+export enum BridgeSignatureReason {
+  AllowanceApproval = 'allowance-approval',
+  TokensTransfer = 'tokens-transfer',
+}
+
+export type BridgeStepDetails = {
+  currentSignature: number;
+  requiredSignatures: number;
+  currentSignatureReason: BridgeSignatureReason;
+};
+
 export type TransferParams = {
   asset: BridgeAsset;
   amount: bigint;
@@ -27,6 +38,7 @@ export type TransferParams = {
   targetChain: Chain;
   sourceProvider?: Provider;
   targetProvider?: Provider;
+  onStepChange?: (stepDetails: BridgeStepDetails) => void;
   sign?: Signer;
 };