Updated CHANGELOGS & MD docs

This commit is contained in:
xianny
2019-11-17 18:03:13 -05:00
parent 34538f2ced
commit cb5f9ba97d
110 changed files with 15001 additions and 34373 deletions

View File

@@ -1,3 +1,367 @@
# Class: AbstractArtifactAdapter
## Methods
### `Abstract` collectContractsDataAsync
▸ **collectContractsDataAsync**(): *`Promise<ContractData[]>`*
*Defined in [sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts:4](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts#L4)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: SolCompilerArtifactAdapter
## Constructors
\+ **new SolCompilerArtifactAdapter**(`artifactsPath?`: undefined | string, `sourcesPath?`: undefined | string): *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)*
*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L18)*
Instantiates a SolCompilerArtifactAdapter
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`artifactsPath?` | undefined \| string | Path to your artifacts directory |
`sourcesPath?` | undefined \| string | Path to your contract sources directory |
**Returns:** *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)*
## Methods
### collectContractsDataAsync
▸ **collectContractsDataAsync**(): *`Promise<ContractData[]>`*
*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)*
*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: TruffleArtifactAdapter
## Constructors
\+ **new TruffleArtifactAdapter**(`projectRoot`: string, `solcVersion`: string): *[TruffleArtifactAdapter](#class-truffleartifactadapter)*
*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:29](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L29)*
Instantiates a TruffleArtifactAdapter
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`projectRoot` | string | Path to the truffle project's root directory |
`solcVersion` | string | Solidity version with which to compile all the contracts |
**Returns:** *[TruffleArtifactAdapter](#class-truffleartifactadapter)*
## Methods
### collectContractsDataAsync
▸ **collectContractsDataAsync**(): *`Promise<ContractData[]>`*
*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)*
*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
## Type aliases
### Callback
Ƭ **Callback**: *function*
*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L131)*
#### Type declaration:
▸ (): *void*
___
### ErrorCallback
Ƭ **ErrorCallback**: *function*
*Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L130)*
#### Type declaration:
▸ (`err`: `Error` | null, `data?`: any): *void*
**Parameters:**
Name | Type |
------ | ------ |
`err` | `Error` \| null |
`data?` | any |
___
### NextCallback
Ƭ **NextCallback**: *function*
*Defined in [subproviders/src/types.ts:133](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L133)*
#### Type declaration:
▸ (`callback?`: [OnNextCompleted](#onnextcompleted)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`callback?` | [OnNextCompleted](#onnextcompleted) |
___
### OnNextCompleted
Ƭ **OnNextCompleted**: *function*
*Defined in [subproviders/src/types.ts:132](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L132)*
#### Type declaration:
▸ (`err`: `Error` | null, `result`: any, `cb`: [Callback](#callback)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`err` | `Error` \| null |
`result` | any |
`cb` | [Callback](#callback) |
<hr />
# Interface: JSONRPCRequestPayload
## Properties
### id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L331)*
___
### jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:332](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L332)*
___
### method
• **method**: *string*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L330)*
___
### params
• **params**: *any[]*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L329)*
<hr />
# Interface: JSONRPCResponseError
## Properties
### code
• **code**: *number*
*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L337)*
___
### message
• **message**: *string*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L336)*
<hr />
# Interface: JSONRPCResponsePayload
## Properties
### `Optional` error
• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)*
*Defined in [ethereum-types/src/index.ts:344](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L344)*
___
### id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L342)*
___
### jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L343)*
___
### result
• **result**: *any*
*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L341)*
<hr />
# Class: CoverageSubprovider
This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface.
@@ -12,7 +376,7 @@ It's used to compute your code coverage while running solidity tests.
*Overrides void*
*Defined in [sol-coverage/src/coverage_subprovider.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-coverage/src/coverage_subprovider.ts#L44)*
*Defined in [sol-coverage/src/coverage_subprovider.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-coverage/src/coverage_subprovider.ts#L44)*
Instantiates a CoverageSubprovider instance
@@ -134,7 +498,7 @@ ___
▸ **writeCoverageAsync**(): *`Promise<void>`*
*Defined in [sol-coverage/src/coverage_subprovider.ts:78](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-coverage/src/coverage_subprovider.ts#L78)*
*Defined in [sol-coverage/src/coverage_subprovider.ts:78](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-coverage/src/coverage_subprovider.ts#L78)*
Write the test coverage results to a file in Istanbul format.
@@ -142,292 +506,6 @@ Write the test coverage results to a file in Istanbul format.
<hr />
# Class: AbstractArtifactAdapter
## Methods
### `Abstract` collectContractsDataAsync
▸ **collectContractsDataAsync**(): *`Promise<ContractData[]>`*
*Defined in [sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts:4](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts#L4)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: SolCompilerArtifactAdapter
## Constructors
\+ **new SolCompilerArtifactAdapter**(`artifactsPath?`: undefined | string, `sourcesPath?`: undefined | string): *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)*
*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L18)*
Instantiates a SolCompilerArtifactAdapter
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`artifactsPath?` | undefined \| string | Path to your artifacts directory |
`sourcesPath?` | undefined \| string | Path to your contract sources directory |
**Returns:** *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)*
## Methods
### collectContractsDataAsync
▸ **collectContractsDataAsync**(): *`Promise<ContractData[]>`*
*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)*
*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: TruffleArtifactAdapter
## Constructors
\+ **new TruffleArtifactAdapter**(`projectRoot`: string, `solcVersion`: string): *[TruffleArtifactAdapter](#class-truffleartifactadapter)*
*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:29](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L29)*
Instantiates a TruffleArtifactAdapter
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`projectRoot` | string | Path to the truffle project's root directory |
`solcVersion` | string | Solidity version with which to compile all the contracts |
**Returns:** *[TruffleArtifactAdapter](#class-truffleartifactadapter)*
## Methods
### collectContractsDataAsync
▸ **collectContractsDataAsync**(): *`Promise<ContractData[]>`*
*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)*
*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:40](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Interface: JSONRPCRequestPayload
## Properties
### id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L330)*
___
### jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L331)*
___
### method
• **method**: *string*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L329)*
___
### params
• **params**: *any[]*
*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L328)*
<hr />
# Interface: JSONRPCResponseError
## Properties
### code
• **code**: *number*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L336)*
___
### message
• **message**: *string*
*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L335)*
<hr />
# Interface: JSONRPCResponsePayload
## Properties
### `Optional` error
• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)*
*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L343)*
___
### id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L341)*
___
### jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L342)*
___
### result
• **result**: *any*
*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L340)*
<hr />
@@ -497,7 +575,7 @@ ___
Defined in ethereum-types/lib/index.d.ts:267
Defined in ethereum-types/lib/index.d.ts:268
___
@@ -507,7 +585,7 @@ ___
Defined in ethereum-types/lib/index.d.ts:268
Defined in ethereum-types/lib/index.d.ts:269
___
@@ -517,7 +595,7 @@ ___
*Overrides void*
*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L136)*
*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L136)*
___
@@ -527,7 +605,7 @@ ___
Defined in ethereum-types/lib/index.d.ts:265
Defined in ethereum-types/lib/index.d.ts:266
<hr />
@@ -577,6 +655,19 @@ Defined in ethereum-types/lib/index.d.ts:265
## Type aliases
@@ -615,7 +706,7 @@ Defined in ethereum-types/lib/index.d.ts:265
Ƭ **CoverageSubproviderPartialConfig**: *`Partial<CoverageSubproviderConfig>`*
*Defined in [sol-coverage/src/coverage_subprovider.ts:31](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-coverage/src/coverage_subprovider.ts#L31)*
*Defined in [sol-coverage/src/coverage_subprovider.ts:31](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-coverage/src/coverage_subprovider.ts#L31)*
## Object literals
@@ -623,19 +714,19 @@ Defined in ethereum-types/lib/index.d.ts:265
#### ▪ **DEFAULT_COVERAGE_SUBPROVIDER_CONFIG**: *object*
*Defined in [sol-coverage/src/coverage_subprovider.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-coverage/src/coverage_subprovider.ts#L33)*
*Defined in [sol-coverage/src/coverage_subprovider.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-coverage/src/coverage_subprovider.ts#L33)*
#### ignoreFilesGlobs
• **ignoreFilesGlobs**: *never[]* = []
*Defined in [sol-coverage/src/coverage_subprovider.ts:35](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-coverage/src/coverage_subprovider.ts#L35)*
*Defined in [sol-coverage/src/coverage_subprovider.ts:35](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-coverage/src/coverage_subprovider.ts#L35)*
#### isVerbose
• **isVerbose**: *boolean* = true
*Defined in [sol-coverage/src/coverage_subprovider.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-coverage/src/coverage_subprovider.ts#L34)*
*Defined in [sol-coverage/src/coverage_subprovider.ts:34](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-coverage/src/coverage_subprovider.ts#L34)*
<hr />
@@ -651,94 +742,3 @@ Defined in ethereum-types/lib/index.d.ts:265
<hr />
## Type aliases
## Type aliases
### Callback
Ƭ **Callback**: *function*
*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L131)*
#### Type declaration:
▸ (): *void*
___
### ErrorCallback
Ƭ **ErrorCallback**: *function*
*Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L130)*
#### Type declaration:
▸ (`err`: `Error` | null, `data?`: any): *void*
**Parameters:**
Name | Type |
------ | ------ |
`err` | `Error` \| null |
`data?` | any |
___
### NextCallback
Ƭ **NextCallback**: *function*
*Defined in [subproviders/src/types.ts:133](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L133)*
#### Type declaration:
▸ (`callback?`: [OnNextCompleted](#onnextcompleted)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`callback?` | [OnNextCompleted](#onnextcompleted) |
___
### OnNextCompleted
Ƭ **OnNextCompleted**: *function*
*Defined in [subproviders/src/types.ts:132](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L132)*
#### Type declaration:
▸ (`err`: `Error` | null, `result`: any, `cb`: [Callback](#callback)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`err` | `Error` \| null |
`result` | any |
`cb` | [Callback](#callback) |
<hr />