chore: read bridge chains from feature flags and add selectors

MetaMask · Jul 25, 2024 · f155cae · f155cae
1 parent d035314
commit f155cae
Show file tree

Hide file tree

Showing 17 changed files with 554 additions and 66 deletions.
diff --git a/app/scripts/controllers/bridge/bridge-controller.test.ts b/app/scripts/controllers/bridge/bridge-controller.test.ts
@@ -1,5 +1,6 @@
 import nock from 'nock';
 import { BRIDGE_API_BASE_URL } from '../../../../shared/constants/bridge';
+import { CHAIN_IDS } from '../../../../shared/constants/network';
 import BridgeController from './bridge-controller';
 import { BridgeControllerMessenger } from './types';
 import { DEFAULT_BRIDGE_CONTROLLER_STATE } from './constants';
@@ -22,21 +23,32 @@ describe('BridgeController', function () {
     bridgeController = new BridgeController({ messenger: messengerMock });
   });
 
+  beforeEach(() => {
+    jest.clearAllMocks();
+    nock(BRIDGE_API_BASE_URL)
+      .get('/getAllFeatureFlags')
+      .reply(200, {
+        'extension-support': true,
+        'src-network-allowlist': [10, 534352],
+        'dest-network-allowlist': [137, 42161],
+      });
+  });
+
   it('constructor should setup correctly', function () {
     expect(bridgeController.state).toStrictEqual(EMPTY_INIT_STATE);
   });
 
   it('setBridgeFeatureFlags should fetch and set the bridge feature flags', async function () {
-    nock(BRIDGE_API_BASE_URL).get('/getAllFeatureFlags').reply(200, {
-      'extension-support': true,
-    });
-    expect(bridgeController.state.bridgeState.bridgeFeatureFlags).toStrictEqual(
-      { extensionSupport: false },
-    );
+    const expectedFeatureFlagsResponse = {
+      extensionSupport: true,
+      destNetworkAllowlist: [CHAIN_IDS.POLYGON, CHAIN_IDS.ARBITRUM],
+      srcNetworkAllowlist: [CHAIN_IDS.OPTIMISM, CHAIN_IDS.SCROLL],
+    };
+    expect(bridgeController.state).toStrictEqual(EMPTY_INIT_STATE);
 
     await bridgeController.setBridgeFeatureFlags();
     expect(bridgeController.state.bridgeState.bridgeFeatureFlags).toStrictEqual(
-      { extensionSupport: true },
+      expectedFeatureFlagsResponse,
     );
   });
 });
diff --git a/app/scripts/controllers/bridge/constants.ts b/app/scripts/controllers/bridge/constants.ts
@@ -5,5 +5,7 @@ export const BRIDGE_CONTROLLER_NAME = 'BridgeController';
 export const DEFAULT_BRIDGE_CONTROLLER_STATE: BridgeControllerState = {
   bridgeFeatureFlags: {
     [BridgeFeatureFlagsKey.EXTENSION_SUPPORT]: false,
+    [BridgeFeatureFlagsKey.NETWORK_SRC_ALLOWLIST]: [],
+    [BridgeFeatureFlagsKey.NETWORK_DEST_ALLOWLIST]: [],
   },
 };
diff --git a/app/scripts/controllers/bridge/types.ts b/app/scripts/controllers/bridge/types.ts
@@ -2,20 +2,26 @@ import {
   ControllerStateChangeEvent,
   RestrictedControllerMessenger,
 } from '@metamask/base-controller';
+import { Hex } from '@metamask/utils';
 import BridgeController from './bridge-controller';
 import { BRIDGE_CONTROLLER_NAME } from './constants';
 
 export enum BridgeFeatureFlagsKey {
   EXTENSION_SUPPORT = 'extensionSupport',
+  NETWORK_SRC_ALLOWLIST = 'srcNetworkAllowlist',
+  NETWORK_DEST_ALLOWLIST = 'destNetworkAllowlist',
 }
 
 export type BridgeFeatureFlags = {
   [BridgeFeatureFlagsKey.EXTENSION_SUPPORT]: boolean;
+  [BridgeFeatureFlagsKey.NETWORK_SRC_ALLOWLIST]: Hex[];
+  [BridgeFeatureFlagsKey.NETWORK_DEST_ALLOWLIST]: Hex[];
 };
 
 export type BridgeControllerState = {
   bridgeFeatureFlags: BridgeFeatureFlags;
 };
