Introduce subprovider for printing revert stack traces

3 files changed, 51 insertions, 22 deletions

diff --git a/packages/contracts/package.json b/packages/contracts/package.json
index d6ca3727b..ad7cbf476 100644
--- a/packages/contracts/package.json
+++ b/packages/contracts/package.json
@@ -19,6 +19,7 @@
         "rebuild_and_test": "run-s build test",
         "test:coverage": "SOLIDITY_COVERAGE=true run-s build run_mocha coverage:report:text coverage:report:lcov",
         "test:profiler": "SOLIDITY_PROFILER=true run-s build run_mocha profiler:report:html",
+        "test:trace": "SOLIDITY_REVERT_TRACE=true run-s run_mocha",
         "run_mocha": "mocha --require source-map-support/register 'lib/test/**/*.js' --timeout 100000 --bail --exit",
         "compile": "sol-compiler",
         "clean": "shx rm -rf lib src/generated_contract_wrappers",
diff --git a/packages/contracts/src/utils/revert_trace.ts b/packages/contracts/src/utils/revert_trace.ts
new file mode 100644
index 000000000..0bf8384bc
--- /dev/null
+++ b/packages/contracts/src/utils/revert_trace.ts
@@ -0,0 +1,21 @@
+import { devConstants } from '@0xproject/dev-utils';
+import { RevertTraceSubprovider, SolCompilerArtifactAdapter } from '@0xproject/sol-cov';
+import * as _ from 'lodash';
+
+let revertTraceSubprovider: RevertTraceSubprovider;
+
+export const revertTrace = {
+    getRevertTraceSubproviderSingleton(): RevertTraceSubprovider {
+        if (_.isUndefined(revertTraceSubprovider)) {
+            revertTraceSubprovider = revertTrace._getRevertTraceSubprovider();
+        }
+        return revertTraceSubprovider;
+    },
+    _getRevertTraceSubprovider(): RevertTraceSubprovider {
+        const defaultFromAddress = devConstants.TESTRPC_FIRST_ADDRESS;
+        const solCompilerArtifactAdapter = new SolCompilerArtifactAdapter();
+        const isVerbose = true;
+        const subprovider = new RevertTraceSubprovider(solCompilerArtifactAdapter, defaultFromAddress, isVerbose);
+        return subprovider;
+    },
+};
diff --git a/packages/contracts/src/utils/web3_wrapper.ts b/packages/contracts/src/utils/web3_wrapper.ts
index c475d96a9..b8e8ed8ce 100644
--- a/packages/contracts/src/utils/web3_wrapper.ts
+++ b/packages/contracts/src/utils/web3_wrapper.ts
@@ -5,6 +5,7 @@ import { Web3Wrapper } from '@0xproject/web3-wrapper';
 
 import { coverage } from './coverage';
 import { profiler } from './profiler';
+import { revertTrace } from './revert_trace';
 
 enum ProviderType {
     Ganache = 'ganache',
@@ -48,28 +49,34 @@ const providerConfigs = testProvider === ProviderType.Ganache ? ganacheConfigs :
 export const provider = web3Factory.getRpcProvider(providerConfigs);
 const isCoverageEnabled = env.parseBoolean(EnvVars.SolidityCoverage);
 const isProfilerEnabled = env.parseBoolean(EnvVars.SolidityProfiler);
-if (isCoverageEnabled && isProfilerEnabled) {
-    throw new Error(
-        `Unfortunately for now you can't enable both coverage and profiler at the same time. They both use coverage.json file and there is no way to configure that.`,
-    );
-}
-if (isCoverageEnabled) {
-    const coverageSubprovider = coverage.getCoverageSubproviderSingleton();
-    prependSubprovider(provider, coverageSubprovider);
-}
-if (isProfilerEnabled) {
-    if (testProvider === ProviderType.Ganache) {
-        logUtils.warn(
-            "Gas costs in Ganache traces are incorrect and we don't recommend using it for profiling. Please switch to Geth",
-        );
-        process.exit(1);
-    }
-    const profilerSubprovider = profiler.getProfilerSubproviderSingleton();
-    logUtils.log(
-        "By default profilerSubprovider is stopped so that you don't get noise from setup code. Don't forget to start it before the code you want to profile and stop it afterwards",
-    );
-    profilerSubprovider.stop();
-    prependSubprovider(provider, profilerSubprovider);
+const isRevertTraceEnabled = env.parseBoolean(EnvVars.SolidityRevertTrace);
+// TODO(albrow): Include revertTrace checks in the warnings below.
+// if (isCoverageEnabled && isProfilerEnabled) {
+//     throw new Error(
+//         `Unfortunately for now you can't enable both coverage and profiler at the same time. They both use coverage.json file and there is no way to configure that.`,
+//     );
+// }
+// if (isCoverageEnabled) {
+//     const coverageSubprovider = coverage.getCoverageSubproviderSingleton();
+//     prependSubprovider(provider, coverageSubprovider);
+// }
+// if (isProfilerEnabled) {
+//     if (testProvider === ProviderType.Ganache) {
+//         logUtils.warn(
+//             "Gas costs in Ganache traces are incorrect and we don't recommend using it for profiling. Please switch to Geth",
+//         );
+//         process.exit(1);
+//     }
+//     const profilerSubprovider = profiler.getProfilerSubproviderSingleton();
+//     logUtils.log(
+//         "By default profilerSubprovider is stopped so that you don't get noise from setup code. Don't forget to start it before the code you want to profile and stop it afterwards",
+//     );
+//     profilerSubprovider.stop();
+//     prependSubprovider(provider, profilerSubprovider);
+// }
+if (isRevertTraceEnabled) {
+    const revertTraceSubprovider = revertTrace.getRevertTraceSubproviderSingleton();
+    prependSubprovider(provider, revertTraceSubprovider);
 }
 
 export const web3Wrapper = new Web3Wrapper(provider);