@metamask-previews/transaction-controller 45.0.0-preview-224dff25 → 45.0.0-preview-1adbaffc

package/dist/TransactionController.cjs

@@ -1,6 +1,4 @@
 "use strict";
-/* istanbul ignore file */
-// FIXME  - remove above ignore
 var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
@@ -239,7 +237,7 @@ class TransactionController extends base_controller_1.BaseController {
             hooks?.beforeCheckPendingTransaction ??
                 /* istanbul ignore next */
                 (() => true);
-        this.beforePublish = hooks?.beforePublish ?? (() => Promise.resolve(true));
+        this.beforePublish = hooks?.beforePublish ?? (() => true);
         this.getAdditionalSignArguments =
             hooks?.getAdditionalSignArguments ?? (() => []);
         this.publish =
@@ -627,7 +625,6 @@ class TransactionController extends base_controller_1.BaseController {
             this.onTransactionStatusChange(updatedTransactionMeta);
             // Intentional given potential duration of process.
             this.updatePostBalance(updatedTransactionMeta).catch((error) => {
-                /* istanbul ignore next */
                 (0, logger_1.projectLogger)('Error while updating post balance', error);
                 throw error;
             });
@@ -858,17 +855,15 @@ class TransactionController extends base_controller_1.BaseController {
      * @param options.errorMessage - The error message to be assigned in case transaction status update to failed.
      * @param options.hash - The new hash value to be assigned.
      * @param options.status - The new status value to be assigned.
-     * @param options.gasLimit - The new gas limit value to be assigned
-     * @param options.gasPrice - The new gas price value to be assigned
-     * @param options.maxFeePerGas - The new max fee per gas value to be assigned
-     * @param options.maxPriorityFeePerGas - The new max priority fee per gas value to be assigned
-     * @param options.nonce - The new nonce value to be assigned
      */
-    updateCustodialTransaction(transactionId, { errorMessage, hash, status, gasLimit, gasPrice, maxFeePerGas, maxPriorityFeePerGas, nonce, }) {
+    updateCustodialTransaction(transactionId, { errorMessage, hash, status, }) {
         const transactionMeta = this.getTransaction(transactionId);
         if (!transactionMeta) {
             throw new Error(`Cannot update custodial transaction as no transaction metadata found`);
         }
+        if (!transactionMeta.custodyId) {
+            throw new Error('Transaction must be a custodian transaction');
+        }
         if (status &&
             ![
                 types_1.TransactionStatus.submitted,
@@ -884,22 +879,6 @@ class TransactionController extends base_controller_1.BaseController {
         if (updatedTransactionMeta.status === types_1.TransactionStatus.failed) {
             updatedTransactionMeta.error = (0, utils_2.normalizeTxError)(new Error(errorMessage));
         }
-        if (gasLimit) {
-            updatedTransactionMeta.txParams.gasLimit = gasLimit;
-        }
-        if (gasPrice) {
-            updatedTransactionMeta.txParams.gasPrice = gasPrice;
-        }
-        if (maxFeePerGas) {
-            updatedTransactionMeta.txParams.maxFeePerGas = maxFeePerGas;
-        }
-        if (maxPriorityFeePerGas) {
-            updatedTransactionMeta.txParams.maxPriorityFeePerGas =
-                maxPriorityFeePerGas;
-        }
-        if (nonce) {
-            updatedTransactionMeta.txParams.nonce = nonce;
-        }
         this.updateTransaction(updatedTransactionMeta, `${controllerName}:updateCustodialTransaction - Custodial transaction updated`);
         if ([types_1.TransactionStatus.submitted, types_1.TransactionStatus.failed].includes(status)) {
             this.messagingSystem.publish(`${controllerName}:transactionFinished`, updatedTransactionMeta);
@@ -1064,7 +1043,6 @@ class TransactionController extends base_controller_1.BaseController {
     /**
      * Stop the signing process for a specific transaction.
      * Throws an error causing the transaction status to be set to failed.
-     *
      * @param transactionId - The ID of the transaction to stop signing.
      */
     abortTransactionSigning(transactionId) {
@@ -1245,7 +1223,7 @@ class TransactionController extends base_controller_1.BaseController {
             });
             this.onTransactionStatusChange(transactionMeta);
             const rawTx = await __classPrivateFieldGet(this, _TransactionController_trace, "f").call(this, { name: 'Sign', parentContext: traceContext }, () => this.signTransaction(transactionMeta, transactionMeta.txParams));
-            if (!(await this.beforePublish(transactionMeta))) {
+            if (!this.beforePublish(transactionMeta)) {
                 (0, logger_1.projectLogger)('Skipping publishing transaction based on hook');
                 this.messagingSystem.publish(`${controllerName}:transactionPublishingSkipped`, transactionMeta);
                 return ApprovalState.SkippedViaBeforePublishHook;
@@ -1337,6 +1315,7 @@ class TransactionController extends base_controller_1.BaseController {
         this.messagingSystem.publish(`${controllerName}:transactionFinished`, updatedTransactionMeta);
         __classPrivateFieldGet(this, _TransactionController_internalEvents, "f").emit(
         // TODO: Either fix this lint violation or explain why it's necessary to ignore.
+        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
         `${transactionMeta.id}:finished`, updatedTransactionMeta);
         this.messagingSystem.publish(`${controllerName}:transactionRejected`, {
             transactionMeta: updatedTransactionMeta,
@@ -1366,6 +1345,7 @@ class TransactionController extends base_controller_1.BaseController {
             const { chainId, status, txParams, time } = tx;
             if (txParams) {
                 // TODO: Either fix this lint violation or explain why it's necessary to ignore.
+                // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
                 const key = `${String(txParams.nonce)}-${(0, controller_utils_1.convertHexToDecimal)(chainId)}-${new Date(time).toDateString()}`;
                 if (nonceNetworkSet.has(key)) {
                     return true;
@@ -1845,6 +1825,7 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
         }),
         hooks: {
             beforeCheckPendingTransaction: this.beforeCheckPendingTransaction.bind(this),
+            beforePublish: this.beforePublish.bind(this),
         },
     });
     __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_addPendingTransactionTrackerListeners).call(this, pendingTransactionTracker);