refactor: reorganize bridge controller

MetaMask · Aug 14, 2024 · ee86bde · ee86bde
1 parent 2707dc3
commit ee86bde
Show file tree

Hide file tree

Showing 10 changed files with 54 additions and 50 deletions.
diff --git a/app/scripts/controllers/bridge.ts b/app/scripts/controllers/bridge.ts
diff --git a/app/scripts/controllers/bridge.test.ts → ...trollers/bridge/bridge-controller.test.ts b/app/scripts/controllers/bridge.test.ts → ...trollers/bridge/bridge-controller.test.ts
@@ -1,6 +1,6 @@
 import nock from 'nock';
-import { BRIDGE_API_BASE_URL } from '../../../shared/constants/bridge';
-import BridgeController from './bridge';
+import { BRIDGE_API_BASE_URL } from '../../../../shared/constants/bridge';
+import BridgeController from './bridge-controller';
 
 const EMPTY_INIT_STATE = {
   bridgeState: {

diff --git a/app/scripts/controllers/bridge/bridge-controller.ts b/app/scripts/controllers/bridge/bridge-controller.ts
@@ -0,0 +1,23 @@
+import { ObservableStore } from '@metamask/obs-store';
+import { fetchBridgeFeatureFlags } from '../../../../ui/pages/bridge/bridge.util';
+import { DEFAULT_BRIDGE_CONTROLLER_STATE } from './constants';
+
+export default class BridgeController {
+  store = new ObservableStore({ bridgeState: DEFAULT_BRIDGE_CONTROLLER_STATE });
+
+  resetState = () => {
+    this.store.updateState({
+      bridgeState: {
+        ...DEFAULT_BRIDGE_CONTROLLER_STATE,
+      },
+    });
+  };
+
+  setBridgeFeatureFlags = async () => {
+    const { bridgeState } = this.store.getState();
+    const bridgeFeatureFlags = await fetchBridgeFeatureFlags();
+    this.store.updateState({
+      bridgeState: { ...bridgeState, bridgeFeatureFlags },
+    });
+  };
+}
diff --git a/app/scripts/controllers/bridge/constants.ts b/app/scripts/controllers/bridge/constants.ts
@@ -0,0 +1,7 @@
+import { BridgeControllerState, BridgeFeatureFlagsKey } from './types';
+
+export const DEFAULT_BRIDGE_CONTROLLER_STATE: BridgeControllerState = {
+  bridgeFeatureFlags: {
+    [BridgeFeatureFlagsKey.EXTENSION_SUPPORT]: false,
+  },
+};
diff --git a/app/scripts/controllers/bridge/types.ts b/app/scripts/controllers/bridge/types.ts
@@ -0,0 +1,16 @@
+// Maps to BridgeController function names
+export enum BridgeBackgroundAction {
+  SET_FEATURE_FLAGS = 'setBridgeFeatureFlags',
+}
+
+export enum BridgeFeatureFlagsKey {
+  EXTENSION_SUPPORT = 'extensionSupport',
+}
+
+export type BridgeFeatureFlags = {
+  [BridgeFeatureFlagsKey.EXTENSION_SUPPORT]: boolean;
+};
+
+export type BridgeControllerState = {
+  bridgeFeatureFlags: BridgeFeatureFlags;
+};
diff --git a/app/scripts/metamask-controller.js b/app/scripts/metamask-controller.js
@@ -331,7 +331,8 @@ import { updateSecurityAlertResponse } from './lib/ppom/ppom-util';
 import createEvmMethodsToNonEvmAccountReqFilterMiddleware from './lib/createEvmMethodsToNonEvmAccountReqFilterMiddleware';
 import { isEthAddress } from './lib/multichain/address';
 import { decodeTransactionData } from './lib/transaction/decode/util';
-import BridgeController, { BridgeBackgroundAction } from './controllers/bridge';
+import { BridgeBackgroundAction } from './controllers/bridge/types';
+import BridgeController from './controllers/bridge/bridge-controller';
 
 export const METAMASK_CONTROLLER_EVENTS = {
   // Fired after state changes that impact the extension badge (unapproved msg count)

diff --git a/ui/ducks/bridge/actions.ts b/ui/ducks/bridge/actions.ts
@@ -1,4 +1,4 @@
-import { BridgeBackgroundAction } from '../../../app/scripts/controllers/bridge';
+import { BridgeBackgroundAction } from '../../../app/scripts/controllers/bridge/types';
 import { forceUpdateMetamaskState } from '../../store/actions';
 import { submitRequestToBackground } from '../../store/background-connection';
 import { MetaMaskReduxDispatch } from '../../store/store';

diff --git a/ui/ducks/bridge/bridge.test.ts b/ui/ducks/bridge/bridge.test.ts
@@ -3,7 +3,7 @@ import thunk from 'redux-thunk';
 import { createBridgeMockStore } from '../../../test/jest/mock-store';
 import { CHAIN_IDS } from '../../../shared/constants/network';
 import { setBackgroundConnection } from '../../store/background-connection';
-import { BridgeBackgroundAction } from '../../../app/scripts/controllers/bridge';
+import { BridgeBackgroundAction } from '../../../app/scripts/controllers/bridge/types';
 import bridgeReducer from './bridge';
 import { setBridgeFeatureFlags, setToChain } from './actions';
 

diff --git a/ui/pages/bridge/bridge.util.ts b/ui/pages/bridge/bridge.util.ts
@@ -1,7 +1,7 @@
 import {
   BridgeFeatureFlagsKey,
   BridgeFeatureFlags,
-} from '../../../app/scripts/controllers/bridge';
+} from '../../../app/scripts/controllers/bridge/types';
 import {
   BRIDGE_API_BASE_URL,
   BRIDGE_CLIENT_ID,

diff --git a/ui/selectors/selectors.js b/ui/selectors/selectors.js
@@ -106,7 +106,7 @@ import {
 import { PRIVACY_POLICY_DATE } from '../helpers/constants/privacy-policy';
 import { ENVIRONMENT_TYPE_POPUP } from '../../shared/constants/app';
 import { MultichainNativeAssets } from '../../shared/constants/multichain/assets';
-import { BridgeFeatureFlagsKey } from '../../app/scripts/controllers/bridge';
+import { BridgeFeatureFlagsKey } from '../../app/scripts/controllers/bridge/types';
 import {
   getAllUnapprovedTransactions,
   getCurrentNetworkTransactions,