Handle revert reason errors for geth >= 1.9.5

Author: cgewecke

TESTING.md

@@ -46,8 +46,8 @@ CI job.
 The npm script `test:e2e:clients` greps all tests with an `[ @E2E ]` tag
 in their mocha test description and runs them against:
 + ganache-cli
-+ geth 1.9.13 (POA, single instance, instamining)
-+ geth 1.9.13 (POA, single instance, mining at 2s intervals)
++ geth stable (POA, single instance, instamining)
++ geth stable (POA, single instance, mining at 2s intervals)
 
 These tests are grouped in files prefixed by "e2e", ex: `test/e2e.method.call.js`.
 

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

@@ -26,7 +26,10 @@
 module.exports = {
     ErrorResponse: function (result) {
         var message = !!result && !!result.error && !!result.error.message ? result.error.message : JSON.stringify(result);
-        return new Error('Returned error: ' + message);
+        var data = (!!result.error && !!result.error.data) ? result.error.data : null;
+        var err = new Error('Returned error: ' + message);
+        err.data = data;
+        return err;
     },
     InvalidNumberOfParams: function (got, expected, method) {
         return new Error('Invalid number of parameters for "'+ method +'". Got '+ got +' expected '+ expected +'!');

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

@@ -550,7 +550,7 @@ Method.prototype._confirmTransaction = function (defer, result, payload) {
         const startInterval = () => {
             intervalId = setInterval(checkConfirmation.bind(null, existingReceipt, true), 1000);
         }
-        
+
         if (!this.requestManager.provider.on) {
             startInterval()
         } else {
@@ -618,22 +618,34 @@ Method.prototype.buildCall = function () {
 
         // CALLBACK function
         var sendTxCallback = function (err, result) {
-            if (method.handleRevert && !err && 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
-                    }
-                );
+            if (method.handleRevert && isCall && method.abiCoder) {
+                var reasonData;
+
+                // Ganache / Geth <= 1.9.13 return the reason data as a successful eth_call response
+                // Geth >= 1.9.15 attaches the reason data to an error object.
+                if (!err && method.isRevertReasonString(result)){
+                    reasonData = result.substring(10);
+                } else if (err && err.data){
+                    reasonData = err.data.substring(10);
+                }
 
-                return;
+                if (reasonData){
+                    var reason = method.abiCoder.decodeParameter('string', '0x' + reasonData);
+                    var signature = 'Error(String)';
+
+                    utils._fireError(
+                        errors.RevertInstructionError(reason, signature),
+                        defer.eventEmitter,
+                        defer.reject,
+                        payload.callback,
+                        {
+                            reason: reason,
+                            signature: signature
+                        }
+                    );
+
+                    return;
+                }
             }
 
             try {

scripts/e2e.geth.automine.sh

@@ -24,7 +24,7 @@ echo " "
 # Launch client w/ two unlocked accounts.
 # + accounts[0] default geth unlocked bal = ~infinity
 # + accounts[1] unlocked, signing password = 'left-hand-of-darkness'
-geth-dev-assistant --period 2 --accounts 1 --tag 'v1.9.13'
+geth-dev-assistant --period 2 --accounts 1 --tag 'stable'
 
 # Test
 GETH_AUTOMINE=true nyc --no-clean --silent _mocha -- \

scripts/e2e.geth.instamine.sh

@@ -24,7 +24,7 @@ echo " "
 # Launch client w/ two unlocked accounts.
 # + accounts[0] default geth unlocked bal = ~infinity
 # + accounts[1] unlocked, bal=50 eth, signing password = 'left-hand-of-darkness'
-geth-dev-assistant --accounts 1 --tag 'v1.9.13'
+geth-dev-assistant --accounts 1 --tag 'stable'
 
 # Test
 GETH_INSTAMINE=true nyc --no-clean --silent _mocha -- \

test/e2e.method.call.js

@@ -62,8 +62,14 @@ describe('method.call [ @E2E ]', function () {
                 assert.fail();
 
             } catch (err) {
-                assert(err.message.includes("Returned values aren't valid"));
-                assert(err.message.includes('the correct ABI'));
+                // ganache | geth <= 1.9.13
+                const nullDataResponse = err.message.includes("Returned values aren't valid") &&
+                                         err.message.includes('the correct ABI');
+
+                // geth >= 1.9.15
+                const gethErrResponse = err.message.includes("revert");
+
+                assert(nullDataResponse || gethErrResponse);
             }
         })
     });