Merge pull request #91 from 0xProject/david/subproviders-clean

chore: clean unused code from @0x/subproviders

Author: rhinodavid

abi-gen/package.json

@@ -93,6 +93,7 @@
         "@types/glob": "5.0.35",
         "@types/mkdirp": "^0.5.2",
         "@types/mocha": "^5.2.7",
+        "@types/sinon": "^2.2.2",
         "@types/tmp": "^0.0.33",
         "@types/yargs": "^11.0.0",
         "chai": "^4.0.1",

abi-gen/test-cli/test_typescript/test/abi_gen_dummy_test.ts

@@ -1,7 +1,7 @@
 import { ContractFunctionObj } from '@0x/base-contract';
 import { BlockchainLifecycle, devConstants, web3Factory } from '@0x/dev-utils';
 import { Web3ProviderEngine } from '@0x/subproviders';
-import { BigNumber, providerUtils, StringRevertError } from '@0x/utils';
+import { BigNumber, StringRevertError } from '@0x/utils';
 import { BlockParamLiteral, Web3Wrapper } from '@0x/web3-wrapper';
 import * as chai from 'chai';
 import * as chaiAsPromised from 'chai-as-promised';

dev-utils/docs/reference.mdx

@@ -1,10 +1,4 @@
-import {
-    EmptyWalletSubprovider,
-    FakeGasEstimateSubprovider,
-    GanacheSubprovider,
-    RPCSubprovider,
-    Web3ProviderEngine,
-} from '@0x/subproviders';
+import { GanacheSubprovider, RPCSubprovider, Web3ProviderEngine } from '@0x/subproviders';
 import { providerUtils } from '@0x/utils';
 import * as fs from 'fs';
 
@@ -15,11 +9,9 @@ import { env, EnvVars } from './env';
 
 export interface Web3Config {
     total_accounts?: number; // default: 10
-    hasAddresses?: boolean; // default: true
     shouldUseInProcessGanache?: boolean; // default: false
     shouldThrowErrorsOnGanacheRPCResponse?: boolean; // default: true
     rpcUrl?: string; // default: localhost:8545
-    shouldUseFakeGasEstimate?: boolean; // default: true
     ganacheDatabasePath?: string; // default: undefined, creates a tmp dir
     shouldAllowUnlimitedContractSize?: boolean;
     fork?: string;
@@ -35,17 +27,6 @@ export const web3Factory = {
     getRpcProvider(config: Web3Config = {}): Web3ProviderEngine {
         const provider = new Web3ProviderEngine();
 
-        const hasAddresses = config.hasAddresses === undefined || config.hasAddresses;
-        const shouldUseFakeGasEstimate =
-            config.shouldUseFakeGasEstimate === undefined || config.shouldUseFakeGasEstimate;
-
-        if (!hasAddresses) {
-            provider.addProvider(new EmptyWalletSubprovider());
-        }
-        if (shouldUseFakeGasEstimate) {
-            provider.addProvider(new FakeGasEstimateSubprovider(constants.GAS_LIMIT));
-        }
-
         const logger = {
             log: (arg: any) => {
                 fs.appendFileSync('ganache.log', `${arg}\n`);

dev-utils/src/web3_factory.ts

@@ -20,7 +20,17 @@
         "IterableIterator": true,
         "Set": true,
         "Exclude": true,
-        "Ajv": true
+        "Ajv": true,
+        "#": "private types below",
+        "EIP712TypedData": true,
+        "ErrorCallback": true,
+        "JSONRPCErrorCallback": true,
+        "JSONRPCRequestPayload": true,
+        "JSONRPCRequestPayloadWithMethod": true,
+        "JSONRPCResponsePayload": true,
+        "MnemonicWalletSubproviderConfigs": true,
+        "NextCallback": true,
+        "PartialTxParams": true
     },
     "ignoredExcessiveTypes": [
         "NonceSubproviderErrors",

doc-gen-config.json

@@ -1,47 +1,53 @@
 # Class: SchemaValidator
 
-A validator for [JSON-schemas](http://json-schema.org/)
+A validator wrapping (AJV) [https://github.com/ajv-validator/ajv]
 
 
 ##   Constructors
 
 
 
-\+ **new SchemaValidator**(): *[SchemaValidator](#class-schemavalidator)*
+\+ **new SchemaValidator**(`newSchemas`: object[]): *[SchemaValidator](#class-schemavalidator)*
 
-*Defined in [schema_validator.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/json-schemas/src/schema_validator.ts#L15)*
+*Defined in [schema_validator.ts:11](https://github.com/0xProject/tools/blob/c64730cff/json-schemas/src/schema_validator.ts#L11)*
 
 Instantiates a SchemaValidator instance
 
+**Parameters:**
+
+Name | Type | Default |
+------ | ------ | ------ |
+`newSchemas` | object[] | [] |
+
 **Returns:** *[SchemaValidator](#class-schemavalidator)*
 
 ## Methods
 
 ###  addSchema
 
-▸ **addSchema**(`schema`: `Schema`): *void*
+▸ **addSchema**(`schemaObjectOrArray`: object | object[]): *void*
 
-*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/json-schemas/src/schema_validator.ts#L32)*
+*Defined in [schema_validator.ts:26](https://github.com/0xProject/tools/blob/c64730cff/json-schemas/src/schema_validator.ts#L26)*
 
 Add a schema to the validator. All schemas and sub-schemas must be added to
 the validator before the `validate` and `isValid` methods can be called with
 instances of that schema.
 
 **Parameters:**
 
-Name | Type | Description |
------- | ------ | ------ |
-`schema` | `Schema` | The schema to add  |
+Name | Type |
+------ | ------ |
+`schemaObjectOrArray` | object | object[] |
 
 **Returns:** *void*
 
 ___
 
 ###  isValid
 
-▸ **isValid**(`instance`: any, `schema`: `Schema`): *boolean*
+▸ **isValid**(`instance`: any, `schema`: object): *boolean*
 
-*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/json-schemas/src/schema_validator.ts#L57)*
+*Defined in [schema_validator.ts:59](https://github.com/0xProject/tools/blob/c64730cff/json-schemas/src/schema_validator.ts#L59)*
 
 Check whether an instance properly adheres to a JSON schema
 
@@ -50,7 +56,7 @@ Check whether an instance properly adheres to a JSON schema
 Name | Type | Description |
 ------ | ------ | ------ |
 `instance` | any | JS object in question |
-`schema` | `Schema` | Schema to check against |
+`schema` | object | Schema to check against |
 
 **Returns:** *boolean*
 
@@ -60,9 +66,9 @@ ___
 
 ###  validate
 
-▸ **validate**(`instance`: any, `schema`: `Schema`): *`ValidatorResult`*
+▸ **validate**(`instance`: any, `schema`: object): *Ajv*
 
-*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/json-schemas/src/schema_validator.ts#L46)*
+*Defined in [schema_validator.ts:49](https://github.com/0xProject/tools/blob/c64730cff/json-schemas/src/schema_validator.ts#L49)*
 
 Validate the JS object conforms to a specific JSON schema
 
@@ -71,12 +77,13 @@ Validate the JS object conforms to a specific JSON schema
 Name | Type | Description |
 ------ | ------ | ------ |
 `instance` | any | JS object in question |
-`schema` | `Schema` | Schema to check against |
+`schema` | object | Schema to check against |
 
-**Returns:** *`ValidatorResult`*
+**Returns:** *Ajv*
 
 The results of the validation
 
+
 <hr />