+
 export enum BridgeBackgroundAction {
   SET_FEATURE_FLAGS = 'setBridgeFeatureFlags',
 }

diff --git a/app/scripts/lib/setupSentry.js b/app/scripts/lib/setupSentry.js
@@ -124,6 +124,8 @@ export const SENTRY_BACKGROUND_STATE = {
     bridgeState: {
       bridgeFeatureFlags: {
         extensionSupport: false,
+        destNetworkAllowlist: [],
+        srcNetworkAllowlist: [],
       },
     },
   },

diff --git a/test/e2e/default-fixture.js b/test/e2e/default-fixture.js
@@ -120,7 +120,9 @@ function defaultFixture(inputChainId = CHAIN_IDS.LOCALHOST) {
       BridgeController: {
         bridgeState: {
           bridgeFeatureFlags: {
+            destNetworkAllowlist: [],
             extensionSupport: false,
+            srcNetworkAllowlist: [],
           },
         },
       },

diff --git a/test/e2e/mock-e2e.js b/test/e2e/mock-e2e.js
@@ -1,11 +1,17 @@
 const fs = require('fs');
 
-const { BRIDGE_API_BASE_URL } = require('../../shared/constants/bridge');
+const {
+  BRIDGE_DEV_API_BASE_URL,
+  BRIDGE_PROD_API_BASE_URL,
+} = require('../../shared/constants/bridge');
 const {
   GAS_API_BASE_URL,
   SWAPS_API_V2_BASE_URL,
   TOKEN_API_BASE_URL,
 } = require('../../shared/constants/swaps');
+const {
+  DEFAULT_FEATURE_FLAGS_RESPONSE: BRIDGE_DEFAULT_FEATURE_FLAGS_RESPONSE,
+} = require('./tests/bridge/constants');
 
 const CDN_CONFIG_PATH = 'test/e2e/mock-cdn/cdn-config.txt';
 const CDN_STALE_DIFF_PATH = 'test/e2e/mock-cdn/cdn-stale-diff.txt';
@@ -294,16 +300,18 @@ async function setupMocking(
       };
     });
 
-  await server
-    .forGet(`${BRIDGE_API_BASE_URL}/getAllFeatureFlags`)
-    .thenCallback(() => {
-      return {
-        statusCode: 200,
-        json: {
-          'extension-support': false,
-        },
-      };
-    });
+  [
+    `${BRIDGE_DEV_API_BASE_URL}/getAllFeatureFlags`,
+    `${BRIDGE_PROD_API_BASE_URL}/getAllFeatureFlags`,
+  ].forEach(
+    async (url) =>
+      await server.forGet(url).thenCallback(() => {
+        return {
+          statusCode: 200,
+          json: BRIDGE_DEFAULT_FEATURE_FLAGS_RESPONSE,
+        };
+      }),
+  );
 
   await server
     .forGet(`https://token.api.cx.metamask.io/tokens/${chainId}`)

