Refactor out sol-cov, sol-profiler and sol-trace into their separate packages

13 files changed, 132 insertions, 52 deletions

diff --git a/packages/website/md/docs/sol_cov/1/installation.md b/packages/website/md/docs/sol_cov/1/installation.md
deleted file mode 100644
index b9ce25a5f..000000000
--- a/packages/website/md/docs/sol_cov/1/installation.md
+++ /dev/null
@@ -1,17 +0,0 @@
-**Install**
-
-```bash
-yarn add @0xproject/sol-cov
-```
-
-**Import**
-
-```javascript
-import { CoverageSubprovider } from '@0xproject/sol-cov';
-```
-
-or
-
-```javascript
-var CoverageSubprovider = require('@0xproject/sol-cov').CoverageSubprovider;
-```
diff --git a/packages/website/md/docs/sol_cov/1/introduction.md b/packages/website/md/docs/sol_cov/1/introduction.md
deleted file mode 100644
index 7064a3554..000000000
--- a/packages/website/md/docs/sol_cov/1/introduction.md
+++ /dev/null
@@ -1 +0,0 @@
-Welcome to the [@0xproject/sol-cov](https://github.com/0xProject/0x-monorepo/tree/development/packages/sol-cov) documentation! Sol-cov is a Solidity coverage tool for your smart contract tests.
diff --git a/packages/website/md/docs/sol_cov/2/installation.md b/packages/website/md/docs/sol_cov/2/installation.md
deleted file mode 100644
index 1d4557cf5..000000000
--- a/packages/website/md/docs/sol_cov/2/installation.md
+++ /dev/null
@@ -1,17 +0,0 @@
-**Install**
-
-```bash
-yarn add @0x/sol-cov
-```
-
-**Import**
-
-```javascript
-import { CoverageSubprovider } from '@0x/sol-cov';
-```
-
-or
-
-```javascript
-var CoverageSubprovider = require('@0x/sol-cov').CoverageSubprovider;
-```
diff --git a/packages/website/md/docs/sol_cov/2/introduction.md b/packages/website/md/docs/sol_cov/2/introduction.md
deleted file mode 100644
index ac3256845..000000000
--- a/packages/website/md/docs/sol_cov/2/introduction.md
+++ /dev/null
@@ -1 +0,0 @@
-Welcome to the [sol-cov](https://github.com/0xProject/0x-monorepo/tree/development/packages/sol-cov) documentation! Sol-cov is a Solidity coverage tool for your smart contract tests.
diff --git a/packages/website/md/docs/sol_coverage/installation.md b/packages/website/md/docs/sol_coverage/installation.md
new file mode 100644
index 000000000..c7aaf07e9
--- /dev/null
+++ b/packages/website/md/docs/sol_coverage/installation.md
@@ -0,0 +1,17 @@
+**Install**
+
+```bash
+yarn add @0x/sol-coverage
+```
+
+**Import**
+
+```javascript
+import { CoverageSubprovider } from '@0x/sol-coverage';
+```
+
+or
+
+```javascript
+var CoverageSubprovider = require('@0x/sol-coverage').CoverageSubprovider;
+```
diff --git a/packages/website/md/docs/sol_coverage/introduction.md b/packages/website/md/docs/sol_coverage/introduction.md
new file mode 100644
index 000000000..3214e93a9
--- /dev/null
+++ b/packages/website/md/docs/sol_coverage/introduction.md
@@ -0,0 +1 @@
+Welcome to the [sol-coverage](https://github.com/0xProject/0x-monorepo/tree/development/packages/sol-coverage) documentation! Sol-coverage is a Solidity coverage tool for your smart contract tests.
diff --git a/packages/website/md/docs/sol_cov/2/usage.md b/packages/website/md/docs/sol_coverage/usage.md
index 8e33f3bf5..dd3cdf597 100644
--- a/packages/website/md/docs/sol_cov/2/usage.md
+++ b/packages/website/md/docs/sol_coverage/usage.md
@@ -1,4 +1,4 @@
-Sol-cov uses transaction traces in order to figure out which lines of Solidity source code have been covered by your tests. In order for it to gather these traces, you must add the `CoverageSubprovider` to the [ProviderEngine](https://github.com/MetaMask/provider-engine) instance you use when running your Solidity tests. If you're unfamiliar with ProviderEngine, please read the [Web3 Provider explained](https://0x.org/wiki#Web3-Provider-Explained) wiki article.
+Sol-coverage uses transaction traces in order to figure out which lines of Solidity source code have been covered by your tests. In order for it to gather these traces, you must add the `CoverageSubprovider` to the [ProviderEngine](https://github.com/MetaMask/provider-engine) instance you use when running your Solidity tests. If you're unfamiliar with ProviderEngine, please read the [Web3 Provider explained](https://0x.org/wiki#Web3-Provider-Explained) wiki article.
 
 The CoverageSubprovider eavesdrops on the `eth_sendTransaction` and `eth_call` RPC calls and collects traces after each call using `debug_traceTransaction`. `eth_call`'s' don't generate traces - so we take a snapshot, re-submit it as a transaction, get the trace and then revert the snapshot.
 
@@ -11,7 +11,7 @@ In order to use `CoverageSubprovider` with your favorite framework you need to p
 If you are generating your artifacts with [@0x/sol-compiler](https://0x.org/docs/sol-compiler) you can use the `SolCompilerArtifactsAdapter` we've implemented for you.
 
 ```typescript
-import { SolCompilerArtifactsAdapter } from '@0x/sol-cov';
+import { SolCompilerArtifactsAdapter } from '@0x/sol-coverage';
 const artifactsPath = 'src/artifacts';
 const contractsPath = 'src/contracts';
 const artifactsAdapter = new SolCompilerArtifactsAdapter(artifactsPath, contractsPath);
@@ -22,7 +22,7 @@ const artifactsAdapter = new SolCompilerArtifactsAdapter(artifactsPath, contract
 If your project is using [Truffle](https://truffleframework.com/), we've written a `TruffleArtifactsAdapter`for you.
 
 ```typescript
-import { TruffleArtifactAdapter } from '@0x/sol-cov';
+import { TruffleArtifactAdapter } from '@0x/sol-coverage';
 const contractsPath = 'src/contracts';
 const artifactAdapter = new TruffleArtifactAdapter(contractsDir);
 ```
@@ -37,7 +37,7 @@ Look at the code of the two adapters above for examples.
 ### Usage
 
 ```typescript
-import { CoverageSubprovider } from '@0x/sol-cov';
+import { CoverageSubprovider } from '@0x/sol-coverage';
 import ProviderEngine = require('web3-provider-engine');
 
 const provider = new ProviderEngine();
diff --git a/packages/website/md/docs/sol_profiler/installation.md b/packages/website/md/docs/sol_profiler/installation.md
new file mode 100644
index 000000000..be9a365f5
--- /dev/null
+++ b/packages/website/md/docs/sol_profiler/installation.md
@@ -0,0 +1,17 @@
+**Install**
+
+```bash
+yarn add @0x/sol-profiler
+```
+
+**Import**
+
+```javascript
+import { ProfilerSubprovider } from '@0x/sol-profiler';
+```
+
+or
+
+```javascript
+var ProfilerSubprovider = require('@0x/sol-profiler').ProfilerSubprovider;
+```
diff --git a/packages/website/md/docs/sol_profiler/introduction.md b/packages/website/md/docs/sol_profiler/introduction.md
new file mode 100644
index 000000000..bd53fb0fe
--- /dev/null
+++ b/packages/website/md/docs/sol_profiler/introduction.md
@@ -0,0 +1 @@
+Welcome to the [sol-profiler](https://github.com/0xProject/0x-monorepo/tree/development/packages/sol-profiler) documentation! Sol-profiler is a Solidity profiler tool.
diff --git a/packages/website/md/docs/sol_cov/1/usage.md b/packages/website/md/docs/sol_profiler/usage.md
index c2b8404af..35ea140da 100644
--- a/packages/website/md/docs/sol_cov/1/usage.md
+++ b/packages/website/md/docs/sol_profiler/usage.md
@@ -1,17 +1,17 @@
-Sol-cov uses transaction traces in order to figure out which lines of Solidity source code have been covered by your tests. In order for it to gather these traces, you must add the `CoverageSubprovider` to the [ProviderEngine](https://github.com/MetaMask/provider-engine) instance you use when running your Solidity tests. If you're unfamiliar with ProviderEngine, please read the [Web3 Provider explained](https://0x.org/wiki#Web3-Provider-Explained) wiki article.
+Sol-profiler uses transaction traces in order to figure out which lines of Solidity source code have been covered by your tests. In order for it to gather these traces, you must add the `ProfilerSubprovider` to the [ProviderEngine](https://github.com/MetaMask/provider-engine) instance you use when running your Solidity tests. If you're unfamiliar with ProviderEngine, please read the [Web3 Provider explained](https://0x.org/wiki#Web3-Provider-Explained) wiki article.
 
-The CoverageSubprovider eavesdrops on the `eth_sendTransaction` and `eth_call` RPC calls and collects traces after each call using `debug_traceTransaction`. `eth_call`'s' don't generate traces - so we take a snapshot, re-submit it as a transaction, get the trace and then revert the snapshot.
+The ProfilerSubprovider eavesdrops on the `eth_sendTransaction` and `eth_call` RPC calls and collects traces after each call using `debug_traceTransaction`. `eth_call`'s' don't generate traces - so we take a snapshot, re-submit it as a transaction, get the trace and then revert the snapshot.
 
-Coverage subprovider needs some info about your contracts (`srcMap`, `bytecode`). It gets that info from your project's artifacts. Some frameworks have their own artifact format. Some artifact formats don't actually contain all the neccessary data.
+Profiler subprovider needs some info about your contracts (`srcMap`, `bytecode`). It gets that info from your project's artifacts. Some frameworks have their own artifact format. Some artifact formats don't actually contain all the neccessary data.
 
-In order to use `CoverageSubprovider` with your favorite framework you need to pass an `artifactsAdapter` to it.
+In order to use `ProfilerSubprovider` with your favorite framework you need to pass an `artifactsAdapter` to it.
 
 ### Sol-compiler
 
-If you are generating your artifacts with [@0xproject/sol-compiler](https://0x.org/docs/sol-compiler) you can use the `SolCompilerArtifactsAdapter` we've implemented for you.
+If you are generating your artifacts with [@0x/sol-compiler](https://0x.org/docs/sol-compiler) you can use the `SolCompilerArtifactsAdapter` we've implemented for you.
 
 ```typescript
-import { SolCompilerArtifactsAdapter } from '@0xproject/sol-cov';
+import { SolCompilerArtifactsAdapter } from '@0x/sol-profiler';
 const artifactsPath = 'src/artifacts';
 const contractsPath = 'src/contracts';
 const artifactsAdapter = new SolCompilerArtifactsAdapter(artifactsPath, contractsPath);
@@ -22,7 +22,7 @@ const artifactsAdapter = new SolCompilerArtifactsAdapter(artifactsPath, contract
 If your project is using [Truffle](https://truffleframework.com/), we've written a `TruffleArtifactsAdapter`for you.
 
 ```typescript
-import { TruffleArtifactAdapter } from '@0xproject/sol-cov';
+import { TruffleArtifactAdapter } from '@0x/sol-profiler';
 const contractsPath = 'src/contracts';
 const artifactAdapter = new TruffleArtifactAdapter(contractsDir);
 ```
@@ -37,7 +37,7 @@ Look at the code of the two adapters above for examples.
 ### Usage
 
 ```typescript
-import { CoverageSubprovider } from '@0xproject/sol-cov';
+import { ProfilerSubprovider } from '@0x/sol-profiler';
 import ProviderEngine = require('web3-provider-engine');
 
 const provider = new ProviderEngine();
@@ -48,15 +48,15 @@ const networkId = 50;
 // Some calls might not have `from` address specified. Nevertheless - transactions need to be submitted from an address with at least some funds. defaultFromAddress is the address that will be used to submit those calls as transactions from.
 const defaultFromAddress = '0x5409ed021d9299bf6814279a6a1411a7e866a631';
 const isVerbose = true;
-const coverageSubprovider = new CoverageSubprovider(artifactsAdapter, defaultFromAddress, isVerbose);
+const profilerSubprovider = new ProfilerSubprovider(artifactsAdapter, defaultFromAddress, isVerbose);
 
-provider.addProvider(coverageSubprovider);
+provider.addProvider(profilerSubprovider);
 ```
 
 After your test suite is complete (e.g in the Mocha global `after` hook), you'll need to call:
 
 ```typescript
-await coverageSubprovider.writeCoverageAsync();
+await profilerSubprovider.writeProfilerAsync();
 ```
 
-This will create a `coverage.json` file in a `coverage` directory. This file has an [Istanbul format](https://github.com/gotwarlost/istanbul/blob/master/coverage.json.md) - so you can use it with any of the existing Istanbul reporters.
+This will create a `profiler.json` file in a `profiler` directory. This file has an [Istanbul format](https://github.com/gotwarlost/istanbul/blob/master/profiler.json.md) - so you can use it with any of the existing Istanbul reporters.
diff --git a/packages/website/md/docs/sol_trace/installation.md b/packages/website/md/docs/sol_trace/installation.md
new file mode 100644
index 000000000..2f794b2f8
--- /dev/null
+++ b/packages/website/md/docs/sol_trace/installation.md
@@ -0,0 +1,17 @@
+**Install**
+
+```bash
+yarn add @0x/sol-trace
+```
+
+**Import**
+
+```javascript
+import { TraceSubprovider } from '@0x/sol-trace';
+```
+
+or
+
+```javascript
+var TraceSubprovider = require('@0x/sol-trace').TraceSubprovider;
+```
diff --git a/packages/website/md/docs/sol_trace/introduction.md b/packages/website/md/docs/sol_trace/introduction.md
new file mode 100644
index 000000000..21fea764e
--- /dev/null
+++ b/packages/website/md/docs/sol_trace/introduction.md
@@ -0,0 +1 @@
+Welcome to the [sol-trace](https://github.com/0xProject/0x-monorepo/tree/development/packages/sol-trace) documentation! Sol-trace is a Solidity trace tool for your smart contract tests.
diff --git a/packages/website/md/docs/sol_trace/usage.md b/packages/website/md/docs/sol_trace/usage.md
new file mode 100644
index 000000000..f3aa6fc35
--- /dev/null
+++ b/packages/website/md/docs/sol_trace/usage.md
@@ -0,0 +1,62 @@
+Sol-trace uses transaction traces in order to figure out which lines of Solidity source code have been covered by your tests. In order for it to gather these traces, you must add the `TraceSubprovider` to the [ProviderEngine](https://github.com/MetaMask/provider-engine) instance you use when running your Solidity tests. If you're unfamiliar with ProviderEngine, please read the [Web3 Provider explained](https://0x.org/wiki#Web3-Provider-Explained) wiki article.
+
+The TraceSubprovider eavesdrops on the `eth_sendTransaction` and `eth_call` RPC calls and collects traces after each call using `debug_traceTransaction`. `eth_call`'s' don't generate traces - so we take a snapshot, re-submit it as a transaction, get the trace and then revert the snapshot.
+
+Trace subprovider needs some info about your contracts (`srcMap`, `bytecode`). It gets that info from your project's artifacts. Some frameworks have their own artifact format. Some artifact formats don't actually contain all the neccessary data.
+
+In order to use `TraceSubprovider` with your favorite framework you need to pass an `artifactsAdapter` to it.
+
+### Sol-compiler
+
+If you are generating your artifacts with [@0x/sol-compiler](https://0x.org/docs/sol-compiler) you can use the `SolCompilerArtifactsAdapter` we've implemented for you.
+
+```typescript
+import { SolCompilerArtifactsAdapter } from '@0x/sol-trace';
+const artifactsPath = 'src/artifacts';
+const contractsPath = 'src/contracts';
+const artifactsAdapter = new SolCompilerArtifactsAdapter(artifactsPath, contractsPath);
+```
+
+### Truffle
+
+If your project is using [Truffle](https://truffleframework.com/), we've written a `TruffleArtifactsAdapter`for you.
+
+```typescript
+import { TruffleArtifactAdapter } from '@0x/sol-trace';
+const contractsPath = 'src/contracts';
+const artifactAdapter = new TruffleArtifactAdapter(contractsDir);
+```
+
+Because truffle artifacts don't have all the data we need - we actually will recompile your contracts under the hood. That's why you don't need to pass an `artifactsPath`.
+
+### Other framework/toolset
+
+You'll need to write your own artifacts adapter. It should extend `AbstractArtifactsAdapter`.
+Look at the code of the two adapters above for examples.
+
+### Usage
+
+```typescript
+import { TraceSubprovider } from '@0x/sol-trace';
+import ProviderEngine = require('web3-provider-engine');
+
+const provider = new ProviderEngine();
+
+const artifactsPath = 'src/artifacts';
+const contractsPath = 'src/contracts';
+const networkId = 50;
+// Some calls might not have `from` address specified. Nevertheless - transactions need to be submitted from an address with at least some funds. defaultFromAddress is the address that will be used to submit those calls as transactions from.
+const defaultFromAddress = '0x5409ed021d9299bf6814279a6a1411a7e866a631';
+const isVerbose = true;
+const traceSubprovider = new TraceSubprovider(artifactsAdapter, defaultFromAddress, isVerbose);
+
+provider.addProvider(traceSubprovider);
+```
+
+After your test suite is complete (e.g in the Mocha global `after` hook), you'll need to call:
+
+```typescript
+await traceSubprovider.writeTraceAsync();
+```
+
+This will create a `trace.json` file in a `trace` directory. This file has an [Istanbul format](https://github.com/gotwarlost/istanbul/blob/master/trace.json.md) - so you can use it with any of the existing Istanbul reporters.