allow sendTransaction and smart contract calls to process options parameter

Author: Muhammad-Altabba

packages/contract/lib/execute.js

@@ -8,6 +8,7 @@ const handlers = require("./handlers");
 const override = require("./override");
 const reformat = require("./reformat");
 const { sendTransactionManual } = require("./manual-send");
+const { DEFAULT_RETURN_FORMAT } = require("web3-types");
 
 const execute = {
   // -----------------------------------  Helpers --------------------------------------------------
@@ -83,6 +84,7 @@ const execute = {
   prepareCall: async function (constructor, methodABI, _arguments, isCall) {
     let args = Array.prototype.slice.call(_arguments);
     let params = utils.getTxParams.call(constructor, methodABI, args, isCall);
+    let options = utils.getTxOptions.call(constructor, methodABI, args);
 
     args = utils.convertToEthersBN(args);
 
@@ -104,7 +106,7 @@ const execute = {
       return { args, params };
     }
     const network = await constructor.detectNetwork();
-    return { args, params, network };
+    return { args, params, network, options };
   },
 
   /**
@@ -202,7 +204,7 @@ const execute = {
       const promiEvent = new PromiEvent(false, constructor.debugger);
       execute
         .prepareCall(constructor, methodABI, arguments)
-        .then(async ({ args, params, network }) => {
+        .then(async ({ args, params, network, options }) => {
           const context = {
             contract: constructor, // Can't name this field `constructor` or `_constructor`
             promiEvent: promiEvent,
@@ -221,15 +223,17 @@ const execute = {
             contract: constructor
           });
 
-          params.gas = await execute.getGasEstimate.call(
-            constructor,
-            params,
-            network.blockLimit,
-            promiEvent.debug //apply stacktracing mode if promiEvent.debug is true
-          );
-
+          // estimate the gas only if it's not provided
+          if (!params || !params[0]?.gas) {
+            params.gas = await execute.getGasEstimate.call(
+              constructor,
+              params,
+              network.blockLimit,
+              promiEvent.debug //apply stacktracing mode if promiEvent.debug is true
+            );
+          }
           execute
-            .sendTransaction(web3, params, promiEvent, context) //the crazy things we do for stacktracing...
+            .sendTransaction(web3, params, promiEvent, context, options) //the crazy things we do for stacktracing...
             .then(receipt => {
               if (promiEvent.debug) {
                 // in this case, we need to manually invoke the handler since it
@@ -561,11 +565,15 @@ const execute = {
   //input works the same as input to web3.sendTransaction
   //(well, OK, it's lacking some things there too, but again, good enough
   //for our purposes)
-  sendTransaction: async function (web3, params, promiEvent, context) {
+  sendTransaction: async function (web3, params, promiEvent, context, options) {
     //if we don't need the debugger, let's not risk any errors on our part,
     //and just have web3 do everything
     if (!promiEvent || !promiEvent.debug) {
-      const deferred = web3.eth.sendTransaction(params);
+      const deferred = web3.eth.sendTransaction(
+        params,
+        DEFAULT_RETURN_FORMAT,
+        options
+      );
       handlers.setup(deferred, context);
       return deferred;
     }

packages/contract/lib/utils/index.js

@@ -22,6 +22,15 @@ const allowedTxParams = new Set([
   "overwrite"
 ]);
 
+const allowedTxOptions = new Set([
+  "checkRevertBeforeSending",
+  "ignoreGasPricing",
+  "transactionResolver",
+  "contractAbi",
+  "checkRevertBeforeSending",
+  "ignoreFillingGasLimit"
+]);
+
 const Utils = {
   is_object(val) {
     return typeof val === "object" && !Array.isArray(val);
@@ -39,6 +48,12 @@ const Utils = {
     return Object.keys(val).some(fieldName => allowedTxParams.has(fieldName));
   },
 
+  isTxOptions(val) {
+    if (!Utils.is_object(val)) return false;
+    if (Utils.is_big_number(val)) return false;
+    return Object.keys(val).some(fieldName => allowedTxOptions.has(fieldName));
+  },
+
   decodeLogs(_logs, isSingle) {
     const constructor = this;
     const logs = Utils.toTruffleLog(_logs, isSingle);
@@ -128,6 +143,20 @@ const Utils = {
     return bytecode;
   },
 
+  // Extracts optional tx options from a list of fn arguments
+  getTxOptions(methodABI, args) {
+    const expectedArgCount = methodABI ? methodABI.inputs.length : 0;
+
+    let txOptions = {};
+    const lastArg = args[args.length - 1];
+
+    if (args.length === expectedArgCount + 1 && Utils.isTxOptions(lastArg)) {
+      txOptions = args.pop();
+    }
+
+    return txOptions;
+  },
+
   // Extracts optional tx params from a list of fn arguments
   getTxParams(methodABI, args, ignoreDefaultGasPriceParams = false) {
     const constructor = this;
@@ -136,9 +165,17 @@ const Utils = {
 
     let txParams = {};
     const lastArg = args[args.length - 1];
+    const beforeLastArg = args.length >= 2 ? args[args.length - 2] : {};
 
     if (args.length === expectedArgCount + 1 && Utils.isTxParams(lastArg)) {
       txParams = args.pop();
+    } else if (
+      args.length === expectedArgCount + 2 &&
+      Utils.isTxParams(beforeLastArg)
+    ) {
+      // remove the item at index - 2 (beforeLastArg) from args
+      args.splice(args.length - 2, 1);
+      txParams = beforeLastArg;
     }
 
     let defaultParams = constructor.class_defaults;