diff --git a/test/e2e/tests/bridge/constants.ts b/test/e2e/tests/bridge/constants.ts
@@ -2,6 +2,8 @@ import { FeatureFlagResponse } from '../../../../ui/pages/bridge/bridge.util';
 
 export const DEFAULT_FEATURE_FLAGS_RESPONSE: FeatureFlagResponse = {
   'extension-support': false,
+  'src-network-allowlist': [1, 42161, 59144],
+  'dest-network-allowlist': [1, 42161, 59144],
 };
 
 export const LOCATOR = {

diff --git a/test/e2e/tests/metrics/state-snapshots/errors-after-init-opt-in-background-state.json b/test/e2e/tests/metrics/state-snapshots/errors-after-init-opt-in-background-state.json
@@ -60,7 +60,21 @@
   },
   "AuthenticationController": { "isSignedIn": "boolean" },
   "BridgeController": {
-    "bridgeState": { "bridgeFeatureFlags": { "extensionSupport": "boolean" } }
+    "bridgeState": {
+      "bridgeFeatureFlags": {
+        "extensionSupport": "boolean",
+        "srcNetworkAllowlist": {
+          "0": "string",
+          "1": "string",
+          "2": "string"
+        },
+        "destNetworkAllowlist": {
+          "0": "string",
+          "1": "string",
+          "2": "string"
+        }
+      }
+    }
   },
   "CronjobController": { "jobs": "object" },
   "CurrencyController": {

diff --git a/test/e2e/tests/metrics/state-snapshots/errors-after-init-opt-in-ui-state.json b/test/e2e/tests/metrics/state-snapshots/errors-after-init-opt-in-ui-state.json
@@ -253,7 +253,21 @@
       "swapsStxMaxFeeMultiplier": 2,
       "swapsFeatureFlags": {}
     },
-    "bridgeState": { "bridgeFeatureFlags": { "extensionSupport": "boolean" } },
+    "bridgeState": {
+      "bridgeFeatureFlags": {
+        "extensionSupport": "boolean",
+        "srcNetworkAllowlist": {
+          "0": "string",
+          "1": "string",
+          "2": "string"
+        },
+        "destNetworkAllowlist": {
+          "0": "string",
+          "1": "string",
+          "2": "string"
+        }
+      }
+    },
     "ensEntries": "object",
     "ensResolutionsByAddress": "object",
     "pendingApprovals": "object",

diff --git a/test/e2e/tests/metrics/state-snapshots/errors-before-init-opt-in-background-state.json b/test/e2e/tests/metrics/state-snapshots/errors-before-init-opt-in-background-state.json
@@ -145,7 +145,9 @@
     "BridgeController": {
       "bridgeState": {
         "bridgeFeatureFlags": {
-          "extensionSupport": "boolean"
+          "destNetworkAllowlist": {},
+          "extensionSupport": "boolean",
+          "srcNetworkAllowlist": {}
         }
       }
     },

diff --git a/test/e2e/tests/metrics/state-snapshots/errors-before-init-opt-in-ui-state.json b/test/e2e/tests/metrics/state-snapshots/errors-before-init-opt-in-ui-state.json
@@ -154,7 +154,9 @@
     "BridgeController": {
       "bridgeState": {
         "bridgeFeatureFlags": {
-          "extensionSupport": "boolean"
+          "extensionSupport": "boolean",
+          "srcNetworkAllowlist": {},
+          "destNetworkAllowlist": {}
         }
       }
     },

diff --git a/test/jest/mock-store.js b/test/jest/mock-store.js
@@ -668,19 +668,25 @@ export const createSwapsMockStore = () => {
   };
 };
 
-export const createBridgeMockStore = (featureFlagOverrides = {}) => {
+export const createBridgeMockStore = (
+  featureFlagOverrides = {},
+  bridgeSliceOverrides = {},
+) => {
   const swapsStore = createSwapsMockStore();
   return {
     ...swapsStore,
     bridge: {
       toChain: null,
+      ...bridgeSliceOverrides,
     },
     metamask: {
       ...swapsStore.metamask,
       bridgeState: {
         ...(swapsStore.metamask.bridgeState ?? {}),
         bridgeFeatureFlags: {
           extensionSupport: false,
+          srcNetworkAllowlist: [],
+          destNetworkAllowlist: [],
           ...featureFlagOverrides,
         },
       },

diff --git a/ui/ducks/bridge/bridge.ts b/ui/ducks/bridge/bridge.ts
@@ -1,9 +1,11 @@
 import { createSlice } from '@reduxjs/toolkit';
+import { ProviderConfig } from '@metamask/network-controller';
+
 import { swapsSlice } from '../swaps/swaps';
 
 // Only states that are not in swaps slice
-type BridgeState = {
-  toChain: string | null;
+export type BridgeState = {
+  toChain: ProviderConfig | null;
 };
 
 const initialState: BridgeState = {