fix: restore saved custom gas settings

Author: pedronfigueiredo

app/components/Views/confirmations/hooks/gas/usePersistGasFeePreference.test.ts

@@ -34,8 +34,8 @@ describe('usePersistGasFeePreference', () => {
       chainId: '0x1',
       gasFeePreferences: {
         userFeeLevel: 'custom',
-        maxBaseFee: '0x1',
-        priorityFee: '0x2',
+        maxBaseFee: '0.000000001',
+        priorityFee: '0.000000002',
       },
     });
   });

app/components/Views/confirmations/hooks/gas/usePersistGasFeePreference.ts

@@ -4,6 +4,7 @@ import type { Hex } from '@metamask/utils';
 
 import Engine from '../../../../../core/Engine';
 import type { AdvancedGasFeePreferences } from '../../../../../core/Engine/controllers/preferences-controller-types';
+import { hexWEIToDecGWEI } from '../../../../../util/conversions';
 
 export function usePersistGasFeePreference() {
   return useCallback(
@@ -21,9 +22,30 @@ export function usePersistGasFeePreference() {
       Engine.context.PreferencesController.setAdvancedGasFee({
         account,
         chainId,
-        gasFeePreferences,
+        gasFeePreferences: normalizeGasFeePreferences(gasFeePreferences),
       });
     },
     [],
   );
 }
+
+function normalizeGasFeePreferences(
+  gasFeePreferences: AdvancedGasFeePreferences,
+): AdvancedGasFeePreferences {
+  return {
+    ...gasFeePreferences,
+    ...(gasFeePreferences.maxBaseFee && {
+      maxBaseFee: hexWEIToDecGWEI(
+        gasFeePreferences.maxBaseFee as Hex,
+      ).toString(),
+    }),
+    ...(gasFeePreferences.priorityFee && {
+      priorityFee: hexWEIToDecGWEI(
+        gasFeePreferences.priorityFee as Hex,
+      ).toString(),
+    }),
+    ...(gasFeePreferences.gasPrice && {
+      gasPrice: hexWEIToDecGWEI(gasFeePreferences.gasPrice as Hex).toString(),
+    }),
+  };
+}

app/core/Engine/controllers/transaction-controller/transaction-controller-init.test.ts

@@ -9,6 +9,7 @@ import {
   TransactionType,
   UserFeeLevel,
   type PublishBatchHookTransaction,
+  type SavedGasFees,
 } from '@metamask/transaction-controller';
 
 import { ORIGIN_METAMASK, toHex } from '@metamask/controller-utils';
@@ -190,6 +191,15 @@ function buildInitRequestMock(
   return requestMock;
 }
 
+type SavedGasFeesWithLevel = SavedGasFees & {
+  gasPrice?: string;
+  level?: UserFeeLevel | GasFeeEstimateLevel;
+};
+
+type GetSavedGasFeesOption = (
+  chainIdOrTransactionMeta: Hex | TransactionMeta,
+) => SavedGasFeesWithLevel | undefined;
+
 describe('Transaction Controller Init', () => {
   const transactionControllerClassMock = jest.mocked(TransactionController);
   const selectShouldUseSmartTransactionMock = jest.mocked(
@@ -336,23 +346,43 @@ describe('Transaction Controller Init', () => {
           },
           selectedAccountAddress: account,
         },
-      );
+      ) as unknown as GetSavedGasFeesOption | undefined;
     }
 
