feat: Dynamic OP Stack L1 gas via gas API

Author: pedronfigueiredo

packages/transaction-controller/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- Identify OP stack chains using gas API ([#6899](https://github.com/MetaMask/core/pull/6899))
+
 ## [60.10.0]
 
 ### Added

packages/transaction-controller/src/gas-flows/OptimismLayer1GasFeeFlow.test.ts

@@ -1,38 +1,139 @@
+import * as ControllerUtils from '@metamask/controller-utils';
+import { hexToNumber, type Hex } from '@metamask/utils';
+
 import { OptimismLayer1GasFeeFlow } from './OptimismLayer1GasFeeFlow';
 import { CHAIN_IDS } from '../constants';
 import type { TransactionControllerMessenger } from '../TransactionController';
 import type { TransactionMeta } from '../types';
 import { TransactionStatus } from '../types';
 
-const TRANSACTION_META_MOCK: TransactionMeta = {
-  id: '1',
-  chainId: CHAIN_IDS.OPTIMISM,
-  networkClientId: 'testNetworkClientId',
-  status: TransactionStatus.unapproved,
-  time: 0,
-  txParams: {
-    from: '0x123',
-    gas: '0x1234',
-  },
+jest.mock('@metamask/controller-utils', () => {
+  const actual = jest.requireActual('@metamask/controller-utils');
+  return { ...actual, handleFetch: jest.fn() };
+});
+
+type SupportedNetworksResponseMock = {
+  fullSupport: number[];
+  partialSupport: { optimism: number[] };
 };
 
+/**
+ * Creates a minimal `TransactionMeta` object for testing with the provided chain ID.
+ *
+ * @param chainId - The hex-encoded chain ID to set on the transaction.
+ * @returns A `TransactionMeta` stub suitable for tests.
+ */
+function createTransaction(chainId: string): TransactionMeta {
+  return {
+    id: '1',
+    chainId: chainId as Hex,
+    networkClientId: 'testNetworkClientId',
+    status: TransactionStatus.unapproved,
+    time: 0,
+    txParams: {
+      from: '0x123',
+      gas: '0x1234',
+    },
+  };
+}
+
 describe('OptimismLayer1GasFeeFlow', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+  const messenger = {} as TransactionControllerMessenger;
+
   describe('matchesTransaction', () => {
+    let handleFetchMock: jest.MockedFunction<
+      (url: string, init?: unknown) => Promise<SupportedNetworksResponseMock>
+    >;
+
+    beforeEach(() => {
+      handleFetchMock = ControllerUtils.handleFetch as jest.MockedFunction<
+        (url: string, init?: unknown) => Promise<SupportedNetworksResponseMock>
+      >;
+      handleFetchMock.mockReset();
+    });
+
     it.each([
-      ['Optimisim mainnet', CHAIN_IDS.OPTIMISM],
-      ['Optimisim testnet', CHAIN_IDS.OPTIMISM_TESTNET],
-    ])('returns true if chain ID is %s', (_title, chainId) => {
+      ['Optimism mainnet', CHAIN_IDS.OPTIMISM],
+      ['Optimism testnet', CHAIN_IDS.OPTIMISM_TESTNET],
+    ])(
+      'uses the fallback list when remote fetch fails for %s',
+      async (_title: string, chainId: string) => {
+        handleFetchMock.mockRejectedValue(new Error('ignore'));
+        const flow = new OptimismLayer1GasFeeFlow();
+        const transactionMeta = createTransaction(chainId);
+
+        expect(
+          await flow.matchesTransaction({
+            transactionMeta,
+            messenger,
+          }),
+        ).toBe(true);
+      },
+    );
+
+    it('returns true when the remote list contains the chain', async () => {
+      handleFetchMock.mockResolvedValue({
+        fullSupport: [],
+        partialSupport: { optimism: [hexToNumber(CHAIN_IDS.OPTIMISM)] },
+      });
       const flow = new OptimismLayer1GasFeeFlow();
+      const transactionMeta = createTransaction(CHAIN_IDS.OPTIMISM);
+
+      expect(
+        await flow.matchesTransaction({
+          transactionMeta,
+          messenger,
+        }),
+      ).toBe(true);
+    });
 
-      const transaction = {
-        ...TRANSACTION_META_MOCK,
-        chainId,
-      };
+    it('falls back to static list when remote list omits the chain', async () => {
+      handleFetchMock.mockResolvedValue({
+        fullSupport: [],
+        partialSupport: { optimism: [] },
+      });
+      const flow = new OptimismLayer1GasFeeFlow();
+      const transactionMeta = createTransaction(CHAIN_IDS.BASE);
+
+      expect(
+        await flow.matchesTransaction({
+          transactionMeta,
+          messenger,
+        }),
+      ).toBe(true);
+    });
+
+    it('returns false when neither remote nor fallback include the chain', async () => {
+      handleFetchMock.mockResolvedValue({
+        fullSupport: [],
+        partialSupport: { optimism: [] },
+      });
+      const flow = new OptimismLayer1GasFeeFlow();
+      const transactionMeta = createTransaction('0x9999');
+
+      expect(
+        await flow.matchesTransaction({
+          transactionMeta,
+          messenger,
+        }),
+      ).toBe(false);
+    });
+
+    it('uses the fallback list when the remote payload is missing', async () => {
+      handleFetchMock.mockResolvedValue(
+        undefined as unknown as SupportedNetworksResponseMock,
+      );
+
+      const flow = new OptimismLayer1GasFeeFlow();
+      const transactionMeta = createTransaction(CHAIN_IDS.ZORA);
 
       expect(
-        flow.matchesTransaction({
-          transactionMeta: transaction,
-          messenger: {} as TransactionControllerMessenger,
+        await flow.matchesTransaction({
+          transactionMeta,
+          messenger,
         }),
       ).toBe(true);
     });

packages/transaction-controller/src/gas-flows/OptimismLayer1GasFeeFlow.ts

@@ -1,11 +1,12 @@
-import { type Hex } from '@metamask/utils';
+import { handleFetch } from '@metamask/controller-utils';
+import { type Hex, hexToNumber } from '@metamask/utils';
 
 import { OracleLayer1GasFeeFlow } from './OracleLayer1GasFeeFlow';
 import { CHAIN_IDS } from '../constants';
 import type { TransactionControllerMessenger } from '../TransactionController';
 import type { TransactionMeta } from '../types';
 
-const OPTIMISM_STACK_CHAIN_IDS: Hex[] = [
+const FALLBACK_OPTIMISM_STACK_CHAIN_IDS: Hex[] = [
   CHAIN_IDS.OPTIMISM,
   CHAIN_IDS.OPTIMISM_TESTNET,
   CHAIN_IDS.BASE,
@@ -15,24 +16,56 @@ const OPTIMISM_STACK_CHAIN_IDS: Hex[] = [
   CHAIN_IDS.ZORA,
 ];
 
-// BlockExplorer link: https://optimistic.etherscan.io/address/0x420000000000000000000000000000000000000f#code
-const OPTIMISM_GAS_PRICE_ORACLE_ADDRESS =
-  '0x420000000000000000000000000000000000000F';
+// Default oracle address now provided by base class
+
+type SupportedNetworksResponse = {
+  readonly fullSupport: readonly number[];
+  readonly partialSupport: {
+    readonly optimism: readonly number[];
+  };
+};
+
+const GAS_SUPPORTED_NETWORKS_ENDPOINT =
+  'https://gas.api.cx.metamask.io/v1/supportedNetworks';
 
 /**
  * Optimism layer 1 gas fee flow that obtains gas fee estimate using an oracle contract.
  */
 export class OptimismLayer1GasFeeFlow extends OracleLayer1GasFeeFlow {
-  constructor() {
-    super(OPTIMISM_GAS_PRICE_ORACLE_ADDRESS);
-  }
-
-  matchesTransaction({
+  async matchesTransaction({
     transactionMeta,
   }: {
     transactionMeta: TransactionMeta;
     messenger: TransactionControllerMessenger;
-  }): boolean {
-    return OPTIMISM_STACK_CHAIN_IDS.includes(transactionMeta.chainId);
+  }): Promise<boolean> {
+    const chainIdAsNumber = hexToNumber(transactionMeta.chainId);
+
+    const supportedChains =
+      await OptimismLayer1GasFeeFlow.fetchOptimismSupportedChains();
+
+    if (supportedChains?.has(chainIdAsNumber)) {
+      return true;
+    }
+
+    return FALLBACK_OPTIMISM_STACK_CHAIN_IDS.includes(transactionMeta.chainId);
+  }
+
+  // Uses default oracle address from base class
+
+  /**
+   * Fetch remote OP-stack support list; fall back to local list when unavailable.
+   *
+   * @returns A set of supported OP-stack chain IDs or null on failure.
+   */
+  private static async fetchOptimismSupportedChains(): Promise<Set<number> | null> {
+    try {
+      const res: SupportedNetworksResponse = await handleFetch(
+        GAS_SUPPORTED_NETWORKS_ENDPOINT,
+      );
+      const list = res?.partialSupport?.optimism ?? [];
+      return new Set<number>(list);
+    } catch {
+      return null;
+    }
   }
 }

packages/transaction-controller/src/gas-flows/OracleLayer1GasFeeFlow.test.ts

@@ -2,9 +2,11 @@ import type { TypedTransaction } from '@ethereumjs/tx';
 import { TransactionFactory } from '@ethereumjs/tx';
 import { Contract } from '@ethersproject/contracts';
 import type { Provider } from '@metamask/network-controller';
+import type { Hex } from '@metamask/utils';
 
 import { OracleLayer1GasFeeFlow } from './OracleLayer1GasFeeFlow';
 import { CHAIN_IDS } from '../constants';
+import type { TransactionControllerMessenger } from '../TransactionController';
 import type { Layer1GasFeeFlowRequest, TransactionMeta } from '../types';
 import { TransactionStatus } from '../types';
 
@@ -33,8 +35,10 @@ const TRANSACTION_META_MOCK: TransactionMeta = {
 };
 
 const SERIALIZED_TRANSACTION_MOCK = '0x1234';
-const ORACLE_ADDRESS_MOCK = '0x5678';
+const ORACLE_ADDRESS_MOCK = '0x5678' as Hex;
 const LAYER_1_FEE_MOCK = '0x9ABCD';
+const DEFAULT_GAS_PRICE_ORACLE_ADDRESS =
+  '0x420000000000000000000000000000000000000F';
 
 /**
  * Creates a mock TypedTransaction object.
@@ -54,7 +58,40 @@ function createMockTypedTransaction(serializedBuffer: Buffer) {
 }
 
 class MockOracleLayer1GasFeeFlow extends OracleLayer1GasFeeFlow {
-  matchesTransaction(): boolean {
+  readonly #sign: boolean;
+
+  constructor(sign: boolean) {
+    super();
+    this.#sign = sign;
+  }
+
+  async matchesTransaction({
+    transactionMeta: _transactionMeta,
+    messenger: _messenger,
+  }: {
+    transactionMeta: TransactionMeta;
+    messenger: TransactionControllerMessenger;
+  }): Promise<boolean> {
+    return true;
+  }
+
+  protected override getOracleAddressForChain(): Hex {
+    return ORACLE_ADDRESS_MOCK;
+  }
+
+  protected override shouldSignTransaction(): boolean {
+    return this.#sign;
+  }
+}
+
+class DefaultOracleLayer1GasFeeFlow extends OracleLayer1GasFeeFlow {
+  async matchesTransaction({
+    transactionMeta: _transactionMeta,
+    messenger: _messenger,
+  }: {
+    transactionMeta: TransactionMeta;
+    messenger: TransactionControllerMessenger;
+  }): Promise<boolean> {
     return true;
   }
 }
@@ -73,6 +110,9 @@ describe('OracleLayer1GasFeeFlow', () => {
       transactionMeta: TRANSACTION_META_MOCK,
     };
 
+    contractMock.mockClear();
+    contractGetL1FeeMock.mockClear();
+
     contractGetL1FeeMock.mockResolvedValue({
       toHexString: () => LAYER_1_FEE_MOCK,
     });
@@ -95,7 +135,7 @@ describe('OracleLayer1GasFeeFlow', () => {
           createMockTypedTransaction(serializedTransactionMock),
         );
 
-      const flow = new MockOracleLayer1GasFeeFlow(ORACLE_ADDRESS_MOCK, false);
+      const flow = new MockOracleLayer1GasFeeFlow(false);
       const response = await flow.getLayer1Fee(request);
 
       expect(response).toStrictEqual({
@@ -132,7 +172,7 @@ describe('OracleLayer1GasFeeFlow', () => {
         .spyOn(TransactionFactory, 'fromTxData')
         .mockReturnValueOnce(typedTransactionMock);
 
-      const flow = new MockOracleLayer1GasFeeFlow(ORACLE_ADDRESS_MOCK, true);
+      const flow = new MockOracleLayer1GasFeeFlow(true);
       const response = await flow.getLayer1Fee(request);
 
       expect(response).toStrictEqual({
@@ -146,7 +186,7 @@ describe('OracleLayer1GasFeeFlow', () => {
       it('if getL1Fee fails', async () => {
         contractGetL1FeeMock.mockRejectedValue(new Error('error'));
 
-        const flow = new MockOracleLayer1GasFeeFlow(ORACLE_ADDRESS_MOCK, false);
+        const flow = new MockOracleLayer1GasFeeFlow(false);
 
         await expect(flow.getLayer1Fee(request)).rejects.toThrow(
           'Failed to get oracle layer 1 gas fee',
@@ -158,12 +198,35 @@ describe('OracleLayer1GasFeeFlow', () => {
           undefined as unknown as ReturnType<typeof contractGetL1FeeMock>,
         );
 
-        const flow = new MockOracleLayer1GasFeeFlow(ORACLE_ADDRESS_MOCK, false);
+        const flow = new MockOracleLayer1GasFeeFlow(false);
 
         await expect(flow.getLayer1Fee(request)).rejects.toThrow(
           'Failed to get oracle layer 1 gas fee',
         );
       });
     });
+
+    it('uses default oracle configuration when subclasses do not override helpers', async () => {
+      const serializedTransactionMock = Buffer.from(
+        SERIALIZED_TRANSACTION_MOCK,
+        'hex',
+      );
+
+      const typedTransactionMock = createMockTypedTransaction(
+        serializedTransactionMock,
+      );
+
+      jest
+        .spyOn(TransactionFactory, 'fromTxData')
+        .mockReturnValueOnce(typedTransactionMock);
+
+      const flow = new DefaultOracleLayer1GasFeeFlow();
+      await flow.getLayer1Fee(request);
+
+      expect(contractMock).toHaveBeenCalledTimes(1);
+      const [oracleAddress] = contractMock.mock.calls[0];
+      expect(oracleAddress).toBe(DEFAULT_GAS_PRICE_ORACLE_ADDRESS);
+      expect(typedTransactionMock.sign).not.toHaveBeenCalled();
+    });
   });
 });