Bug fix: Provide reason for calls

packages/truffle-contract/lib/execute.js

@@ -99,22 +99,26 @@ var execute = {
    * @return {Promise}             Return value of the call.
    */
   call: function(fn, methodABI, address) {
-    var constructor = this;
+    const constructor = this;
+    const web3 = constructor.web3;
 
     return function() {
-      var defaultBlock = "latest";
-      var args = Array.prototype.slice.call(arguments);
-      var lastArg = args[args.length - 1];
-      var promiEvent = new Web3PromiEvent();
+      let defaultBlock = "latest";
+      let args = Array.prototype.slice.call(arguments);
+      const lastArg = args[args.length - 1];
+      const promiEvent = new Web3PromiEvent();
 
       // Extract defaultBlock parameter
       if (execute.hasDefaultBlock(args, lastArg, methodABI.inputs)) {
         defaultBlock = args.pop();
       }
 
+      let params;
       execute
         .prepareCall(constructor, methodABI, args)
-        .then(async ({ args, params }) => {
+        .then(async data => {
+          args = data.args;
+          params = data.params;
           let result;
 
           params.to = address;
@@ -135,7 +139,14 @@ var execute = {
           );
           return promiEvent.resolve(result);
         })
-        .catch(promiEvent.reject);
+        .catch(async error => {
+          const reason = await override.getErrorReason(params, web3);
+          if (reason) {
+            error.reason = reason;
+            error.message += ` -- Reason given: ${reason}.`;
+          }
+          promiEvent.reject(error);
+        });
 
       return promiEvent.eventEmitter;
     };
@@ -149,17 +160,17 @@ var execute = {
    * @return {PromiEvent}          Resolves a transaction receipt (via the receipt handler)
    */
   send: function(fn, methodABI, address) {
-    var constructor = this;
-    var web3 = constructor.web3;
+    const constructor = this;
+    const web3 = constructor.web3;
 
     return function() {
-      var deferred;
-      var promiEvent = new Web3PromiEvent();
+      let deferred;
+      const promiEvent = new Web3PromiEvent();
 
       execute
         .prepareCall(constructor, methodABI, arguments)
         .then(async ({ args, params, network }) => {
-          var context = {
+          const context = {
             contract: constructor, // Can't name this field `constructor` or `_constructor`
             promiEvent: promiEvent,
             params: params

packages/truffle-contract/lib/override.js

@@ -1,32 +1,38 @@
-var Reason = require('./reason');
-var handlers = require('./handlers');
+var Reason = require("./reason");
+var handlers = require("./handlers");
 
-var override = {
-
-  timeoutMessage: 'not mined within', // Substring of timeout err fired by web3
-  defaultMaxBlocks: 50,               // Max # of blocks web3 will wait for a tx
+const override = {
+  timeoutMessage: "not mined within", // Substring of timeout err fired by web3
+  defaultMaxBlocks: 50, // Max # of blocks web3 will wait for a tx
   pollingInterval: 1000,
 
   /**
    * Attempts to extract receipt object from Web3 error message
    * @param  {Object} message       web3 error
    * @return {Object|undefined} receipt
    */
-  extractReceipt(message){
-    const hasReceipt = message &&
-                       message.includes('{');
-                       message.includes('}');
+  extractReceipt(message) {
+    const hasReceipt = message && message.includes("{");
+    message.includes("}");
 
-    if (hasReceipt){
-      const receiptString =  '{' + message.split('{')[1].trim();
+    if (hasReceipt) {
+      const receiptString = "{" + message.split("{")[1].trim();
       try {
         return JSON.parse(receiptString);
-      } catch (err){
+      } catch (err) {
         // ignore
       }
     }
   },
 
+  getErrorReason: async function(params, web3) {
+    // This will run if there's a reason and no status field
+    // e.g: revert with reason ganache-cli --vmErrorsOnRPCResponse=true
+    const reason = await Reason.get(params, web3);
+    if (reason) return reason;
+    return null;
+  },
+
   /**
    * Fired after web3 ceases to support subscriptions if user has specified
    * a higher block wait time than web3's 50 blocks limit. Opens a subscription to listen
@@ -36,30 +42,30 @@ var override = {
    * @param  {Object} context execution state
    * @param  {Object} err     error
    */
-  start: async function(context, web3Error){
-    var constructor = this;
-    var blockNumber = null;
-    var currentBlock = override.defaultMaxBlocks;
-    var maxBlocks = constructor.timeoutBlocks;
+  start: async function(context, web3Error) {
+    const constructor = this;
+    let currentBlock = override.defaultMaxBlocks;
+    const maxBlocks = constructor.timeoutBlocks;
 
-    var timedOut = web3Error.message && web3Error.message.includes(override.timeoutMessage);
-    var shouldWait = maxBlocks > currentBlock;
+    const timedOut =
+      web3Error.message && web3Error.message.includes(override.timeoutMessage);
+    const shouldWait = maxBlocks > currentBlock;
 
     // Reject after attempting to get reason string if we shouldn't be waiting.
-    if (!timedOut || !shouldWait){
-
+    if (!timedOut || !shouldWait) {
       // We might have been routed here in web3 >= beta.34 by their own status check
       // error. We want to extract the receipt, emit a receipt event
       // and reject it ourselves.
-      var receipt = override.extractReceipt(web3Error.message);
-      if (receipt){
+      const receipt = override.extractReceipt(web3Error.message);
+      if (receipt) {
         await handlers.receipt(context, receipt);
         return;
       }
 
-      // This will run if there's a reason and no status field
-      // e.g: revert with reason ganache-cli --vmErrorsOnRPCResponse=true
-      var reason = await Reason.get(context.params, constructor.web3);
+      const reason = await override.getErrorReason(
+        context.params,
+        constructor.web3
+      );
       if (reason) {
         web3Error.reason = reason;
         web3Error.message += ` -- Reason given: ${reason}.`;
@@ -69,27 +75,25 @@ var override = {
     }
 
     // This will run every block from now until contract.timeoutBlocks
-    var listener = function(pollID){
-      var self = this;
+    const listener = function(pollID) {
       currentBlock++;
 
-      if (currentBlock > constructor.timeoutBlocks){
+      if (currentBlock > constructor.timeoutBlocks) {
         clearInterval(pollID);
         return;
       }
 
-      constructor.web3.eth.getTransactionReceipt(context.transactionHash)
+      constructor.web3.eth
+        .getTransactionReceipt(context.transactionHash)
         .then(result => {
           if (!result) return;
 
-          (result.contractAddress)
+          result.contractAddress
             ? constructor
                 .at(result.contractAddress)
                 .then(context.promiEvent.resolve)
                 .catch(context.promiEvent.reject)
-
             : constructor.promiEvent.resolve(result);
-
         })
         .catch(err => {
           clearInterval(pollID);
@@ -100,15 +104,15 @@ var override = {
     // Start polling
     let currentPollingBlock = await constructor.web3.eth.getBlockNumber();
 
-    const pollID = setInterval(async() => {
+    const pollID = setInterval(async () => {
       const newBlock = await constructor.web3.eth.getBlockNumber();
 
-      if(newBlock > currentPollingBlock){
+      if (newBlock > currentPollingBlock) {
         currentPollingBlock = newBlock;
         listener(pollID);
       }
     }, override.pollingInterval);
-  },
+  }
 };
 
 module.exports = override;

packages/truffle-contract/test/revertReasons.js

@@ -0,0 +1,35 @@
+const { assert } = require("chai");
+const util = require("./util");
+
+describe("revert reasons", function() {
+  let RevertingContract;
+  const providerOptions = { vmErrorsOnRPCResponse: true }; // <--- TRUE
+
+  before(async function() {
+    this.timeout(10000);
+
+    RevertingContract = await util.createRevertingContract();
+
+    await util.setUpProvider(RevertingContract, providerOptions);
+  });
+
+  it("provides a reason when a function reverts", async () => {
+    try {
+      let instance = await RevertingContract.new();
+      await instance.revertingFunction();
+      assert.fail();
+    } catch (error) {
+      assert(error.reason, "Too reverty of a function");
+    }
+  });
+
+  it("provides a reason when a view function (call) reverts", async () => {
+    try {
+      let instance = await RevertingContract.new();
+      await instance.revertingView();
+      assert.fail();
+    } catch (error) {
+      assert(error.reason, "Too reverty of a view");
+    }
+  });
+});

packages/truffle-contract/test/sources/RevertingContract.sol

@@ -0,0 +1,17 @@
+pragma solidity ^0.5.0;
+
+contract RevertingContract {
+  uint256 public value;
+
+  constructor() public {
+    value = 0;
+  }
+
+  function revertingView() public view {
+    require(value > 0, "Too reverty of a view");
+  }
+
+  function revertingFunction() public {
+    require(value > 0, "Too reverty of a function");
+  }
+}

packages/truffle-contract/test/util.js

@@ -35,6 +35,13 @@ var util = {
     );
   },
 
+  createRevertingContract: async function() {
+    return await util._createContractInstance(
+      path.join(__dirname, "sources", "RevertingContract.sol"),
+      "RevertingContract"
+    );
+  },
+
   _createContractInstance: async function(sourcePath, contractName) {
     var contractObj;
     const sources = {

yarn.lock

@@ -5775,7 +5775,7 @@ [email protected], ethjs-util@^0.1.3, ethjs-util@^0.1.6:
     is-hex-prefixed "1.0.0"
     strip-hex-prefix "1.0.0"
 
-ethpm-registry@^0.1.0-next.3:
+[email protected]:
   version "0.1.0-next.3"
   resolved "https://registry.yarnpkg.com/ethpm-registry/-/ethpm-registry-0.1.0-next.3.tgz#e335e7f57cda3c1cead388db6833903121773e9c"
   integrity sha512-PZZ1wo7lf2J3xWfvdEHzG6gJzh2wJiw8jzBcLgqOicLQoxVzgzCCcF6GZKakIeDZfMilrP/0fm7uu5PviZzECg==