@metamask/transaction-controller 61.0.0 → 61.2.0

package/dist/gas-flows/OptimismLayer1GasFeeFlow.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"OptimismLayer1GasFeeFlow.mjs","sourceRoot":"","sources":["../../src/gas-flows/OptimismLayer1GasFeeFlow.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,sBAAsB,EAAE,qCAAiC;AAClE,OAAO,EAAE,SAAS,EAAE,yBAAqB;AAIzC,MAAM,wBAAwB,GAAU;IACtC,SAAS,CAAC,QAAQ;IAClB,SAAS,CAAC,gBAAgB;IAC1B,SAAS,CAAC,IAAI;IACd,SAAS,CAAC,YAAY;IACtB,SAAS,CAAC,KAAK;IACf,SAAS,CAAC,aAAa;IACvB,SAAS,CAAC,IAAI;CACf,CAAC;AAEF,8GAA8G;AAC9G,MAAM,iCAAiC,GACrC,4CAA4C,CAAC;AAE/C;;GAEG;AACH,MAAM,OAAO,wBAAyB,SAAQ,sBAAsB;IAClE;QACE,KAAK,CAAC,iCAAiC,CAAC,CAAC;IAC3C,CAAC;IAED,kBAAkB,CAAC,EACjB,eAAe,GAIhB;QACC,OAAO,wBAAwB,CAAC,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IACpE,CAAC;CACF","sourcesContent":["import { type Hex } from '@metamask/utils';\n\nimport { OracleLayer1GasFeeFlow } from './OracleLayer1GasFeeFlow';\nimport { CHAIN_IDS } from '../constants';\nimport type { TransactionControllerMessenger } from '../TransactionController';\nimport type { TransactionMeta } from '../types';\n\nconst OPTIMISM_STACK_CHAIN_IDS: Hex[] = [\n  CHAIN_IDS.OPTIMISM,\n  CHAIN_IDS.OPTIMISM_TESTNET,\n  CHAIN_IDS.BASE,\n  CHAIN_IDS.BASE_TESTNET,\n  CHAIN_IDS.OPBNB,\n  CHAIN_IDS.OPBNB_TESTNET,\n  CHAIN_IDS.ZORA,\n];\n\n// BlockExplorer link: https://optimistic.etherscan.io/address/0x420000000000000000000000000000000000000f#code\nconst OPTIMISM_GAS_PRICE_ORACLE_ADDRESS =\n  '0x420000000000000000000000000000000000000F';\n\n/**\n * Optimism layer 1 gas fee flow that obtains gas fee estimate using an oracle contract.\n */\nexport class OptimismLayer1GasFeeFlow extends OracleLayer1GasFeeFlow {\n  constructor() {\n    super(OPTIMISM_GAS_PRICE_ORACLE_ADDRESS);\n  }\n\n  matchesTransaction({\n    transactionMeta,\n  }: {\n    transactionMeta: TransactionMeta;\n    messenger: TransactionControllerMessenger;\n  }): boolean {\n    return OPTIMISM_STACK_CHAIN_IDS.includes(transactionMeta.chainId);\n  }\n}\n"]}
+{"version":3,"file":"OptimismLayer1GasFeeFlow.mjs","sourceRoot":"","sources":["../../src/gas-flows/OptimismLayer1GasFeeFlow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,mCAAmC;AACzD,OAAO,EAAY,WAAW,EAAE,wBAAwB;AAExD,OAAO,EAAE,sBAAsB,EAAE,qCAAiC;AAClE,OAAO,EAAE,SAAS,EAAE,yBAAqB;AAIzC,MAAM,iCAAiC,GAAU;IAC/C,SAAS,CAAC,QAAQ;IAClB,SAAS,CAAC,gBAAgB;IAC1B,SAAS,CAAC,IAAI;IACd,SAAS,CAAC,YAAY;IACtB,SAAS,CAAC,KAAK;IACf,SAAS,CAAC,aAAa;IACvB,SAAS,CAAC,IAAI;CACf,CAAC;AAWF,MAAM,+BAA+B,GACnC,qDAAqD,CAAC;AAExD;;GAEG;AACH,MAAM,OAAO,wBAAyB,SAAQ,sBAAsB;IAClE,KAAK,CAAC,kBAAkB,CAAC,EACvB,eAAe,GAIhB;QACC,MAAM,eAAe,GAAG,WAAW,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QAE7D,MAAM,eAAe,GACnB,MAAM,wBAAwB,CAAC,4BAA4B,EAAE,CAAC;QAEhE,IAAI,eAAe,EAAE,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC;YAC1C,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,iCAAiC,CAAC,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED,8CAA8C;IAE9C;;;;OAIG;IACK,MAAM,CAAC,KAAK,CAAC,4BAA4B;QAC/C,IAAI,CAAC;YACH,MAAM,GAAG,GAA8B,MAAM,WAAW,CACtD,+BAA+B,CAChC,CAAC;YACF,MAAM,IAAI,GAAG,GAAG,EAAE,cAAc,EAAE,QAAQ,IAAI,EAAE,CAAC;YACjD,OAAO,IAAI,GAAG,CAAS,IAAI,CAAC,CAAC;QAC/B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;CACF","sourcesContent":["import { handleFetch } from '@metamask/controller-utils';\nimport { type Hex, hexToNumber } from '@metamask/utils';\n\nimport { OracleLayer1GasFeeFlow } from './OracleLayer1GasFeeFlow';\nimport { CHAIN_IDS } from '../constants';\nimport type { TransactionControllerMessenger } from '../TransactionController';\nimport type { TransactionMeta } from '../types';\n\nconst FALLBACK_OPTIMISM_STACK_CHAIN_IDS: Hex[] = [\n  CHAIN_IDS.OPTIMISM,\n  CHAIN_IDS.OPTIMISM_TESTNET,\n  CHAIN_IDS.BASE,\n  CHAIN_IDS.BASE_TESTNET,\n  CHAIN_IDS.OPBNB,\n  CHAIN_IDS.OPBNB_TESTNET,\n  CHAIN_IDS.ZORA,\n];\n\n// Default oracle address now provided by base class\n\ntype SupportedNetworksResponse = {\n  readonly fullSupport: readonly number[];\n  readonly partialSupport: {\n    readonly optimism: readonly number[];\n  };\n};\n\nconst GAS_SUPPORTED_NETWORKS_ENDPOINT =\n  'https://gas.api.cx.metamask.io/v1/supportedNetworks';\n\n/**\n * Optimism layer 1 gas fee flow that obtains gas fee estimate using an oracle contract.\n */\nexport class OptimismLayer1GasFeeFlow extends OracleLayer1GasFeeFlow {\n  async matchesTransaction({\n    transactionMeta,\n  }: {\n    transactionMeta: TransactionMeta;\n    messenger: TransactionControllerMessenger;\n  }): Promise<boolean> {\n    const chainIdAsNumber = hexToNumber(transactionMeta.chainId);\n\n    const supportedChains =\n      await OptimismLayer1GasFeeFlow.fetchOptimismSupportedChains();\n\n    if (supportedChains?.has(chainIdAsNumber)) {\n      return true;\n    }\n\n    return FALLBACK_OPTIMISM_STACK_CHAIN_IDS.includes(transactionMeta.chainId);\n  }\n\n  // Uses default oracle address from base class\n\n  /**\n   * Fetch remote OP-stack support list; fall back to local list when unavailable.\n   *\n   * @returns A set of supported OP-stack chain IDs or null on failure.\n   */\n  private static async fetchOptimismSupportedChains(): Promise<Set<number> | null> {\n    try {\n      const res: SupportedNetworksResponse = await handleFetch(\n        GAS_SUPPORTED_NETWORKS_ENDPOINT,\n      );\n      const list = res?.partialSupport?.optimism ?? [];\n      return new Set<number>(list);\n    } catch {\n      return null;\n    }\n  }\n}\n"]}

package/dist/gas-flows/OracleLayer1GasFeeFlow.cjs

@@ -1,48 +1,107 @@
 "use strict";
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
 var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _OracleLayer1GasFeeFlow_instances, _OracleLayer1GasFeeFlow_oracleAddress, _OracleLayer1GasFeeFlow_signTransaction, _OracleLayer1GasFeeFlow_getOracleLayer1GasFee, _OracleLayer1GasFeeFlow_buildUnserializedTransaction, _OracleLayer1GasFeeFlow_buildTransactionParams;
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _OracleLayer1GasFeeFlow_instances, _OracleLayer1GasFeeFlow_getOracleLayer1GasFee, _OracleLayer1GasFeeFlow_getOperatorLayer1GasFee, _OracleLayer1GasFeeFlow_buildUnserializedTransaction, _OracleLayer1GasFeeFlow_buildTransactionParams, _OracleLayer1GasFeeFlow_getGasPriceOracleContract;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OracleLayer1GasFeeFlow = void 0;
 const contracts_1 = require("@ethersproject/contracts");
 const providers_1 = require("@ethersproject/providers");
 const utils_1 = require("@metamask/utils");
+const bn_js_1 = __importDefault(require("bn.js"));
 const logger_1 = require("../logger.cjs");
 const prepare_1 = require("../utils/prepare.cjs");
+const utils_2 = require("../utils/utils.cjs");
 const log = (0, utils_1.createModuleLogger)(logger_1.projectLogger, 'oracle-layer1-gas-fee-flow');
+const ZERO = new bn_js_1.default(0);
 const DUMMY_KEY = 'abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789';
 const GAS_PRICE_ORACLE_ABI = [
     {
-        inputs: [{ internalType: 'bytes', name: '_data', type: 'bytes' }],
+        inputs: [
+            {
+                internalType: 'bytes',
+                name: '_data',
+                type: 'bytes',
+            },
+        ],
         name: 'getL1Fee',
-        outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+        outputs: [
+            {
+                internalType: 'uint256',
+                name: '',
+                type: 'uint256',
+            },
+        ],
+        stateMutability: 'view',
+        type: 'function',
+    },
+    // only available post Isthmus
+    {
+        inputs: [
+            {
+                internalType: 'uint256',
+                name: '_gasUsed',
+                type: 'uint256',
+            },
+        ],
+        name: 'getOperatorFee',
+        outputs: [
+            {
+                internalType: 'uint256',
+                name: '',
+                type: 'uint256',
+            },
+        ],
         stateMutability: 'view',
         type: 'function',
     },
 ];
+// Default OP Stack gas price oracle address used across supported networks
+const DEFAULT_GAS_PRICE_ORACLE_ADDRESS = '0x420000000000000000000000000000000000000F';
 /**
  * Layer 1 gas fee flow that obtains gas fee estimate using an oracle smart contract.
  */
 class OracleLayer1GasFeeFlow {
-    constructor(oracleAddress, signTransaction) {
+    constructor() {
         _OracleLayer1GasFeeFlow_instances.add(this);
-        _OracleLayer1GasFeeFlow_oracleAddress.set(this, void 0);
-        _OracleLayer1GasFeeFlow_signTransaction.set(this, void 0);
-        __classPrivateFieldSet(this, _OracleLayer1GasFeeFlow_oracleAddress, oracleAddress, "f");
-        __classPrivateFieldSet(this, _OracleLayer1GasFeeFlow_signTransaction, signTransaction ?? false, "f");
+    }
+    /**
+     * Resolves the oracle address for the given chain. Subclasses can override
+     * this method to provide chain-specific oracle addresses. By default, this
+     * returns the standard OP Stack gas price oracle address.
+     *
+     * @param _chainId - The chain ID to resolve the oracle address for.
+     * @returns The oracle address for the given chain.
+     */
+    getOracleAddressForChain(_chainId) {
+        return DEFAULT_GAS_PRICE_ORACLE_ADDRESS;
+    }
+    /**
+     * Whether to sign the transaction with a dummy key prior to calling the
+     * oracle contract. Some oracle contracts require a signed payload even for
+     * read-only methods.
+     *
+     * Subclasses can override to enable signing when needed. Defaults to false.
+     *
+     * @returns Whether the transaction should be signed prior to the oracle call.
+     */
+    shouldSignTransaction() {
+        return false;
     }
     async getLayer1Fee(request) {
         try {
-            return await __classPrivateFieldGet(this, _OracleLayer1GasFeeFlow_instances, "m", _OracleLayer1GasFeeFlow_getOracleLayer1GasFee).call(this, request);
+            const { provider, transactionMeta } = request;
+            const contract = __classPrivateFieldGet(this, _OracleLayer1GasFeeFlow_instances, "m", _OracleLayer1GasFeeFlow_getGasPriceOracleContract).call(this, provider, transactionMeta.chainId);
+            const oracleFee = await __classPrivateFieldGet(this, _OracleLayer1GasFeeFlow_instances, "m", _OracleLayer1GasFeeFlow_getOracleLayer1GasFee).call(this, contract, transactionMeta);
+            const operatorFee = await __classPrivateFieldGet(this, _OracleLayer1GasFeeFlow_instances, "m", _OracleLayer1GasFeeFlow_getOperatorLayer1GasFee).call(this, contract, transactionMeta);
+            return {
+                layer1Fee: (0, utils_1.add0x)((0, utils_2.padHexToEvenLength)(oracleFee.add(operatorFee).toString(16))),
+            };
         }
         catch (error) {
             log('Failed to get oracle layer 1 gas fee', error);
@@ -51,26 +110,37 @@ class OracleLayer1GasFeeFlow {
     }
 }
 exports.OracleLayer1GasFeeFlow = OracleLayer1GasFeeFlow;
-_OracleLayer1GasFeeFlow_oracleAddress = new WeakMap(), _OracleLayer1GasFeeFlow_signTransaction = new WeakMap(), _OracleLayer1GasFeeFlow_instances = new WeakSet(), _OracleLayer1GasFeeFlow_getOracleLayer1GasFee = async function _OracleLayer1GasFeeFlow_getOracleLayer1GasFee(request) {
-    const { provider, transactionMeta } = request;
-    const contract = new contracts_1.Contract(__classPrivateFieldGet(this, _OracleLayer1GasFeeFlow_oracleAddress, "f"), GAS_PRICE_ORACLE_ABI, 
-    // Network controller provider type is incompatible with ethers provider
-    new providers_1.Web3Provider(provider));
-    const serializedTransaction = __classPrivateFieldGet(this, _OracleLayer1GasFeeFlow_instances, "m", _OracleLayer1GasFeeFlow_buildUnserializedTransaction).call(this, transactionMeta, __classPrivateFieldGet(this, _OracleLayer1GasFeeFlow_signTransaction, "f")).serialize();
+_OracleLayer1GasFeeFlow_instances = new WeakSet(), _OracleLayer1GasFeeFlow_getOracleLayer1GasFee = async function _OracleLayer1GasFeeFlow_getOracleLayer1GasFee(contract, transactionMeta) {
+    const serializedTransaction = __classPrivateFieldGet(this, _OracleLayer1GasFeeFlow_instances, "m", _OracleLayer1GasFeeFlow_buildUnserializedTransaction).call(this, transactionMeta, this.shouldSignTransaction()).serialize();
     const result = await contract.getL1Fee(serializedTransaction);
     if (result === undefined) {
         throw new Error('No value returned from oracle contract');
     }
-    return {
-        layer1Fee: result.toHexString(),
-    };
+    return (0, utils_2.toBN)(result);
+}, _OracleLayer1GasFeeFlow_getOperatorLayer1GasFee = async function _OracleLayer1GasFeeFlow_getOperatorLayer1GasFee(contract, transactionMeta) {
+    const { gasUsed } = transactionMeta;
+    if (!gasUsed) {
+        return ZERO;
+    }
+    try {
+        const result = await contract.getOperatorFee(gasUsed);
+        if (result === undefined) {
+            return ZERO;
+        }
+        return (0, utils_2.toBN)(result);
+    }
+    catch (error) {
+        log('Failed to get operator layer 1 gas fee', error);
+        return ZERO;
+    }
 }, _OracleLayer1GasFeeFlow_buildUnserializedTransaction = function _OracleLayer1GasFeeFlow_buildUnserializedTransaction(transactionMeta, sign) {
     const txParams = __classPrivateFieldGet(this, _OracleLayer1GasFeeFlow_instances, "m", _OracleLayer1GasFeeFlow_buildTransactionParams).call(this, transactionMeta);
     const { chainId } = transactionMeta;
     let unserializedTransaction = (0, prepare_1.prepareTransaction)(chainId, txParams);
     if (sign) {
         const keyBuffer = Buffer.from(DUMMY_KEY, 'hex');
-        unserializedTransaction = unserializedTransaction.sign(keyBuffer);
+        const keyBytes = Uint8Array.from(keyBuffer);
+        unserializedTransaction = unserializedTransaction.sign(keyBytes);
     }
     return unserializedTransaction;
 }, _OracleLayer1GasFeeFlow_buildTransactionParams = function _OracleLayer1GasFeeFlow_buildTransactionParams(transactionMeta) {
@@ -78,5 +148,9 @@ _OracleLayer1GasFeeFlow_oracleAddress = new WeakMap(), _OracleLayer1GasFeeFlow_s
         ...transactionMeta.txParams,
         gasLimit: transactionMeta.txParams.gas,
     };
+}, _OracleLayer1GasFeeFlow_getGasPriceOracleContract = function _OracleLayer1GasFeeFlow_getGasPriceOracleContract(provider, chainId) {
+    return new contracts_1.Contract(this.getOracleAddressForChain(chainId), GAS_PRICE_ORACLE_ABI, 
+    // Network controller provider type is incompatible with ethers provider
+    new providers_1.Web3Provider(provider));
 };
 //# sourceMappingURL=OracleLayer1GasFeeFlow.cjs.map

package/dist/gas-flows/OracleLayer1GasFeeFlow.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"OracleLayer1GasFeeFlow.cjs","sourceRoot":"","sources":["../../src/gas-flows/OracleLayer1GasFeeFlow.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,wDAAoD;AACpD,wDAA+E;AAE/E,2CAAqD;AAErD,0CAA0C;AAQ1C,kDAAsD;AAEtD,MAAM,GAAG,GAAG,IAAA,0BAAkB,EAAC,sBAAa,EAAE,4BAA4B,CAAC,CAAC;AAE5E,MAAM,SAAS,GACb,kEAAkE,CAAC;AAErE,MAAM,oBAAoB,GAAG;IAC3B;QACE,MAAM,EAAE,CAAC,EAAE,YAAY,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;QACjE,IAAI,EAAE,UAAU;QAChB,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QACjE,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;CACF,CAAC;AAEF;;GAEG;AACH,MAAsB,sBAAsB;IAK1C,YAAY,aAAkB,EAAE,eAAyB;;QAJhD,wDAAoB;QAEpB,0DAA0B;QAGjC,uBAAA,IAAI,yCAAkB,aAAa,MAAA,CAAC;QACpC,uBAAA,IAAI,2CAAoB,eAAe,IAAI,KAAK,MAAA,CAAC;IACnD,CAAC;IAUD,KAAK,CAAC,YAAY,CAChB,OAAgC;QAEhC,IAAI;YACF,OAAO,MAAM,uBAAA,IAAI,wFAAuB,MAA3B,IAAI,EAAwB,OAAO,CAAC,CAAC;SACnD;QAAC,OAAO,KAAK,EAAE;YACd,GAAG,CAAC,sCAAsC,EAAE,KAAK,CAAC,CAAC;YACnD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;SACzD;IACH,CAAC;CAuDF;AAlFD,wDAkFC;mNArDC,KAAK,wDACH,OAAgC;IAEhC,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;IAE9C,MAAM,QAAQ,GAAG,IAAI,oBAAQ,CAC3B,uBAAA,IAAI,6CAAe,EACnB,oBAAoB;IACpB,wEAAwE;IACxE,IAAI,wBAAY,CAAC,QAAuC,CAAC,CAC1D,CAAC;IAEF,MAAM,qBAAqB,GAAG,uBAAA,IAAI,+FAA8B,MAAlC,IAAI,EAChC,eAAe,EACf,uBAAA,IAAI,+CAAiB,CACtB,CAAC,SAAS,EAAE,CAAC;IAEd,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC;IAE9D,IAAI,MAAM,KAAK,SAAS,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;KAC3D;IAED,OAAO;QACL,SAAS,EAAE,MAAM,CAAC,WAAW,EAAE;KAChC,CAAC;AACJ,CAAC,uHAGC,eAAgC,EAChC,IAAa;IAEb,MAAM,QAAQ,GAAG,uBAAA,IAAI,yFAAwB,MAA5B,IAAI,EAAyB,eAAe,CAAC,CAAC;IAC/D,MAAM,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;IAEpC,IAAI,uBAAuB,GAAG,IAAA,4BAAkB,EAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAEpE,IAAI,IAAI,EAAE;QACR,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAChD,uBAAuB,GAAG,uBAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;KACnE;IAED,OAAO,uBAAuB,CAAC;AACjC,CAAC,2GAGC,eAAgC;IAEhC,OAAO;QACL,GAAG,eAAe,CAAC,QAAQ;QAC3B,QAAQ,EAAE,eAAe,CAAC,QAAQ,CAAC,GAAG;KACvC,CAAC;AACJ,CAAC","sourcesContent":["import { Contract } from '@ethersproject/contracts';\nimport { Web3Provider, type ExternalProvider } from '@ethersproject/providers';\nimport type { Hex } from '@metamask/utils';\nimport { createModuleLogger } from '@metamask/utils';\n\nimport { projectLogger } from '../logger';\nimport type { TransactionControllerMessenger } from '../TransactionController';\nimport type {\n  Layer1GasFeeFlow,\n  Layer1GasFeeFlowRequest,\n  Layer1GasFeeFlowResponse,\n  TransactionMeta,\n} from '../types';\nimport { prepareTransaction } from '../utils/prepare';\n\nconst log = createModuleLogger(projectLogger, 'oracle-layer1-gas-fee-flow');\n\nconst DUMMY_KEY =\n  'abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789';\n\nconst GAS_PRICE_ORACLE_ABI = [\n  {\n    inputs: [{ internalType: 'bytes', name: '_data', type: 'bytes' }],\n    name: 'getL1Fee',\n    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],\n    stateMutability: 'view',\n    type: 'function',\n  },\n];\n\n/**\n * Layer 1 gas fee flow that obtains gas fee estimate using an oracle smart contract.\n */\nexport abstract class OracleLayer1GasFeeFlow implements Layer1GasFeeFlow {\n  readonly #oracleAddress: Hex;\n\n  readonly #signTransaction: boolean;\n\n  constructor(oracleAddress: Hex, signTransaction?: boolean) {\n    this.#oracleAddress = oracleAddress;\n    this.#signTransaction = signTransaction ?? false;\n  }\n\n  abstract matchesTransaction({\n    transactionMeta,\n    messenger,\n  }: {\n    transactionMeta: TransactionMeta;\n    messenger: TransactionControllerMessenger;\n  }): boolean;\n\n  async getLayer1Fee(\n    request: Layer1GasFeeFlowRequest,\n  ): Promise<Layer1GasFeeFlowResponse> {\n    try {\n      return await this.#getOracleLayer1GasFee(request);\n    } catch (error) {\n      log('Failed to get oracle layer 1 gas fee', error);\n      throw new Error(`Failed to get oracle layer 1 gas fee`);\n    }\n  }\n\n  async #getOracleLayer1GasFee(\n    request: Layer1GasFeeFlowRequest,\n  ): Promise<Layer1GasFeeFlowResponse> {\n    const { provider, transactionMeta } = request;\n\n    const contract = new Contract(\n      this.#oracleAddress,\n      GAS_PRICE_ORACLE_ABI,\n      // Network controller provider type is incompatible with ethers provider\n      new Web3Provider(provider as unknown as ExternalProvider),\n    );\n\n    const serializedTransaction = this.#buildUnserializedTransaction(\n      transactionMeta,\n      this.#signTransaction,\n    ).serialize();\n\n    const result = await contract.getL1Fee(serializedTransaction);\n\n    if (result === undefined) {\n      throw new Error('No value returned from oracle contract');\n    }\n\n    return {\n      layer1Fee: result.toHexString(),\n    };\n  }\n\n  #buildUnserializedTransaction(\n    transactionMeta: TransactionMeta,\n    sign: boolean,\n  ) {\n    const txParams = this.#buildTransactionParams(transactionMeta);\n    const { chainId } = transactionMeta;\n\n    let unserializedTransaction = prepareTransaction(chainId, txParams);\n\n    if (sign) {\n      const keyBuffer = Buffer.from(DUMMY_KEY, 'hex');\n      unserializedTransaction = unserializedTransaction.sign(keyBuffer);\n    }\n\n    return unserializedTransaction;\n  }\n\n  #buildTransactionParams(\n    transactionMeta: TransactionMeta,\n  ): TransactionMeta['txParams'] {\n    return {\n      ...transactionMeta.txParams,\n      gasLimit: transactionMeta.txParams.gas,\n    };\n  }\n}\n"]}
+{"version":3,"file":"OracleLayer1GasFeeFlow.cjs","sourceRoot":"","sources":["../../src/gas-flows/OracleLayer1GasFeeFlow.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wDAAoD;AACpD,wDAA+E;AAE/E,2CAA4D;AAC5D,kDAAuB;AAEvB,0CAA0C;AAQ1C,kDAAsD;AACtD,8CAA0D;AAE1D,MAAM,GAAG,GAAG,IAAA,0BAAkB,EAAC,sBAAa,EAAE,4BAA4B,CAAC,CAAC;AAE5E,MAAM,IAAI,GAAG,IAAI,eAAE,CAAC,CAAC,CAAC,CAAC;AAEvB,MAAM,SAAS,GACb,kEAAkE,CAAC;AAErE,MAAM,oBAAoB,GAAG;IAC3B;QACE,MAAM,EAAE;YACN;gBACE,YAAY,EAAE,OAAO;gBACrB,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,OAAO;aACd;SACF;QACD,IAAI,EAAE,UAAU;QAChB,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,SAAS;aAChB;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD,8BAA8B;IAC9B;QACE,MAAM,EAAE;YACN;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,SAAS;aAChB;SACF;QACD,IAAI,EAAE,gBAAgB;QACtB,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,SAAS;aAChB;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;CACF,CAAC;AAEF,2EAA2E;AAC3E,MAAM,gCAAgC,GACpC,4CAAmD,CAAC;AAEtD;;GAEG;AACH,MAAsB,sBAAsB;IAA5C;;IAiJA,CAAC;IAhJC;;;;;;;OAOG;IACO,wBAAwB,CAAC,QAAa;QAC9C,OAAO,gCAAgC,CAAC;IAC1C,CAAC;IAED;;;;;;;;OAQG;IACO,qBAAqB;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IAUD,KAAK,CAAC,YAAY,CAChB,OAAgC;QAEhC,IAAI,CAAC;YACH,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;YAE9C,MAAM,QAAQ,GAAG,uBAAA,IAAI,4FAA2B,MAA/B,IAAI,EACnB,QAAQ,EACR,eAAe,CAAC,OAAO,CACxB,CAAC;YAEF,MAAM,SAAS,GAAG,MAAM,uBAAA,IAAI,wFAAuB,MAA3B,IAAI,EAC1B,QAAQ,EACR,eAAe,CAChB,CAAC;YACF,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,0FAAyB,MAA7B,IAAI,EAC5B,QAAQ,EACR,eAAe,CAChB,CAAC;YAEF,OAAO;gBACL,SAAS,EAAE,IAAA,aAAK,EACd,IAAA,0BAAkB,EAAC,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CACrD;aACT,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,GAAG,CAAC,sCAAsC,EAAE,KAAK,CAAC,CAAC;YACnD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;CAkFF;AAjJD,wDAiJC;mGAhFC,KAAK,wDACH,QAAkB,EAClB,eAAgC;IAEhC,MAAM,qBAAqB,GAAG,uBAAA,IAAI,+FAA8B,MAAlC,IAAI,EAChC,eAAe,EACf,IAAI,CAAC,qBAAqB,EAAE,CAC7B,CAAC,SAAS,EAAE,CAAC;IAEd,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC;IAE9D,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO,IAAA,YAAI,EAAC,MAAM,CAAC,CAAC;AACtB,CAAC,oDAED,KAAK,0DACH,QAAkB,EAClB,eAAgC;IAEhC,MAAM,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;IAEpC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAEtD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,IAAA,YAAI,EAAC,MAAM,CAAC,CAAC;IACtB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,GAAG,CAAC,wCAAwC,EAAE,KAAK,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC,uHAGC,eAAgC,EAChC,IAAa;IAEb,MAAM,QAAQ,GAAG,uBAAA,IAAI,yFAAwB,MAA5B,IAAI,EAAyB,eAAe,CAAC,CAAC;IAC/D,MAAM,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;IAEpC,IAAI,uBAAuB,GAAG,IAAA,4BAAkB,EAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAEpE,IAAI,IAAI,EAAE,CAAC;QACT,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAChD,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC5C,uBAAuB,GAAG,uBAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnE,CAAC;IAED,OAAO,uBAAuB,CAAC;AACjC,CAAC,2GAGC,eAAgC;IAEhC,OAAO;QACL,GAAG,eAAe,CAAC,QAAQ;QAC3B,QAAQ,EAAE,eAAe,CAAC,QAAQ,CAAC,GAAG;KACvC,CAAC;AACJ,CAAC,iHAGC,QAA6C,EAC7C,OAAY;IAEZ,OAAO,IAAI,oBAAQ,CACjB,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,EACtC,oBAAoB;IACpB,wEAAwE;IACxE,IAAI,wBAAY,CAAC,QAAuC,CAAC,CAC1D,CAAC;AACJ,CAAC","sourcesContent":["import { Contract } from '@ethersproject/contracts';\nimport { Web3Provider, type ExternalProvider } from '@ethersproject/providers';\nimport type { Hex } from '@metamask/utils';\nimport { add0x, createModuleLogger } from '@metamask/utils';\nimport BN from 'bn.js';\n\nimport { projectLogger } from '../logger';\nimport type { TransactionControllerMessenger } from '../TransactionController';\nimport type {\n  Layer1GasFeeFlow,\n  Layer1GasFeeFlowRequest,\n  Layer1GasFeeFlowResponse,\n  TransactionMeta,\n} from '../types';\nimport { prepareTransaction } from '../utils/prepare';\nimport { padHexToEvenLength, toBN } from '../utils/utils';\n\nconst log = createModuleLogger(projectLogger, 'oracle-layer1-gas-fee-flow');\n\nconst ZERO = new BN(0);\n\nconst DUMMY_KEY =\n  'abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789';\n\nconst GAS_PRICE_ORACLE_ABI = [\n  {\n    inputs: [\n      {\n        internalType: 'bytes',\n        name: '_data',\n        type: 'bytes',\n      },\n    ],\n    name: 'getL1Fee',\n    outputs: [\n      {\n        internalType: 'uint256',\n        name: '',\n        type: 'uint256',\n      },\n    ],\n    stateMutability: 'view',\n    type: 'function',\n  },\n  // only available post Isthmus\n  {\n    inputs: [\n      {\n        internalType: 'uint256',\n        name: '_gasUsed',\n        type: 'uint256',\n      },\n    ],\n    name: 'getOperatorFee',\n    outputs: [\n      {\n        internalType: 'uint256',\n        name: '',\n        type: 'uint256',\n      },\n    ],\n    stateMutability: 'view',\n    type: 'function',\n  },\n];\n\n// Default OP Stack gas price oracle address used across supported networks\nconst DEFAULT_GAS_PRICE_ORACLE_ADDRESS =\n  '0x420000000000000000000000000000000000000F' as Hex;\n\n/**\n * Layer 1 gas fee flow that obtains gas fee estimate using an oracle smart contract.\n */\nexport abstract class OracleLayer1GasFeeFlow implements Layer1GasFeeFlow {\n  /**\n   * Resolves the oracle address for the given chain. Subclasses can override\n   * this method to provide chain-specific oracle addresses. By default, this\n   * returns the standard OP Stack gas price oracle address.\n   *\n   * @param _chainId - The chain ID to resolve the oracle address for.\n   * @returns The oracle address for the given chain.\n   */\n  protected getOracleAddressForChain(_chainId: Hex): Hex {\n    return DEFAULT_GAS_PRICE_ORACLE_ADDRESS;\n  }\n\n  /**\n   * Whether to sign the transaction with a dummy key prior to calling the\n   * oracle contract. Some oracle contracts require a signed payload even for\n   * read-only methods.\n   *\n   * Subclasses can override to enable signing when needed. Defaults to false.\n   *\n   * @returns Whether the transaction should be signed prior to the oracle call.\n   */\n  protected shouldSignTransaction(): boolean {\n    return false;\n  }\n\n  abstract matchesTransaction({\n    transactionMeta,\n    messenger,\n  }: {\n    transactionMeta: TransactionMeta;\n    messenger: TransactionControllerMessenger;\n  }): Promise<boolean>;\n\n  async getLayer1Fee(\n    request: Layer1GasFeeFlowRequest,\n  ): Promise<Layer1GasFeeFlowResponse> {\n    try {\n      const { provider, transactionMeta } = request;\n\n      const contract = this.#getGasPriceOracleContract(\n        provider,\n        transactionMeta.chainId,\n      );\n\n      const oracleFee = await this.#getOracleLayer1GasFee(\n        contract,\n        transactionMeta,\n      );\n      const operatorFee = await this.#getOperatorLayer1GasFee(\n        contract,\n        transactionMeta,\n      );\n\n      return {\n        layer1Fee: add0x(\n          padHexToEvenLength(oracleFee.add(operatorFee).toString(16)),\n        ) as Hex,\n      };\n    } catch (error) {\n      log('Failed to get oracle layer 1 gas fee', error);\n      throw new Error(`Failed to get oracle layer 1 gas fee`);\n    }\n  }\n\n  async #getOracleLayer1GasFee(\n    contract: Contract,\n    transactionMeta: TransactionMeta,\n  ): Promise<BN> {\n    const serializedTransaction = this.#buildUnserializedTransaction(\n      transactionMeta,\n      this.shouldSignTransaction(),\n    ).serialize();\n\n    const result = await contract.getL1Fee(serializedTransaction);\n\n    if (result === undefined) {\n      throw new Error('No value returned from oracle contract');\n    }\n\n    return toBN(result);\n  }\n\n  async #getOperatorLayer1GasFee(\n    contract: Contract,\n    transactionMeta: TransactionMeta,\n  ): Promise<BN> {\n    const { gasUsed } = transactionMeta;\n\n    if (!gasUsed) {\n      return ZERO;\n    }\n\n    try {\n      const result = await contract.getOperatorFee(gasUsed);\n\n      if (result === undefined) {\n        return ZERO;\n      }\n\n      return toBN(result);\n    } catch (error) {\n      log('Failed to get operator layer 1 gas fee', error);\n      return ZERO;\n    }\n  }\n\n  #buildUnserializedTransaction(\n    transactionMeta: TransactionMeta,\n    sign: boolean,\n  ) {\n    const txParams = this.#buildTransactionParams(transactionMeta);\n    const { chainId } = transactionMeta;\n\n    let unserializedTransaction = prepareTransaction(chainId, txParams);\n\n    if (sign) {\n      const keyBuffer = Buffer.from(DUMMY_KEY, 'hex');\n      const keyBytes = Uint8Array.from(keyBuffer);\n      unserializedTransaction = unserializedTransaction.sign(keyBytes);\n    }\n\n    return unserializedTransaction;\n  }\n\n  #buildTransactionParams(\n    transactionMeta: TransactionMeta,\n  ): TransactionMeta['txParams'] {\n    return {\n      ...transactionMeta.txParams,\n      gasLimit: transactionMeta.txParams.gas,\n    };\n  }\n\n  #getGasPriceOracleContract(\n    provider: Layer1GasFeeFlowRequest['provider'],\n    chainId: Hex,\n  ) {\n    return new Contract(\n      this.getOracleAddressForChain(chainId),\n      GAS_PRICE_ORACLE_ABI,\n      // Network controller provider type is incompatible with ethers provider\n      new Web3Provider(provider as unknown as ExternalProvider),\n    );\n  }\n}\n"]}

package/dist/gas-flows/OracleLayer1GasFeeFlow.d.cts

@@ -6,11 +6,29 @@ import type { Layer1GasFeeFlow, Layer1GasFeeFlowRequest, Layer1GasFeeFlowRespons
  */
 export declare abstract class OracleLayer1GasFeeFlow implements Layer1GasFeeFlow {
     #private;
-    constructor(oracleAddress: Hex, signTransaction?: boolean);
+    /**
+     * Resolves the oracle address for the given chain. Subclasses can override
+     * this method to provide chain-specific oracle addresses. By default, this
+     * returns the standard OP Stack gas price oracle address.
+     *
+     * @param _chainId - The chain ID to resolve the oracle address for.
+     * @returns The oracle address for the given chain.
+     */
+    protected getOracleAddressForChain(_chainId: Hex): Hex;
+    /**
+     * Whether to sign the transaction with a dummy key prior to calling the
+     * oracle contract. Some oracle contracts require a signed payload even for
+     * read-only methods.
+     *
+     * Subclasses can override to enable signing when needed. Defaults to false.
+     *
+     * @returns Whether the transaction should be signed prior to the oracle call.
+     */
+    protected shouldSignTransaction(): boolean;
     abstract matchesTransaction({ transactionMeta, messenger, }: {
         transactionMeta: TransactionMeta;
         messenger: TransactionControllerMessenger;
-    }): boolean;
+    }): Promise<boolean>;
     getLayer1Fee(request: Layer1GasFeeFlowRequest): Promise<Layer1GasFeeFlowResponse>;
 }
 //# sourceMappingURL=OracleLayer1GasFeeFlow.d.cts.map

package/dist/gas-flows/OracleLayer1GasFeeFlow.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"OracleLayer1GasFeeFlow.d.cts","sourceRoot":"","sources":["../../src/gas-flows/OracleLayer1GasFeeFlow.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAI3C,OAAO,KAAK,EAAE,8BAA8B,EAAE,qCAAiC;AAC/E,OAAO,KAAK,EACV,gBAAgB,EAChB,uBAAuB,EACvB,wBAAwB,EACxB,eAAe,EAChB,qBAAiB;AAkBlB;;GAEG;AACH,8BAAsB,sBAAuB,YAAW,gBAAgB;;gBAK1D,aAAa,EAAE,GAAG,EAAE,eAAe,CAAC,EAAE,OAAO;IAKzD,QAAQ,CAAC,kBAAkB,CAAC,EAC1B,eAAe,EACf,SAAS,GACV,EAAE;QACD,eAAe,EAAE,eAAe,CAAC;QACjC,SAAS,EAAE,8BAA8B,CAAC;KAC3C,GAAG,OAAO;IAEL,YAAY,CAChB,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;CA8DrC"}
+{"version":3,"file":"OracleLayer1GasFeeFlow.d.cts","sourceRoot":"","sources":["../../src/gas-flows/OracleLayer1GasFeeFlow.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAK3C,OAAO,KAAK,EAAE,8BAA8B,EAAE,qCAAiC;AAC/E,OAAO,KAAK,EACV,gBAAgB,EAChB,uBAAuB,EACvB,wBAAwB,EACxB,eAAe,EAChB,qBAAiB;AAyDlB;;GAEG;AACH,8BAAsB,sBAAuB,YAAW,gBAAgB;;IACtE;;;;;;;OAOG;IACH,SAAS,CAAC,wBAAwB,CAAC,QAAQ,EAAE,GAAG,GAAG,GAAG;IAItD;;;;;;;;OAQG;IACH,SAAS,CAAC,qBAAqB,IAAI,OAAO;IAI1C,QAAQ,CAAC,kBAAkB,CAAC,EAC1B,eAAe,EACf,SAAS,GACV,EAAE;QACD,eAAe,EAAE,eAAe,CAAC;QACjC,SAAS,EAAE,8BAA8B,CAAC;KAC3C,GAAG,OAAO,CAAC,OAAO,CAAC;IAEd,YAAY,CAChB,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;CA6GrC"}

package/dist/gas-flows/OracleLayer1GasFeeFlow.d.mts

@@ -6,11 +6,29 @@ import type { Layer1GasFeeFlow, Layer1GasFeeFlowRequest, Layer1GasFeeFlowRespons
  */
 export declare abstract class OracleLayer1GasFeeFlow implements Layer1GasFeeFlow {
     #private;
-    constructor(oracleAddress: Hex, signTransaction?: boolean);
+    /**
+     * Resolves the oracle address for the given chain. Subclasses can override
+     * this method to provide chain-specific oracle addresses. By default, this
+     * returns the standard OP Stack gas price oracle address.
+     *
+     * @param _chainId - The chain ID to resolve the oracle address for.
+     * @returns The oracle address for the given chain.
+     */
+    protected getOracleAddressForChain(_chainId: Hex): Hex;
+    /**
+     * Whether to sign the transaction with a dummy key prior to calling the
+     * oracle contract. Some oracle contracts require a signed payload even for
+     * read-only methods.
+     *
+     * Subclasses can override to enable signing when needed. Defaults to false.
+     *
+     * @returns Whether the transaction should be signed prior to the oracle call.
+     */
+    protected shouldSignTransaction(): boolean;
     abstract matchesTransaction({ transactionMeta, messenger, }: {
         transactionMeta: TransactionMeta;
         messenger: TransactionControllerMessenger;
-    }): boolean;
+    }): Promise<boolean>;
     getLayer1Fee(request: Layer1GasFeeFlowRequest): Promise<Layer1GasFeeFlowResponse>;
 }
 //# sourceMappingURL=OracleLayer1GasFeeFlow.d.mts.map

package/dist/gas-flows/OracleLayer1GasFeeFlow.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"OracleLayer1GasFeeFlow.d.mts","sourceRoot":"","sources":["../../src/gas-flows/OracleLayer1GasFeeFlow.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAI3C,OAAO,KAAK,EAAE,8BAA8B,EAAE,qCAAiC;AAC/E,OAAO,KAAK,EACV,gBAAgB,EAChB,uBAAuB,EACvB,wBAAwB,EACxB,eAAe,EAChB,qBAAiB;AAkBlB;;GAEG;AACH,8BAAsB,sBAAuB,YAAW,gBAAgB;;gBAK1D,aAAa,EAAE,GAAG,EAAE,eAAe,CAAC,EAAE,OAAO;IAKzD,QAAQ,CAAC,kBAAkB,CAAC,EAC1B,eAAe,EACf,SAAS,GACV,EAAE;QACD,eAAe,EAAE,eAAe,CAAC;QACjC,SAAS,EAAE,8BAA8B,CAAC;KAC3C,GAAG,OAAO;IAEL,YAAY,CAChB,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;CA8DrC"}
+{"version":3,"file":"OracleLayer1GasFeeFlow.d.mts","sourceRoot":"","sources":["../../src/gas-flows/OracleLayer1GasFeeFlow.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAK3C,OAAO,KAAK,EAAE,8BAA8B,EAAE,qCAAiC;AAC/E,OAAO,KAAK,EACV,gBAAgB,EAChB,uBAAuB,EACvB,wBAAwB,EACxB,eAAe,EAChB,qBAAiB;AAyDlB;;GAEG;AACH,8BAAsB,sBAAuB,YAAW,gBAAgB;;IACtE;;;;;;;OAOG;IACH,SAAS,CAAC,wBAAwB,CAAC,QAAQ,EAAE,GAAG,GAAG,GAAG;IAItD;;;;;;;;OAQG;IACH,SAAS,CAAC,qBAAqB,IAAI,OAAO;IAI1C,QAAQ,CAAC,kBAAkB,CAAC,EAC1B,eAAe,EACf,SAAS,GACV,EAAE;QACD,eAAe,EAAE,eAAe,CAAC;QACjC,SAAS,EAAE,8BAA8B,CAAC;KAC3C,GAAG,OAAO,CAAC,OAAO,CAAC;IAEd,YAAY,CAChB,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;CA6GrC"}

package/dist/gas-flows/OracleLayer1GasFeeFlow.mjs

@@ -1,45 +1,108 @@
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
 var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _OracleLayer1GasFeeFlow_instances, _OracleLayer1GasFeeFlow_oracleAddress, _OracleLayer1GasFeeFlow_signTransaction, _OracleLayer1GasFeeFlow_getOracleLayer1GasFee, _OracleLayer1GasFeeFlow_buildUnserializedTransaction, _OracleLayer1GasFeeFlow_buildTransactionParams;
+var _OracleLayer1GasFeeFlow_instances, _OracleLayer1GasFeeFlow_getOracleLayer1GasFee, _OracleLayer1GasFeeFlow_getOperatorLayer1GasFee, _OracleLayer1GasFeeFlow_buildUnserializedTransaction, _OracleLayer1GasFeeFlow_buildTransactionParams, _OracleLayer1GasFeeFlow_getGasPriceOracleContract;
+function $importDefault(module) {
+    if (module?.__esModule) {
+        return module.default;
+    }
+    return module;
+}
 import { Contract } from "@ethersproject/contracts";
 import { Web3Provider } from "@ethersproject/providers";
-import { createModuleLogger } from "@metamask/utils";
+import { add0x, createModuleLogger } from "@metamask/utils";
+import $BN from "bn.js";
+const BN = $importDefault($BN);
 import { projectLogger } from "../logger.mjs";
 import { prepareTransaction } from "../utils/prepare.mjs";
+import { padHexToEvenLength, toBN } from "../utils/utils.mjs";
 const log = createModuleLogger(projectLogger, 'oracle-layer1-gas-fee-flow');
+const ZERO = new BN(0);
 const DUMMY_KEY = 'abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789';
 const GAS_PRICE_ORACLE_ABI = [
     {
-        inputs: [{ internalType: 'bytes', name: '_data', type: 'bytes' }],
+        inputs: [
+            {
+                internalType: 'bytes',
+                name: '_data',
+                type: 'bytes',
+            },
+        ],
         name: 'getL1Fee',
-        outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+        outputs: [
+            {
+                internalType: 'uint256',
+                name: '',
+                type: 'uint256',
+            },
+        ],
+        stateMutability: 'view',
+        type: 'function',
+    },
+    // only available post Isthmus
+    {
+        inputs: [
+            {
+                internalType: 'uint256',
+                name: '_gasUsed',
+                type: 'uint256',
+            },
+        ],
+        name: 'getOperatorFee',
+        outputs: [
+            {
+                internalType: 'uint256',
+                name: '',
+                type: 'uint256',
+            },
+        ],
         stateMutability: 'view',
         type: 'function',
     },
 ];
+// Default OP Stack gas price oracle address used across supported networks
+const DEFAULT_GAS_PRICE_ORACLE_ADDRESS = '0x420000000000000000000000000000000000000F';
 /**
  * Layer 1 gas fee flow that obtains gas fee estimate using an oracle smart contract.
  */
 export class OracleLayer1GasFeeFlow {
-    constructor(oracleAddress, signTransaction) {
+    constructor() {
         _OracleLayer1GasFeeFlow_instances.add(this);
-        _OracleLayer1GasFeeFlow_oracleAddress.set(this, void 0);
-        _OracleLayer1GasFeeFlow_signTransaction.set(this, void 0);
-        __classPrivateFieldSet(this, _OracleLayer1GasFeeFlow_oracleAddress, oracleAddress, "f");
-        __classPrivateFieldSet(this, _OracleLayer1GasFeeFlow_signTransaction, signTransaction ?? false, "f");
+    }
+    /**
+     * Resolves the oracle address for the given chain. Subclasses can override
+     * this method to provide chain-specific oracle addresses. By default, this
+     * returns the standard OP Stack gas price oracle address.
+     *
+     * @param _chainId - The chain ID to resolve the oracle address for.
+     * @returns The oracle address for the given chain.
+     */
+    getOracleAddressForChain(_chainId) {
+        return DEFAULT_GAS_PRICE_ORACLE_ADDRESS;
+    }
+    /**
+     * Whether to sign the transaction with a dummy key prior to calling the
+     * oracle contract. Some oracle contracts require a signed payload even for
+     * read-only methods.
+     *
+     * Subclasses can override to enable signing when needed. Defaults to false.
+     *
+     * @returns Whether the transaction should be signed prior to the oracle call.
+     */
+    shouldSignTransaction() {
+        return false;
     }
     async getLayer1Fee(request) {
         try {
-            return await __classPrivateFieldGet(this, _OracleLayer1GasFeeFlow_instances, "m", _OracleLayer1GasFeeFlow_getOracleLayer1GasFee).call(this, request);
+            const { provider, transactionMeta } = request;
+            const contract = __classPrivateFieldGet(this, _OracleLayer1GasFeeFlow_instances, "m", _OracleLayer1GasFeeFlow_getGasPriceOracleContract).call(this, provider, transactionMeta.chainId);
+            const oracleFee = await __classPrivateFieldGet(this, _OracleLayer1GasFeeFlow_instances, "m", _OracleLayer1GasFeeFlow_getOracleLayer1GasFee).call(this, contract, transactionMeta);
+            const operatorFee = await __classPrivateFieldGet(this, _OracleLayer1GasFeeFlow_instances, "m", _OracleLayer1GasFeeFlow_getOperatorLayer1GasFee).call(this, contract, transactionMeta);
+            return {
+                layer1Fee: add0x(padHexToEvenLength(oracleFee.add(operatorFee).toString(16))),
+            };
         }
         catch (error) {
             log('Failed to get oracle layer 1 gas fee', error);
@@ -47,26 +110,37 @@ export class OracleLayer1GasFeeFlow {
         }
     }
 }
-_OracleLayer1GasFeeFlow_oracleAddress = new WeakMap(), _OracleLayer1GasFeeFlow_signTransaction = new WeakMap(), _OracleLayer1GasFeeFlow_instances = new WeakSet(), _OracleLayer1GasFeeFlow_getOracleLayer1GasFee = async function _OracleLayer1GasFeeFlow_getOracleLayer1GasFee(request) {
-    const { provider, transactionMeta } = request;
-    const contract = new Contract(__classPrivateFieldGet(this, _OracleLayer1GasFeeFlow_oracleAddress, "f"), GAS_PRICE_ORACLE_ABI, 
-    // Network controller provider type is incompatible with ethers provider
-    new Web3Provider(provider));
-    const serializedTransaction = __classPrivateFieldGet(this, _OracleLayer1GasFeeFlow_instances, "m", _OracleLayer1GasFeeFlow_buildUnserializedTransaction).call(this, transactionMeta, __classPrivateFieldGet(this, _OracleLayer1GasFeeFlow_signTransaction, "f")).serialize();
+_OracleLayer1GasFeeFlow_instances = new WeakSet(), _OracleLayer1GasFeeFlow_getOracleLayer1GasFee = async function _OracleLayer1GasFeeFlow_getOracleLayer1GasFee(contract, transactionMeta) {
+    const serializedTransaction = __classPrivateFieldGet(this, _OracleLayer1GasFeeFlow_instances, "m", _OracleLayer1GasFeeFlow_buildUnserializedTransaction).call(this, transactionMeta, this.shouldSignTransaction()).serialize();
     const result = await contract.getL1Fee(serializedTransaction);
     if (result === undefined) {
         throw new Error('No value returned from oracle contract');
     }
-    return {
-        layer1Fee: result.toHexString(),
-    };
+    return toBN(result);
+}, _OracleLayer1GasFeeFlow_getOperatorLayer1GasFee = async function _OracleLayer1GasFeeFlow_getOperatorLayer1GasFee(contract, transactionMeta) {
+    const { gasUsed } = transactionMeta;
+    if (!gasUsed) {
+        return ZERO;
+    }
+    try {
+        const result = await contract.getOperatorFee(gasUsed);
+        if (result === undefined) {
+            return ZERO;
+        }
+        return toBN(result);
+    }
+    catch (error) {
+        log('Failed to get operator layer 1 gas fee', error);
+        return ZERO;
+    }
 }, _OracleLayer1GasFeeFlow_buildUnserializedTransaction = function _OracleLayer1GasFeeFlow_buildUnserializedTransaction(transactionMeta, sign) {
     const txParams = __classPrivateFieldGet(this, _OracleLayer1GasFeeFlow_instances, "m", _OracleLayer1GasFeeFlow_buildTransactionParams).call(this, transactionMeta);
     const { chainId } = transactionMeta;
     let unserializedTransaction = prepareTransaction(chainId, txParams);
     if (sign) {
         const keyBuffer = Buffer.from(DUMMY_KEY, 'hex');
-        unserializedTransaction = unserializedTransaction.sign(keyBuffer);
+        const keyBytes = Uint8Array.from(keyBuffer);
+        unserializedTransaction = unserializedTransaction.sign(keyBytes);
     }
     return unserializedTransaction;
 }, _OracleLayer1GasFeeFlow_buildTransactionParams = function _OracleLayer1GasFeeFlow_buildTransactionParams(transactionMeta) {
@@ -74,5 +148,9 @@ _OracleLayer1GasFeeFlow_oracleAddress = new WeakMap(), _OracleLayer1GasFeeFlow_s
         ...transactionMeta.txParams,
         gasLimit: transactionMeta.txParams.gas,
     };
+}, _OracleLayer1GasFeeFlow_getGasPriceOracleContract = function _OracleLayer1GasFeeFlow_getGasPriceOracleContract(provider, chainId) {
+    return new Contract(this.getOracleAddressForChain(chainId), GAS_PRICE_ORACLE_ABI, 
+    // Network controller provider type is incompatible with ethers provider
+    new Web3Provider(provider));
 };
 //# sourceMappingURL=OracleLayer1GasFeeFlow.mjs.map

package/dist/gas-flows/OracleLayer1GasFeeFlow.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"OracleLayer1GasFeeFlow.mjs","sourceRoot":"","sources":["../../src/gas-flows/OracleLayer1GasFeeFlow.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,iCAAiC;AACpD,OAAO,EAAE,YAAY,EAAyB,iCAAiC;AAE/E,OAAO,EAAE,kBAAkB,EAAE,wBAAwB;AAErD,OAAO,EAAE,aAAa,EAAE,sBAAkB;AAQ1C,OAAO,EAAE,kBAAkB,EAAE,6BAAyB;AAEtD,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,4BAA4B,CAAC,CAAC;AAE5E,MAAM,SAAS,GACb,kEAAkE,CAAC;AAErE,MAAM,oBAAoB,GAAG;IAC3B;QACE,MAAM,EAAE,CAAC,EAAE,YAAY,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;QACjE,IAAI,EAAE,UAAU;QAChB,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QACjE,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,OAAgB,sBAAsB;IAK1C,YAAY,aAAkB,EAAE,eAAyB;;QAJhD,wDAAoB;QAEpB,0DAA0B;QAGjC,uBAAA,IAAI,yCAAkB,aAAa,MAAA,CAAC;QACpC,uBAAA,IAAI,2CAAoB,eAAe,IAAI,KAAK,MAAA,CAAC;IACnD,CAAC;IAUD,KAAK,CAAC,YAAY,CAChB,OAAgC;QAEhC,IAAI;YACF,OAAO,MAAM,uBAAA,IAAI,wFAAuB,MAA3B,IAAI,EAAwB,OAAO,CAAC,CAAC;SACnD;QAAC,OAAO,KAAK,EAAE;YACd,GAAG,CAAC,sCAAsC,EAAE,KAAK,CAAC,CAAC;YACnD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;SACzD;IACH,CAAC;CAuDF;mNArDC,KAAK,wDACH,OAAgC;IAEhC,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;IAE9C,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAC3B,uBAAA,IAAI,6CAAe,EACnB,oBAAoB;IACpB,wEAAwE;IACxE,IAAI,YAAY,CAAC,QAAuC,CAAC,CAC1D,CAAC;IAEF,MAAM,qBAAqB,GAAG,uBAAA,IAAI,+FAA8B,MAAlC,IAAI,EAChC,eAAe,EACf,uBAAA,IAAI,+CAAiB,CACtB,CAAC,SAAS,EAAE,CAAC;IAEd,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC;IAE9D,IAAI,MAAM,KAAK,SAAS,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;KAC3D;IAED,OAAO;QACL,SAAS,EAAE,MAAM,CAAC,WAAW,EAAE;KAChC,CAAC;AACJ,CAAC,uHAGC,eAAgC,EAChC,IAAa;IAEb,MAAM,QAAQ,GAAG,uBAAA,IAAI,yFAAwB,MAA5B,IAAI,EAAyB,eAAe,CAAC,CAAC;IAC/D,MAAM,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;IAEpC,IAAI,uBAAuB,GAAG,kBAAkB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAEpE,IAAI,IAAI,EAAE;QACR,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAChD,uBAAuB,GAAG,uBAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;KACnE;IAED,OAAO,uBAAuB,CAAC;AACjC,CAAC,2GAGC,eAAgC;IAEhC,OAAO;QACL,GAAG,eAAe,CAAC,QAAQ;QAC3B,QAAQ,EAAE,eAAe,CAAC,QAAQ,CAAC,GAAG;KACvC,CAAC;AACJ,CAAC","sourcesContent":["import { Contract } from '@ethersproject/contracts';\nimport { Web3Provider, type ExternalProvider } from '@ethersproject/providers';\nimport type { Hex } from '@metamask/utils';\nimport { createModuleLogger } from '@metamask/utils';\n\nimport { projectLogger } from '../logger';\nimport type { TransactionControllerMessenger } from '../TransactionController';\nimport type {\n  Layer1GasFeeFlow,\n  Layer1GasFeeFlowRequest,\n  Layer1GasFeeFlowResponse,\n  TransactionMeta,\n} from '../types';\nimport { prepareTransaction } from '../utils/prepare';\n\nconst log = createModuleLogger(projectLogger, 'oracle-layer1-gas-fee-flow');\n\nconst DUMMY_KEY =\n  'abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789';\n\nconst GAS_PRICE_ORACLE_ABI = [\n  {\n    inputs: [{ internalType: 'bytes', name: '_data', type: 'bytes' }],\n    name: 'getL1Fee',\n    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],\n    stateMutability: 'view',\n    type: 'function',\n  },\n];\n\n/**\n * Layer 1 gas fee flow that obtains gas fee estimate using an oracle smart contract.\n */\nexport abstract class OracleLayer1GasFeeFlow implements Layer1GasFeeFlow {\n  readonly #oracleAddress: Hex;\n\n  readonly #signTransaction: boolean;\n\n  constructor(oracleAddress: Hex, signTransaction?: boolean) {\n    this.#oracleAddress = oracleAddress;\n    this.#signTransaction = signTransaction ?? false;\n  }\n\n  abstract matchesTransaction({\n    transactionMeta,\n    messenger,\n  }: {\n    transactionMeta: TransactionMeta;\n    messenger: TransactionControllerMessenger;\n  }): boolean;\n\n  async getLayer1Fee(\n    request: Layer1GasFeeFlowRequest,\n  ): Promise<Layer1GasFeeFlowResponse> {\n    try {\n      return await this.#getOracleLayer1GasFee(request);\n    } catch (error) {\n      log('Failed to get oracle layer 1 gas fee', error);\n      throw new Error(`Failed to get oracle layer 1 gas fee`);\n    }\n  }\n\n  async #getOracleLayer1GasFee(\n    request: Layer1GasFeeFlowRequest,\n  ): Promise<Layer1GasFeeFlowResponse> {\n    const { provider, transactionMeta } = request;\n\n    const contract = new Contract(\n      this.#oracleAddress,\n      GAS_PRICE_ORACLE_ABI,\n      // Network controller provider type is incompatible with ethers provider\n      new Web3Provider(provider as unknown as ExternalProvider),\n    );\n\n    const serializedTransaction = this.#buildUnserializedTransaction(\n      transactionMeta,\n      this.#signTransaction,\n    ).serialize();\n\n    const result = await contract.getL1Fee(serializedTransaction);\n\n    if (result === undefined) {\n      throw new Error('No value returned from oracle contract');\n    }\n\n    return {\n      layer1Fee: result.toHexString(),\n    };\n  }\n\n  #buildUnserializedTransaction(\n    transactionMeta: TransactionMeta,\n    sign: boolean,\n  ) {\n    const txParams = this.#buildTransactionParams(transactionMeta);\n    const { chainId } = transactionMeta;\n\n    let unserializedTransaction = prepareTransaction(chainId, txParams);\n\n    if (sign) {\n      const keyBuffer = Buffer.from(DUMMY_KEY, 'hex');\n      unserializedTransaction = unserializedTransaction.sign(keyBuffer);\n    }\n\n    return unserializedTransaction;\n  }\n\n  #buildTransactionParams(\n    transactionMeta: TransactionMeta,\n  ): TransactionMeta['txParams'] {\n    return {\n      ...transactionMeta.txParams,\n      gasLimit: transactionMeta.txParams.gas,\n    };\n  }\n}\n"]}
+{"version":3,"file":"OracleLayer1GasFeeFlow.mjs","sourceRoot":"","sources":["../../src/gas-flows/OracleLayer1GasFeeFlow.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,iCAAiC;AACpD,OAAO,EAAE,YAAY,EAAyB,iCAAiC;AAE/E,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,wBAAwB;AAC5D,OAAO,GAAE,cAAc;;AAEvB,OAAO,EAAE,aAAa,EAAE,sBAAkB;AAQ1C,OAAO,EAAE,kBAAkB,EAAE,6BAAyB;AACtD,OAAO,EAAE,kBAAkB,EAAE,IAAI,EAAE,2BAAuB;AAE1D,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,4BAA4B,CAAC,CAAC;AAE5E,MAAM,IAAI,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAEvB,MAAM,SAAS,GACb,kEAAkE,CAAC;AAErE,MAAM,oBAAoB,GAAG;IAC3B;QACE,MAAM,EAAE;YACN;gBACE,YAAY,EAAE,OAAO;gBACrB,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,OAAO;aACd;SACF;QACD,IAAI,EAAE,UAAU;QAChB,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,SAAS;aAChB;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD,8BAA8B;IAC9B;QACE,MAAM,EAAE;YACN;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,SAAS;aAChB;SACF;QACD,IAAI,EAAE,gBAAgB;QACtB,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,SAAS;aAChB;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;CACF,CAAC;AAEF,2EAA2E;AAC3E,MAAM,gCAAgC,GACpC,4CAAmD,CAAC;AAEtD;;GAEG;AACH,MAAM,OAAgB,sBAAsB;IAA5C;;IAiJA,CAAC;IAhJC;;;;;;;OAOG;IACO,wBAAwB,CAAC,QAAa;QAC9C,OAAO,gCAAgC,CAAC;IAC1C,CAAC;IAED;;;;;;;;OAQG;IACO,qBAAqB;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IAUD,KAAK,CAAC,YAAY,CAChB,OAAgC;QAEhC,IAAI,CAAC;YACH,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;YAE9C,MAAM,QAAQ,GAAG,uBAAA,IAAI,4FAA2B,MAA/B,IAAI,EACnB,QAAQ,EACR,eAAe,CAAC,OAAO,CACxB,CAAC;YAEF,MAAM,SAAS,GAAG,MAAM,uBAAA,IAAI,wFAAuB,MAA3B,IAAI,EAC1B,QAAQ,EACR,eAAe,CAChB,CAAC;YACF,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,0FAAyB,MAA7B,IAAI,EAC5B,QAAQ,EACR,eAAe,CAChB,CAAC;YAEF,OAAO;gBACL,SAAS,EAAE,KAAK,CACd,kBAAkB,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CACrD;aACT,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,GAAG,CAAC,sCAAsC,EAAE,KAAK,CAAC,CAAC;YACnD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;CAkFF;mGAhFC,KAAK,wDACH,QAAkB,EAClB,eAAgC;IAEhC,MAAM,qBAAqB,GAAG,uBAAA,IAAI,+FAA8B,MAAlC,IAAI,EAChC,eAAe,EACf,IAAI,CAAC,qBAAqB,EAAE,CAC7B,CAAC,SAAS,EAAE,CAAC;IAEd,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC;IAE9D,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC;AACtB,CAAC,oDAED,KAAK,0DACH,QAAkB,EAClB,eAAgC;IAEhC,MAAM,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;IAEpC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAEtD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,GAAG,CAAC,wCAAwC,EAAE,KAAK,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC,uHAGC,eAAgC,EAChC,IAAa;IAEb,MAAM,QAAQ,GAAG,uBAAA,IAAI,yFAAwB,MAA5B,IAAI,EAAyB,eAAe,CAAC,CAAC;IAC/D,MAAM,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;IAEpC,IAAI,uBAAuB,GAAG,kBAAkB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAEpE,IAAI,IAAI,EAAE,CAAC;QACT,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAChD,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC5C,uBAAuB,GAAG,uBAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnE,CAAC;IAED,OAAO,uBAAuB,CAAC;AACjC,CAAC,2GAGC,eAAgC;IAEhC,OAAO;QACL,GAAG,eAAe,CAAC,QAAQ;QAC3B,QAAQ,EAAE,eAAe,CAAC,QAAQ,CAAC,GAAG;KACvC,CAAC;AACJ,CAAC,iHAGC,QAA6C,EAC7C,OAAY;IAEZ,OAAO,IAAI,QAAQ,CACjB,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,EACtC,oBAAoB;IACpB,wEAAwE;IACxE,IAAI,YAAY,CAAC,QAAuC,CAAC,CAC1D,CAAC;AACJ,CAAC","sourcesContent":["import { Contract } from '@ethersproject/contracts';\nimport { Web3Provider, type ExternalProvider } from '@ethersproject/providers';\nimport type { Hex } from '@metamask/utils';\nimport { add0x, createModuleLogger } from '@metamask/utils';\nimport BN from 'bn.js';\n\nimport { projectLogger } from '../logger';\nimport type { TransactionControllerMessenger } from '../TransactionController';\nimport type {\n  Layer1GasFeeFlow,\n  Layer1GasFeeFlowRequest,\n  Layer1GasFeeFlowResponse,\n  TransactionMeta,\n} from '../types';\nimport { prepareTransaction } from '../utils/prepare';\nimport { padHexToEvenLength, toBN } from '../utils/utils';\n\nconst log = createModuleLogger(projectLogger, 'oracle-layer1-gas-fee-flow');\n\nconst ZERO = new BN(0);\n\nconst DUMMY_KEY =\n  'abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789';\n\nconst GAS_PRICE_ORACLE_ABI = [\n  {\n    inputs: [\n      {\n        internalType: 'bytes',\n        name: '_data',\n        type: 'bytes',\n      },\n    ],\n    name: 'getL1Fee',\n    outputs: [\n      {\n        internalType: 'uint256',\n        name: '',\n        type: 'uint256',\n      },\n    ],\n    stateMutability: 'view',\n    type: 'function',\n  },\n  // only available post Isthmus\n  {\n    inputs: [\n      {\n        internalType: 'uint256',\n        name: '_gasUsed',\n        type: 'uint256',\n      },\n    ],\n    name: 'getOperatorFee',\n    outputs: [\n      {\n        internalType: 'uint256',\n        name: '',\n        type: 'uint256',\n      },\n    ],\n    stateMutability: 'view',\n    type: 'function',\n  },\n];\n\n// Default OP Stack gas price oracle address used across supported networks\nconst DEFAULT_GAS_PRICE_ORACLE_ADDRESS =\n  '0x420000000000000000000000000000000000000F' as Hex;\n\n/**\n * Layer 1 gas fee flow that obtains gas fee estimate using an oracle smart contract.\n */\nexport abstract class OracleLayer1GasFeeFlow implements Layer1GasFeeFlow {\n  /**\n   * Resolves the oracle address for the given chain. Subclasses can override\n   * this method to provide chain-specific oracle addresses. By default, this\n   * returns the standard OP Stack gas price oracle address.\n   *\n   * @param _chainId - The chain ID to resolve the oracle address for.\n   * @returns The oracle address for the given chain.\n   */\n  protected getOracleAddressForChain(_chainId: Hex): Hex {\n    return DEFAULT_GAS_PRICE_ORACLE_ADDRESS;\n  }\n\n  /**\n   * Whether to sign the transaction with a dummy key prior to calling the\n   * oracle contract. Some oracle contracts require a signed payload even for\n   * read-only methods.\n   *\n   * Subclasses can override to enable signing when needed. Defaults to false.\n   *\n   * @returns Whether the transaction should be signed prior to the oracle call.\n   */\n  protected shouldSignTransaction(): boolean {\n    return false;\n  }\n\n  abstract matchesTransaction({\n    transactionMeta,\n    messenger,\n  }: {\n    transactionMeta: TransactionMeta;\n    messenger: TransactionControllerMessenger;\n  }): Promise<boolean>;\n\n  async getLayer1Fee(\n    request: Layer1GasFeeFlowRequest,\n  ): Promise<Layer1GasFeeFlowResponse> {\n    try {\n      const { provider, transactionMeta } = request;\n\n      const contract = this.#getGasPriceOracleContract(\n        provider,\n        transactionMeta.chainId,\n      );\n\n      const oracleFee = await this.#getOracleLayer1GasFee(\n        contract,\n        transactionMeta,\n      );\n      const operatorFee = await this.#getOperatorLayer1GasFee(\n        contract,\n        transactionMeta,\n      );\n\n      return {\n        layer1Fee: add0x(\n          padHexToEvenLength(oracleFee.add(operatorFee).toString(16)),\n        ) as Hex,\n      };\n    } catch (error) {\n      log('Failed to get oracle layer 1 gas fee', error);\n      throw new Error(`Failed to get oracle layer 1 gas fee`);\n    }\n  }\n\n  async #getOracleLayer1GasFee(\n    contract: Contract,\n    transactionMeta: TransactionMeta,\n  ): Promise<BN> {\n    const serializedTransaction = this.#buildUnserializedTransaction(\n      transactionMeta,\n      this.shouldSignTransaction(),\n    ).serialize();\n\n    const result = await contract.getL1Fee(serializedTransaction);\n\n    if (result === undefined) {\n      throw new Error('No value returned from oracle contract');\n    }\n\n    return toBN(result);\n  }\n\n  async #getOperatorLayer1GasFee(\n    contract: Contract,\n    transactionMeta: TransactionMeta,\n  ): Promise<BN> {\n    const { gasUsed } = transactionMeta;\n\n    if (!gasUsed) {\n      return ZERO;\n    }\n\n    try {\n      const result = await contract.getOperatorFee(gasUsed);\n\n      if (result === undefined) {\n        return ZERO;\n      }\n\n      return toBN(result);\n    } catch (error) {\n      log('Failed to get operator layer 1 gas fee', error);\n      return ZERO;\n    }\n  }\n\n  #buildUnserializedTransaction(\n    transactionMeta: TransactionMeta,\n    sign: boolean,\n  ) {\n    const txParams = this.#buildTransactionParams(transactionMeta);\n    const { chainId } = transactionMeta;\n\n    let unserializedTransaction = prepareTransaction(chainId, txParams);\n\n    if (sign) {\n      const keyBuffer = Buffer.from(DUMMY_KEY, 'hex');\n      const keyBytes = Uint8Array.from(keyBuffer);\n      unserializedTransaction = unserializedTransaction.sign(keyBytes);\n    }\n\n    return unserializedTransaction;\n  }\n\n  #buildTransactionParams(\n    transactionMeta: TransactionMeta,\n  ): TransactionMeta['txParams'] {\n    return {\n      ...transactionMeta.txParams,\n      gasLimit: transactionMeta.txParams.gas,\n    };\n  }\n\n  #getGasPriceOracleContract(\n    provider: Layer1GasFeeFlowRequest['provider'],\n    chainId: Hex,\n  ) {\n    return new Contract(\n      this.getOracleAddressForChain(chainId),\n      GAS_PRICE_ORACLE_ABI,\n      // Network controller provider type is incompatible with ethers provider\n      new Web3Provider(provider as unknown as ExternalProvider),\n    );\n  }\n}\n"]}

package/dist/gas-flows/RandomisedEstimationsGasFeeFlow.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"RandomisedEstimationsGasFeeFlow.cjs","sourceRoot":"","sources":["../../src/gas-flows/RandomisedEstimationsGasFeeFlow.ts"],"names":[],"mappings":";;;;;;;;;AACA,qEAAkE;AAClE,2CAAsE;AAEtE,+DAAwD;AACxD,0CAA0C;AAU1C,wCAAmE;AACnE,8DAAgE;AAChE,oDAG2B;AAE3B,MAAM,GAAG,GAAG,IAAA,0BAAkB,EAC5B,sBAAa,EACb,oCAAoC,CACrC,CAAC;AAEF,MAAM,iCAAiC,GAAG,CAAC,CAAC;AAE5C;;GAEG;AACH,MAAa,+BAA+B;IAA5C;;IA+GA,CAAC;IA9GC,kBAAkB,CAAC,EACjB,eAAe,EACf,SAAS,GAIV;QACC,MAAM,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;QAEpC,MAAM,mBAAmB,GAAG,IAAA,sCAAsB,EAAC,SAAS,CAAC,CAAC;QAE9D,MAAM,sBAAsB,GAC1B,mBAAmB,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;QAEtD,OAAO,sBAAsB,KAAK,SAAS,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,OAA0B;QACzC,IAAI;YACF,OAAO,MAAM,uBAAA,IAAI,yGAAsB,MAA1B,IAAI,EAAuB,OAAO,CAAC,CAAC;SAClD;QAAC,OAAO,KAAK,EAAE;YACd,GAAG,CAAC,6CAA6C,EAAE,KAAK,CAAC,CAAC;YAC1D,OAAO,MAAM,uBAAA,IAAI,sGAAmB,MAAvB,IAAI,EAAoB,OAAO,CAAC,CAAC;SAC/C;IACH,CAAC;CAsFF;AA/GD,0EA+GC;iHApFC,KAAK,6DACH,OAA0B;IAE1B,OAAO,IAAI,qCAAiB,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;AACrD,CAAC,0DAED,KAAK,gEACH,OAA0B;IAE1B,MAAM,EAAE,SAAS,EAAE,oBAAoB,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;IACrE,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,GAAG,oBAAoB,CAAC;IAElE,MAAM,mBAAmB,GAAG,IAAA,sCAAsB,EAAC,SAAS,CAAC,CAAC;IAE9D,MAAM,sBAAsB,GAC1B,mBAAmB,CAAC,sBAAsB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAEtE,MAAM,uBAAuB,GAC3B,mBAAmB,CAAC,uBAAuB;QAC3C,iCAAiC,CAAC;IAEpC,IAAI,eAAe,KAAK,uCAAkB,CAAC,UAAU,EAAE;QACrD,GAAG,CAAC,kCAAkC,EAAE,eAAe,CAAC,CAAC;QACzD,MAAM,4BAA4B,GAChC,uBAAA,IAAI,oHAAiC,MAArC,IAAI,EACF,eAAe,EACf,sBAAsB,EACtB,uBAAuB,CACxB,CAAC;QACJ,GAAG,CACD,uCAAuC,EACvC,4BAA4B,CAC7B,CAAC;QAEF,OAAO;YACL,SAAS,EAAE,4BAA4B;SACxC,CAAC;KACH;IAED,OAAO,MAAM,uBAAA,IAAI,sGAAmB,MAAvB,IAAI,EAAoB,OAAO,CAAC,CAAC;AAChD,CAAC,+IAGC,eAA0C,EAC1C,WAAmB,EACnB,uBAA+B;IAE/B,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,2BAAmB,CAAC,CAAC,MAAM,CACtD,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAClB,GAAG,MAAM;QACT,CAAC,KAAK,CAAC,EAAE,uBAAA,IAAI,gHAA6B,MAAjC,IAAI,EACX,eAAe,EACf,KAAK,EACL,WAAW,EACX,uBAAuB,CACxB;KACF,CAAC,EACF,EAA4C,CAC7C,CAAC;IAEF,OAAO;QACL,IAAI,EAAE,0BAAkB,CAAC,SAAS;QAClC,GAAG,MAAM;KACV,CAAC;AACJ,CAAC,uIAGC,eAA0C,EAC1C,KAA0B,EAC1B,WAAmB,EACnB,uBAA+B;IAE/B,OAAO;QACL,YAAY,EAAE,IAAA,8BAAmB,EAC/B,eAAe,CAAC,KAAK,CAAC,CAAC,qBAAqB,CAC7C;QACD,kCAAkC;QAClC,oBAAoB,EAAE,mCAAmC,CACvD,eAAe,CAAC,KAAK,CAAC,CAAC,6BAA6B,EACpD,WAAW,EACX,uBAAuB,CACxB;KACF,CAAC;AACJ,CAAC;AAGH;;;;;;GAMG;AACH,SAAS,oBAAoB,CAAC,UAAkB,EAAE,QAAgB;IAChE,MAAM,UAAU,GAAG,EAAE,IAAI,UAAU,CAAC;IACpC,OAAO,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,UAAU,GAAG,QAAQ,CAAC,CAAC,CAAC;AACxE,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,mCAAmC,CACjD,gBAAiC,EACjC,iCAAyC,EACzC,uBAA+B;IAE/B,MAAM,eAAe,GAAG,IAAA,kCAAuB,EAAC,gBAAgB,CAAC,CAAC;IAClE,MAAM,aAAa,GAAG,eAAe,CAAC,MAAM,CAAC;IAE7C,wFAAwF;IACxF,MAAM,0BAA0B,GAAG,IAAI,CAAC,GAAG,CACzC,iCAAiC,EACjC,aAAa,GAAG,uBAAuB,CACxC,CAAC;IAEF,mDAAmD;IACnD,IAAI,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,0BAA0B,IAAI,CAAC,EAAE;QACpE,OAAO,KAAK,MAAM,CAAC,eAAe,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAS,CAAC;KAC3D;IAED,oEAAoE;IACpE,MAAM,sBAAsB,GAAG,aAAa,GAAG,0BAA0B,CAAC;IAC1E,MAAM,iBAAiB,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC;IAE3E,2DAA2D;IAC3D,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC,0BAA0B,CAAC,CAAC;IACxE,MAAM,oBAAoB,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;IAElD,sFAAsF;IACtF,MAAM,kBAAkB,GAAG,oBAAoB,CAC7C,0BAA0B,EAC1B,oBAAoB,CACrB,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,CACrB,iBAAiB,GAAG,GAAG,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAC3D,CAAC;IACF,MAAM,oBAAoB,GAAG,QAAQ,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAC;IAEnE,MAAM,gBAAgB,GAAG,KAAK,oBAAoB,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;IAElE,OAAO,IAAA,aAAK,EAAC,gBAAgB,CAAC,CAAC;AACjC,CAAC;AAzCD,kFAyCC","sourcesContent":["import type { GasFeeEstimates as FeeMarketGasPriceEstimate } from '@metamask/gas-fee-controller';\nimport { GAS_ESTIMATE_TYPES } from '@metamask/gas-fee-controller';\nimport { add0x, createModuleLogger, type Hex } from '@metamask/utils';\n\nimport { DefaultGasFeeFlow } from './DefaultGasFeeFlow';\nimport { projectLogger } from '../logger';\nimport type { TransactionControllerMessenger } from '../TransactionController';\nimport type {\n  FeeMarketGasFeeEstimateForLevel,\n  FeeMarketGasFeeEstimates,\n  GasFeeFlow,\n  GasFeeFlowRequest,\n  GasFeeFlowResponse,\n  TransactionMeta,\n} from '../types';\nimport { GasFeeEstimateLevel, GasFeeEstimateType } from '../types';\nimport { getGasFeeRandomisation } from '../utils/feature-flags';\nimport {\n  gweiDecimalToWeiDecimal,\n  gweiDecimalToWeiHex,\n} from '../utils/gas-fees';\n\nconst log = createModuleLogger(\n  projectLogger,\n  'randomised-estimation-gas-fee-flow',\n);\n\nconst DEFAULT_PRESERVE_NUMBER_OF_DIGITS = 2;\n\n/**\n * Implementation of a gas fee flow that randomises the last digits of gas fee estimations\n */\nexport class RandomisedEstimationsGasFeeFlow implements GasFeeFlow {\n  matchesTransaction({\n    transactionMeta,\n    messenger,\n  }: {\n    transactionMeta: TransactionMeta;\n    messenger: TransactionControllerMessenger;\n  }): boolean {\n    const { chainId } = transactionMeta;\n\n    const gasFeeRandomisation = getGasFeeRandomisation(messenger);\n\n    const randomisedGasFeeDigits =\n      gasFeeRandomisation.randomisedGasFeeDigits[chainId];\n\n    return randomisedGasFeeDigits !== undefined;\n  }\n\n  async getGasFees(request: GasFeeFlowRequest): Promise<GasFeeFlowResponse> {\n    try {\n      return await this.#getRandomisedGasFees(request);\n    } catch (error) {\n      log('Using default flow as fallback due to error', error);\n      return await this.#getDefaultGasFees(request);\n    }\n  }\n\n  async #getDefaultGasFees(\n    request: GasFeeFlowRequest,\n  ): Promise<GasFeeFlowResponse> {\n    return new DefaultGasFeeFlow().getGasFees(request);\n  }\n\n  async #getRandomisedGasFees(\n    request: GasFeeFlowRequest,\n  ): Promise<GasFeeFlowResponse> {\n    const { messenger, gasFeeControllerData, transactionMeta } = request;\n    const { gasEstimateType, gasFeeEstimates } = gasFeeControllerData;\n\n    const gasFeeRandomisation = getGasFeeRandomisation(messenger);\n\n    const randomisedGasFeeDigits =\n      gasFeeRandomisation.randomisedGasFeeDigits[transactionMeta.chainId];\n\n    const preservedNumberOfDigits =\n      gasFeeRandomisation.preservedNumberOfDigits ??\n      DEFAULT_PRESERVE_NUMBER_OF_DIGITS;\n\n    if (gasEstimateType === GAS_ESTIMATE_TYPES.FEE_MARKET) {\n      log('Randomising fee market estimates', gasFeeEstimates);\n      const randomisedFeeMarketEstimates =\n        this.#getRandomisedFeeMarketEstimates(\n          gasFeeEstimates,\n          randomisedGasFeeDigits,\n          preservedNumberOfDigits,\n        );\n      log(\n        'Added randomised fee market estimates',\n        randomisedFeeMarketEstimates,\n      );\n\n      return {\n        estimates: randomisedFeeMarketEstimates,\n      };\n    }\n\n    return await this.#getDefaultGasFees(request);\n  }\n\n  #getRandomisedFeeMarketEstimates(\n    gasFeeEstimates: FeeMarketGasPriceEstimate,\n    lastNDigits: number,\n    preservedNumberOfDigits: number,\n  ): FeeMarketGasFeeEstimates {\n    const levels = Object.values(GasFeeEstimateLevel).reduce(\n      (result, level) => ({\n        ...result,\n        [level]: this.#getRandomisedFeeMarketLevel(\n          gasFeeEstimates,\n          level,\n          lastNDigits,\n          preservedNumberOfDigits,\n        ),\n      }),\n      {} as Omit<FeeMarketGasFeeEstimates, 'type'>,\n    );\n\n    return {\n      type: GasFeeEstimateType.FeeMarket,\n      ...levels,\n    };\n  }\n\n  #getRandomisedFeeMarketLevel(\n    gasFeeEstimates: FeeMarketGasPriceEstimate,\n    level: GasFeeEstimateLevel,\n    lastNDigits: number,\n    preservedNumberOfDigits: number,\n  ): FeeMarketGasFeeEstimateForLevel {\n    return {\n      maxFeePerGas: gweiDecimalToWeiHex(\n        gasFeeEstimates[level].suggestedMaxFeePerGas,\n      ),\n      // Only priority fee is randomised\n      maxPriorityFeePerGas: randomiseDecimalGWEIAndConvertToHex(\n        gasFeeEstimates[level].suggestedMaxPriorityFeePerGas,\n        lastNDigits,\n        preservedNumberOfDigits,\n      ),\n    };\n  }\n}\n\n/**\n * Generates a random number with the specified number of digits that is greater than or equal to the given minimum value.\n *\n * @param digitCount - The number of digits the random number should have\n * @param minValue - The minimum value the random number should have\n * @returns A random number with the specified number of digits\n */\nfunction generateRandomDigits(digitCount: number, minValue: number): number {\n  const multiplier = 10 ** digitCount;\n  return minValue + Math.floor(Math.random() * (multiplier - minValue));\n}\n\n/**\n * Randomises the least significant digits of a decimal gas fee value and converts it to a hexadecimal Wei value.\n *\n * This function preserves the more significant digits while randomizing only the least significant ones,\n * ensuring that fees remain close to the original estimation while providing randomisation.\n * The randomisation is performed in Wei units for more precision.\n *\n * @param gweiDecimalValue - The original gas fee value in Gwei (decimal)\n * @param numberOfDigitsToRandomizeAtTheEnd - The number of least significant digits to randomise\n * @param preservedNumberOfDigits - The number of most significant digits to preserve\n * @returns The randomised value converted to Wei in hexadecimal format\n */\nexport function randomiseDecimalGWEIAndConvertToHex(\n  gweiDecimalValue: string | number,\n  numberOfDigitsToRandomizeAtTheEnd: number,\n  preservedNumberOfDigits: number,\n): Hex {\n  const weiDecimalValue = gweiDecimalToWeiDecimal(gweiDecimalValue);\n  const decimalLength = weiDecimalValue.length;\n\n  // Determine how many digits to randomise while preserving the PRESERVE_NUMBER_OF_DIGITS\n  const effectiveDigitsToRandomise = Math.min(\n    numberOfDigitsToRandomizeAtTheEnd,\n    decimalLength - preservedNumberOfDigits,\n  );\n\n  // Handle the case when the value is 0 or too small\n  if (Number(weiDecimalValue) === 0 || effectiveDigitsToRandomise <= 0) {\n    return `0x${Number(weiDecimalValue).toString(16)}` as Hex;\n  }\n\n  // Use string manipulation to get the base part (significant digits)\n  const significantDigitsCount = decimalLength - effectiveDigitsToRandomise;\n  const significantDigits = weiDecimalValue.slice(0, significantDigitsCount);\n\n  // Get the original ending digits using string manipulation\n  const endingDigits = weiDecimalValue.slice(-effectiveDigitsToRandomise);\n  const originalEndingDigits = Number(endingDigits);\n\n  // Generate random digits that are greater than or equal to the original ending digits\n  const randomEndingDigits = generateRandomDigits(\n    effectiveDigitsToRandomise,\n    originalEndingDigits,\n  );\n\n  const basePart = BigInt(\n    significantDigits + '0'.repeat(effectiveDigitsToRandomise),\n  );\n  const randomisedWeiDecimal = basePart + BigInt(randomEndingDigits);\n\n  const hexRandomisedWei = `0x${randomisedWeiDecimal.toString(16)}`;\n\n  return add0x(hexRandomisedWei);\n}\n"]}
+{"version":3,"file":"RandomisedEstimationsGasFeeFlow.cjs","sourceRoot":"","sources":["../../src/gas-flows/RandomisedEstimationsGasFeeFlow.ts"],"names":[],"mappings":";;;;;;;;;AACA,qEAAkE;AAClE,2CAAsE;AAEtE,+DAAwD;AACxD,0CAA0C;AAU1C,wCAAmE;AACnE,8DAAgE;AAChE,oDAG2B;AAE3B,MAAM,GAAG,GAAG,IAAA,0BAAkB,EAC5B,sBAAa,EACb,oCAAoC,CACrC,CAAC;AAEF,MAAM,iCAAiC,GAAG,CAAC,CAAC;AAE5C;;GAEG;AACH,MAAa,+BAA+B;IAA5C;;IA+GA,CAAC;IA9GC,kBAAkB,CAAC,EACjB,eAAe,EACf,SAAS,GAIV;QACC,MAAM,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;QAEpC,MAAM,mBAAmB,GAAG,IAAA,sCAAsB,EAAC,SAAS,CAAC,CAAC;QAE9D,MAAM,sBAAsB,GAC1B,mBAAmB,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;QAEtD,OAAO,sBAAsB,KAAK,SAAS,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,OAA0B;QACzC,IAAI,CAAC;YACH,OAAO,MAAM,uBAAA,IAAI,yGAAsB,MAA1B,IAAI,EAAuB,OAAO,CAAC,CAAC;QACnD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,GAAG,CAAC,6CAA6C,EAAE,KAAK,CAAC,CAAC;YAC1D,OAAO,MAAM,uBAAA,IAAI,sGAAmB,MAAvB,IAAI,EAAoB,OAAO,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;CAsFF;AA/GD,0EA+GC;iHApFC,KAAK,6DACH,OAA0B;IAE1B,OAAO,IAAI,qCAAiB,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;AACrD,CAAC,0DAED,KAAK,gEACH,OAA0B;IAE1B,MAAM,EAAE,SAAS,EAAE,oBAAoB,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;IACrE,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,GAAG,oBAAoB,CAAC;IAElE,MAAM,mBAAmB,GAAG,IAAA,sCAAsB,EAAC,SAAS,CAAC,CAAC;IAE9D,MAAM,sBAAsB,GAC1B,mBAAmB,CAAC,sBAAsB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAEtE,MAAM,uBAAuB,GAC3B,mBAAmB,CAAC,uBAAuB;QAC3C,iCAAiC,CAAC;IAEpC,IAAI,eAAe,KAAK,uCAAkB,CAAC,UAAU,EAAE,CAAC;QACtD,GAAG,CAAC,kCAAkC,EAAE,eAAe,CAAC,CAAC;QACzD,MAAM,4BAA4B,GAChC,uBAAA,IAAI,oHAAiC,MAArC,IAAI,EACF,eAAe,EACf,sBAAsB,EACtB,uBAAuB,CACxB,CAAC;QACJ,GAAG,CACD,uCAAuC,EACvC,4BAA4B,CAC7B,CAAC;QAEF,OAAO;YACL,SAAS,EAAE,4BAA4B;SACxC,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,uBAAA,IAAI,sGAAmB,MAAvB,IAAI,EAAoB,OAAO,CAAC,CAAC;AAChD,CAAC,+IAGC,eAA0C,EAC1C,WAAmB,EACnB,uBAA+B;IAE/B,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,2BAAmB,CAAC,CAAC,MAAM,CACtD,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAClB,GAAG,MAAM;QACT,CAAC,KAAK,CAAC,EAAE,uBAAA,IAAI,gHAA6B,MAAjC,IAAI,EACX,eAAe,EACf,KAAK,EACL,WAAW,EACX,uBAAuB,CACxB;KACF,CAAC,EACF,EAA4C,CAC7C,CAAC;IAEF,OAAO;QACL,IAAI,EAAE,0BAAkB,CAAC,SAAS;QAClC,GAAG,MAAM;KACV,CAAC;AACJ,CAAC,uIAGC,eAA0C,EAC1C,KAA0B,EAC1B,WAAmB,EACnB,uBAA+B;IAE/B,OAAO;QACL,YAAY,EAAE,IAAA,8BAAmB,EAC/B,eAAe,CAAC,KAAK,CAAC,CAAC,qBAAqB,CAC7C;QACD,kCAAkC;QAClC,oBAAoB,EAAE,mCAAmC,CACvD,eAAe,CAAC,KAAK,CAAC,CAAC,6BAA6B,EACpD,WAAW,EACX,uBAAuB,CACxB;KACF,CAAC;AACJ,CAAC;AAGH;;;;;;GAMG;AACH,SAAS,oBAAoB,CAAC,UAAkB,EAAE,QAAgB;IAChE,MAAM,UAAU,GAAG,EAAE,IAAI,UAAU,CAAC;IACpC,OAAO,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,UAAU,GAAG,QAAQ,CAAC,CAAC,CAAC;AACxE,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,mCAAmC,CACjD,gBAAiC,EACjC,iCAAyC,EACzC,uBAA+B;IAE/B,MAAM,eAAe,GAAG,IAAA,kCAAuB,EAAC,gBAAgB,CAAC,CAAC;IAClE,MAAM,aAAa,GAAG,eAAe,CAAC,MAAM,CAAC;IAE7C,wFAAwF;IACxF,MAAM,0BAA0B,GAAG,IAAI,CAAC,GAAG,CACzC,iCAAiC,EACjC,aAAa,GAAG,uBAAuB,CACxC,CAAC;IAEF,mDAAmD;IACnD,IAAI,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,0BAA0B,IAAI,CAAC,EAAE,CAAC;QACrE,OAAO,KAAK,MAAM,CAAC,eAAe,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAS,CAAC;IAC5D,CAAC;IAED,oEAAoE;IACpE,MAAM,sBAAsB,GAAG,aAAa,GAAG,0BAA0B,CAAC;IAC1E,MAAM,iBAAiB,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC;IAE3E,2DAA2D;IAC3D,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC,0BAA0B,CAAC,CAAC;IACxE,MAAM,oBAAoB,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;IAElD,sFAAsF;IACtF,MAAM,kBAAkB,GAAG,oBAAoB,CAC7C,0BAA0B,EAC1B,oBAAoB,CACrB,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,CACrB,iBAAiB,GAAG,GAAG,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAC3D,CAAC;IACF,MAAM,oBAAoB,GAAG,QAAQ,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAC;IAEnE,MAAM,gBAAgB,GAAG,KAAK,oBAAoB,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;IAElE,OAAO,IAAA,aAAK,EAAC,gBAAgB,CAAC,CAAC;AACjC,CAAC;AAzCD,kFAyCC","sourcesContent":["import type { GasFeeEstimates as FeeMarketGasPriceEstimate } from '@metamask/gas-fee-controller';\nimport { GAS_ESTIMATE_TYPES } from '@metamask/gas-fee-controller';\nimport { add0x, createModuleLogger, type Hex } from '@metamask/utils';\n\nimport { DefaultGasFeeFlow } from './DefaultGasFeeFlow';\nimport { projectLogger } from '../logger';\nimport type { TransactionControllerMessenger } from '../TransactionController';\nimport type {\n  FeeMarketGasFeeEstimateForLevel,\n  FeeMarketGasFeeEstimates,\n  GasFeeFlow,\n  GasFeeFlowRequest,\n  GasFeeFlowResponse,\n  TransactionMeta,\n} from '../types';\nimport { GasFeeEstimateLevel, GasFeeEstimateType } from '../types';\nimport { getGasFeeRandomisation } from '../utils/feature-flags';\nimport {\n  gweiDecimalToWeiDecimal,\n  gweiDecimalToWeiHex,\n} from '../utils/gas-fees';\n\nconst log = createModuleLogger(\n  projectLogger,\n  'randomised-estimation-gas-fee-flow',\n);\n\nconst DEFAULT_PRESERVE_NUMBER_OF_DIGITS = 2;\n\n/**\n * Implementation of a gas fee flow that randomises the last digits of gas fee estimations\n */\nexport class RandomisedEstimationsGasFeeFlow implements GasFeeFlow {\n  matchesTransaction({\n    transactionMeta,\n    messenger,\n  }: {\n    transactionMeta: TransactionMeta;\n    messenger: TransactionControllerMessenger;\n  }): boolean {\n    const { chainId } = transactionMeta;\n\n    const gasFeeRandomisation = getGasFeeRandomisation(messenger);\n\n    const randomisedGasFeeDigits =\n      gasFeeRandomisation.randomisedGasFeeDigits[chainId];\n\n    return randomisedGasFeeDigits !== undefined;\n  }\n\n  async getGasFees(request: GasFeeFlowRequest): Promise<GasFeeFlowResponse> {\n    try {\n      return await this.#getRandomisedGasFees(request);\n    } catch (error) {\n      log('Using default flow as fallback due to error', error);\n      return await this.#getDefaultGasFees(request);\n    }\n  }\n\n  async #getDefaultGasFees(\n    request: GasFeeFlowRequest,\n  ): Promise<GasFeeFlowResponse> {\n    return new DefaultGasFeeFlow().getGasFees(request);\n  }\n\n  async #getRandomisedGasFees(\n    request: GasFeeFlowRequest,\n  ): Promise<GasFeeFlowResponse> {\n    const { messenger, gasFeeControllerData, transactionMeta } = request;\n    const { gasEstimateType, gasFeeEstimates } = gasFeeControllerData;\n\n    const gasFeeRandomisation = getGasFeeRandomisation(messenger);\n\n    const randomisedGasFeeDigits =\n      gasFeeRandomisation.randomisedGasFeeDigits[transactionMeta.chainId];\n\n    const preservedNumberOfDigits =\n      gasFeeRandomisation.preservedNumberOfDigits ??\n      DEFAULT_PRESERVE_NUMBER_OF_DIGITS;\n\n    if (gasEstimateType === GAS_ESTIMATE_TYPES.FEE_MARKET) {\n      log('Randomising fee market estimates', gasFeeEstimates);\n      const randomisedFeeMarketEstimates =\n        this.#getRandomisedFeeMarketEstimates(\n          gasFeeEstimates,\n          randomisedGasFeeDigits,\n          preservedNumberOfDigits,\n        );\n      log(\n        'Added randomised fee market estimates',\n        randomisedFeeMarketEstimates,\n      );\n\n      return {\n        estimates: randomisedFeeMarketEstimates,\n      };\n    }\n\n    return await this.#getDefaultGasFees(request);\n  }\n\n  #getRandomisedFeeMarketEstimates(\n    gasFeeEstimates: FeeMarketGasPriceEstimate,\n    lastNDigits: number,\n    preservedNumberOfDigits: number,\n  ): FeeMarketGasFeeEstimates {\n    const levels = Object.values(GasFeeEstimateLevel).reduce(\n      (result, level) => ({\n        ...result,\n        [level]: this.#getRandomisedFeeMarketLevel(\n          gasFeeEstimates,\n          level,\n          lastNDigits,\n          preservedNumberOfDigits,\n        ),\n      }),\n      {} as Omit<FeeMarketGasFeeEstimates, 'type'>,\n    );\n\n    return {\n      type: GasFeeEstimateType.FeeMarket,\n      ...levels,\n    };\n  }\n\n  #getRandomisedFeeMarketLevel(\n    gasFeeEstimates: FeeMarketGasPriceEstimate,\n    level: GasFeeEstimateLevel,\n    lastNDigits: number,\n    preservedNumberOfDigits: number,\n  ): FeeMarketGasFeeEstimateForLevel {\n    return {\n      maxFeePerGas: gweiDecimalToWeiHex(\n        gasFeeEstimates[level].suggestedMaxFeePerGas,\n      ),\n      // Only priority fee is randomised\n      maxPriorityFeePerGas: randomiseDecimalGWEIAndConvertToHex(\n        gasFeeEstimates[level].suggestedMaxPriorityFeePerGas,\n        lastNDigits,\n        preservedNumberOfDigits,\n      ),\n    };\n  }\n}\n\n/**\n * Generates a random number with the specified number of digits that is greater than or equal to the given minimum value.\n *\n * @param digitCount - The number of digits the random number should have\n * @param minValue - The minimum value the random number should have\n * @returns A random number with the specified number of digits\n */\nfunction generateRandomDigits(digitCount: number, minValue: number): number {\n  const multiplier = 10 ** digitCount;\n  return minValue + Math.floor(Math.random() * (multiplier - minValue));\n}\n\n/**\n * Randomises the least significant digits of a decimal gas fee value and converts it to a hexadecimal Wei value.\n *\n * This function preserves the more significant digits while randomizing only the least significant ones,\n * ensuring that fees remain close to the original estimation while providing randomisation.\n * The randomisation is performed in Wei units for more precision.\n *\n * @param gweiDecimalValue - The original gas fee value in Gwei (decimal)\n * @param numberOfDigitsToRandomizeAtTheEnd - The number of least significant digits to randomise\n * @param preservedNumberOfDigits - The number of most significant digits to preserve\n * @returns The randomised value converted to Wei in hexadecimal format\n */\nexport function randomiseDecimalGWEIAndConvertToHex(\n  gweiDecimalValue: string | number,\n  numberOfDigitsToRandomizeAtTheEnd: number,\n  preservedNumberOfDigits: number,\n): Hex {\n  const weiDecimalValue = gweiDecimalToWeiDecimal(gweiDecimalValue);\n  const decimalLength = weiDecimalValue.length;\n\n  // Determine how many digits to randomise while preserving the PRESERVE_NUMBER_OF_DIGITS\n  const effectiveDigitsToRandomise = Math.min(\n    numberOfDigitsToRandomizeAtTheEnd,\n    decimalLength - preservedNumberOfDigits,\n  );\n\n  // Handle the case when the value is 0 or too small\n  if (Number(weiDecimalValue) === 0 || effectiveDigitsToRandomise <= 0) {\n    return `0x${Number(weiDecimalValue).toString(16)}` as Hex;\n  }\n\n  // Use string manipulation to get the base part (significant digits)\n  const significantDigitsCount = decimalLength - effectiveDigitsToRandomise;\n  const significantDigits = weiDecimalValue.slice(0, significantDigitsCount);\n\n  // Get the original ending digits using string manipulation\n  const endingDigits = weiDecimalValue.slice(-effectiveDigitsToRandomise);\n  const originalEndingDigits = Number(endingDigits);\n\n  // Generate random digits that are greater than or equal to the original ending digits\n  const randomEndingDigits = generateRandomDigits(\n    effectiveDigitsToRandomise,\n    originalEndingDigits,\n  );\n\n  const basePart = BigInt(\n    significantDigits + '0'.repeat(effectiveDigitsToRandomise),\n  );\n  const randomisedWeiDecimal = basePart + BigInt(randomEndingDigits);\n\n  const hexRandomisedWei = `0x${randomisedWeiDecimal.toString(16)}`;\n\n  return add0x(hexRandomisedWei);\n}\n"]}