@metamask-previews/transaction-controller 36.1.0-preview-9d310688 → 37.0.0-preview-e34879fb

package/CHANGELOG.md

@@ -7,6 +7,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [37.0.0]
+
+### Changed
+
+- Remove unapproved transactions during initialisation ([#4658](https://github.com/MetaMask/core/pull/4658))
+- Fail approved and signed transactions during initialisation ([#4658](https://github.com/MetaMask/core/pull/4658))
+- Remove `TraceContext`, `TraceRequest`, and `TraceCallback` types ([#4655](https://github.com/MetaMask/core/pull/4655))
+  - These were moved to `@metamask/controller-utils`.
+
+### Removed
+
+- **BREAKING:** Remove `initApprovals` method ([#4658](https://github.com/MetaMask/core/pull/4658))
+- **BREAKING:** Remove `beforeApproveOnInit` hook ([#4658](https://github.com/MetaMask/core/pull/4658))
+
+### Fixed
+
+- Produce and export ESM-compatible TypeScript type declaration files in addition to CommonJS-compatible declaration files ([#4648](https://github.com/MetaMask/core/pull/4648))
+  - Previously, this package shipped with only one variant of type declaration
+    files, and these files were only CommonJS-compatible, and the `exports`
+    field in `package.json` linked to these files. This is an anti-pattern and
+    was rightfully flagged by the
+    ["Are the Types Wrong?"](https://arethetypeswrong.github.io/) tool as
+    ["masquerading as CJS"](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseCJS.md).
+    All of the ATTW checks now pass.
+- Remove chunk files ([#4648](https://github.com/MetaMask/core/pull/4648)).
+  - Previously, the build tool we used to generate JavaScript files extracted
+    common code to "chunk" files. While this was intended to make this package
+    more tree-shakeable, it also made debugging more difficult for our
+    development teams. These chunk files are no longer present.
+
 ## [36.1.0]
 
 ### Added
@@ -993,7 +1023,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@36.1.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@37.0.0...HEAD
+[37.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@36.1.0...@metamask/transaction-controller@37.0.0
 [36.1.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@36.0.0...@metamask/transaction-controller@36.1.0
 [36.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@35.2.0...@metamask/transaction-controller@36.0.0
 [35.2.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@35.1.1...@metamask/transaction-controller@35.2.0

package/dist/TransactionController.cjs

@@ -13,7 +13,7 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _TransactionController_instances, _TransactionController_internalEvents, _TransactionController_incomingTransactionOptions, _TransactionController_pendingTransactionOptions, _TransactionController_trace, _TransactionController_transactionHistoryLimit, _TransactionController_isSimulationEnabled, _TransactionController_testGasFeeFlows, _TransactionController_multichainTrackingHelper, _TransactionController_retryTransaction, _TransactionController_createNonceTracker, _TransactionController_createIncomingTransactionHelper, _TransactionController_createPendingTransactionTracker, _TransactionController_checkForPendingTransactionAndStartPolling, _TransactionController_stopAllTracking, _TransactionController_removeIncomingTransactionHelperListeners, _TransactionController_addIncomingTransactionHelperListeners, _TransactionController_removePendingTransactionTrackerListeners, _TransactionController_addPendingTransactionTrackerListeners, _TransactionController_getNonceTrackerPendingTransactions, _TransactionController_getGasFeeFlows, _TransactionController_getLayer1GasFeeFlows, _TransactionController_updateTransactionInternal, _TransactionController_checkIfTransactionParamsUpdated, _TransactionController_onTransactionParamsUpdated, _TransactionController_updateSimulationData, _TransactionController_onGasFeePollerTransactionUpdate, _TransactionController_getNetworkClientId, _TransactionController_getGlobalNetworkClientId, _TransactionController_getGlobalChainId, _TransactionController_isCustomNetwork, _TransactionController_getSelectedAccount, _TransactionController_updateSubmitHistory;
+var _TransactionController_instances, _TransactionController_internalEvents, _TransactionController_incomingTransactionOptions, _TransactionController_pendingTransactionOptions, _TransactionController_trace, _TransactionController_transactionHistoryLimit, _TransactionController_isSimulationEnabled, _TransactionController_testGasFeeFlows, _TransactionController_multichainTrackingHelper, _TransactionController_retryTransaction, _TransactionController_createNonceTracker, _TransactionController_createIncomingTransactionHelper, _TransactionController_createPendingTransactionTracker, _TransactionController_checkForPendingTransactionAndStartPolling, _TransactionController_stopAllTracking, _TransactionController_removeIncomingTransactionHelperListeners, _TransactionController_addIncomingTransactionHelperListeners, _TransactionController_removePendingTransactionTrackerListeners, _TransactionController_addPendingTransactionTrackerListeners, _TransactionController_getNonceTrackerPendingTransactions, _TransactionController_getGasFeeFlows, _TransactionController_getLayer1GasFeeFlows, _TransactionController_updateTransactionInternal, _TransactionController_checkIfTransactionParamsUpdated, _TransactionController_onTransactionParamsUpdated, _TransactionController_updateSimulationData, _TransactionController_onGasFeePollerTransactionUpdate, _TransactionController_getNetworkClientId, _TransactionController_getGlobalNetworkClientId, _TransactionController_getGlobalChainId, _TransactionController_isCustomNetwork, _TransactionController_getSelectedAccount;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TransactionController = exports.ApprovalState = exports.SPEED_UP_RATE = exports.CANCEL_RATE = exports.HARDFORK = void 0;
 const common_1 = require("@ethereumjs/common");
@@ -73,13 +73,8 @@ const metadata = {
         persist: true,
         anonymous: false,
     },
-    submitHistory: {
-        persist: true,
-        anonymous: false,
-    },
 };
 exports.HARDFORK = common_1.Hardfork.London;
-const SUBMIT_HISTORY_LIMIT = 100;
 /**
  * Multiplier used to determine a transaction's increased gas fee during cancellation
  */
@@ -111,7 +106,6 @@ function getDefaultTransactionControllerState() {
         methodData: {},
         transactions: [],
         lastFetchedBlockNumbers: {},
-        submitHistory: [],
     };
 }
 /**
@@ -381,7 +375,7 @@ class TransactionController extends base_controller_1.BaseController {
         const networkClientId = requestNetworkClientId ?? __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getGlobalNetworkClientId).call(this);
         const isEIP1559Compatible = await this.getEIP1559Compatibility(networkClientId);
         (0, validation_1.validateTxParams)(txParams, isEIP1559Compatible);
-        if (origin && this.getPermittedAccounts) {
+        if (origin) {
             await (0, validation_1.validateTransactionOrigin)(await this.getPermittedAccounts(origin), __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getSelectedAccount).call(this).address, txParams.from, origin);
         }
         const dappSuggestedGasFees = this.generateDappSuggestedGasFees(txParams, origin);
@@ -1306,10 +1300,7 @@ class TransactionController extends base_controller_1.BaseController {
             await __classPrivateFieldGet(this, _TransactionController_trace, "f").call(this, { name: 'Publish', parentContext: traceContext }, async () => {
                 ({ transactionHash: hash } = await this.publish(transactionMeta, rawTx));
                 if (hash === undefined) {
-                    hash = await this.publishTransaction(ethQuery, {
-                        ...transactionMeta,
-                        rawTx,
-                    });
+                    hash = await this.publishTransaction(ethQuery, rawTx);
                 }
             });
             (0, logger_1.projectLogger)('Publish successful', hash);
@@ -1343,14 +1334,8 @@ class TransactionController extends base_controller_1.BaseController {
             cleanupTasks.forEach((task) => task());
         }
     }
-    async publishTransaction(ethQuery, transactionMeta, { skipSubmitHistory } = {}) {
-        const transactionHash = await (0, controller_utils_1.query)(ethQuery, 'sendRawTransaction', [
-            transactionMeta.rawTx,
-        ]);
-        if (skipSubmitHistory !== true) {
-            __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_updateSubmitHistory).call(this, transactionMeta, transactionHash);
-        }
-        return transactionHash;
+    async publishTransaction(ethQuery, rawTransaction) {
+        return await (0, controller_utils_1.query)(ethQuery, 'sendRawTransaction', [rawTransaction]);
     }
     /**
      * Cancels a transaction based on its ID by setting its status to "rejected"
@@ -1757,9 +1742,10 @@ class TransactionController extends base_controller_1.BaseController {
             (0, logger_1.projectLogger)('Error while updating post transaction balance', error);
         }
     }
-    async publishTransactionForRetry(ethQuery, transactionMeta) {
+    async publishTransactionForRetry(ethQuery, rawTx, transactionMeta) {
         try {
-            return await this.publishTransaction(ethQuery, transactionMeta);
+            const hash = await this.publishTransaction(ethQuery, rawTx);
+            return hash;
         }
         catch (error) {
             if (this.isTransactionAlreadyConfirmedError(error)) {
@@ -1823,10 +1809,12 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_in
         networkClientId: transactionMeta.networkClientId,
         chainId: transactionMeta.chainId,
     });
+    const hash = await this.publishTransactionForRetry(ethQuery, rawTx, transactionMeta);
     const newTransactionMeta = {
         ...transactionMetaWithRsv,
         actionId,
         estimatedBaseFee,
+        hash,
         id: (0, uuid_1.v1)(),
         originalGasEstimate: transactionMeta.txParams.gas,
         originalType: transactionMeta.type,
@@ -1835,11 +1823,6 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_in
         txParams: newTxParams,
         type: transactionType,
     };
-    const hash = await this.publishTransactionForRetry(ethQuery, {
-        ...newTransactionMeta,
-        origin: label,
-    });
-    newTransactionMeta.hash = hash;
     this.addMetadata(newTransactionMeta);
     // speedUpTransaction has no approval request, so we assume the user has already approved the transaction
     this.messagingSystem.publish(`${controllerName}:transactionApproved`, {
@@ -1866,7 +1849,6 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_in
         blockTracker,
         getCurrentAccount: () => __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getSelectedAccount).call(this),
         getLastFetchedBlockNumbers: () => this.state.lastFetchedBlockNumbers,
-        getLocalTransactions: () => this.state.transactions,
         getChainId: chainId ? () => chainId : this.getChainId.bind(this),
         isEnabled: __classPrivateFieldGet(this, _TransactionController_incomingTransactionOptions, "f").isEnabled,
         queryEntireHistory: __classPrivateFieldGet(this, _TransactionController_incomingTransactionOptions, "f").queryEntireHistory,
@@ -1888,9 +1870,7 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_in
         getGlobalLock: () => __classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").acquireNonceLockForChainIdKey({
             chainId: getChainId(),
         }),
-        publishTransaction: (_ethQuery, transactionMeta) => this.publishTransaction(_ethQuery, transactionMeta, {
-            skipSubmitHistory: true,
-        }),
+        publishTransaction: this.publishTransaction.bind(this),
         hooks: {
             beforeCheckPendingTransaction: this.beforeCheckPendingTransaction.bind(this),
             beforePublish: this.beforePublish.bind(this),
@@ -2042,30 +2022,5 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_in
     return (this.messagingSystem.call(`NetworkController:getNetworkClientById`, networkClientId).configuration.type === network_controller_1.NetworkClientType.Custom);
 }, _TransactionController_getSelectedAccount = function _TransactionController_getSelectedAccount() {
     return this.messagingSystem.call('AccountsController:getSelectedAccount');
-}, _TransactionController_updateSubmitHistory = function _TransactionController_updateSubmitHistory(transactionMeta, hash) {
-    const { chainId, networkClientId, origin, rawTx, txParams } = transactionMeta;
-    const { networkConfigurationsByChainId } = this.getNetworkState();
-    const networkConfiguration = networkConfigurationsByChainId[chainId];
-    const endpoint = networkConfiguration?.rpcEndpoints.find((currentEndpoint) => currentEndpoint.networkClientId === networkClientId);
-    const networkUrl = endpoint?.url;
-    const networkType = endpoint?.name ?? networkClientId;
-    const submitHistoryEntry = {
-        chainId,
-        hash,
-        networkType,
-        networkUrl,
-        origin,
-        rawTransaction: rawTx,
-        time: Date.now(),
-        transaction: txParams,
-    };
-    (0, logger_1.projectLogger)('Updating submit history', submitHistoryEntry);
-    this.update((state) => {
-        const { submitHistory } = state;
-        if (submitHistory.length === SUBMIT_HISTORY_LIMIT) {
-            submitHistory.pop();
-        }
-        submitHistory.unshift(submitHistoryEntry);
-    });
 };
 //# sourceMappingURL=TransactionController.cjs.map