-    it('returns saved custom gas fees for the selected account on the chain', () => {
+    it('returns saved custom gas fees for the transaction account on the chain', () => {
       const optionFn = getSavedGasFeesOption({
         userFeeLevel: UserFeeLevel.CUSTOM,
-        maxBaseFee: '0x1',
-        priorityFee: '0x2',
+        maxBaseFee: '1',
+        priorityFee: '2',
       });
 
-      expect(optionFn?.('0x1')).toEqual({
-        maxBaseFee: '0x1',
-        priorityFee: '0x2',
+      expect(optionFn?.(MOCK_TRANSACTION_META)).toEqual({
+        level: UserFeeLevel.CUSTOM,
+        maxBaseFee: '1',
+        priorityFee: '2',
+      });
+    });
+
+    it('normalizes the transaction account before lookup', () => {
+      const optionFn = getSavedGasFeesOption({
+        userFeeLevel: UserFeeLevel.CUSTOM,
+        maxBaseFee: '1',
+        priorityFee: '2',
+      });
+
+      expect(
+        optionFn?.({
+          ...MOCK_TRANSACTION_META,
+          txParams: { from: account.toUpperCase() },
+        } as TransactionMeta),
+      ).toEqual({
+        level: UserFeeLevel.CUSTOM,
+        maxBaseFee: '1',
+        priorityFee: '2',
       });
     });
 
-    it('normalizes the selected account before lookup', () => {
+    it('uses the transaction account instead of the selected account', () => {
       const optionFn = testConstructorOption(
         'getSavedGasFees',
         {},
@@ -363,49 +393,71 @@ describe('Transaction Controller Init', () => {
             useTransactionSimulations: true,
             advancedGasFee: {
               '0x1': {
-                [account]: {
+                '0x456': {
                   userFeeLevel: UserFeeLevel.CUSTOM,
-                  maxBaseFee: '0x1',
-                  priorityFee: '0x2',
+                  maxBaseFee: '1',
+                  priorityFee: '2',
                 },
               },
             },
           },
-          selectedAccountAddress: account.toUpperCase(),
+          selectedAccountAddress: account,
         },
-      );
+      ) as unknown as GetSavedGasFeesOption | undefined;
 
-      expect(optionFn?.('0x1')).toEqual({
-        maxBaseFee: '0x1',
-        priorityFee: '0x2',
+      expect(
+        optionFn?.({
+          ...MOCK_TRANSACTION_META,
+          txParams: { from: '0x456' },
+        } as TransactionMeta),
+      ).toEqual({
+        level: UserFeeLevel.CUSTOM,
+        maxBaseFee: '1',
+        priorityFee: '2',
       });
     });
 
-    it('returns undefined for estimate-level saved preferences', () => {
+    it('returns saved estimate-level preferences', () => {
       const optionFn = getSavedGasFeesOption({
         userFeeLevel: GasFeeEstimateLevel.Low,
       });
 
-      expect(optionFn?.('0x1')).toBeUndefined();
+      expect(optionFn?.(MOCK_TRANSACTION_META)).toEqual({
+        level: GasFeeEstimateLevel.Low,
+      });
+    });
+
+    it('returns saved legacy custom gas price preferences', () => {
+      const optionFn = getSavedGasFeesOption({
+        userFeeLevel: UserFeeLevel.CUSTOM,
+        gasPrice: '10',
+      });
+
+      expect(optionFn?.(MOCK_TRANSACTION_META)).toEqual({
+        gasPrice: '10',
+        level: UserFeeLevel.CUSTOM,
+      });
     });
 
     it('returns undefined when the custom fees are incomplete', () => {
       const optionFn = getSavedGasFeesOption({
         userFeeLevel: UserFeeLevel.CUSTOM,
-        maxBaseFee: '0x1',
+        maxBaseFee: '1',
       });
 
-      expect(optionFn?.('0x1')).toBeUndefined();
+      expect(optionFn?.(MOCK_TRANSACTION_META)).toBeUndefined();
     });
 
     it('returns undefined when there is no saved preference for the chain', () => {
       const optionFn = getSavedGasFeesOption({
         userFeeLevel: UserFeeLevel.CUSTOM,
-        maxBaseFee: '0x1',
-        priorityFee: '0x2',
+        maxBaseFee: '1',
+        priorityFee: '2',
       });
 
-      expect(optionFn?.('0x2')).toBeUndefined();
+      expect(
+        optionFn?.({ ...MOCK_TRANSACTION_META, chainId: '0x2' }),
+      ).toBeUndefined();
     });
   });
 

app/core/Engine/controllers/transaction-controller/transaction-controller-init.ts

@@ -1,4 +1,5 @@
 import {
+  GasFeeEstimateLevel,
   TransactionController,
   TransactionType,
   UserFeeLevel,
@@ -96,7 +97,8 @@ export const TransactionControllerInit: MessengerClientInitFunction<
         isSimulationEnabled: () =>
           initMessenger.call('PreferencesController:getState')
             .useTransactionSimulations,
-        getSavedGasFees: (chainId) => getSavedGasFees(chainId, initMessenger),
+        getSavedGasFees: (chainIdOrTransactionMeta) =>
+          getSavedGasFees(chainIdOrTransactionMeta, initMessenger),
         messenger: controllerMessenger,
         publicKeyEIP7702: AppConstants.EIP_7702_PUBLIC_KEY as Hex | undefined,
         state: persistedState.TransactionController,
@@ -120,21 +122,31 @@ function isFirstTimeInteractionEnabled(
   );
 }
 
+type SavedGasFeesWithLevel = SavedGasFees & {
+  gasPrice?: string;
+  level?: UserFeeLevel | GasFeeEstimateLevel;
+};
+
 /**
- * `TransactionController` only exposes this hook as `(chainId) => SavedGasFees`,
- * with no account context, so the selected account is used as the best
- * available proxy for "the account this transaction is from". Only a custom
- * EIP-1559 fee override (both `maxBaseFee` and `priorityFee` present) can be
- * expressed by `SavedGasFees` — estimate-level preferences (Low/Medium/High)
- * and legacy `gasPrice` overrides aren't restored through this hook.
+ * Retrieve saved gas fee preferences for the transaction account and chain.
  */
 function getSavedGasFees(
-  chainId: Hex,
+  chainIdOrTransactionMeta: Hex | TransactionMeta,
   initMessenger: TransactionControllerInitMessenger,
-): SavedGasFees | undefined {
-  const account = initMessenger
-    .call('AccountsController:getSelectedAccount')
-    .address.toLowerCase();
+): SavedGasFeesWithLevel | undefined {
+  const selectedAccount = initMessenger.call(
+    'AccountsController:getSelectedAccount',
+  ).address;
+  const isTransactionMeta = typeof chainIdOrTransactionMeta !== 'string';
+  const transactionMeta = isTransactionMeta
+    ? chainIdOrTransactionMeta
+    : undefined;
+  const account = (
+    transactionMeta?.txParams.from ?? selectedAccount
+  ).toLowerCase();
+  const chainId = isTransactionMeta
+    ? chainIdOrTransactionMeta.chainId
+    : chainIdOrTransactionMeta;
 
   const preferencesState = initMessenger.call(
     'PreferencesController:getState',
@@ -143,17 +155,26 @@ function getSavedGasFees(
   const savedGasFeePreference =
     preferencesState.advancedGasFee?.[chainId]?.[account];
 
-  if (savedGasFeePreference?.userFeeLevel !== UserFeeLevel.CUSTOM) {
+  if (!savedGasFeePreference) {
     return undefined;
   }
 
-  const { maxBaseFee, priorityFee } = savedGasFeePreference;
+  const { gasPrice, maxBaseFee, priorityFee, userFeeLevel } =
+    savedGasFeePreference;
+
+  if (userFeeLevel !== UserFeeLevel.CUSTOM) {
+    return { level: userFeeLevel as UserFeeLevel | GasFeeEstimateLevel };
+  }
+
+  if (gasPrice) {
+    return { gasPrice, level: UserFeeLevel.CUSTOM };
+  }
 
   if (!maxBaseFee || !priorityFee) {
     return undefined;
   }
 
-  return { maxBaseFee, priorityFee };
+  return { maxBaseFee, priorityFee, level: UserFeeLevel.CUSTOM };
 }
 
 function getKeyringController(messenger: TransactionControllerInitMessenger) {