feat: migrate to Unified Bridge, introduce the ICTT bridge (ava-labs#82)

package.json

@@ -26,7 +26,7 @@
     "@avalabs/avalanche-module": "0.11.12",
     "@avalabs/avalanchejs": "4.1.0-alpha.25",
     "@avalabs/bitcoin-module": "0.11.12",
-    "@avalabs/bridge-unified": "0.0.0-feat-ictt-configs-20241009072139",
+    "@avalabs/bridge-unified": "4.0.0",
     "@avalabs/core-bridge-sdk": "3.1.0-alpha.19",
     "@avalabs/core-chains-sdk": "3.1.0-alpha.19",
     "@avalabs/core-coingecko-sdk": "3.1.0-alpha.19",

src/background/services/featureFlags/models.ts

@@ -31,6 +31,10 @@ export enum FeatureGates {
   SEEEDLESS_MFA_SETTINGS = 'seedless-mfa-settings',
   SEEDLESS_OPTIONAL_MFA = 'seedless-optional-mfa',
   UNIFIED_BRIDGE_CCTP = 'unified-bridge-cctp',
+  UNIFIED_BRIDGE_ICTT = 'unified-bridge-ictt',
+  UNIFIED_BRIDGE_AB_EVM = 'unified-bridge-ab-evm',
+  UNIFIED_BRIDGE_AB_AVA_TO_BTC = 'unified-bridge-ab-ava-to-btc',
+  UNIFIED_BRIDGE_AB_BTC_TO_AVA = 'unified-bridge-ab-btc-to-ava',
   DEBANK_TRANSACTION_PARSING = 'debank-transaction-parsing',
   DEBANK_TRANSACTION_PRE_EXECUTION = 'debank-transaction-pre-execution',
   PRIMARY_ACCOUNT_REMOVAL = 'primary-account-removal',
@@ -77,6 +81,10 @@ export const DISABLED_FLAG_VALUES: FeatureFlags = {
   [FeatureGates.SEEEDLESS_MFA_SETTINGS]: false,
   [FeatureGates.SEEDLESS_OPTIONAL_MFA]: false,
   [FeatureGates.UNIFIED_BRIDGE_CCTP]: false,
+  [FeatureGates.UNIFIED_BRIDGE_ICTT]: false,
+  [FeatureGates.UNIFIED_BRIDGE_AB_EVM]: false,
+  [FeatureGates.UNIFIED_BRIDGE_AB_AVA_TO_BTC]: false,
+  [FeatureGates.UNIFIED_BRIDGE_AB_BTC_TO_AVA]: false,
   [FeatureGates.DEBANK_TRANSACTION_PARSING]: false,
   [FeatureGates.DEBANK_TRANSACTION_PRE_EXECUTION]: false,
   [FeatureGates.PRIMARY_ACCOUNT_REMOVAL]: false,
@@ -122,6 +130,10 @@ export const DEFAULT_FLAGS: FeatureFlags = {
   [FeatureGates.SEEEDLESS_MFA_SETTINGS]: true,
   [FeatureGates.SEEDLESS_OPTIONAL_MFA]: true,
   [FeatureGates.UNIFIED_BRIDGE_CCTP]: true,
+  [FeatureGates.UNIFIED_BRIDGE_ICTT]: true,
+  [FeatureGates.UNIFIED_BRIDGE_AB_EVM]: true,
+  [FeatureGates.UNIFIED_BRIDGE_AB_AVA_TO_BTC]: true,
+  [FeatureGates.UNIFIED_BRIDGE_AB_BTC_TO_AVA]: true,
   [FeatureGates.DEBANK_TRANSACTION_PARSING]: false,
   [FeatureGates.DEBANK_TRANSACTION_PRE_EXECUTION]: false,
   [FeatureGates.PRIMARY_ACCOUNT_REMOVAL]: true,

src/background/services/storage/schemaMigrations/migrations/unified_bridge_v2.test.ts

@@ -70,6 +70,33 @@ describe('background/services/storage/schemaMigrations/migrations/unified_bridge
       error: undefined,
       value: stateWithPendingTransfers,
     });
+
+    expect(
+      unified_bridge_v2.previousSchema.validate({
+        addresses: [],
+        pendingTransfers: {},
+        version: 1,
+      })
+    ).toEqual({
+      error: undefined,
+      value: {
+        addresses: [],
+        pendingTransfers: {},
+        version: 1,
+      },
+    });
+
+    expect(
+      unified_bridge_v2.previousSchema.validate({ pendingTransfers: {} })
+    ).toEqual({
+      error: undefined,
+      value: { pendingTransfers: {} },
+    });
+
+    expect(unified_bridge_v2.previousSchema.validate({})).toEqual({
+      error: undefined,
+      value: {},
+    });
   });
 
   it('rejects incorrect inputs', () => {
@@ -151,7 +178,7 @@ describe('background/services/storage/schemaMigrations/migrations/unified_bridge
             },
             targetConfirmationCount: 2,
             targetRequiredConfirmationCount: 4,
-            targetStartBlockNumber: 1234567,
+            targetStartBlockNumber: 1234567n,
           },
         },
         version: 2,

src/background/services/storage/schemaMigrations/migrations/unified_bridge_v2.ts

@@ -5,14 +5,14 @@ const VERSION = 2;
 // Schemas & types below only list the relevant properties
 // that actually changed. The rest is untouched & untyped.
 type LegacyBridgeTransfer = {
-  amountDecimals: number;
+  amountDecimals?: number; // the very first version of the SDK did not have it
   symbol: string;
   sourceChain: {
     chainId: string;
   };
   requiredSourceConfirmationCount: number;
   requiredTargetConfirmationCount: number;
-  startBlockNumber?: number;
+  startBlockNumber?: number | bigint; // Even though types say it's always a bigint, I've seen it as a number in my storage.
 };
 
 type NewBridgeTransfer = {
@@ -25,12 +25,13 @@ type NewBridgeTransfer = {
   };
   sourceRequiredConfirmationCount: number;
   targetRequiredConfirmationCount: number;
-  targetStartBlockNumber?: number;
+  targetStartBlockNumber?: bigint;
 };
 
 type PreviousSchema = {
   pendingTransfers?: Record<string, LegacyBridgeTransfer>;
   addresses?: string[];
+  version?: number;
 };
 
 type NewSchema = {
@@ -63,7 +64,7 @@ const previousSchema = Joi.object<PreviousSchema>({
       sourceChain: Joi.object({ chainId: Joi.string() }).unknown(true),
     }).unknown(true)
   ),
-});
+}).unknown(true);
 
 const getUsdcAddressByChainId = (caipId: string) => {
   switch (caipId) {
@@ -102,16 +103,19 @@ const up = async (
       newTransfers[id] = {
         ...rest,
         asset: {
-          // Prior to this schema upgrad, only USDC was possible to bridge (via CCTP)
-          decimals: amountDecimals,
+          // Prior to this schema upgrade, only USDC was possible to bridge (via CCTP)
+          decimals: amountDecimals ?? 6,
           symbol,
           type: 'erc20',
           name: 'USD Coin',
           address: getUsdcAddressByChainId(rest.sourceChain.chainId),
         },
         sourceRequiredConfirmationCount: requiredSourceConfirmationCount,
         targetRequiredConfirmationCount: requiredTargetConfirmationCount,
-        targetStartBlockNumber: startBlockNumber,
+        targetStartBlockNumber:
+          typeof startBlockNumber !== 'undefined'
+            ? BigInt(startBlockNumber)
+            : undefined,
       };
     }
   }

src/background/services/storage/schemaMigrations/schemaMigrations.ts

@@ -34,7 +34,10 @@ export const migrateToLatest = async <T>(
         return result;
       }
 
-      if (currentMigration.migration.previousSchema.validate(result).error) {
+      const { error: validationError } =
+        currentMigration.migration.previousSchema.validate(result);
+
+      if (validationError) {
         throw new Error(
           `Error while upgrading ${key} to version ${currentMigration.version}`
         );

src/background/services/unifiedBridge/UnifiedBridgeService.test.ts

@@ -29,6 +29,7 @@ describe('src/background/services/unifiedBridge/UnifiedBridgeService', () => {
     isMainnet: jest.fn(),
     getNetwork: jest.fn(),
     getProviderForNetwork: jest.fn(),
+    getBitcoinProvider: jest.fn(),
     sendTransaction: jest.fn(),
   } as any;
 
@@ -41,6 +42,10 @@ describe('src/background/services/unifiedBridge/UnifiedBridgeService', () => {
     featureFlags: {
       [FeatureGates.IMPORT_FIREBLOCKS]: true,
       [FeatureGates.UNIFIED_BRIDGE_CCTP]: true,
+      [FeatureGates.UNIFIED_BRIDGE_ICTT]: true,
+      [FeatureGates.UNIFIED_BRIDGE_AB_AVA_TO_BTC]: true,
+      [FeatureGates.UNIFIED_BRIDGE_AB_BTC_TO_AVA]: true,
+      [FeatureGates.UNIFIED_BRIDGE_AB_EVM]: true,
     },
     addListener: jest.fn(),
   } as any;
@@ -64,6 +69,7 @@ describe('src/background/services/unifiedBridge/UnifiedBridgeService', () => {
     networkService.getNetwork.mockImplementation(async (chainId) => ({
       chainId,
     }));
+    networkService.getBitcoinProvider.mockResolvedValue({} as any);
   });
 
   it('creates core instance with proper environment', async () => {
@@ -118,6 +124,10 @@ describe('src/background/services/unifiedBridge/UnifiedBridgeService', () => {
     // Toggle an irrelevant flag off
     mockFeatureFlagChanges({
       [FeatureGates.UNIFIED_BRIDGE_CCTP]: true,
+      [FeatureGates.UNIFIED_BRIDGE_ICTT]: true,
+      [FeatureGates.UNIFIED_BRIDGE_AB_AVA_TO_BTC]: true,
+      [FeatureGates.UNIFIED_BRIDGE_AB_BTC_TO_AVA]: true,
+      [FeatureGates.UNIFIED_BRIDGE_AB_EVM]: true,
       [FeatureGates.IMPORT_FIREBLOCKS]: false,
     });
 
@@ -127,6 +137,10 @@ describe('src/background/services/unifiedBridge/UnifiedBridgeService', () => {
     // Toggle a relevant flag off
     mockFeatureFlagChanges({
       [FeatureGates.UNIFIED_BRIDGE_CCTP]: false,
+      [FeatureGates.UNIFIED_BRIDGE_ICTT]: true,
+      [FeatureGates.UNIFIED_BRIDGE_AB_AVA_TO_BTC]: true,
+      [FeatureGates.UNIFIED_BRIDGE_AB_BTC_TO_AVA]: true,
+      [FeatureGates.UNIFIED_BRIDGE_AB_EVM]: true,
       [FeatureGates.IMPORT_FIREBLOCKS]: false,
     });
 
@@ -180,30 +194,13 @@ describe('src/background/services/unifiedBridge/UnifiedBridgeService', () => {
       });
 
       new UnifiedBridgeService(networkService, storageService, flagsService);
+      await jest.runAllTimersAsync();
       await jest.runAllTicks();
 
-      expect(getEnabledBridgeServices).toHaveBeenCalledTimes(1);
+      expect(getEnabledBridgeServices).toHaveBeenCalledTimes(4);
       expect(wait).toHaveBeenNthCalledWith(1, 2000);
-
-      jest.advanceTimersByTime(2000);
-      await jest.runOnlyPendingTimers();
-      await jest.runAllTicks();
-
-      expect(getEnabledBridgeServices).toHaveBeenCalledTimes(2);
       expect(wait).toHaveBeenNthCalledWith(2, 4000);
-
-      jest.advanceTimersByTime(4000);
-      await jest.runOnlyPendingTimers();
-      await jest.runAllTicks();
-
-      expect(getEnabledBridgeServices).toHaveBeenCalledTimes(3);
       expect(wait).toHaveBeenNthCalledWith(3, 8000);
-
-      jest.advanceTimersByTime(8000);
-      await jest.runOnlyPendingTimers();
-      await jest.runAllTicks();
-
-      expect(getEnabledBridgeServices).toHaveBeenCalledTimes(4);
       expect(createUnifiedBridgeService).toHaveBeenCalled();
     });
   });

src/background/services/unifiedBridge/UnifiedBridgeService.ts

@@ -2,12 +2,14 @@ import { singleton } from 'tsyringe';
 import {
   AnalyzeTxParams,
   AnalyzeTxResult,
+  BridgeInitializer,
   BridgeTransfer,
   BridgeType,
   createUnifiedBridgeService,
   Environment,
   getEnabledBridgeServices,
 } from '@avalabs/bridge-unified';
+import { BitcoinProvider } from '@avalabs/core-wallets-sdk';
 import { wait } from '@avalabs/core-utils-sdk';
 import EventEmitter from 'events';
 
@@ -32,6 +34,7 @@ import {
 import sentryCaptureException, {
   SentryExceptionTypes,
 } from '@src/monitoring/sentryCaptureException';
+import { getEnabledBridgeTypes } from '@src/utils/getEnabledBridgeTypes';
 
 @singleton()
 export class UnifiedBridgeService implements OnStorageReady {
@@ -110,16 +113,49 @@ export class UnifiedBridgeService implements OnStorageReady {
       });
   }
 
-  #getDisabledBridges(): BridgeType[] {
-    const bridges: BridgeType[] = [
-      BridgeType.ICTT_ERC20_ERC20,
-      BridgeType.AVALANCHE_EVM,
-    ];
+  #getBridgeInitializers(
+    bitcoinProvider: BitcoinProvider
+  ): BridgeInitializer[] {
+    return getEnabledBridgeTypes(this.#flagStates).map((type) =>
+      this.#getInitializerForBridgeType(type, bitcoinProvider)
+    );
+  }
 
-    if (!this.#flagStates[FeatureGates.UNIFIED_BRIDGE_CCTP]) {
-      bridges.push(BridgeType.CCTP);
+  #getInitializerForBridgeType(
+    type: BridgeType,
+    bitcoinProvider: BitcoinProvider
+  ): BridgeInitializer {
+    // This backend service is only used for transaction tracking purposes,
+    // therefore we don't need to provide true signing capabilities.
+    const dummySigner = {
+      async sign() {
+        return '0x' as const;
+      },
+    };
+
+    switch (type) {
+      case BridgeType.CCTP:
+      case BridgeType.ICTT_ERC20_ERC20:
+      case BridgeType.AVALANCHE_EVM:
+        return {
+          type,
+          signer: dummySigner,
+        };
+
+      case BridgeType.AVALANCHE_AVA_BTC:
+        return {
+          type,
+          signer: dummySigner,
+          bitcoinFunctions: bitcoinProvider,
+        };
+
+      case BridgeType.AVALANCHE_BTC_AVA:
+        return {
+          type,
+          signer: dummySigner,
+          bitcoinFunctions: bitcoinProvider,
+        };
     }
-    return bridges;
   }
 
   async #recreateService() {
@@ -128,11 +164,13 @@ export class UnifiedBridgeService implements OnStorageReady {
       : Environment.TEST;
 
     try {
+      const bitcoinProvider = await this.networkService.getBitcoinProvider();
+
       this.#core = createUnifiedBridgeService({
         environment,
         enabledBridgeServices: await getEnabledBridgeServices(
           environment,
-          this.#getDisabledBridges()
+          this.#getBridgeInitializers(bitcoinProvider)
         ),
       });
       this.#failedInitAttempts = 0;

src/background/services/unifiedBridge/models.ts

@@ -12,13 +12,20 @@ export enum UnifiedBridgeError {
   InvalidFee = 'invalid-fee',
   UnsupportedNetwork = 'unsupported-network',
   InvalidTxPayload = 'invalid-tx-payload',
+  NonBitcoinAccount = 'non-bitcoin-account',
 }
 
 export type UnifiedBridgeState = {
   pendingTransfers: Record<string, BridgeTransfer>;
 };
 
-export const UNIFIED_BRIDGE_TRACKED_FLAGS = [FeatureGates.UNIFIED_BRIDGE_CCTP];
+export const UNIFIED_BRIDGE_TRACKED_FLAGS = [
+  FeatureGates.UNIFIED_BRIDGE_CCTP,
+  FeatureGates.UNIFIED_BRIDGE_ICTT,
+  FeatureGates.UNIFIED_BRIDGE_AB_AVA_TO_BTC,
+  FeatureGates.UNIFIED_BRIDGE_AB_BTC_TO_AVA,
+  FeatureGates.UNIFIED_BRIDGE_AB_EVM,
+];
 
 export const UNIFIED_BRIDGE_DEFAULT_STATE: UnifiedBridgeState = {
   pendingTransfers: {},

src/components/common/ContainedDropdown.tsx

@@ -107,7 +107,7 @@ export const ContainedDropdown = ({
         width: width ?? '100%',
         borderRadius: borderRadius ?? spacing(0, 0, 1, 1),
         margin: margin ?? '0',
-        height: isOpen ? `${height || calculatedHeight}px` : 0,
+        height: isOpen ? `${height || calculatedHeight - top}px` : 0,
         top,
         opacity: isOpen ? 1 : 0,
       }}