feat: enable STX by default with migration and notification

app/scripts/controllers/preferences-controller.test.ts

@@ -733,6 +733,7 @@ describe('preferences controller', () => {
         privacyMode: false,
         showFiatInTestnets: false,
         showTestNetworks: false,
+        smartTransactionsMigrationApplied: false,
         smartTransactionsOptInStatus: true,
         useNativeCurrencyAsPrimaryCurrency: true,
         hideZeroBalanceTokens: false,
@@ -762,6 +763,7 @@ describe('preferences controller', () => {
         showExtensionInFullSizeView: false,
         showFiatInTestnets: false,
         showTestNetworks: false,
+        smartTransactionsMigrationApplied: false,
         smartTransactionsOptInStatus: true,
         useNativeCurrencyAsPrimaryCurrency: true,
         hideZeroBalanceTokens: false,

app/scripts/controllers/preferences-controller.ts

@@ -104,6 +104,7 @@ export type Preferences = {
   showFiatInTestnets: boolean;
   showTestNetworks: boolean;
   smartTransactionsOptInStatus: boolean;
+  smartTransactionsMigrationApplied: boolean;
   showNativeTokenAsMainBalance: boolean;
   useNativeCurrencyAsPrimaryCurrency: boolean;
   hideZeroBalanceTokens: boolean;
@@ -129,6 +130,7 @@ export type PreferencesControllerState = Omit<
   PreferencesState,
   | 'showTestNetworks'
   | 'smartTransactionsOptInStatus'
+  | 'smartTransactionsMigrationApplied'
   | 'privacyMode'
   | 'tokenSortConfig'
   | 'useMultiRpcMigration'
@@ -217,6 +219,7 @@ export const getDefaultPreferencesControllerState =
       showFiatInTestnets: false,
       showTestNetworks: false,
       smartTransactionsOptInStatus: true,
+      smartTransactionsMigrationApplied: false,
       showNativeTokenAsMainBalance: false,
       useNativeCurrencyAsPrimaryCurrency: true,
       hideZeroBalanceTokens: false,
@@ -406,6 +409,16 @@ const controllerMetadata = {
   preferences: {
     persist: true,
     anonymous: true,
+    properties: {
+      smartTransactionsOptInStatus: {
+        persist: true,
+        anonymous: true,
+      },
+      smartTransactionsMigrationApplied: {
+        persist: true,
+        anonymous: true,
+      },
+    },
   },
   ipfsGateway: {
     persist: true,

app/scripts/migrations/135.test.ts

@@ -0,0 +1,187 @@
+import { SmartTransaction } from '@metamask/smart-transactions-controller/dist/types';
+import { migrate, VersionedData } from './135';
+
+const prevVersion = 134;
+
+describe('migration #135', () => {
+  const mockSmartTransaction: SmartTransaction = {
+    uuid: 'test-uuid',
+  };
+
+  it('should update the version metadata', async () => {
+    const oldStorage: VersionedData = {
+      meta: { version: prevVersion },
+      data: {},
+    };
+
+    const newStorage = await migrate(oldStorage);
+    expect(newStorage.meta).toStrictEqual({ version: 135 });
+  });
+
+  it('should set stx opt-in to true and migration flag when stx opt-in status is null', async () => {
+    const oldStorage: VersionedData = {
+      meta: { version: prevVersion },
+      data: {
+        PreferencesController: {
+          preferences: {
+            smartTransactionsOptInStatus: null,
+          },
+        },
+      },
+    };
+
+    const newStorage = await migrate(oldStorage);
+    expect(
+      newStorage.data.PreferencesController?.preferences
+        ?.smartTransactionsOptInStatus,
+    ).toBe(true);
+    expect(
+      newStorage.data.PreferencesController?.preferences
+        ?.smartTransactionsMigrationApplied,
+    ).toBe(true);
+  });
+
+  it('should set stx opt-in to true and migration flag when stx opt-in status is undefined', async () => {
+    const oldStorage: VersionedData = {
+      meta: { version: prevVersion },
+      data: {
+        PreferencesController: {},
+      },
+    };
+
+    const newStorage = await migrate(oldStorage);
+    expect(
+      newStorage.data.PreferencesController?.preferences
+        ?.smartTransactionsOptInStatus,
+    ).toBe(true);
+    expect(
+      newStorage.data.PreferencesController?.preferences
+        ?.smartTransactionsMigrationApplied,
+    ).toBe(true);
+  });
+
+  it('should set stx opt-in to true and migration flag when stx opt-in is false and no existing mainnet smart transactions', async () => {
+    const oldStorage: VersionedData = {
+      meta: { version: prevVersion },
+      data: {
+        PreferencesController: {
+          preferences: {
+            smartTransactionsOptInStatus: false,
+          },
+        },
+        SmartTransactionsController: {
+          smartTransactionsState: {
+            smartTransactions: {
+              '0x1': [], // Empty mainnet transactions
+              '0xAA36A7': [mockSmartTransaction], // Sepolia has transactions
+            },
+          },
+        },
+      },
+    };
+
+    const newStorage = await migrate(oldStorage);
+    expect(
+      newStorage.data.PreferencesController?.preferences
+        ?.smartTransactionsOptInStatus,
+    ).toBe(true);
+    expect(
+      newStorage.data.PreferencesController?.preferences
+        ?.smartTransactionsMigrationApplied,
+    ).toBe(true);
+  });
+
+  it('should not change stx opt-in when stx opt-in is false but has existing smart transactions, but should set migration flag', async () => {
+    const oldStorage: VersionedData = {
+      meta: { version: prevVersion },
+      data: {
+        PreferencesController: {
+          preferences: {
+            smartTransactionsOptInStatus: false,
+          },
+        },
+        SmartTransactionsController: {
+          smartTransactionsState: {
+            smartTransactions: {
+              '0x1': [mockSmartTransaction],
+            },
+          },
+        },
+      },
+    };
+
+    const newStorage = await migrate(oldStorage);
+    expect(
+      newStorage.data.PreferencesController?.preferences
+        ?.smartTransactionsOptInStatus,
+    ).toBe(false);
+    expect(
+      newStorage.data.PreferencesController?.preferences
+        ?.smartTransactionsMigrationApplied,
+    ).toBe(true);
+  });
+
+  it('should not change stx opt-in when stx opt-in is already true, but should set migration flag', async () => {
+    const oldStorage: VersionedData = {
+      meta: { version: prevVersion },
+      data: {
+        PreferencesController: {
+          preferences: {
+            smartTransactionsOptInStatus: true,
+          },
+        },
+      },
+    };
+
+    const newStorage = await migrate(oldStorage);
+    expect(
+      newStorage.data.PreferencesController?.preferences
+        ?.smartTransactionsOptInStatus,
+    ).toBe(true);
+    expect(
+      newStorage.data.PreferencesController?.preferences
+        ?.smartTransactionsMigrationApplied,
+    ).toBe(true);
+  });
+
+  it('should initialize preferences object if it does not exist', async () => {
+    const oldStorage: VersionedData = {
+      meta: { version: prevVersion },
+      data: {
+        PreferencesController: {
+          preferences: {
+            smartTransactionsOptInStatus: true,
+          },
+        },
+      },
+    };
+
+    const newStorage = await migrate(oldStorage);
+    expect(newStorage.data.PreferencesController?.preferences).toBeDefined();
+    expect(
+      newStorage.data.PreferencesController?.preferences
+        ?.smartTransactionsMigrationApplied,
+    ).toBe(true);
+  });
+
+  it('should capture exception if PreferencesController state is invalid', async () => {
+    const sentryCaptureExceptionMock = jest.fn();
+    global.sentry = {
+      captureException: sentryCaptureExceptionMock,
+    };
+
+    const oldStorage = {
+      meta: { version: prevVersion },
+      data: {
+        PreferencesController: 'invalid',
+      },
+    } as unknown as VersionedData;
+
+    await migrate(oldStorage);
+
+    expect(sentryCaptureExceptionMock).toHaveBeenCalledTimes(1);
+    expect(sentryCaptureExceptionMock).toHaveBeenCalledWith(
+      new Error('Invalid PreferencesController state: string'),
+    );
+  });
+});

app/scripts/migrations/135.ts

@@ -0,0 +1,84 @@
+import { hasProperty, isObject } from '@metamask/utils';
+import { cloneDeep } from 'lodash';
+import type { SmartTransaction } from '@metamask/smart-transactions-controller/dist/types';
+import { CHAIN_IDS } from '@metamask/transaction-controller';
+
+export type VersionedData = {
+  meta: {
+    version: number;
+  };
+  data: {
+    PreferencesController?: {
+      preferences?: {
+        smartTransactionsOptInStatus?: boolean | null;
+        smartTransactionsMigrationApplied?: boolean;
+      };
+    };
+    SmartTransactionsController?: {
+      smartTransactionsState: {
+        smartTransactions: Record<string, SmartTransaction[]>;
+      };
+    };
+  };
+};
+
+export const version = 135;
+
+function transformState(state: VersionedData['data']) {
+  if (
+    !hasProperty(state, 'PreferencesController') ||
+    !isObject(state.PreferencesController)
+  ) {
+    global.sentry?.captureException?.(
+      new Error(
+        `Invalid PreferencesController state: ${typeof state.PreferencesController}`,
+      ),
+    );
+    return state;
+  }
+
+  const { PreferencesController } = state;
+
+  const currentOptInStatus =
+    PreferencesController.preferences?.smartTransactionsOptInStatus;
+
+  if (
+    currentOptInStatus === undefined ||
+    currentOptInStatus === null ||
+    (currentOptInStatus === false && !hasExistingSmartTransactions(state))
+  ) {
+    state.PreferencesController.preferences = {
+      ...state.PreferencesController.preferences,
+      smartTransactionsOptInStatus: true,
+      smartTransactionsMigrationApplied: true,
+    };
+  } else {
+    state.PreferencesController.preferences = {
+      ...state.PreferencesController.preferences,
+      smartTransactionsMigrationApplied: true,
+    };
+  }
+
+  return state;
+}
+
+function hasExistingSmartTransactions(state: VersionedData['data']): boolean {
+  const smartTransactions =
+    state?.SmartTransactionsController?.smartTransactionsState
+      ?.smartTransactions;
+
+  if (!isObject(smartTransactions)) {
+    return false;
+  }
+
+  return (smartTransactions[CHAIN_IDS.MAINNET] || []).length > 0;
+}
+
+export async function migrate(
+  originalVersionedData: VersionedData,
+): Promise<VersionedData> {
+  const versionedData = cloneDeep(originalVersionedData);
+  versionedData.meta.version = version;
+  transformState(versionedData.data);
+  return versionedData;
+}

app/scripts/migrations/index.js

@@ -158,6 +158,7 @@ const migrations = [
   require('./133.1'),
   require('./133.2'),
   require('./134'),
+  require('./135'),
 ];
 
 export default migrations;

privacy-snapshot.json

@@ -13,6 +13,7 @@
   "bafkreifvhjdf6ve4jfv6qytqtux5nd4nwnelioeiqx5x2ez5yrgrzk7ypi.ipfs.dweb.link",
   "bafybeidxfmwycgzcp4v2togflpqh2gnibuexjy4m4qqwxp7nh3jx5zlh4y.ipfs.dweb.link",
   "bridge.api.cx.metamask.io",
+  "bridge.dev-api.cx.metamask.io",
   "cdn.segment.com",
   "cdn.segment.io",
   "cdnjs.cloudflare.com",

shared/constants/alerts.ts

@@ -2,6 +2,7 @@ export enum AlertTypes {
   unconnectedAccount = 'unconnectedAccount',
   web3ShimUsage = 'web3ShimUsage',
   invalidCustomNetwork = 'invalidCustomNetwork',
+  smartTransactionsMigration = 'smartTransactionsMigration',
 }
 
 /**
@@ -10,6 +11,7 @@ export enum AlertTypes {
 export const TOGGLEABLE_ALERT_TYPES = [
   AlertTypes.unconnectedAccount,
   AlertTypes.web3ShimUsage,
+  AlertTypes.smartTransactionsMigration,
 ];
 
 export enum Web3ShimUsageAlertStates {