Adds revert instruction handling

packages/web3-core-helpers/src/errors.js

@@ -43,5 +43,12 @@ module.exports = {
     },
     ConnectionTimeout: function (ms){
         return new Error('CONNECTION TIMEOUT: timeout of ' + ms + ' ms achived');
+    },
+    RevertInstructionError: function(reason, signature) {
+        var error = new Error('Your request got reverted with the following reason string: ' + reason);
+        error.reason = reason;
+        error.signature = signature;
+
+        return error;
     }
 };

packages/web3-core-helpers/types/index.d.ts

@@ -66,6 +66,7 @@ export class errors {
     static InvalidProvider(): Error;
     static InvalidResponse(result: Error): Error;
     static ConnectionTimeout(ms: string): Error;
+    static RevertInstructionError(reason: string, signature: string): RevertInstructionError
 }
 
 export class WebsocketProviderBase {
@@ -182,3 +183,8 @@ export interface JsonRpcResponse {
     result?: any;
     error?: string;
 }
+
+export interface RevertInstructionError extends Error {
+    reason: string;
+    signature: string;
+}

packages/web3-core-helpers/types/tests/errors-test.ts

@@ -36,3 +36,6 @@ errors.InvalidResponse(new Error('hey'));
 
 // $ExpectType Error
 errors.ConnectionTimeout('timeout');
+
+// $ExpectType RevertInstructionError
+errors.RevertInstructionError('reason', 'signature');

packages/web3-core-method/src/index.js

@@ -43,6 +43,7 @@ var Method = function Method(options) {
     this.outputFormatter = options.outputFormatter;
     this.transformPayload = options.transformPayload;
     this.extraFormatters = options.extraFormatters;
+    this.abiCoder = options.abiCoder; // Will be used to encode the revert reason string
 
     this.requestManager = options.requestManager;
 
@@ -391,7 +392,7 @@ Method.prototype._confirmTransaction = function(defer, result, payload) {
                     return receipt;
                 })
                 // CHECK for normal tx check for receipt only
-                .then(function(receipt) {
+                .then(async function(receipt) {
                     if (!isContractDeployment && !promiseResolved) {
                         if (!receipt.outOfGas &&
                             (!gasProvided || gasProvided !== receipt.gasUsed) &&
@@ -408,13 +409,39 @@ Method.prototype._confirmTransaction = function(defer, result, payload) {
                             receiptJSON = JSON.stringify(receipt, null, 2);
 
                             if (receipt.status === false || receipt.status === '0x0') {
-                                utils._fireError(
-                                    new Error('Transaction has been reverted by the EVM:\n' + receiptJSON),
-                                    defer.eventEmitter,
-                                    defer.reject,
-                                    null,
-                                    receipt
-                                );
+                                try {
+                                    var revertMessage = await method.getRevertReason(
+                                        payload.params[0],
+                                        receipt.blockNumber
+                                    );
+
+                                    if (revertMessage) {
+                                        utils._fireError(
+                                            errors.RevertInstructionError(revertMessage.reason, revertMessage.signature),
+                                            defer.eventEmitter,
+                                            defer.reject,
+                                            payload.callback,
+                                            receipt
+                                        );
+                                    } else {
+                                        utils._fireError(
+                                            new Error('Transaction has been reverted by the EVM:\n' + receiptJSON),
+                                            defer.eventEmitter,
+                                            defer.reject,
+                                            null,
+                                            receipt
+                                        );
+                                    }
+                                } catch (error) {
+                                    utils._fireError(
+                                        new Error('Transaction has been reverted by the EVM:\n' + receiptJSON),
+                                        defer.eventEmitter,
+                                        defer.reject,
+                                        null,
+                                        receipt
+                                    );
+                                }
+
                             } else {
                                 utils._fireError(
                                     new Error('Transaction ran out of gas. Please provide more gas:\n' + receiptJSON),
@@ -526,16 +553,34 @@ var getWallet = function(from, accounts) {
 
 Method.prototype.buildCall = function() {
     var method = this,
-        isSendTx = (method.call === 'eth_sendTransaction' || method.call === 'eth_sendRawTransaction'); // || method.call === 'personal_sendTransaction'
+        isSendTx = (method.call === 'eth_sendTransaction' || method.call === 'eth_sendRawTransaction'), // || method.call === 'personal_sendTransaction'
+        isCall = (method.call === 'eth_call');
 
     // actual send function
     var send = function() {
         var defer = promiEvent(!isSendTx),
             payload = method.toPayload(Array.prototype.slice.call(arguments));
 
-
         // CALLBACK function
         var sendTxCallback = function(err, result) {
+            if (isCall && (method.isRevertReasonString(result) && method.abiCoder)) {
+                var reason = method.abiCoder.decodeParameter('string', '0x' + result.substring(10));
+                var signature = 'Error(String)';
+
+                utils._fireError(
+                    errors.RevertInstructionError(reason, signature),
+                    defer.eventEmitter,
+                    defer.reject,
+                    payload.callback,
+                    {
+                        reason: reason,
+                        signature: signature
+                    }
+                );
+
+                return;
+            }
+
             try {
                 result = method.formatOutput(result);
             } catch (e) {
@@ -560,10 +605,8 @@ Method.prototype.buildCall = function() {
 
             // return PROMISE
             if (!isSendTx) {
-
                 if (!err) {
                     defer.resolve(result);
-
                 }
 
                 // return PROMIEVENT
@@ -620,8 +663,7 @@ Method.prototype.buildCall = function() {
                                 if (_.isFunction(defer.eventEmitter.listeners) && defer.eventEmitter.listeners('error').length) {
                                     defer.eventEmitter.emit('error', err);
                                     defer.eventEmitter.removeAllListeners();
-                                    defer.eventEmitter.catch(function() {
-                                    });
+                                    defer.eventEmitter.catch(function() {});
                                 }
                                 defer.reject(err);
                             });
@@ -683,6 +725,56 @@ Method.prototype.buildCall = function() {
     return send;
 };
 
+/**
+ * Returns the revert reason string if existing or otherwise false.
+ *
+ * @method getRevertReason
+ *
+ * @param {Object} txOptions
+ * @param {Number} blockNumber
+ *
+ * @returns {Promise<Boolean|String>}
+ */
+Method.prototype.getRevertReason = function(txOptions, blockNumber) {
+    var self = this;
+
+    return new Promise(function(resolve, reject) {
+        (new Method({
+            name: 'call',
+            call: 'eth_call',
+            params: 2,
+            abiCoder: self.abiCoder
+        }))
+            .createFunction(self.requestManager)(txOptions, utils.numberToHex(blockNumber))
+            .then(function() {
+                resolve(false);
+            })
+            .catch(function(error) {
+                if (error.reason) {
+                    resolve({
+                        reason: error.reason,
+                        signature: error.signature
+                    });
+                } else {
+                    reject(error);
+                }
+            });
+    });
+};
+
+/**
+ * Checks if the given hex string is a revert message from the EVM
+ *
+ * @method isRevertReasonString
+ *
+ * @param {String} data - Hex string prefixed with 0x
+ *
+ * @returns {Boolean}
+ */
+Method.prototype.isRevertReasonString = function (data) {
+    return ((data.length - 2) / 2) % 32 === 4 && data.substring(0, 10) === '0x08c379a0';
+};
+
 /**
  * Should be called to create the pure JSONRPC request which can be used in a batch request
  *

packages/web3-core-method/types/index.d.ts

@@ -29,4 +29,5 @@ export interface Method {
     extraFormatters?: any;
     defaultBlock?: string;
     defaultAccount?: string | null;
+    abiCoder?: any
 }

packages/web3-eth-contract/src/index.js

@@ -826,7 +826,8 @@ Contract.prototype._executeMethod = function _executeMethod(){
                     requestManager: _this._parent._requestManager,
                     accounts: ethAccounts, // is eth.accounts (necessary for wallet signing)
                     defaultAccount: _this._parent.defaultAccount,
-                    defaultBlock: _this._parent.defaultBlock
+                    defaultBlock: _this._parent.defaultBlock,
+                    abiCoder: abi
                 })).createFunction();
 
                 return call(args.options, args.defaultBlock, args.callback);
@@ -903,7 +904,8 @@ Contract.prototype._executeMethod = function _executeMethod(){
                     defaultCommon: _this._parent.defaultCommon,
                     defaultChain: _this._parent.defaultChain,
                     defaultHardfork: _this._parent.defaultHardfork,
-                    extraFormatters: extraFormatters
+                    extraFormatters: extraFormatters,
+                    abiCoder: abi
                 })).createFunction();
 
                 return sendTransaction(args.options, args.callback);

packages/web3-eth/src/index.js

@@ -423,7 +423,8 @@ var Eth = function Eth() {
             name: 'sendSignedTransaction',
             call: 'eth_sendRawTransaction',
             params: 1,
-            inputFormatter: [null]
+            inputFormatter: [null],
+            abiCoder: abi
         }),
         new Method({
             name: 'signTransaction',
@@ -435,7 +436,8 @@ var Eth = function Eth() {
             name: 'sendTransaction',
             call: 'eth_sendTransaction',
             params: 1,
-            inputFormatter: [formatter.inputTransactionFormatter]
+            inputFormatter: [formatter.inputTransactionFormatter],
+            abiCoder: abi
         }),
         new Method({
             name: 'sign',
@@ -451,7 +453,8 @@ var Eth = function Eth() {
             name: 'call',
             call: 'eth_call',
             params: 2,
-            inputFormatter: [formatter.inputCallFormatter, formatter.inputDefaultBlockNumberFormatter]
+            inputFormatter: [formatter.inputCallFormatter, formatter.inputDefaultBlockNumberFormatter],
+            abiCoder: abi
         }),
         new Method({
             name: 'estimateGas',

packages/web3-eth/types/index.d.ts

@@ -38,6 +38,7 @@ import {
     LogsOptions,
     PastLogsOptions
 } from 'web3-core';
+import {RevertInstructionError} from 'web3-core-helpers';
 import {Subscription} from 'web3-core-subscriptions';
 import {AbiCoder} from 'web3-eth-abi';
 import {Accounts} from 'web3-eth-accounts';
@@ -294,12 +295,12 @@ export class Eth {
     sendTransaction(
         transactionConfig: TransactionConfig,
         callback?: (error: Error, hash: string) => void
-    ): PromiEvent<TransactionReceipt>;
+    ): PromiEvent<TransactionReceipt | RevertInstructionError>;
 
     sendSignedTransaction(
         signedTransactionData: string,
         callback?: (error: Error, hash: string) => void
-    ): PromiEvent<TransactionReceipt>;
+    ): PromiEvent<TransactionReceipt | RevertInstructionError>;
 
     sign(
         dataToSign: string,
@@ -327,20 +328,20 @@ export class Eth {
         ) => void
     ): Promise<RLPEncodedTransaction>;
 
-    call(transactionConfig: TransactionConfig): Promise<string>;
+    call(transactionConfig: TransactionConfig): Promise<string | RevertInstructionError>;
     call(
         transactionConfig: TransactionConfig,
         defaultBlock?: BlockNumber
-    ): Promise<string>;
+    ): Promise<string | RevertInstructionError>;
     call(
         transactionConfig: TransactionConfig,
         callback?: (error: Error, data: string) => void
-    ): Promise<string>;
+    ): Promise<string | RevertInstructionError>;
     call(
         transactionConfig: TransactionConfig,
         defaultBlock: BlockNumber,
         callback: (error: Error, data: string) => void
-    ): Promise<string>;
+    ): Promise<string | RevertInstructionError>;
 
     estimateGas(
         transactionConfig: TransactionConfig,