@metamask/transaction-controller 66.0.0 → 66.0.1

package/CHANGELOG.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [66.0.1]
+
+### Changed
+
+- Bump `@metamask/accounts-controller` from `^38.1.1` to `^39.0.0` ([#8912](https://github.com/MetaMask/core/pull/8912), [#8999](https://github.com/MetaMask/core/pull/8999))
+- Bump `@metamask/core-backend` from `^6.3.0` to `^6.3.2` ([#8912](https://github.com/MetaMask/core/pull/8912), [#8999](https://github.com/MetaMask/core/pull/8999))
+- Bump `@metamask/remote-feature-flag-controller` from `^4.2.1` to `^4.2.2` ([#8986](https://github.com/MetaMask/core/pull/8986))
+
+### Fixed
+
+- Include Mantle operator fee in the displayed L1 gas estimate when simulated `gasUsed` is unavailable, by falling back to the transaction's gas limit ([#8837](https://github.com/MetaMask/core/pull/8837))
+  - Adds a `protected getOperatorFeeGas` hook on `OracleLayer1GasFeeFlow` that subclasses can override to supply a fallback value. The default behaviour is unchanged (returns `transactionMeta.gasUsed`).
+  - `MantleLayer1GasFeeFlow` overrides the hook with `gasUsed ?? txParams.gas ?? txParams.gasLimit`, so the operator-fee oracle is called with the gas limit when `gasUsed` is missing. Gas limit is an upper bound on actual gas used, so the operator fee is over-estimated rather than under-reported.
+- Fix `ExtraTransactionsPublishHook` not passing `isInternal: true` when calling `addTransactionBatch`, causing the duplicate-batch-ID guard to incorrectly throw `DuplicateBundleId` (error 5720) for nested ERC-20 gas-fee-token transfers that share a `batchId` with their parent batch ([#8884](https://github.com/MetaMask/core/pull/8884))
+
 ## [66.0.0]
 
 ### Changed
@@ -2443,7 +2458,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
     All changes listed after this point were applied to this package following the monorepo conversion.
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@66.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@66.0.1...HEAD
+[66.0.1]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@66.0.0...@metamask/transaction-controller@66.0.1
 [66.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@65.4.0...@metamask/transaction-controller@66.0.0
 [65.4.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@65.3.0...@metamask/transaction-controller@65.4.0
 [65.3.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@65.2.0...@metamask/transaction-controller@65.3.0

package/dist/gas-flows/MantleLayer1GasFeeFlow.cjs

@@ -34,6 +34,11 @@ class MantleLayer1GasFeeFlow extends OracleLayer1GasFeeFlow_1.OracleLayer1GasFee
     async matchesTransaction({ transactionMeta, }) {
         return MANTLE_CHAIN_IDS.includes(transactionMeta.chainId);
     }
+    getOperatorFeeGas(transactionMeta) {
+        return (transactionMeta.gasUsed ??
+            transactionMeta.txParams.gas ??
+            transactionMeta.txParams.gasLimit);
+    }
     async transformOracleFee(oracleFee, request) {
         const { provider, transactionMeta } = request;
         const oracleAddress = this.getOracleAddressForChain(transactionMeta.chainId);

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

@@ -1 +1 @@
-{"version":3,"file":"MantleLayer1GasFeeFlow.cjs","sourceRoot":"","sources":["../../src/gas-flows/MantleLayer1GasFeeFlow.ts"],"names":[],"mappings":";;;AAAA,wDAAoD;AACpD,wDAAwD;AAKxD,gDAAyC;AAGzC,8CAAsC;AACtC,yEAAkE;AAElE,MAAM,gBAAgB,GAAU,CAAC,qBAAS,CAAC,MAAM,EAAE,qBAAS,CAAC,cAAc,CAAC,CAAC;AAE7E,MAAM,eAAe,GAAG;IACtB;QACE,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;QAClB,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;;;;;;;GAOG;AACH,MAAa,sBAAuB,SAAQ,+CAAsB;IAChE,KAAK,CAAC,kBAAkB,CAAC,EACvB,eAAe,GAIhB;QACC,OAAO,gBAAgB,CAAC,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAC5D,CAAC;IAEkB,KAAK,CAAC,kBAAkB,CACzC,SAAa,EACb,OAAgC;QAEhC,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;QAC9C,MAAM,aAAa,GAAG,IAAI,CAAC,wBAAwB,CACjD,eAAe,CAAC,OAAO,CACxB,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,oBAAQ,CAC3B,aAAa,EACb,eAAe,EACf,IAAI,wBAAY,CAAC,QAAuC,CAAC,CAC1D,CAAC;QAEF,MAAM,UAAU,GAAG,IAAA,YAAI,EAAC,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QACrD,OAAO,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACnC,CAAC;CACF;AA5BD,wDA4BC","sourcesContent":["import { Contract } from '@ethersproject/contracts';\nimport { Web3Provider } from '@ethersproject/providers';\nimport type { ExternalProvider } from '@ethersproject/providers';\nimport type { Hex } from '@metamask/utils';\nimport type BN from 'bn.js';\n\nimport { CHAIN_IDS } from '../constants';\nimport type { TransactionControllerMessenger } from '../TransactionController';\nimport type { Layer1GasFeeFlowRequest, TransactionMeta } from '../types';\nimport { toBN } from '../utils/utils';\nimport { OracleLayer1GasFeeFlow } from './OracleLayer1GasFeeFlow';\n\nconst MANTLE_CHAIN_IDS: Hex[] = [CHAIN_IDS.MANTLE, CHAIN_IDS.MANTLE_SEPOLIA];\n\nconst TOKEN_RATIO_ABI = [\n  {\n    inputs: [],\n    name: 'tokenRatio',\n    outputs: [\n      {\n        internalType: 'uint256',\n        name: '',\n        type: 'uint256',\n      },\n    ],\n    stateMutability: 'view',\n    type: 'function',\n  },\n];\n\n/**\n * Mantle layer 1 gas fee flow.\n *\n * Mantle uses MNT as its native gas token, but the oracle's getL1Fee returns\n * values denominated in ETH. This subclass multiplies the L1 fee by the\n * tokenRatio (ETH/MNT exchange rate) from the oracle contract to convert\n * the fee to MNT.\n */\nexport class MantleLayer1GasFeeFlow extends OracleLayer1GasFeeFlow {\n  async matchesTransaction({\n    transactionMeta,\n  }: {\n    transactionMeta: TransactionMeta;\n    messenger: TransactionControllerMessenger;\n  }): Promise<boolean> {\n    return MANTLE_CHAIN_IDS.includes(transactionMeta.chainId);\n  }\n\n  protected override async transformOracleFee(\n    oracleFee: BN,\n    request: Layer1GasFeeFlowRequest,\n  ): Promise<BN> {\n    const { provider, transactionMeta } = request;\n    const oracleAddress = this.getOracleAddressForChain(\n      transactionMeta.chainId,\n    );\n\n    const contract = new Contract(\n      oracleAddress,\n      TOKEN_RATIO_ABI,\n      new Web3Provider(provider as unknown as ExternalProvider),\n    );\n\n    const tokenRatio = toBN(await contract.tokenRatio());\n    return oracleFee.mul(tokenRatio);\n  }\n}\n"]}
+{"version":3,"file":"MantleLayer1GasFeeFlow.cjs","sourceRoot":"","sources":["../../src/gas-flows/MantleLayer1GasFeeFlow.ts"],"names":[],"mappings":";;;AAAA,wDAAoD;AACpD,wDAAwD;AAKxD,gDAAyC;AAGzC,8CAAsC;AACtC,yEAAkE;AAElE,MAAM,gBAAgB,GAAU,CAAC,qBAAS,CAAC,MAAM,EAAE,qBAAS,CAAC,cAAc,CAAC,CAAC;AAE7E,MAAM,eAAe,GAAG;IACtB;QACE,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;QAClB,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;;;;;;;GAOG;AACH,MAAa,sBAAuB,SAAQ,+CAAsB;IAChE,KAAK,CAAC,kBAAkB,CAAC,EACvB,eAAe,GAIhB;QACC,OAAO,gBAAgB,CAAC,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAC5D,CAAC;IAEkB,iBAAiB,CAClC,eAAgC;QAEhC,OAAO,CACL,eAAe,CAAC,OAAO;YACvB,eAAe,CAAC,QAAQ,CAAC,GAAG;YAC5B,eAAe,CAAC,QAAQ,CAAC,QAAQ,CAClC,CAAC;IACJ,CAAC;IAEkB,KAAK,CAAC,kBAAkB,CACzC,SAAa,EACb,OAAgC;QAEhC,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;QAC9C,MAAM,aAAa,GAAG,IAAI,CAAC,wBAAwB,CACjD,eAAe,CAAC,OAAO,CACxB,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,oBAAQ,CAC3B,aAAa,EACb,eAAe,EACf,IAAI,wBAAY,CAAC,QAAuC,CAAC,CAC1D,CAAC;QAEF,MAAM,UAAU,GAAG,IAAA,YAAI,EAAC,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QACrD,OAAO,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACnC,CAAC;CACF;AAtCD,wDAsCC","sourcesContent":["import { Contract } from '@ethersproject/contracts';\nimport { Web3Provider } from '@ethersproject/providers';\nimport type { ExternalProvider } from '@ethersproject/providers';\nimport type { Hex } from '@metamask/utils';\nimport type BN from 'bn.js';\n\nimport { CHAIN_IDS } from '../constants';\nimport type { TransactionControllerMessenger } from '../TransactionController';\nimport type { Layer1GasFeeFlowRequest, TransactionMeta } from '../types';\nimport { toBN } from '../utils/utils';\nimport { OracleLayer1GasFeeFlow } from './OracleLayer1GasFeeFlow';\n\nconst MANTLE_CHAIN_IDS: Hex[] = [CHAIN_IDS.MANTLE, CHAIN_IDS.MANTLE_SEPOLIA];\n\nconst TOKEN_RATIO_ABI = [\n  {\n    inputs: [],\n    name: 'tokenRatio',\n    outputs: [\n      {\n        internalType: 'uint256',\n        name: '',\n        type: 'uint256',\n      },\n    ],\n    stateMutability: 'view',\n    type: 'function',\n  },\n];\n\n/**\n * Mantle layer 1 gas fee flow.\n *\n * Mantle uses MNT as its native gas token, but the oracle's getL1Fee returns\n * values denominated in ETH. This subclass multiplies the L1 fee by the\n * tokenRatio (ETH/MNT exchange rate) from the oracle contract to convert\n * the fee to MNT.\n */\nexport class MantleLayer1GasFeeFlow extends OracleLayer1GasFeeFlow {\n  async matchesTransaction({\n    transactionMeta,\n  }: {\n    transactionMeta: TransactionMeta;\n    messenger: TransactionControllerMessenger;\n  }): Promise<boolean> {\n    return MANTLE_CHAIN_IDS.includes(transactionMeta.chainId);\n  }\n\n  protected override getOperatorFeeGas(\n    transactionMeta: TransactionMeta,\n  ): string | undefined {\n    return (\n      transactionMeta.gasUsed ??\n      transactionMeta.txParams.gas ??\n      transactionMeta.txParams.gasLimit\n    );\n  }\n\n  protected override async transformOracleFee(\n    oracleFee: BN,\n    request: Layer1GasFeeFlowRequest,\n  ): Promise<BN> {\n    const { provider, transactionMeta } = request;\n    const oracleAddress = this.getOracleAddressForChain(\n      transactionMeta.chainId,\n    );\n\n    const contract = new Contract(\n      oracleAddress,\n      TOKEN_RATIO_ABI,\n      new Web3Provider(provider as unknown as ExternalProvider),\n    );\n\n    const tokenRatio = toBN(await contract.tokenRatio());\n    return oracleFee.mul(tokenRatio);\n  }\n}\n"]}

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

@@ -15,6 +15,7 @@ export declare class MantleLayer1GasFeeFlow extends OracleLayer1GasFeeFlow {
         transactionMeta: TransactionMeta;
         messenger: TransactionControllerMessenger;
     }): Promise<boolean>;
+    protected getOperatorFeeGas(transactionMeta: TransactionMeta): string | undefined;
     protected transformOracleFee(oracleFee: BN, request: Layer1GasFeeFlowRequest): Promise<BN>;
 }
 //# sourceMappingURL=MantleLayer1GasFeeFlow.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"MantleLayer1GasFeeFlow.d.cts","sourceRoot":"","sources":["../../src/gas-flows/MantleLayer1GasFeeFlow.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc;AAG5B,OAAO,KAAK,EAAE,8BAA8B,EAAE,qCAAiC;AAC/E,OAAO,KAAK,EAAE,uBAAuB,EAAE,eAAe,EAAE,qBAAiB;AAEzE,OAAO,EAAE,sBAAsB,EAAE,qCAAiC;AAoBlE;;;;;;;GAOG;AACH,qBAAa,sBAAuB,SAAQ,sBAAsB;IAC1D,kBAAkB,CAAC,EACvB,eAAe,GAChB,EAAE;QACD,eAAe,EAAE,eAAe,CAAC;QACjC,SAAS,EAAE,8BAA8B,CAAC;KAC3C,GAAG,OAAO,CAAC,OAAO,CAAC;cAIK,kBAAkB,CACzC,SAAS,EAAE,EAAE,EACb,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,EAAE,CAAC;CAef"}
+{"version":3,"file":"MantleLayer1GasFeeFlow.d.cts","sourceRoot":"","sources":["../../src/gas-flows/MantleLayer1GasFeeFlow.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc;AAG5B,OAAO,KAAK,EAAE,8BAA8B,EAAE,qCAAiC;AAC/E,OAAO,KAAK,EAAE,uBAAuB,EAAE,eAAe,EAAE,qBAAiB;AAEzE,OAAO,EAAE,sBAAsB,EAAE,qCAAiC;AAoBlE;;;;;;;GAOG;AACH,qBAAa,sBAAuB,SAAQ,sBAAsB;IAC1D,kBAAkB,CAAC,EACvB,eAAe,GAChB,EAAE;QACD,eAAe,EAAE,eAAe,CAAC;QACjC,SAAS,EAAE,8BAA8B,CAAC;KAC3C,GAAG,OAAO,CAAC,OAAO,CAAC;cAID,iBAAiB,CAClC,eAAe,EAAE,eAAe,GAC/B,MAAM,GAAG,SAAS;cAQI,kBAAkB,CACzC,SAAS,EAAE,EAAE,EACb,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,EAAE,CAAC;CAef"}

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

@@ -15,6 +15,7 @@ export declare class MantleLayer1GasFeeFlow extends OracleLayer1GasFeeFlow {
         transactionMeta: TransactionMeta;
         messenger: TransactionControllerMessenger;
     }): Promise<boolean>;
+    protected getOperatorFeeGas(transactionMeta: TransactionMeta): string | undefined;
     protected transformOracleFee(oracleFee: BN, request: Layer1GasFeeFlowRequest): Promise<BN>;
 }
 //# sourceMappingURL=MantleLayer1GasFeeFlow.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"MantleLayer1GasFeeFlow.d.mts","sourceRoot":"","sources":["../../src/gas-flows/MantleLayer1GasFeeFlow.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc;AAG5B,OAAO,KAAK,EAAE,8BAA8B,EAAE,qCAAiC;AAC/E,OAAO,KAAK,EAAE,uBAAuB,EAAE,eAAe,EAAE,qBAAiB;AAEzE,OAAO,EAAE,sBAAsB,EAAE,qCAAiC;AAoBlE;;;;;;;GAOG;AACH,qBAAa,sBAAuB,SAAQ,sBAAsB;IAC1D,kBAAkB,CAAC,EACvB,eAAe,GAChB,EAAE;QACD,eAAe,EAAE,eAAe,CAAC;QACjC,SAAS,EAAE,8BAA8B,CAAC;KAC3C,GAAG,OAAO,CAAC,OAAO,CAAC;cAIK,kBAAkB,CACzC,SAAS,EAAE,EAAE,EACb,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,EAAE,CAAC;CAef"}
+{"version":3,"file":"MantleLayer1GasFeeFlow.d.mts","sourceRoot":"","sources":["../../src/gas-flows/MantleLayer1GasFeeFlow.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc;AAG5B,OAAO,KAAK,EAAE,8BAA8B,EAAE,qCAAiC;AAC/E,OAAO,KAAK,EAAE,uBAAuB,EAAE,eAAe,EAAE,qBAAiB;AAEzE,OAAO,EAAE,sBAAsB,EAAE,qCAAiC;AAoBlE;;;;;;;GAOG;AACH,qBAAa,sBAAuB,SAAQ,sBAAsB;IAC1D,kBAAkB,CAAC,EACvB,eAAe,GAChB,EAAE;QACD,eAAe,EAAE,eAAe,CAAC;QACjC,SAAS,EAAE,8BAA8B,CAAC;KAC3C,GAAG,OAAO,CAAC,OAAO,CAAC;cAID,iBAAiB,CAClC,eAAe,EAAE,eAAe,GAC/B,MAAM,GAAG,SAAS;cAQI,kBAAkB,CACzC,SAAS,EAAE,EAAE,EACb,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,EAAE,CAAC;CAef"}

package/dist/gas-flows/MantleLayer1GasFeeFlow.mjs

@@ -31,6 +31,11 @@ export class MantleLayer1GasFeeFlow extends OracleLayer1GasFeeFlow {
     async matchesTransaction({ transactionMeta, }) {
         return MANTLE_CHAIN_IDS.includes(transactionMeta.chainId);
     }
+    getOperatorFeeGas(transactionMeta) {
+        return (transactionMeta.gasUsed ??
+            transactionMeta.txParams.gas ??
+            transactionMeta.txParams.gasLimit);
+    }
     async transformOracleFee(oracleFee, request) {
         const { provider, transactionMeta } = request;
         const oracleAddress = this.getOracleAddressForChain(transactionMeta.chainId);

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

@@ -1 +1 @@
-{"version":3,"file":"MantleLayer1GasFeeFlow.mjs","sourceRoot":"","sources":["../../src/gas-flows/MantleLayer1GasFeeFlow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,iCAAiC;AACpD,OAAO,EAAE,YAAY,EAAE,iCAAiC;AAKxD,OAAO,EAAE,SAAS,EAAE,yBAAqB;AAGzC,OAAO,EAAE,IAAI,EAAE,2BAAuB;AACtC,OAAO,EAAE,sBAAsB,EAAE,qCAAiC;AAElE,MAAM,gBAAgB,GAAU,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC;AAE7E,MAAM,eAAe,GAAG;IACtB;QACE,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;QAClB,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;;;;;;;GAOG;AACH,MAAM,OAAO,sBAAuB,SAAQ,sBAAsB;IAChE,KAAK,CAAC,kBAAkB,CAAC,EACvB,eAAe,GAIhB;QACC,OAAO,gBAAgB,CAAC,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAC5D,CAAC;IAEkB,KAAK,CAAC,kBAAkB,CACzC,SAAa,EACb,OAAgC;QAEhC,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;QAC9C,MAAM,aAAa,GAAG,IAAI,CAAC,wBAAwB,CACjD,eAAe,CAAC,OAAO,CACxB,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAC3B,aAAa,EACb,eAAe,EACf,IAAI,YAAY,CAAC,QAAuC,CAAC,CAC1D,CAAC;QAEF,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QACrD,OAAO,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACnC,CAAC;CACF","sourcesContent":["import { Contract } from '@ethersproject/contracts';\nimport { Web3Provider } from '@ethersproject/providers';\nimport type { ExternalProvider } from '@ethersproject/providers';\nimport type { Hex } from '@metamask/utils';\nimport type BN from 'bn.js';\n\nimport { CHAIN_IDS } from '../constants';\nimport type { TransactionControllerMessenger } from '../TransactionController';\nimport type { Layer1GasFeeFlowRequest, TransactionMeta } from '../types';\nimport { toBN } from '../utils/utils';\nimport { OracleLayer1GasFeeFlow } from './OracleLayer1GasFeeFlow';\n\nconst MANTLE_CHAIN_IDS: Hex[] = [CHAIN_IDS.MANTLE, CHAIN_IDS.MANTLE_SEPOLIA];\n\nconst TOKEN_RATIO_ABI = [\n  {\n    inputs: [],\n    name: 'tokenRatio',\n    outputs: [\n      {\n        internalType: 'uint256',\n        name: '',\n        type: 'uint256',\n      },\n    ],\n    stateMutability: 'view',\n    type: 'function',\n  },\n];\n\n/**\n * Mantle layer 1 gas fee flow.\n *\n * Mantle uses MNT as its native gas token, but the oracle's getL1Fee returns\n * values denominated in ETH. This subclass multiplies the L1 fee by the\n * tokenRatio (ETH/MNT exchange rate) from the oracle contract to convert\n * the fee to MNT.\n */\nexport class MantleLayer1GasFeeFlow extends OracleLayer1GasFeeFlow {\n  async matchesTransaction({\n    transactionMeta,\n  }: {\n    transactionMeta: TransactionMeta;\n    messenger: TransactionControllerMessenger;\n  }): Promise<boolean> {\n    return MANTLE_CHAIN_IDS.includes(transactionMeta.chainId);\n  }\n\n  protected override async transformOracleFee(\n    oracleFee: BN,\n    request: Layer1GasFeeFlowRequest,\n  ): Promise<BN> {\n    const { provider, transactionMeta } = request;\n    const oracleAddress = this.getOracleAddressForChain(\n      transactionMeta.chainId,\n    );\n\n    const contract = new Contract(\n      oracleAddress,\n      TOKEN_RATIO_ABI,\n      new Web3Provider(provider as unknown as ExternalProvider),\n    );\n\n    const tokenRatio = toBN(await contract.tokenRatio());\n    return oracleFee.mul(tokenRatio);\n  }\n}\n"]}
+{"version":3,"file":"MantleLayer1GasFeeFlow.mjs","sourceRoot":"","sources":["../../src/gas-flows/MantleLayer1GasFeeFlow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,iCAAiC;AACpD,OAAO,EAAE,YAAY,EAAE,iCAAiC;AAKxD,OAAO,EAAE,SAAS,EAAE,yBAAqB;AAGzC,OAAO,EAAE,IAAI,EAAE,2BAAuB;AACtC,OAAO,EAAE,sBAAsB,EAAE,qCAAiC;AAElE,MAAM,gBAAgB,GAAU,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC;AAE7E,MAAM,eAAe,GAAG;IACtB;QACE,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;QAClB,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;;;;;;;GAOG;AACH,MAAM,OAAO,sBAAuB,SAAQ,sBAAsB;IAChE,KAAK,CAAC,kBAAkB,CAAC,EACvB,eAAe,GAIhB;QACC,OAAO,gBAAgB,CAAC,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAC5D,CAAC;IAEkB,iBAAiB,CAClC,eAAgC;QAEhC,OAAO,CACL,eAAe,CAAC,OAAO;YACvB,eAAe,CAAC,QAAQ,CAAC,GAAG;YAC5B,eAAe,CAAC,QAAQ,CAAC,QAAQ,CAClC,CAAC;IACJ,CAAC;IAEkB,KAAK,CAAC,kBAAkB,CACzC,SAAa,EACb,OAAgC;QAEhC,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;QAC9C,MAAM,aAAa,GAAG,IAAI,CAAC,wBAAwB,CACjD,eAAe,CAAC,OAAO,CACxB,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAC3B,aAAa,EACb,eAAe,EACf,IAAI,YAAY,CAAC,QAAuC,CAAC,CAC1D,CAAC;QAEF,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QACrD,OAAO,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACnC,CAAC;CACF","sourcesContent":["import { Contract } from '@ethersproject/contracts';\nimport { Web3Provider } from '@ethersproject/providers';\nimport type { ExternalProvider } from '@ethersproject/providers';\nimport type { Hex } from '@metamask/utils';\nimport type BN from 'bn.js';\n\nimport { CHAIN_IDS } from '../constants';\nimport type { TransactionControllerMessenger } from '../TransactionController';\nimport type { Layer1GasFeeFlowRequest, TransactionMeta } from '../types';\nimport { toBN } from '../utils/utils';\nimport { OracleLayer1GasFeeFlow } from './OracleLayer1GasFeeFlow';\n\nconst MANTLE_CHAIN_IDS: Hex[] = [CHAIN_IDS.MANTLE, CHAIN_IDS.MANTLE_SEPOLIA];\n\nconst TOKEN_RATIO_ABI = [\n  {\n    inputs: [],\n    name: 'tokenRatio',\n    outputs: [\n      {\n        internalType: 'uint256',\n        name: '',\n        type: 'uint256',\n      },\n    ],\n    stateMutability: 'view',\n    type: 'function',\n  },\n];\n\n/**\n * Mantle layer 1 gas fee flow.\n *\n * Mantle uses MNT as its native gas token, but the oracle's getL1Fee returns\n * values denominated in ETH. This subclass multiplies the L1 fee by the\n * tokenRatio (ETH/MNT exchange rate) from the oracle contract to convert\n * the fee to MNT.\n */\nexport class MantleLayer1GasFeeFlow extends OracleLayer1GasFeeFlow {\n  async matchesTransaction({\n    transactionMeta,\n  }: {\n    transactionMeta: TransactionMeta;\n    messenger: TransactionControllerMessenger;\n  }): Promise<boolean> {\n    return MANTLE_CHAIN_IDS.includes(transactionMeta.chainId);\n  }\n\n  protected override getOperatorFeeGas(\n    transactionMeta: TransactionMeta,\n  ): string | undefined {\n    return (\n      transactionMeta.gasUsed ??\n      transactionMeta.txParams.gas ??\n      transactionMeta.txParams.gasLimit\n    );\n  }\n\n  protected override async transformOracleFee(\n    oracleFee: BN,\n    request: Layer1GasFeeFlowRequest,\n  ): Promise<BN> {\n    const { provider, transactionMeta } = request;\n    const oracleAddress = this.getOracleAddressForChain(\n      transactionMeta.chainId,\n    );\n\n    const contract = new Contract(\n      oracleAddress,\n      TOKEN_RATIO_ABI,\n      new Web3Provider(provider as unknown as ExternalProvider),\n    );\n\n    const tokenRatio = toBN(await contract.tokenRatio());\n    return oracleFee.mul(tokenRatio);\n  }\n}\n"]}

package/dist/gas-flows/OracleLayer1GasFeeFlow.cjs

@@ -123,6 +123,18 @@ class OracleLayer1GasFeeFlow {
             throw new Error(`Failed to get oracle layer 1 gas fee`);
         }
     }
+    /**
+     * Returns the gas value to pass to the operator-fee oracle, or undefined
+     * to skip the operator-fee call entirely. Defaults to the simulated
+     * `gasUsed` on the transaction. Subclasses can override to supply a
+     * fallback (e.g. estimated gas limit) when `gasUsed` is unavailable.
+     *
+     * @param transactionMeta - The transaction metadata.
+     * @returns The gas value, or undefined to skip the operator-fee call.
+     */
+    getOperatorFeeGas(transactionMeta) {
+        return transactionMeta.gasUsed;
+    }
 }
 exports.OracleLayer1GasFeeFlow = OracleLayer1GasFeeFlow;
 _OracleLayer1GasFeeFlow_instances = new WeakSet(), _OracleLayer1GasFeeFlow_getOracleLayer1GasFee = async function _OracleLayer1GasFeeFlow_getOracleLayer1GasFee(contract, transactionMeta) {
@@ -133,12 +145,12 @@ _OracleLayer1GasFeeFlow_instances = new WeakSet(), _OracleLayer1GasFeeFlow_getOr
     }
     return (0, utils_2.toBN)(result);
 }, _OracleLayer1GasFeeFlow_getOperatorLayer1GasFee = async function _OracleLayer1GasFeeFlow_getOperatorLayer1GasFee(contract, transactionMeta) {
-    const { gasUsed } = transactionMeta;
-    if (!gasUsed) {
+    const gas = this.getOperatorFeeGas(transactionMeta);
+    if (!gas) {
         return ZERO;
     }
     try {
-        const result = await contract.getOperatorFee(gasUsed);
+        const result = await contract.getOperatorFee(gas);
         if (result === undefined) {
             return ZERO;
         }

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,wDAAwD;AAGxD,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;;IAqKA,CAAC;IApKC;;;;;;;OAOG;IACO,wBAAwB,CAAC,QAAa;QAC9C,OAAO,gCAAgC,CAAC;IAC1C,CAAC;IAED;;;;;;;;OAQG;IACO,qBAAqB;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IAUD;;;;;;;;;;OAUG;IACO,KAAK,CAAC,kBAAkB,CAChC,SAAa,EACb,QAAiC;QAEjC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,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,cAAc,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YACzE,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,cAAc,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CACjE;aACF,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;CAmFF;AArKD,wDAqKC;mGAjFC,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,iDAAiD;QACjD,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 } from '@ethersproject/providers';\nimport 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  /**\n   * Transforms the raw oracle L1 fee before it is combined with the operator\n   * fee. Subclasses can override this to apply chain-specific conversions\n   * (e.g. currency conversion via an on-chain exchange rate).\n   *\n   * Defaults to returning the fee unchanged.\n   *\n   * @param oracleFee - The raw L1 fee returned by the oracle contract.\n   * @param _request - The original fee flow request (provider + transaction).\n   * @returns The transformed fee.\n   */\n  protected async transformOracleFee(\n    oracleFee: BN,\n    _request: Layer1GasFeeFlowRequest,\n  ): Promise<BN> {\n    return oracleFee;\n  }\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 transformedFee = await this.transformOracleFee(oracleFee, request);\n      const operatorFee = await this.#getOperatorLayer1GasFee(\n        contract,\n        transactionMeta,\n      );\n\n      return {\n        layer1Fee: add0x(\n          padHexToEvenLength(transformedFee.add(operatorFee).toString(16)),\n        ),\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  ): ReturnType<typeof prepareTransaction> {\n    const txParams = this.#buildTransactionParams(transactionMeta);\n    const { chainId } = transactionMeta;\n\n    let unserializedTransaction = prepareTransaction(chainId, txParams);\n\n    if (sign) {\n      // eslint-disable-next-line no-restricted-globals\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  ): Contract {\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"]}
+{"version":3,"file":"OracleLayer1GasFeeFlow.cjs","sourceRoot":"","sources":["../../src/gas-flows/OracleLayer1GasFeeFlow.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wDAAoD;AACpD,wDAAwD;AAGxD,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;;IAoLA,CAAC;IAnLC;;;;;;;OAOG;IACO,wBAAwB,CAAC,QAAa;QAC9C,OAAO,gCAAgC,CAAC;IAC1C,CAAC;IAED;;;;;;;;OAQG;IACO,qBAAqB;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IAUD;;;;;;;;;;OAUG;IACO,KAAK,CAAC,kBAAkB,CAChC,SAAa,EACb,QAAiC;QAEjC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,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,cAAc,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YACzE,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,cAAc,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CACjE;aACF,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;IAoBD;;;;;;;;OAQG;IACO,iBAAiB,CACzB,eAAgC;QAEhC,OAAO,eAAe,CAAC,OAAO,CAAC;IACjC,CAAC;CAiEF;AApLD,wDAoLC;mGAhGC,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,oDAiBD,KAAK,0DACH,QAAkB,EAClB,eAAgC;IAEhC,MAAM,GAAG,GAAG,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;IAEpD,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QAElD,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,iDAAiD;QACjD,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 } from '@ethersproject/providers';\nimport 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  /**\n   * Transforms the raw oracle L1 fee before it is combined with the operator\n   * fee. Subclasses can override this to apply chain-specific conversions\n   * (e.g. currency conversion via an on-chain exchange rate).\n   *\n   * Defaults to returning the fee unchanged.\n   *\n   * @param oracleFee - The raw L1 fee returned by the oracle contract.\n   * @param _request - The original fee flow request (provider + transaction).\n   * @returns The transformed fee.\n   */\n  protected async transformOracleFee(\n    oracleFee: BN,\n    _request: Layer1GasFeeFlowRequest,\n  ): Promise<BN> {\n    return oracleFee;\n  }\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 transformedFee = await this.transformOracleFee(oracleFee, request);\n      const operatorFee = await this.#getOperatorLayer1GasFee(\n        contract,\n        transactionMeta,\n      );\n\n      return {\n        layer1Fee: add0x(\n          padHexToEvenLength(transformedFee.add(operatorFee).toString(16)),\n        ),\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  /**\n   * Returns the gas value to pass to the operator-fee oracle, or undefined\n   * to skip the operator-fee call entirely. Defaults to the simulated\n   * `gasUsed` on the transaction. Subclasses can override to supply a\n   * fallback (e.g. estimated gas limit) when `gasUsed` is unavailable.\n   *\n   * @param transactionMeta - The transaction metadata.\n   * @returns The gas value, or undefined to skip the operator-fee call.\n   */\n  protected getOperatorFeeGas(\n    transactionMeta: TransactionMeta,\n  ): string | undefined {\n    return transactionMeta.gasUsed;\n  }\n\n  async #getOperatorLayer1GasFee(\n    contract: Contract,\n    transactionMeta: TransactionMeta,\n  ): Promise<BN> {\n    const gas = this.getOperatorFeeGas(transactionMeta);\n\n    if (!gas) {\n      return ZERO;\n    }\n\n    try {\n      const result = await contract.getOperatorFee(gas);\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  ): ReturnType<typeof prepareTransaction> {\n    const txParams = this.#buildTransactionParams(transactionMeta);\n    const { chainId } = transactionMeta;\n\n    let unserializedTransaction = prepareTransaction(chainId, txParams);\n\n    if (sign) {\n      // eslint-disable-next-line no-restricted-globals\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  ): Contract {\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

@@ -43,5 +43,15 @@ export declare abstract class OracleLayer1GasFeeFlow implements Layer1GasFeeFlow
      */
     protected transformOracleFee(oracleFee: BN, _request: Layer1GasFeeFlowRequest): Promise<BN>;
     getLayer1Fee(request: Layer1GasFeeFlowRequest): Promise<Layer1GasFeeFlowResponse>;
+    /**
+     * Returns the gas value to pass to the operator-fee oracle, or undefined
+     * to skip the operator-fee call entirely. Defaults to the simulated
+     * `gasUsed` on the transaction. Subclasses can override to supply a
+     * fallback (e.g. estimated gas limit) when `gasUsed` is unavailable.
+     *
+     * @param transactionMeta - The transaction metadata.
+     * @returns The gas value, or undefined to skip the operator-fee call.
+     */
+    protected getOperatorFeeGas(transactionMeta: TransactionMeta): string | undefined;
 }
 //# 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":"AAGA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C,OAAO,EAAE,cAAc;AAGvB,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;IAEpB;;;;;;;;;;OAUG;cACa,kBAAkB,CAChC,SAAS,EAAE,EAAE,EACb,QAAQ,EAAE,uBAAuB,GAChC,OAAO,CAAC,EAAE,CAAC;IAIR,YAAY,CAChB,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;CA+GrC"}
+{"version":3,"file":"OracleLayer1GasFeeFlow.d.cts","sourceRoot":"","sources":["../../src/gas-flows/OracleLayer1GasFeeFlow.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C,OAAO,EAAE,cAAc;AAGvB,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;IAEpB;;;;;;;;;;OAUG;cACa,kBAAkB,CAChC,SAAS,EAAE,EAAE,EACb,QAAQ,EAAE,uBAAuB,GAChC,OAAO,CAAC,EAAE,CAAC;IAIR,YAAY,CAChB,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;IAgDpC;;;;;;;;OAQG;IACH,SAAS,CAAC,iBAAiB,CACzB,eAAe,EAAE,eAAe,GAC/B,MAAM,GAAG,SAAS;CAmEtB"}

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

@@ -43,5 +43,15 @@ export declare abstract class OracleLayer1GasFeeFlow implements Layer1GasFeeFlow
      */
     protected transformOracleFee(oracleFee: BN, _request: Layer1GasFeeFlowRequest): Promise<BN>;
     getLayer1Fee(request: Layer1GasFeeFlowRequest): Promise<Layer1GasFeeFlowResponse>;
+    /**
+     * Returns the gas value to pass to the operator-fee oracle, or undefined
+     * to skip the operator-fee call entirely. Defaults to the simulated
+     * `gasUsed` on the transaction. Subclasses can override to supply a
+     * fallback (e.g. estimated gas limit) when `gasUsed` is unavailable.
+     *
+     * @param transactionMeta - The transaction metadata.
+     * @returns The gas value, or undefined to skip the operator-fee call.
+     */
+    protected getOperatorFeeGas(transactionMeta: TransactionMeta): string | undefined;
 }
 //# 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":"AAGA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C,OAAO,EAAE,cAAc;AAGvB,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;IAEpB;;;;;;;;;;OAUG;cACa,kBAAkB,CAChC,SAAS,EAAE,EAAE,EACb,QAAQ,EAAE,uBAAuB,GAChC,OAAO,CAAC,EAAE,CAAC;IAIR,YAAY,CAChB,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;CA+GrC"}
+{"version":3,"file":"OracleLayer1GasFeeFlow.d.mts","sourceRoot":"","sources":["../../src/gas-flows/OracleLayer1GasFeeFlow.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C,OAAO,EAAE,cAAc;AAGvB,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;IAEpB;;;;;;;;;;OAUG;cACa,kBAAkB,CAChC,SAAS,EAAE,EAAE,EACb,QAAQ,EAAE,uBAAuB,GAChC,OAAO,CAAC,EAAE,CAAC;IAIR,YAAY,CAChB,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;IAgDpC;;;;;;;;OAQG;IACH,SAAS,CAAC,iBAAiB,CACzB,eAAe,EAAE,eAAe,GAC/B,MAAM,GAAG,SAAS;CAmEtB"}

package/dist/gas-flows/OracleLayer1GasFeeFlow.mjs

@@ -124,6 +124,18 @@ export class OracleLayer1GasFeeFlow {
             throw new Error(`Failed to get oracle layer 1 gas fee`);
         }
     }
+    /**
+     * Returns the gas value to pass to the operator-fee oracle, or undefined
+     * to skip the operator-fee call entirely. Defaults to the simulated
+     * `gasUsed` on the transaction. Subclasses can override to supply a
+     * fallback (e.g. estimated gas limit) when `gasUsed` is unavailable.
+     *
+     * @param transactionMeta - The transaction metadata.
+     * @returns The gas value, or undefined to skip the operator-fee call.
+     */
+    getOperatorFeeGas(transactionMeta) {
+        return transactionMeta.gasUsed;
+    }
 }
 _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();
@@ -133,12 +145,12 @@ _OracleLayer1GasFeeFlow_instances = new WeakSet(), _OracleLayer1GasFeeFlow_getOr
     }
     return toBN(result);
 }, _OracleLayer1GasFeeFlow_getOperatorLayer1GasFee = async function _OracleLayer1GasFeeFlow_getOperatorLayer1GasFee(contract, transactionMeta) {
-    const { gasUsed } = transactionMeta;
-    if (!gasUsed) {
+    const gas = this.getOperatorFeeGas(transactionMeta);
+    if (!gas) {
         return ZERO;
     }
     try {
-        const result = await contract.getOperatorFee(gasUsed);
+        const result = await contract.getOperatorFee(gas);
         if (result === undefined) {
             return ZERO;
         }

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,EAAE,iCAAiC;AAGxD,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;;IAqKA,CAAC;IApKC;;;;;;;OAOG;IACO,wBAAwB,CAAC,QAAa;QAC9C,OAAO,gCAAgC,CAAC;IAC1C,CAAC;IAED;;;;;;;;OAQG;IACO,qBAAqB;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IAUD;;;;;;;;;;OAUG;IACO,KAAK,CAAC,kBAAkB,CAChC,SAAa,EACb,QAAiC;QAEjC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,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,cAAc,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YACzE,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,0FAAyB,MAA7B,IAAI,EAC5B,QAAQ,EACR,eAAe,CAChB,CAAC;YAEF,OAAO;gBACL,SAAS,EAAE,KAAK,CACd,kBAAkB,CAAC,cAAc,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CACjE;aACF,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;CAmFF;mGAjFC,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,iDAAiD;QACjD,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 } from '@ethersproject/providers';\nimport 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  /**\n   * Transforms the raw oracle L1 fee before it is combined with the operator\n   * fee. Subclasses can override this to apply chain-specific conversions\n   * (e.g. currency conversion via an on-chain exchange rate).\n   *\n   * Defaults to returning the fee unchanged.\n   *\n   * @param oracleFee - The raw L1 fee returned by the oracle contract.\n   * @param _request - The original fee flow request (provider + transaction).\n   * @returns The transformed fee.\n   */\n  protected async transformOracleFee(\n    oracleFee: BN,\n    _request: Layer1GasFeeFlowRequest,\n  ): Promise<BN> {\n    return oracleFee;\n  }\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 transformedFee = await this.transformOracleFee(oracleFee, request);\n      const operatorFee = await this.#getOperatorLayer1GasFee(\n        contract,\n        transactionMeta,\n      );\n\n      return {\n        layer1Fee: add0x(\n          padHexToEvenLength(transformedFee.add(operatorFee).toString(16)),\n        ),\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  ): ReturnType<typeof prepareTransaction> {\n    const txParams = this.#buildTransactionParams(transactionMeta);\n    const { chainId } = transactionMeta;\n\n    let unserializedTransaction = prepareTransaction(chainId, txParams);\n\n    if (sign) {\n      // eslint-disable-next-line no-restricted-globals\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  ): Contract {\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"]}
+{"version":3,"file":"OracleLayer1GasFeeFlow.mjs","sourceRoot":"","sources":["../../src/gas-flows/OracleLayer1GasFeeFlow.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,iCAAiC;AACpD,OAAO,EAAE,YAAY,EAAE,iCAAiC;AAGxD,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;;IAoLA,CAAC;IAnLC;;;;;;;OAOG;IACO,wBAAwB,CAAC,QAAa;QAC9C,OAAO,gCAAgC,CAAC;IAC1C,CAAC;IAED;;;;;;;;OAQG;IACO,qBAAqB;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IAUD;;;;;;;;;;OAUG;IACO,KAAK,CAAC,kBAAkB,CAChC,SAAa,EACb,QAAiC;QAEjC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,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,cAAc,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YACzE,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,0FAAyB,MAA7B,IAAI,EAC5B,QAAQ,EACR,eAAe,CAChB,CAAC;YAEF,OAAO;gBACL,SAAS,EAAE,KAAK,CACd,kBAAkB,CAAC,cAAc,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CACjE;aACF,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;IAoBD;;;;;;;;OAQG;IACO,iBAAiB,CACzB,eAAgC;QAEhC,OAAO,eAAe,CAAC,OAAO,CAAC;IACjC,CAAC;CAiEF;mGAhGC,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,oDAiBD,KAAK,0DACH,QAAkB,EAClB,eAAgC;IAEhC,MAAM,GAAG,GAAG,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;IAEpD,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QAElD,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,iDAAiD;QACjD,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 } from '@ethersproject/providers';\nimport 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  /**\n   * Transforms the raw oracle L1 fee before it is combined with the operator\n   * fee. Subclasses can override this to apply chain-specific conversions\n   * (e.g. currency conversion via an on-chain exchange rate).\n   *\n   * Defaults to returning the fee unchanged.\n   *\n   * @param oracleFee - The raw L1 fee returned by the oracle contract.\n   * @param _request - The original fee flow request (provider + transaction).\n   * @returns The transformed fee.\n   */\n  protected async transformOracleFee(\n    oracleFee: BN,\n    _request: Layer1GasFeeFlowRequest,\n  ): Promise<BN> {\n    return oracleFee;\n  }\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 transformedFee = await this.transformOracleFee(oracleFee, request);\n      const operatorFee = await this.#getOperatorLayer1GasFee(\n        contract,\n        transactionMeta,\n      );\n\n      return {\n        layer1Fee: add0x(\n          padHexToEvenLength(transformedFee.add(operatorFee).toString(16)),\n        ),\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  /**\n   * Returns the gas value to pass to the operator-fee oracle, or undefined\n   * to skip the operator-fee call entirely. Defaults to the simulated\n   * `gasUsed` on the transaction. Subclasses can override to supply a\n   * fallback (e.g. estimated gas limit) when `gasUsed` is unavailable.\n   *\n   * @param transactionMeta - The transaction metadata.\n   * @returns The gas value, or undefined to skip the operator-fee call.\n   */\n  protected getOperatorFeeGas(\n    transactionMeta: TransactionMeta,\n  ): string | undefined {\n    return transactionMeta.gasUsed;\n  }\n\n  async #getOperatorLayer1GasFee(\n    contract: Contract,\n    transactionMeta: TransactionMeta,\n  ): Promise<BN> {\n    const gas = this.getOperatorFeeGas(transactionMeta);\n\n    if (!gas) {\n      return ZERO;\n    }\n\n    try {\n      const result = await contract.getOperatorFee(gas);\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  ): ReturnType<typeof prepareTransaction> {\n    const txParams = this.#buildTransactionParams(transactionMeta);\n    const { chainId } = transactionMeta;\n\n    let unserializedTransaction = prepareTransaction(chainId, txParams);\n\n    if (sign) {\n      // eslint-disable-next-line no-restricted-globals\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  ): Contract {\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/hooks/ExtraTransactionsPublishHook.cjs

@@ -115,6 +115,7 @@ _ExtraTransactionsPublishHook_addTransactionBatch = new WeakMap(), _ExtraTransac
     };
     await __classPrivateFieldGet(this, _ExtraTransactionsPublishHook_addTransactionBatch, "f").call(this, {
         from,
+        isInternal: true,
         networkClientId,
         requireApproval: false,
         transactions,

package/dist/hooks/ExtraTransactionsPublishHook.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"ExtraTransactionsPublishHook.cjs","sourceRoot":"","sources":["../../src/hooks/ExtraTransactionsPublishHook.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAA4E;AAI5E,0CAA0C;AAS1C,MAAM,GAAG,GAAG,IAAA,0BAAkB,EAC5B,sBAAa,EACb,iCAAiC,CAClC,CAAC;AAEF;;;GAGG;AACH,MAAa,4BAA4B;IAOvC,YAAY,EACV,mBAAmB,EACnB,cAAc,EACd,mBAAmB,GAKpB;;QAdQ,oEAAmE;QAEnE,+DAA4D;QAE5D,oEAAkC;QAWzC,uBAAA,IAAI,qDAAwB,mBAAmB,MAAA,CAAC;QAChD,uBAAA,IAAI,gDAAmB,cAAc,MAAA,CAAC;QACtC,uBAAA,IAAI,qDAAwB,mBAAmB,MAAA,CAAC;IAClD,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,uBAAA,IAAI,mFAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;CA8HF;AAxJD,oEAwJC;kSA5HC,KAAK,6CACH,eAAgC,EAChC,QAAgB;IAEhB,GAAG,CAAC,iCAAiC,EAAE,EAAE,eAAe,EAAE,QAAQ,EAAE,CAAC,CAAC;IAEtE,MAAM,EACJ,iBAAiB,EACjB,wBAAwB,EACxB,EAAE,EAAE,aAAa,EACjB,eAAe,EACf,QAAQ,GACT,GAAG,eAAe,CAAC;IAEpB,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAW,CAAC;IAClC,MAAM,EAAE,GAAG,QAAQ,CAAC,EAAqB,CAAC;IAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAuB,CAAC;IAC9C,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAwB,CAAC;IAChD,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAsB,CAAC;IAC5C,MAAM,YAAY,GAAG,QAAQ,CAAC,YAA+B,CAAC;IAE9D,MAAM,oBAAoB,GAAG,QAAQ,CAAC,oBAEzB,CAAC;IAEd,MAAM,iBAAiB,GAAG,QAAe,CAAC;IAC1C,MAAM,aAAa,GAAG,IAAA,6BAAqB,GAAqB,CAAC;IAEjE,MAAM,SAAS,GAAG,CAAC,EACjB,YAAY,EACZ,eAAe,GAIhB,EAAQ,EAAE;QACT,IAAI,YAAY,EAAE,CAAC;YACjB,MAAM,qBAAqB,GAAG,uBAAA,IAAI,oDAAgB,MAApB,IAAI,EAAiB,aAAa,CAAC,CAAC;YAElE,GAAG,CAAC,kDAAkD,EAAE;gBACtD,qBAAqB;gBACrB,YAAY;aACb,CAAC,CAAC;YAEH,uBAAA,IAAI,yDAAqB,MAAzB,IAAI,EAAsB,qBAAqB,EAAE,YAAY,CAAC;iBAC3D,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;iBAC3B,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;YAE/B,OAAO;QACT,CAAC;QAED,aAAa,CAAC,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC,CAAC;IAC7C,CAAC,CAAC;IAEF,MAAM,WAAW,GAA2B;QAC1C,IAAI;QACJ,GAAG;QACH,YAAY;QACZ,oBAAoB;QACpB,EAAE;QACF,KAAK;KACN,CAAC;IAEF,MAAM,eAAe,GAAkC;QACrD,mBAAmB,EAAE;YACnB,EAAE,EAAE,aAAa;YACjB,SAAS;YACT,iBAAiB;SAClB;QACD,MAAM,EAAE,WAAW;KACpB,CAAC;IAEF,MAAM,iBAAiB,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE;QACtE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,WAAW,CAAC;QAC/C,OAAO;YACL,OAAO;YACP,MAAM,EAAE,IAAI;YACZ,IAAI;SACL,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,MAAM,kBAAkB,GACtB,iBAAiB;SACd,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,KAAK,KAAK,CAAC;SACtD,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QAC9B,GAAG,IAAI;KACR,CAAC,CAAC,CAAC;IAER,MAAM,iBAAiB,GAAoC,iBAAiB;SACzE,MAAM,CACL,CAAC,WAAW,EAAE,EAAE,CACd,WAAW,CAAC,OAAO,KAAK,SAAS,IAAI,WAAW,CAAC,OAAO,CAC3D;SACA,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QAC9B,GAAG,IAAI;KACR,CAAC,CAAC,CAAC;IAEN,MAAM,YAAY,GAAoC;QACpD,GAAG,kBAAkB;QACrB,eAAe;QACf,GAAG,iBAAiB;KACrB,CAAC;IAEF,GAAG,CAAC,0BAA0B,EAAE;QAC9B,IAAI;QACJ,eAAe;QACf,YAAY;KACb,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,wBAAwB,IAAI;QAC1C,WAAW,EAAE,IAAI;QACjB,WAAW,EAAE,KAAK;QAClB,iBAAiB,EAAE,IAAI;KACxB,CAAC;IAEF,MAAM,uBAAA,IAAI,yDAAqB,MAAzB,IAAI,EAAsB;QAC9B,IAAI;QACJ,eAAe;QACf,eAAe,EAAE,KAAK;QACtB,YAAY;QACZ,GAAG,OAAO;KACX,CAAC,CAAC;IAEH,OAAO,aAAa,CAAC,OAAO,CAAC;AAC/B,CAAC","sourcesContent":["import { createDeferredPromise, createModuleLogger } from '@metamask/utils';\nimport type { Hex } from '@metamask/utils';\n\nimport type { TransactionController } from '..';\nimport { projectLogger } from '../logger';\nimport type {\n  BatchTransactionParams,\n  PublishHook,\n  PublishHookResult,\n  TransactionBatchSingleRequest,\n  TransactionMeta,\n} from '../types';\n\nconst log = createModuleLogger(\n  projectLogger,\n  'extra-transactions-publish-hook',\n);\n\n/**\n * Custom publish logic that also publishes additional transactions in an batch.\n * Requires the batch to be successful to resolve.\n */\nexport class ExtraTransactionsPublishHook {\n  readonly #addTransactionBatch: TransactionController['addTransactionBatch'];\n\n  readonly #getTransaction: (transactionId: string) => TransactionMeta;\n\n  readonly #originalPublishHook: PublishHook;\n\n  constructor({\n    addTransactionBatch,\n    getTransaction,\n    originalPublishHook,\n  }: {\n    addTransactionBatch: TransactionController['addTransactionBatch'];\n    getTransaction: (transactionId: string) => TransactionMeta;\n    originalPublishHook: PublishHook;\n  }) {\n    this.#addTransactionBatch = addTransactionBatch;\n    this.#getTransaction = getTransaction;\n    this.#originalPublishHook = originalPublishHook;\n  }\n\n  /**\n   * @returns The publish hook function.\n   */\n  getHook(): PublishHook {\n    return this.#hook.bind(this);\n  }\n\n  async #hook(\n    transactionMeta: TransactionMeta,\n    signedTx: string,\n  ): Promise<PublishHookResult> {\n    log('Publishing transaction as batch', { transactionMeta, signedTx });\n\n    const {\n      batchTransactions,\n      batchTransactionsOptions,\n      id: transactionId,\n      networkClientId,\n      txParams,\n    } = transactionMeta;\n\n    const from = txParams.from as Hex;\n    const to = txParams.to as Hex | undefined;\n    const data = txParams.data as Hex | undefined;\n    const value = txParams.value as Hex | undefined;\n    const gas = txParams.gas as Hex | undefined;\n    const maxFeePerGas = txParams.maxFeePerGas as Hex | undefined;\n\n    const maxPriorityFeePerGas = txParams.maxPriorityFeePerGas as\n      | Hex\n      | undefined;\n\n    const signedTransaction = signedTx as Hex;\n    const resultPromise = createDeferredPromise<PublishHookResult>();\n\n    const onPublish = ({\n      newSignature,\n      transactionHash,\n    }: {\n      newSignature?: Hex;\n      transactionHash?: string;\n    }): void => {\n      if (newSignature) {\n        const latestTransactionMeta = this.#getTransaction(transactionId);\n\n        log('Calling original publish hook with new signature', {\n          latestTransactionMeta,\n          newSignature,\n        });\n\n        this.#originalPublishHook(latestTransactionMeta, newSignature)\n          .then(resultPromise.resolve)\n          .catch(resultPromise.reject);\n\n        return;\n      }\n\n      resultPromise.resolve({ transactionHash });\n    };\n\n    const firstParams: BatchTransactionParams = {\n      data,\n      gas,\n      maxFeePerGas,\n      maxPriorityFeePerGas,\n      to,\n      value,\n    };\n\n    const mainTransaction: TransactionBatchSingleRequest = {\n      existingTransaction: {\n        id: transactionId,\n        onPublish,\n        signedTransaction,\n      },\n      params: firstParams,\n    };\n\n    const extraTransactions = (batchTransactions ?? []).map((transaction) => {\n      const { isAfter, type, ...rest } = transaction;\n      return {\n        isAfter,\n        params: rest,\n        type,\n      };\n    });\n\n    const beforeTransactions: TransactionBatchSingleRequest[] =\n      extraTransactions\n        .filter((transaction) => transaction.isAfter === false)\n        .map(({ isAfter, ...rest }) => ({\n          ...rest,\n        }));\n\n    const afterTransactions: TransactionBatchSingleRequest[] = extraTransactions\n      .filter(\n        (transaction) =>\n          transaction.isAfter === undefined || transaction.isAfter,\n      )\n      .map(({ isAfter, ...rest }) => ({\n        ...rest,\n      }));\n\n    const transactions: TransactionBatchSingleRequest[] = [\n      ...beforeTransactions,\n      mainTransaction,\n      ...afterTransactions,\n    ];\n\n    log('Adding transaction batch', {\n      from,\n      networkClientId,\n      transactions,\n    });\n\n    const options = batchTransactionsOptions ?? {\n      disable7702: true,\n      disableHook: false,\n      disableSequential: true,\n    };\n\n    await this.#addTransactionBatch({\n      from,\n      networkClientId,\n      requireApproval: false,\n      transactions,\n      ...options,\n    });\n\n    return resultPromise.promise;\n  }\n}\n"]}
+{"version":3,"file":"ExtraTransactionsPublishHook.cjs","sourceRoot":"","sources":["../../src/hooks/ExtraTransactionsPublishHook.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAA4E;AAI5E,0CAA0C;AAS1C,MAAM,GAAG,GAAG,IAAA,0BAAkB,EAC5B,sBAAa,EACb,iCAAiC,CAClC,CAAC;AAEF;;;GAGG;AACH,MAAa,4BAA4B;IAOvC,YAAY,EACV,mBAAmB,EACnB,cAAc,EACd,mBAAmB,GAKpB;;QAdQ,oEAAmE;QAEnE,+DAA4D;QAE5D,oEAAkC;QAWzC,uBAAA,IAAI,qDAAwB,mBAAmB,MAAA,CAAC;QAChD,uBAAA,IAAI,gDAAmB,cAAc,MAAA,CAAC;QACtC,uBAAA,IAAI,qDAAwB,mBAAmB,MAAA,CAAC;IAClD,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,uBAAA,IAAI,mFAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;CA+HF;AAzJD,oEAyJC;kSA7HC,KAAK,6CACH,eAAgC,EAChC,QAAgB;IAEhB,GAAG,CAAC,iCAAiC,EAAE,EAAE,eAAe,EAAE,QAAQ,EAAE,CAAC,CAAC;IAEtE,MAAM,EACJ,iBAAiB,EACjB,wBAAwB,EACxB,EAAE,EAAE,aAAa,EACjB,eAAe,EACf,QAAQ,GACT,GAAG,eAAe,CAAC;IAEpB,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAW,CAAC;IAClC,MAAM,EAAE,GAAG,QAAQ,CAAC,EAAqB,CAAC;IAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAuB,CAAC;IAC9C,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAwB,CAAC;IAChD,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAsB,CAAC;IAC5C,MAAM,YAAY,GAAG,QAAQ,CAAC,YAA+B,CAAC;IAE9D,MAAM,oBAAoB,GAAG,QAAQ,CAAC,oBAEzB,CAAC;IAEd,MAAM,iBAAiB,GAAG,QAAe,CAAC;IAC1C,MAAM,aAAa,GAAG,IAAA,6BAAqB,GAAqB,CAAC;IAEjE,MAAM,SAAS,GAAG,CAAC,EACjB,YAAY,EACZ,eAAe,GAIhB,EAAQ,EAAE;QACT,IAAI,YAAY,EAAE,CAAC;YACjB,MAAM,qBAAqB,GAAG,uBAAA,IAAI,oDAAgB,MAApB,IAAI,EAAiB,aAAa,CAAC,CAAC;YAElE,GAAG,CAAC,kDAAkD,EAAE;gBACtD,qBAAqB;gBACrB,YAAY;aACb,CAAC,CAAC;YAEH,uBAAA,IAAI,yDAAqB,MAAzB,IAAI,EAAsB,qBAAqB,EAAE,YAAY,CAAC;iBAC3D,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;iBAC3B,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;YAE/B,OAAO;QACT,CAAC;QAED,aAAa,CAAC,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC,CAAC;IAC7C,CAAC,CAAC;IAEF,MAAM,WAAW,GAA2B;QAC1C,IAAI;QACJ,GAAG;QACH,YAAY;QACZ,oBAAoB;QACpB,EAAE;QACF,KAAK;KACN,CAAC;IAEF,MAAM,eAAe,GAAkC;QACrD,mBAAmB,EAAE;YACnB,EAAE,EAAE,aAAa;YACjB,SAAS;YACT,iBAAiB;SAClB;QACD,MAAM,EAAE,WAAW;KACpB,CAAC;IAEF,MAAM,iBAAiB,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE;QACtE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,WAAW,CAAC;QAC/C,OAAO;YACL,OAAO;YACP,MAAM,EAAE,IAAI;YACZ,IAAI;SACL,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,MAAM,kBAAkB,GACtB,iBAAiB;SACd,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,KAAK,KAAK,CAAC;SACtD,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QAC9B,GAAG,IAAI;KACR,CAAC,CAAC,CAAC;IAER,MAAM,iBAAiB,GAAoC,iBAAiB;SACzE,MAAM,CACL,CAAC,WAAW,EAAE,EAAE,CACd,WAAW,CAAC,OAAO,KAAK,SAAS,IAAI,WAAW,CAAC,OAAO,CAC3D;SACA,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QAC9B,GAAG,IAAI;KACR,CAAC,CAAC,CAAC;IAEN,MAAM,YAAY,GAAoC;QACpD,GAAG,kBAAkB;QACrB,eAAe;QACf,GAAG,iBAAiB;KACrB,CAAC;IAEF,GAAG,CAAC,0BAA0B,EAAE;QAC9B,IAAI;QACJ,eAAe;QACf,YAAY;KACb,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,wBAAwB,IAAI;QAC1C,WAAW,EAAE,IAAI;QACjB,WAAW,EAAE,KAAK;QAClB,iBAAiB,EAAE,IAAI;KACxB,CAAC;IAEF,MAAM,uBAAA,IAAI,yDAAqB,MAAzB,IAAI,EAAsB;QAC9B,IAAI;QACJ,UAAU,EAAE,IAAI;QAChB,eAAe;QACf,eAAe,EAAE,KAAK;QACtB,YAAY;QACZ,GAAG,OAAO;KACX,CAAC,CAAC;IAEH,OAAO,aAAa,CAAC,OAAO,CAAC;AAC/B,CAAC","sourcesContent":["import { createDeferredPromise, createModuleLogger } from '@metamask/utils';\nimport type { Hex } from '@metamask/utils';\n\nimport type { TransactionController } from '..';\nimport { projectLogger } from '../logger';\nimport type {\n  BatchTransactionParams,\n  PublishHook,\n  PublishHookResult,\n  TransactionBatchSingleRequest,\n  TransactionMeta,\n} from '../types';\n\nconst log = createModuleLogger(\n  projectLogger,\n  'extra-transactions-publish-hook',\n);\n\n/**\n * Custom publish logic that also publishes additional transactions in an batch.\n * Requires the batch to be successful to resolve.\n */\nexport class ExtraTransactionsPublishHook {\n  readonly #addTransactionBatch: TransactionController['addTransactionBatch'];\n\n  readonly #getTransaction: (transactionId: string) => TransactionMeta;\n\n  readonly #originalPublishHook: PublishHook;\n\n  constructor({\n    addTransactionBatch,\n    getTransaction,\n    originalPublishHook,\n  }: {\n    addTransactionBatch: TransactionController['addTransactionBatch'];\n    getTransaction: (transactionId: string) => TransactionMeta;\n    originalPublishHook: PublishHook;\n  }) {\n    this.#addTransactionBatch = addTransactionBatch;\n    this.#getTransaction = getTransaction;\n    this.#originalPublishHook = originalPublishHook;\n  }\n\n  /**\n   * @returns The publish hook function.\n   */\n  getHook(): PublishHook {\n    return this.#hook.bind(this);\n  }\n\n  async #hook(\n    transactionMeta: TransactionMeta,\n    signedTx: string,\n  ): Promise<PublishHookResult> {\n    log('Publishing transaction as batch', { transactionMeta, signedTx });\n\n    const {\n      batchTransactions,\n      batchTransactionsOptions,\n      id: transactionId,\n      networkClientId,\n      txParams,\n    } = transactionMeta;\n\n    const from = txParams.from as Hex;\n    const to = txParams.to as Hex | undefined;\n    const data = txParams.data as Hex | undefined;\n    const value = txParams.value as Hex | undefined;\n    const gas = txParams.gas as Hex | undefined;\n    const maxFeePerGas = txParams.maxFeePerGas as Hex | undefined;\n\n    const maxPriorityFeePerGas = txParams.maxPriorityFeePerGas as\n      | Hex\n      | undefined;\n\n    const signedTransaction = signedTx as Hex;\n    const resultPromise = createDeferredPromise<PublishHookResult>();\n\n    const onPublish = ({\n      newSignature,\n      transactionHash,\n    }: {\n      newSignature?: Hex;\n      transactionHash?: string;\n    }): void => {\n      if (newSignature) {\n        const latestTransactionMeta = this.#getTransaction(transactionId);\n\n        log('Calling original publish hook with new signature', {\n          latestTransactionMeta,\n          newSignature,\n        });\n\n        this.#originalPublishHook(latestTransactionMeta, newSignature)\n          .then(resultPromise.resolve)\n          .catch(resultPromise.reject);\n\n        return;\n      }\n\n      resultPromise.resolve({ transactionHash });\n    };\n\n    const firstParams: BatchTransactionParams = {\n      data,\n      gas,\n      maxFeePerGas,\n      maxPriorityFeePerGas,\n      to,\n      value,\n    };\n\n    const mainTransaction: TransactionBatchSingleRequest = {\n      existingTransaction: {\n        id: transactionId,\n        onPublish,\n        signedTransaction,\n      },\n      params: firstParams,\n    };\n\n    const extraTransactions = (batchTransactions ?? []).map((transaction) => {\n      const { isAfter, type, ...rest } = transaction;\n      return {\n        isAfter,\n        params: rest,\n        type,\n      };\n    });\n\n    const beforeTransactions: TransactionBatchSingleRequest[] =\n      extraTransactions\n        .filter((transaction) => transaction.isAfter === false)\n        .map(({ isAfter, ...rest }) => ({\n          ...rest,\n        }));\n\n    const afterTransactions: TransactionBatchSingleRequest[] = extraTransactions\n      .filter(\n        (transaction) =>\n          transaction.isAfter === undefined || transaction.isAfter,\n      )\n      .map(({ isAfter, ...rest }) => ({\n        ...rest,\n      }));\n\n    const transactions: TransactionBatchSingleRequest[] = [\n      ...beforeTransactions,\n      mainTransaction,\n      ...afterTransactions,\n    ];\n\n    log('Adding transaction batch', {\n      from,\n      networkClientId,\n      transactions,\n    });\n\n    const options = batchTransactionsOptions ?? {\n      disable7702: true,\n      disableHook: false,\n      disableSequential: true,\n    };\n\n    await this.#addTransactionBatch({\n      from,\n      isInternal: true,\n      networkClientId,\n      requireApproval: false,\n      transactions,\n      ...options,\n    });\n\n    return resultPromise.promise;\n  }\n}\n"]}

package/dist/hooks/ExtraTransactionsPublishHook.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"ExtraTransactionsPublishHook.d.cts","sourceRoot":"","sources":["../../src/hooks/ExtraTransactionsPublishHook.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,qBAAqB,EAAE,qBAAW;AAEhD,OAAO,KAAK,EAEV,WAAW,EAGX,eAAe,EAChB,qBAAiB;AAOlB;;;GAGG;AACH,qBAAa,4BAA4B;;gBAO3B,EACV,mBAAmB,EACnB,cAAc,EACd,mBAAmB,GACpB,EAAE;QACD,mBAAmB,EAAE,qBAAqB,CAAC,qBAAqB,CAAC,CAAC;QAClE,cAAc,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,eAAe,CAAC;QAC3D,mBAAmB,EAAE,WAAW,CAAC;KAClC;IAMD;;OAEG;IACH,OAAO,IAAI,WAAW;CAgIvB"}
+{"version":3,"file":"ExtraTransactionsPublishHook.d.cts","sourceRoot":"","sources":["../../src/hooks/ExtraTransactionsPublishHook.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,qBAAqB,EAAE,qBAAW;AAEhD,OAAO,KAAK,EAEV,WAAW,EAGX,eAAe,EAChB,qBAAiB;AAOlB;;;GAGG;AACH,qBAAa,4BAA4B;;gBAO3B,EACV,mBAAmB,EACnB,cAAc,EACd,mBAAmB,GACpB,EAAE;QACD,mBAAmB,EAAE,qBAAqB,CAAC,qBAAqB,CAAC,CAAC;QAClE,cAAc,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,eAAe,CAAC;QAC3D,mBAAmB,EAAE,WAAW,CAAC;KAClC;IAMD;;OAEG;IACH,OAAO,IAAI,WAAW;CAiIvB"}

package/dist/hooks/ExtraTransactionsPublishHook.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"ExtraTransactionsPublishHook.d.mts","sourceRoot":"","sources":["../../src/hooks/ExtraTransactionsPublishHook.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,qBAAqB,EAAE,qBAAW;AAEhD,OAAO,KAAK,EAEV,WAAW,EAGX,eAAe,EAChB,qBAAiB;AAOlB;;;GAGG;AACH,qBAAa,4BAA4B;;gBAO3B,EACV,mBAAmB,EACnB,cAAc,EACd,mBAAmB,GACpB,EAAE;QACD,mBAAmB,EAAE,qBAAqB,CAAC,qBAAqB,CAAC,CAAC;QAClE,cAAc,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,eAAe,CAAC;QAC3D,mBAAmB,EAAE,WAAW,CAAC;KAClC;IAMD;;OAEG;IACH,OAAO,IAAI,WAAW;CAgIvB"}
+{"version":3,"file":"ExtraTransactionsPublishHook.d.mts","sourceRoot":"","sources":["../../src/hooks/ExtraTransactionsPublishHook.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,qBAAqB,EAAE,qBAAW;AAEhD,OAAO,KAAK,EAEV,WAAW,EAGX,eAAe,EAChB,qBAAiB;AAOlB;;;GAGG;AACH,qBAAa,4BAA4B;;gBAO3B,EACV,mBAAmB,EACnB,cAAc,EACd,mBAAmB,GACpB,EAAE;QACD,mBAAmB,EAAE,qBAAqB,CAAC,qBAAqB,CAAC,CAAC;QAClE,cAAc,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,eAAe,CAAC;QAC3D,mBAAmB,EAAE,WAAW,CAAC;KAClC;IAMD;;OAEG;IACH,OAAO,IAAI,WAAW;CAiIvB"}

package/dist/hooks/ExtraTransactionsPublishHook.mjs

@@ -111,6 +111,7 @@ _ExtraTransactionsPublishHook_addTransactionBatch = new WeakMap(), _ExtraTransac
     };
     await __classPrivateFieldGet(this, _ExtraTransactionsPublishHook_addTransactionBatch, "f").call(this, {
         from,
+        isInternal: true,
         networkClientId,
         requireApproval: false,
         transactions,

package/dist/hooks/ExtraTransactionsPublishHook.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"ExtraTransactionsPublishHook.mjs","sourceRoot":"","sources":["../../src/hooks/ExtraTransactionsPublishHook.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,wBAAwB;AAI5E,OAAO,EAAE,aAAa,EAAE,sBAAkB;AAS1C,MAAM,GAAG,GAAG,kBAAkB,CAC5B,aAAa,EACb,iCAAiC,CAClC,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,4BAA4B;IAOvC,YAAY,EACV,mBAAmB,EACnB,cAAc,EACd,mBAAmB,GAKpB;;QAdQ,oEAAmE;QAEnE,+DAA4D;QAE5D,oEAAkC;QAWzC,uBAAA,IAAI,qDAAwB,mBAAmB,MAAA,CAAC;QAChD,uBAAA,IAAI,gDAAmB,cAAc,MAAA,CAAC;QACtC,uBAAA,IAAI,qDAAwB,mBAAmB,MAAA,CAAC;IAClD,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,uBAAA,IAAI,mFAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;CA8HF;kSA5HC,KAAK,6CACH,eAAgC,EAChC,QAAgB;IAEhB,GAAG,CAAC,iCAAiC,EAAE,EAAE,eAAe,EAAE,QAAQ,EAAE,CAAC,CAAC;IAEtE,MAAM,EACJ,iBAAiB,EACjB,wBAAwB,EACxB,EAAE,EAAE,aAAa,EACjB,eAAe,EACf,QAAQ,GACT,GAAG,eAAe,CAAC;IAEpB,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAW,CAAC;IAClC,MAAM,EAAE,GAAG,QAAQ,CAAC,EAAqB,CAAC;IAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAuB,CAAC;IAC9C,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAwB,CAAC;IAChD,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAsB,CAAC;IAC5C,MAAM,YAAY,GAAG,QAAQ,CAAC,YAA+B,CAAC;IAE9D,MAAM,oBAAoB,GAAG,QAAQ,CAAC,oBAEzB,CAAC;IAEd,MAAM,iBAAiB,GAAG,QAAe,CAAC;IAC1C,MAAM,aAAa,GAAG,qBAAqB,EAAqB,CAAC;IAEjE,MAAM,SAAS,GAAG,CAAC,EACjB,YAAY,EACZ,eAAe,GAIhB,EAAQ,EAAE;QACT,IAAI,YAAY,EAAE,CAAC;YACjB,MAAM,qBAAqB,GAAG,uBAAA,IAAI,oDAAgB,MAApB,IAAI,EAAiB,aAAa,CAAC,CAAC;YAElE,GAAG,CAAC,kDAAkD,EAAE;gBACtD,qBAAqB;gBACrB,YAAY;aACb,CAAC,CAAC;YAEH,uBAAA,IAAI,yDAAqB,MAAzB,IAAI,EAAsB,qBAAqB,EAAE,YAAY,CAAC;iBAC3D,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;iBAC3B,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;YAE/B,OAAO;QACT,CAAC;QAED,aAAa,CAAC,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC,CAAC;IAC7C,CAAC,CAAC;IAEF,MAAM,WAAW,GAA2B;QAC1C,IAAI;QACJ,GAAG;QACH,YAAY;QACZ,oBAAoB;QACpB,EAAE;QACF,KAAK;KACN,CAAC;IAEF,MAAM,eAAe,GAAkC;QACrD,mBAAmB,EAAE;YACnB,EAAE,EAAE,aAAa;YACjB,SAAS;YACT,iBAAiB;SAClB;QACD,MAAM,EAAE,WAAW;KACpB,CAAC;IAEF,MAAM,iBAAiB,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE;QACtE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,WAAW,CAAC;QAC/C,OAAO;YACL,OAAO;YACP,MAAM,EAAE,IAAI;YACZ,IAAI;SACL,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,MAAM,kBAAkB,GACtB,iBAAiB;SACd,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,KAAK,KAAK,CAAC;SACtD,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QAC9B,GAAG,IAAI;KACR,CAAC,CAAC,CAAC;IAER,MAAM,iBAAiB,GAAoC,iBAAiB;SACzE,MAAM,CACL,CAAC,WAAW,EAAE,EAAE,CACd,WAAW,CAAC,OAAO,KAAK,SAAS,IAAI,WAAW,CAAC,OAAO,CAC3D;SACA,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QAC9B,GAAG,IAAI;KACR,CAAC,CAAC,CAAC;IAEN,MAAM,YAAY,GAAoC;QACpD,GAAG,kBAAkB;QACrB,eAAe;QACf,GAAG,iBAAiB;KACrB,CAAC;IAEF,GAAG,CAAC,0BAA0B,EAAE;QAC9B,IAAI;QACJ,eAAe;QACf,YAAY;KACb,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,wBAAwB,IAAI;QAC1C,WAAW,EAAE,IAAI;QACjB,WAAW,EAAE,KAAK;QAClB,iBAAiB,EAAE,IAAI;KACxB,CAAC;IAEF,MAAM,uBAAA,IAAI,yDAAqB,MAAzB,IAAI,EAAsB;QAC9B,IAAI;QACJ,eAAe;QACf,eAAe,EAAE,KAAK;QACtB,YAAY;QACZ,GAAG,OAAO;KACX,CAAC,CAAC;IAEH,OAAO,aAAa,CAAC,OAAO,CAAC;AAC/B,CAAC","sourcesContent":["import { createDeferredPromise, createModuleLogger } from '@metamask/utils';\nimport type { Hex } from '@metamask/utils';\n\nimport type { TransactionController } from '..';\nimport { projectLogger } from '../logger';\nimport type {\n  BatchTransactionParams,\n  PublishHook,\n  PublishHookResult,\n  TransactionBatchSingleRequest,\n  TransactionMeta,\n} from '../types';\n\nconst log = createModuleLogger(\n  projectLogger,\n  'extra-transactions-publish-hook',\n);\n\n/**\n * Custom publish logic that also publishes additional transactions in an batch.\n * Requires the batch to be successful to resolve.\n */\nexport class ExtraTransactionsPublishHook {\n  readonly #addTransactionBatch: TransactionController['addTransactionBatch'];\n\n  readonly #getTransaction: (transactionId: string) => TransactionMeta;\n\n  readonly #originalPublishHook: PublishHook;\n\n  constructor({\n    addTransactionBatch,\n    getTransaction,\n    originalPublishHook,\n  }: {\n    addTransactionBatch: TransactionController['addTransactionBatch'];\n    getTransaction: (transactionId: string) => TransactionMeta;\n    originalPublishHook: PublishHook;\n  }) {\n    this.#addTransactionBatch = addTransactionBatch;\n    this.#getTransaction = getTransaction;\n    this.#originalPublishHook = originalPublishHook;\n  }\n\n  /**\n   * @returns The publish hook function.\n   */\n  getHook(): PublishHook {\n    return this.#hook.bind(this);\n  }\n\n  async #hook(\n    transactionMeta: TransactionMeta,\n    signedTx: string,\n  ): Promise<PublishHookResult> {\n    log('Publishing transaction as batch', { transactionMeta, signedTx });\n\n    const {\n      batchTransactions,\n      batchTransactionsOptions,\n      id: transactionId,\n      networkClientId,\n      txParams,\n    } = transactionMeta;\n\n    const from = txParams.from as Hex;\n    const to = txParams.to as Hex | undefined;\n    const data = txParams.data as Hex | undefined;\n    const value = txParams.value as Hex | undefined;\n    const gas = txParams.gas as Hex | undefined;\n    const maxFeePerGas = txParams.maxFeePerGas as Hex | undefined;\n\n    const maxPriorityFeePerGas = txParams.maxPriorityFeePerGas as\n      | Hex\n      | undefined;\n\n    const signedTransaction = signedTx as Hex;\n    const resultPromise = createDeferredPromise<PublishHookResult>();\n\n    const onPublish = ({\n      newSignature,\n      transactionHash,\n    }: {\n      newSignature?: Hex;\n      transactionHash?: string;\n    }): void => {\n      if (newSignature) {\n        const latestTransactionMeta = this.#getTransaction(transactionId);\n\n        log('Calling original publish hook with new signature', {\n          latestTransactionMeta,\n          newSignature,\n        });\n\n        this.#originalPublishHook(latestTransactionMeta, newSignature)\n          .then(resultPromise.resolve)\n          .catch(resultPromise.reject);\n\n        return;\n      }\n\n      resultPromise.resolve({ transactionHash });\n    };\n\n    const firstParams: BatchTransactionParams = {\n      data,\n      gas,\n      maxFeePerGas,\n      maxPriorityFeePerGas,\n      to,\n      value,\n    };\n\n    const mainTransaction: TransactionBatchSingleRequest = {\n      existingTransaction: {\n        id: transactionId,\n        onPublish,\n        signedTransaction,\n      },\n      params: firstParams,\n    };\n\n    const extraTransactions = (batchTransactions ?? []).map((transaction) => {\n      const { isAfter, type, ...rest } = transaction;\n      return {\n        isAfter,\n        params: rest,\n        type,\n      };\n    });\n\n    const beforeTransactions: TransactionBatchSingleRequest[] =\n      extraTransactions\n        .filter((transaction) => transaction.isAfter === false)\n        .map(({ isAfter, ...rest }) => ({\n          ...rest,\n        }));\n\n    const afterTransactions: TransactionBatchSingleRequest[] = extraTransactions\n      .filter(\n        (transaction) =>\n          transaction.isAfter === undefined || transaction.isAfter,\n      )\n      .map(({ isAfter, ...rest }) => ({\n        ...rest,\n      }));\n\n    const transactions: TransactionBatchSingleRequest[] = [\n      ...beforeTransactions,\n      mainTransaction,\n      ...afterTransactions,\n    ];\n\n    log('Adding transaction batch', {\n      from,\n      networkClientId,\n      transactions,\n    });\n\n    const options = batchTransactionsOptions ?? {\n      disable7702: true,\n      disableHook: false,\n      disableSequential: true,\n    };\n\n    await this.#addTransactionBatch({\n      from,\n      networkClientId,\n      requireApproval: false,\n      transactions,\n      ...options,\n    });\n\n    return resultPromise.promise;\n  }\n}\n"]}
+{"version":3,"file":"ExtraTransactionsPublishHook.mjs","sourceRoot":"","sources":["../../src/hooks/ExtraTransactionsPublishHook.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,wBAAwB;AAI5E,OAAO,EAAE,aAAa,EAAE,sBAAkB;AAS1C,MAAM,GAAG,GAAG,kBAAkB,CAC5B,aAAa,EACb,iCAAiC,CAClC,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,4BAA4B;IAOvC,YAAY,EACV,mBAAmB,EACnB,cAAc,EACd,mBAAmB,GAKpB;;QAdQ,oEAAmE;QAEnE,+DAA4D;QAE5D,oEAAkC;QAWzC,uBAAA,IAAI,qDAAwB,mBAAmB,MAAA,CAAC;QAChD,uBAAA,IAAI,gDAAmB,cAAc,MAAA,CAAC;QACtC,uBAAA,IAAI,qDAAwB,mBAAmB,MAAA,CAAC;IAClD,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,uBAAA,IAAI,mFAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;CA+HF;kSA7HC,KAAK,6CACH,eAAgC,EAChC,QAAgB;IAEhB,GAAG,CAAC,iCAAiC,EAAE,EAAE,eAAe,EAAE,QAAQ,EAAE,CAAC,CAAC;IAEtE,MAAM,EACJ,iBAAiB,EACjB,wBAAwB,EACxB,EAAE,EAAE,aAAa,EACjB,eAAe,EACf,QAAQ,GACT,GAAG,eAAe,CAAC;IAEpB,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAW,CAAC;IAClC,MAAM,EAAE,GAAG,QAAQ,CAAC,EAAqB,CAAC;IAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAuB,CAAC;IAC9C,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAwB,CAAC;IAChD,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAsB,CAAC;IAC5C,MAAM,YAAY,GAAG,QAAQ,CAAC,YAA+B,CAAC;IAE9D,MAAM,oBAAoB,GAAG,QAAQ,CAAC,oBAEzB,CAAC;IAEd,MAAM,iBAAiB,GAAG,QAAe,CAAC;IAC1C,MAAM,aAAa,GAAG,qBAAqB,EAAqB,CAAC;IAEjE,MAAM,SAAS,GAAG,CAAC,EACjB,YAAY,EACZ,eAAe,GAIhB,EAAQ,EAAE;QACT,IAAI,YAAY,EAAE,CAAC;YACjB,MAAM,qBAAqB,GAAG,uBAAA,IAAI,oDAAgB,MAApB,IAAI,EAAiB,aAAa,CAAC,CAAC;YAElE,GAAG,CAAC,kDAAkD,EAAE;gBACtD,qBAAqB;gBACrB,YAAY;aACb,CAAC,CAAC;YAEH,uBAAA,IAAI,yDAAqB,MAAzB,IAAI,EAAsB,qBAAqB,EAAE,YAAY,CAAC;iBAC3D,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;iBAC3B,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;YAE/B,OAAO;QACT,CAAC;QAED,aAAa,CAAC,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC,CAAC;IAC7C,CAAC,CAAC;IAEF,MAAM,WAAW,GAA2B;QAC1C,IAAI;QACJ,GAAG;QACH,YAAY;QACZ,oBAAoB;QACpB,EAAE;QACF,KAAK;KACN,CAAC;IAEF,MAAM,eAAe,GAAkC;QACrD,mBAAmB,EAAE;YACnB,EAAE,EAAE,aAAa;YACjB,SAAS;YACT,iBAAiB;SAClB;QACD,MAAM,EAAE,WAAW;KACpB,CAAC;IAEF,MAAM,iBAAiB,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE;QACtE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,WAAW,CAAC;QAC/C,OAAO;YACL,OAAO;YACP,MAAM,EAAE,IAAI;YACZ,IAAI;SACL,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,MAAM,kBAAkB,GACtB,iBAAiB;SACd,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,KAAK,KAAK,CAAC;SACtD,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QAC9B,GAAG,IAAI;KACR,CAAC,CAAC,CAAC;IAER,MAAM,iBAAiB,GAAoC,iBAAiB;SACzE,MAAM,CACL,CAAC,WAAW,EAAE,EAAE,CACd,WAAW,CAAC,OAAO,KAAK,SAAS,IAAI,WAAW,CAAC,OAAO,CAC3D;SACA,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QAC9B,GAAG,IAAI;KACR,CAAC,CAAC,CAAC;IAEN,MAAM,YAAY,GAAoC;QACpD,GAAG,kBAAkB;QACrB,eAAe;QACf,GAAG,iBAAiB;KACrB,CAAC;IAEF,GAAG,CAAC,0BAA0B,EAAE;QAC9B,IAAI;QACJ,eAAe;QACf,YAAY;KACb,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,wBAAwB,IAAI;QAC1C,WAAW,EAAE,IAAI;QACjB,WAAW,EAAE,KAAK;QAClB,iBAAiB,EAAE,IAAI;KACxB,CAAC;IAEF,MAAM,uBAAA,IAAI,yDAAqB,MAAzB,IAAI,EAAsB;QAC9B,IAAI;QACJ,UAAU,EAAE,IAAI;QAChB,eAAe;QACf,eAAe,EAAE,KAAK;QACtB,YAAY;QACZ,GAAG,OAAO;KACX,CAAC,CAAC;IAEH,OAAO,aAAa,CAAC,OAAO,CAAC;AAC/B,CAAC","sourcesContent":["import { createDeferredPromise, createModuleLogger } from '@metamask/utils';\nimport type { Hex } from '@metamask/utils';\n\nimport type { TransactionController } from '..';\nimport { projectLogger } from '../logger';\nimport type {\n  BatchTransactionParams,\n  PublishHook,\n  PublishHookResult,\n  TransactionBatchSingleRequest,\n  TransactionMeta,\n} from '../types';\n\nconst log = createModuleLogger(\n  projectLogger,\n  'extra-transactions-publish-hook',\n);\n\n/**\n * Custom publish logic that also publishes additional transactions in an batch.\n * Requires the batch to be successful to resolve.\n */\nexport class ExtraTransactionsPublishHook {\n  readonly #addTransactionBatch: TransactionController['addTransactionBatch'];\n\n  readonly #getTransaction: (transactionId: string) => TransactionMeta;\n\n  readonly #originalPublishHook: PublishHook;\n\n  constructor({\n    addTransactionBatch,\n    getTransaction,\n    originalPublishHook,\n  }: {\n    addTransactionBatch: TransactionController['addTransactionBatch'];\n    getTransaction: (transactionId: string) => TransactionMeta;\n    originalPublishHook: PublishHook;\n  }) {\n    this.#addTransactionBatch = addTransactionBatch;\n    this.#getTransaction = getTransaction;\n    this.#originalPublishHook = originalPublishHook;\n  }\n\n  /**\n   * @returns The publish hook function.\n   */\n  getHook(): PublishHook {\n    return this.#hook.bind(this);\n  }\n\n  async #hook(\n    transactionMeta: TransactionMeta,\n    signedTx: string,\n  ): Promise<PublishHookResult> {\n    log('Publishing transaction as batch', { transactionMeta, signedTx });\n\n    const {\n      batchTransactions,\n      batchTransactionsOptions,\n      id: transactionId,\n      networkClientId,\n      txParams,\n    } = transactionMeta;\n\n    const from = txParams.from as Hex;\n    const to = txParams.to as Hex | undefined;\n    const data = txParams.data as Hex | undefined;\n    const value = txParams.value as Hex | undefined;\n    const gas = txParams.gas as Hex | undefined;\n    const maxFeePerGas = txParams.maxFeePerGas as Hex | undefined;\n\n    const maxPriorityFeePerGas = txParams.maxPriorityFeePerGas as\n      | Hex\n      | undefined;\n\n    const signedTransaction = signedTx as Hex;\n    const resultPromise = createDeferredPromise<PublishHookResult>();\n\n    const onPublish = ({\n      newSignature,\n      transactionHash,\n    }: {\n      newSignature?: Hex;\n      transactionHash?: string;\n    }): void => {\n      if (newSignature) {\n        const latestTransactionMeta = this.#getTransaction(transactionId);\n\n        log('Calling original publish hook with new signature', {\n          latestTransactionMeta,\n          newSignature,\n        });\n\n        this.#originalPublishHook(latestTransactionMeta, newSignature)\n          .then(resultPromise.resolve)\n          .catch(resultPromise.reject);\n\n        return;\n      }\n\n      resultPromise.resolve({ transactionHash });\n    };\n\n    const firstParams: BatchTransactionParams = {\n      data,\n      gas,\n      maxFeePerGas,\n      maxPriorityFeePerGas,\n      to,\n      value,\n    };\n\n    const mainTransaction: TransactionBatchSingleRequest = {\n      existingTransaction: {\n        id: transactionId,\n        onPublish,\n        signedTransaction,\n      },\n      params: firstParams,\n    };\n\n    const extraTransactions = (batchTransactions ?? []).map((transaction) => {\n      const { isAfter, type, ...rest } = transaction;\n      return {\n        isAfter,\n        params: rest,\n        type,\n      };\n    });\n\n    const beforeTransactions: TransactionBatchSingleRequest[] =\n      extraTransactions\n        .filter((transaction) => transaction.isAfter === false)\n        .map(({ isAfter, ...rest }) => ({\n          ...rest,\n        }));\n\n    const afterTransactions: TransactionBatchSingleRequest[] = extraTransactions\n      .filter(\n        (transaction) =>\n          transaction.isAfter === undefined || transaction.isAfter,\n      )\n      .map(({ isAfter, ...rest }) => ({\n        ...rest,\n      }));\n\n    const transactions: TransactionBatchSingleRequest[] = [\n      ...beforeTransactions,\n      mainTransaction,\n      ...afterTransactions,\n    ];\n\n    log('Adding transaction batch', {\n      from,\n      networkClientId,\n      transactions,\n    });\n\n    const options = batchTransactionsOptions ?? {\n      disable7702: true,\n      disableHook: false,\n      disableSequential: true,\n    };\n\n    await this.#addTransactionBatch({\n      from,\n      isInternal: true,\n      networkClientId,\n      requireApproval: false,\n      transactions,\n      ...options,\n    });\n\n    return resultPromise.promise;\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/transaction-controller",
-  "version": "66.0.0",
+  "version": "66.0.1",
   "description": "Stores transactions alongside their periodically updated statuses and manages interactions such as approval and cancellation",
   "keywords": [
     "Ethereum",
@@ -60,17 +60,17 @@
     "@ethersproject/contracts": "^5.7.0",
     "@ethersproject/providers": "^5.7.0",
     "@ethersproject/wallet": "^5.7.0",
-    "@metamask/accounts-controller": "^38.1.1",
+    "@metamask/accounts-controller": "^39.0.0",
     "@metamask/approval-controller": "^9.0.1",
     "@metamask/base-controller": "^9.1.0",
     "@metamask/controller-utils": "^12.1.0",
-    "@metamask/core-backend": "^6.3.0",
+    "@metamask/core-backend": "^6.3.2",
     "@metamask/gas-fee-controller": "^26.2.2",
     "@metamask/messenger": "^1.2.0",
     "@metamask/metamask-eth-abis": "^3.1.1",
     "@metamask/network-controller": "^32.0.0",
     "@metamask/nonce-tracker": "^6.0.0",
-    "@metamask/remote-feature-flag-controller": "^4.2.1",
+    "@metamask/remote-feature-flag-controller": "^4.2.2",
     "@metamask/rpc-errors": "^7.0.2",
     "@metamask/utils": "^11.9.0",
     "async-mutex": "^0.5.0",