crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated CHANGELOGS & MD docs

Browse Source
This commit is contained in:
xianny 2019-11-05 16:58:00 -08:00
parent 44793a9cf9
commit f65d8cc325
111 changed files with 14231 additions and 29708 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
contracts/asset-proxy/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "2.3.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "2.3.0-beta.0",
"changes": [

6
contracts/asset-proxy/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v2.3.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v2.3.0-beta.0 - _October 3, 2019_
* Disallow the zero address from being made an authorized address in MixinAuthorizable, and created an archive directory that includes an old version of Ownable (#2019)
@ -13,6 +17,8 @@ CHANGELOG
* Remove unused dependency on IAuthorizable in IAssetProxy (#1910)
* Add `ERC20BridgeProxy` (#2220)
* Add `Eth2DaiBridge` (#2221)
* Add `UniswapBridge` (#2233)
* Replaced `SafeMath` with `LibSafeMath` (#2254)
## v2.2.8 - _September 17, 2019_

9
contracts/coordinator/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "2.1.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "2.1.0-beta.0",
"changes": [

4
contracts/coordinator/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v2.1.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v2.1.0-beta.0 - _October 3, 2019_
* Add chainId to domain separator (#1742)

9
contracts/dev-utils/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "0.1.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "0.1.0-beta.0",
"changes": [

4
contracts/dev-utils/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v0.1.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v0.1.0-beta.0 - _October 3, 2019_
* Use built in selectors instead of hard coded constants (#2055)

9
contracts/erc1155/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "1.2.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "1.2.0-beta.0",
"changes": [

5
contracts/erc1155/CHANGELOG.md
View File

@ -5,9 +5,14 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v1.2.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v1.2.0-beta.0 - _October 3, 2019_
* Add `mintKnownFungibleTokensAsync()`, `isNonFungibleItemAsync()`, `isFungibleItemAsync()`, `getOwnerOfAsync()`, `getBalanceAsync()` to `Erc1155Wrapper`. (#1819)
* Replaced `SafeMath` with `LibSafeMath` (#2254)
## v1.1.15 - _September 17, 2019_

3
contracts/erc20/CHANGELOG.json
View File

@ -6,7 +6,8 @@
"note": "Create `LibERC20Token`",
"pr": 2309
}
]
],
"timestamp": 1573001598
},
{
"version": "2.3.0-beta.0",

5
contracts/erc20/CHANGELOG.md
View File

@ -5,9 +5,14 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v2.3.0-beta.1 - _November 6, 2019_
* Create `LibERC20Token` (#2309)
## v2.3.0-beta.0 - _October 3, 2019_
* Dependencies updated
* Replaced `SafeMath` with `LibSafeMath` (#2254)
## v2.2.14 - _September 17, 2019_

9
contracts/erc721/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "2.2.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "2.2.0-beta.0",
"changes": [

5
contracts/erc721/CHANGELOG.md
View File

@ -5,9 +5,14 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v2.2.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v2.2.0-beta.0 - _October 3, 2019_
* Dependencies updated
* Replaced `SafeMath` with `LibSafeMath` (#2254)
## v2.1.15 - _September 17, 2019_

3
contracts/exchange-forwarder/CHANGELOG.json
View File

@ -6,7 +6,8 @@
"note": "Use `LibERC20Token` in `MixinAssets`",
"pr": 2309
}
]
],
"timestamp": 1573001598
},
{
"version": "3.1.0-beta.0",

4
contracts/exchange-forwarder/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v3.1.0-beta.1 - _November 6, 2019_
* Use `LibERC20Token` in `MixinAssets` (#2309)
## v3.1.0-beta.0 - _October 3, 2019_
* Dependencies updated

9
contracts/exchange-libs/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "3.1.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "3.1.0-beta.0",
"changes": [

5
contracts/exchange-libs/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v3.1.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v3.1.0-beta.0 - _October 3, 2019_
* Break up `LibEIP712` into reusable components (#1742)
@ -33,6 +37,7 @@ CHANGELOG
* Remove `_hashEIP712ExchangeMessage` from `LibEIP712ExchangeDomain` (#2055)
* Compile and export all contracts, artifacts, and wrappers by default (#2055)
* Update `IncompleteFillError` to take an `errorCode`, `expectedAssetFillAmount`, and `actualAssetFillAmount` fields. (#2075)
* Move `IWallet.sol` from `asset-proxy` and `exchange` packages to here. (#2233)
## v3.0.8 - _September 17, 2019_

9
contracts/exchange/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "2.2.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "2.2.0-beta.0",
"changes": [

4
contracts/exchange/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v2.2.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v2.2.0-beta.0 - _October 3, 2019_
* Use new/cheaper reentrancy guard/mutex (#1699)

9
contracts/extensions/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "4.1.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "4.1.0-beta.0",
"changes": [

5
contracts/extensions/CHANGELOG.md
View File

@ -5,9 +5,14 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v4.1.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v4.1.0-beta.0 - _October 3, 2019_
* Dependencies updated
* Replaced the use of `SafeMath` with `LibSafeMath` (#2254)
## v4.0.8 - _September 17, 2019_

9
contracts/integrations/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "1.0.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "1.0.0",
"changes": [

15
contracts/integrations/CHANGELOG.md Normal file
View File

@ -0,0 +1,15 @@
<!--
changelogUtils.file is auto-generated using the monorepo-scripts package. Don't edit directly.
Edit the package's CHANGELOG.json file only.
-->
CHANGELOG
## v1.0.1 - _November 6, 2019_
* Dependencies updated
## v1.0.0 - _Invalid date_
* Created package (#2240)
* Added the deployment manager class (#2240)

9
contracts/multisig/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "3.2.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "3.2.0-beta.0",
"changes": [

4
contracts/multisig/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v3.2.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v3.2.0-beta.0 - _October 3, 2019_
* Dependencies updated

3
contracts/staking/CHANGELOG.json
View File

@ -34,7 +34,8 @@
"note": "Unit tests for MixinCumulativeRewards",
"pr": 2316
}
]
],
"timestamp": 1573001598
},
{
"version": "1.1.0-beta.0",

18
contracts/staking/CHANGELOG.md
View File

@ -5,6 +5,17 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v1.1.0-beta.1 - _November 6, 2019_
* Add more overflow safeguards to `LibFixedMath` (#2255)
* Refactored finalization state. (#2276)
* Removed protocol fee != 0 assertion. (#2278)
* Call `StakingProxy.assertValidStorageParams()` in `MixinParams.setParams()` (#2279)
* The fallback function in `StakingProxy` reverts if there is no staking contract attached (#2310)
* Fix overflow w/ `LibFixedMath._mul(-1, -2*255) (#2311)
* Unit tests for MixinScheduler (#2314)
* Unit tests for MixinCumulativeRewards (#2316)
## v1.1.0-beta.0 - _October 3, 2019_
* Created package (#1821)
@ -24,3 +35,10 @@ CHANGELOG
* Introduce multi-block finalization. (#2155)
* Removed reference counting for cumulative rewards. (#2188)
* Removed explicit dependency on epoch+1 when delegating. (#2188)
## v1.1.0-beta.1 - _Invalid date_
* Removed handshake when adding maker to pool. (#2250)
* Removed upper limit on number of makers in a pool. (#2250)
* Removed operator permissions from makers. (#2250)
* Pool Id starts at 1 and increases by 1. (#2250)

9
contracts/test-utils/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "3.2.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "3.2.0-beta.0",
"changes": [

5
contracts/test-utils/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v3.2.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v3.2.0-beta.0 - _October 3, 2019_
* Add `chainId` to `TransactionFactory` constructor (#1742)
@ -31,6 +35,7 @@ CHANGELOG
* Add `hexHash()` to `hex_utils` (#2155)
* Add `shortZip()` to `lang_utils.ts` (#2155)
* Add `number_utils.ts` and `hexSize()` (#2220)
* Add `verifyEventsFromLogs()` (#2287)
## v3.1.16 - _September 17, 2019_

9
contracts/tests/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"timestamp": 1573001598,
"version": "0.0.2",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"version": "0.0.1",
"changes": [

14
contracts/tests/CHANGELOG.md Normal file
View File

@ -0,0 +1,14 @@
<!--
changelogUtils.file is auto-generated using the monorepo-scripts package. Don't edit directly.
Edit the package's CHANGELOG.json file only.
-->
CHANGELOG
## v0.0.2 - _November 6, 2019_
* Dependencies updated
## v0.0.1 - _Invalid date_
* Created package (#2261)

9
contracts/utils/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "3.3.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "3.3.0-beta.0",
"changes": [

7
contracts/utils/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v3.3.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v3.3.0-beta.0 - _October 3, 2019_
* Change ReentrancyGuard implementation to cheaper one (#1699)
@ -22,6 +26,9 @@ CHANGELOG
* Compile and export all contracts, artifacts, and wrappers by default (#2055)
* Added LibFractions (#2118)
* Introduce automatic normalization and some zero-value shortcuts in `LibFractions`. (#2155)
* Emit an event in `transferOwnership` (#2253)
* Removed `deepCopyBytes`, `popLast20Bytes`, `readBytesWithLength`, and `writeBytesWithLength` in `LibBytes`. (#2265)
* Replaced `SafeMath` with `LibSafeMath` (#2254)
## v3.2.4 - _September 17, 2019_

9
packages/0x.js/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "7.1.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "7.1.0-beta.0",
"changes": [

4
packages/0x.js/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v7.1.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v7.1.0-beta.0 - _October 3, 2019_
* Updated to work with 0x v3

12855
packages/0x.js/docs/reference.mdx
View File

File diff suppressed because one or more lines are too long

3
packages/abi-gen-wrappers/CHANGELOG.json
View File

@ -18,7 +18,8 @@
"note": "Remove `validateAndSendTransactionAsync`. Replaced with `shouldValidate` key in TxOpts. Defaults to true",
"pr": 2243
}
]
],
"timestamp": 1573001598
},
{
"version": "5.4.0-beta.0",

7
packages/abi-gen-wrappers/CHANGELOG.md
View File

@ -5,6 +5,13 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v5.4.0-beta.1 - _November 6, 2019_
* Remove debug functions `getABIDecodedTransactionData` and `getABIDecodedReturnData` (#2243)
* Remove `getABIEncodedTransactionData` for constant functions (pure and view) (#2243)
* Introduce TxOpts object for `sendTransactionAsync` and `awaitTransactionSuccessAsync`. Replaces `timeoutMs` and `pollingIntervalMs` arguments for `awaitTransactionSuccessAsync` (#2243)
* Remove `validateAndSendTransactionAsync`. Replaced with `shouldValidate` key in TxOpts. Defaults to true (#2243)
## v5.4.0-beta.0 - _October 3, 2019_
* Use V3 contracts (#2181)

9
packages/abi-gen/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "4.4.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "4.4.0-beta.0",
"changes": [

8
packages/abi-gen/CHANGELOG.md
View File

@ -5,6 +5,14 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v4.4.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v4.4.0-beta.0 - _Invalid date_
* Add `getSelector` method to all functions (#2224)
## v4.3.0-beta.0 - _October 3, 2019_
* Dependencies updated

9
packages/assert/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "2.2.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "2.2.0-beta.0",
"changes": [

4
packages/assert/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v2.2.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v2.2.0-beta.0 - _October 3, 2019_
* Dependencies updated

9
packages/asset-buyer/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "6.2.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "6.2.0-beta.0",
"changes": [

4
packages/asset-buyer/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v6.2.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v6.2.0-beta.0 - _October 3, 2019_
* Dependencies updated

704
packages/asset-buyer/docs/reference.mdx
View File

File diff suppressed because it is too large Load Diff

9
packages/asset-swapper/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "2.1.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "2.1.0-beta.0",
"changes": [

4
packages/asset-swapper/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v2.1.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v2.1.0-beta.0 - _October 3, 2019_
* Dependencies updated

5142
packages/asset-swapper/docs/reference.mdx
View File

File diff suppressed because it is too large Load Diff

3
packages/base-contract/CHANGELOG.json
View File

@ -10,7 +10,8 @@
"note": "Remove duplicate types `IndexedFilterValues`, `DecodedLogEvent`, `EventCallback`",
"pr": 2243
}
]
],
"timestamp": 1573001598
},
{
"version": "5.5.0-beta.0",

5
packages/base-contract/CHANGELOG.md
View File

@ -5,6 +5,11 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v5.5.0-beta.1 - _November 6, 2019_
* Make `evmExecAsync` protected and rename to `_evmExecAsync` (#2243)
* Remove duplicate types `IndexedFilterValues`, `DecodedLogEvent`, `EventCallback` (#2243)
## v5.5.0-beta.0 - _October 3, 2019_
* Automatically decode and throw rich reverts in `_throwIfRevertWithReasonCallResult` (#1761)

9
packages/connect/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "5.1.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "5.1.0-beta.0",
"changes": [

4
packages/connect/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v5.1.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v5.1.0-beta.0 - _October 3, 2019_
* Dependencies updated

298
packages/connect/docs/reference.mdx
View File

@ -1,196 +1,73 @@
# Class: HttpClient
This class includes all the functionality related to interacting with a set of HTTP endpoints
that implement the standard relayer API v2
## Constructors
\+ **new HttpClient**(`url`: string): *[HttpClient](#class-httpclient)*
*Defined in [connect/src/http_client.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/connect/src/http_client.ts#L44)*
Instantiates a new HttpClient instance
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`url` | string | The relayer API base HTTP url you would like to interact with |
**Returns:** *[HttpClient](#class-httpclient)*
An instance of HttpClient
## Methods
### getAssetPairsAsync
▸ **getAssetPairsAsync**(`requestOpts?`: `RequestOpts` & `AssetPairsRequestOpts` & `PagedRequestOpts`): *`Promise<AssetPairsResponse>`*
*Defined in [connect/src/http_client.ts:59](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/connect/src/http_client.ts#L59)*
Retrieve assetData pair info from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`requestOpts?` | `RequestOpts` & `AssetPairsRequestOpts` & `PagedRequestOpts` | Options specifying assetData information to retrieve, page information, and network id. |
**Returns:** *`Promise<AssetPairsResponse>`*
The resulting AssetPairsResponse that match the request
## Type aliases
### AssetPairsResponse
Ƭ **AssetPairsResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*[AssetPairsItem](#interface-assetpairsitem)*›*
*Defined in [types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L416)*
___
### getFeeRecipientsAsync
▸ **getFeeRecipientsAsync**(`requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise<FeeRecipientsResponse>`*
*Defined in [connect/src/http_client.ts:160](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/connect/src/http_client.ts#L160)*
Retrieve the list of fee recipient addresses used by the relayer.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`requestOpts?` | `RequestOpts` & `PagedRequestOpts` | Options specifying page information, and network id. |
**Returns:** *`Promise<FeeRecipientsResponse>`*
### FeeRecipientsResponse
The resulting FeeRecipientsResponse
Ƭ **FeeRecipientsResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*string*›*
*Defined in [types/src/index.ts:484](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L484)*
___
### getOrderAsync
▸ **getOrderAsync**(`orderHash`: string, `requestOpts?`: [RequestOpts](#interface-requestopts)): *`Promise<APIOrder>`*
*Defined in [connect/src/http_client.ts:99](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/connect/src/http_client.ts#L99)*
Retrieve a specific order from the API
**Parameters:**
### OrdersResponse
Name | Type | Description |
------ | ------ | ------ |
`orderHash` | string | An orderHash generated from the desired order |
`requestOpts?` | [RequestOpts](#interface-requestopts) | - |
Ƭ **OrdersResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*[APIOrder](#interface-apiorder)*›*
**Returns:** *`Promise<APIOrder>`*
The APIOrder that matches the supplied orderHash
*Defined in [types/src/index.ts:404](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L404)*
___
### getOrderConfigAsync
▸ **getOrderConfigAsync**(`request`: `OrderConfigRequest`, `requestOpts?`: [RequestOpts](#interface-requestopts)): *`Promise<OrderConfigResponse>`*
*Defined in [connect/src/http_client.ts:139](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/connect/src/http_client.ts#L139)*
Retrieve fee information from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`request` | `OrderConfigRequest` | A OrderConfigRequest instance describing the specific fees to retrieve |
`requestOpts?` | [RequestOpts](#interface-requestopts) | Options specifying network id. |
**Returns:** *`Promise<OrderConfigResponse>`*
The resulting OrderConfigResponse that matches the request
___
### getOrderbookAsync
▸ **getOrderbookAsync**(`request`: `OrderbookRequest`, `requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise<OrderbookResponse>`*
*Defined in [connect/src/http_client.ts:117](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/connect/src/http_client.ts#L117)*
Retrieve an orderbook from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`request` | `OrderbookRequest` | An OrderbookRequest instance describing the specific orderbook to retrieve |
`requestOpts?` | `RequestOpts` & `PagedRequestOpts` | Options specifying page information, and network id. |
**Returns:** *`Promise<OrderbookResponse>`*
The resulting OrderbookResponse that matches the request
___
### getOrdersAsync
▸ **getOrdersAsync**(`requestOpts?`: `RequestOpts` & `OrdersRequestOpts` & `PagedRequestOpts`): *`Promise<OrdersResponse>`*
*Defined in [connect/src/http_client.ts:79](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/connect/src/http_client.ts#L79)*
Retrieve orders from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`requestOpts?` | `RequestOpts` & `OrdersRequestOpts` & `PagedRequestOpts` | Options specifying orders to retrieve and page information, page information, and network id. |
**Returns:** *`Promise<OrdersResponse>`*
The resulting OrdersResponse that match the request
___
### submitOrderAsync
▸ **submitOrderAsync**(`signedOrder`: `SignedOrder`, `requestOpts?`: [RequestOpts](#interface-requestopts)): *`Promise<void>`*
*Defined in [connect/src/http_client.ts:177](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/connect/src/http_client.ts#L177)*
Submit a signed order to the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`signedOrder` | `SignedOrder` | A SignedOrder instance to submit |
`requestOpts?` | [RequestOpts](#interface-requestopts) | Options specifying network id. |
**Returns:** *`Promise<void>`*
<hr />
@ -209,7 +86,7 @@ Name | Type | Description |
• **metaData**: *object*
*Defined in [types/src/index.ts:408](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L408)*
*Defined in [types/src/index.ts:408](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L408)*
___
@ -217,7 +94,7 @@ ___
• **order**: *[SignedOrder](#class-signedorder)*
*Defined in [types/src/index.ts:407](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L407)*
*Defined in [types/src/index.ts:407](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L407)*
<hr />
@ -308,6 +185,8 @@ ___
@ -320,7 +199,7 @@ ___
• **page**? : *undefined | number*
*Defined in [types/src/index.ts:491](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L491)*
*Defined in [types/src/index.ts:491](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L491)*
___
@ -328,7 +207,7 @@ ___
• **perPage**? : *undefined | number*
*Defined in [types/src/index.ts:492](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L492)*
*Defined in [types/src/index.ts:492](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L492)*
<hr />
@ -345,7 +224,7 @@ ___
• **page**: *number*
*Defined in [types/src/index.ts:459](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L459)*
*Defined in [types/src/index.ts:459](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L459)*
___
@ -353,7 +232,7 @@ ___
• **perPage**: *number*
*Defined in [types/src/index.ts:460](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L460)*
*Defined in [types/src/index.ts:460](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L460)*
___
@ -361,7 +240,7 @@ ___
• **records**: *`T`[]*
*Defined in [types/src/index.ts:461](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L461)*
*Defined in [types/src/index.ts:461](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L461)*
___
@ -369,7 +248,7 @@ ___
• **total**: *number*
*Defined in [types/src/index.ts:458](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L458)*
*Defined in [types/src/index.ts:458](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L458)*
<hr />
@ -386,10 +265,12 @@ ___
• **networkId**? : *undefined | number*
*Defined in [types/src/index.ts:487](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L487)*
*Defined in [types/src/index.ts:487](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L487)*
<hr />
# Interface: SignedOrder
@ -401,7 +282,7 @@ ___
*Inherited from [Order](#interface-order).[chainId](#chainid)*
*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L14)*
*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L14)*
___
@ -411,7 +292,7 @@ ___
*Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)*
*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L15)*
*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L15)*
___
@ -421,7 +302,7 @@ ___
*Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)*
*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L24)*
*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L24)*
___
@ -431,7 +312,7 @@ ___
*Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)*
*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L18)*
*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L18)*
___
@ -441,7 +322,7 @@ ___
*Inherited from [Order](#interface-order).[makerAddress](#makeraddress)*
*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L16)*
*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L16)*
___
@ -451,7 +332,7 @@ ___
*Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)*
*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L20)*
*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L20)*
___
@ -461,7 +342,7 @@ ___
*Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)*
*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L26)*
*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L26)*
___
@ -471,7 +352,7 @@ ___
*Inherited from [Order](#interface-order).[makerFee](#makerfee)*
*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L22)*
*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L22)*
___
@ -481,7 +362,7 @@ ___
*Inherited from [Order](#interface-order).[makerFeeAssetData](#makerfeeassetdata)*
*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L28)*
*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L28)*
___
@ -491,7 +372,7 @@ ___
*Inherited from [Order](#interface-order).[salt](#salt)*
*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L25)*
*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L25)*
___
@ -501,7 +382,7 @@ ___
*Inherited from [Order](#interface-order).[senderAddress](#senderaddress)*
*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L19)*
*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L19)*
___
@ -509,7 +390,7 @@ ___
• **signature**: *string*
*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L33)*
*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L33)*
___
@ -519,7 +400,7 @@ ___
*Inherited from [Order](#interface-order).[takerAddress](#takeraddress)*
*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L17)*
*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L17)*
___
@ -529,7 +410,7 @@ ___
*Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)*
*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L21)*
*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L21)*
___
@ -539,7 +420,7 @@ ___
*Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)*
*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L27)*
*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L27)*
___
@ -549,7 +430,7 @@ ___
*Inherited from [Order](#interface-order).[takerFee](#takerfee)*
*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L23)*
*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L23)*
___
@ -559,7 +440,7 @@ ___
*Inherited from [Order](#interface-order).[takerFeeAssetData](#takerfeeassetdata)*
*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L29)*
*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L29)*
<hr />
@ -610,6 +491,10 @@ ___
<hr />
<hr />
@ -622,13 +507,13 @@ ___
#### ▪ **ordersChannelFactory**: *object*
*Defined in [connect/src/orders_channel_factory.ts:7](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/connect/src/orders_channel_factory.ts#L7)*
*Defined in [connect/src/orders_channel_factory.ts:7](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/connect/src/orders_channel_factory.ts#L7)*
#### createWebSocketOrdersChannelAsync
▸ **createWebSocketOrdersChannelAsync**(`url`: string, `handler`: [OrdersChannelHandler](#interface-orderschannelhandler)): *`Promise<OrdersChannel>`*
*Defined in [connect/src/orders_channel_factory.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/connect/src/orders_channel_factory.ts#L15)*
*Defined in [connect/src/orders_channel_factory.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/connect/src/orders_channel_factory.ts#L15)*
Instantiates a new WebSocketOrdersChannel instance
@ -645,52 +530,3 @@ An OrdersChannel Promise
<hr />
<hr />
## Type aliases
### AssetPairsResponse
Ƭ **AssetPairsResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*[AssetPairsItem](#interface-assetpairsitem)*›*
*Defined in [types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L416)*
___
### FeeRecipientsResponse
Ƭ **FeeRecipientsResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*string*›*
*Defined in [types/src/index.ts:484](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L484)*
___
### OrdersResponse
Ƭ **OrdersResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*[APIOrder](#interface-apiorder)*›*
*Defined in [types/src/index.ts:404](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L404)*
___

5
packages/contract-addresses/CHANGELOG.json
View File

@ -1,6 +1,6 @@
[
{
"version": "3.4.0-beta.0",
"version": "3.3.0-beta.1",
"changes": [
{
"note": "Remove `readOnlyProxy` from addresses interface",
@ -14,7 +14,8 @@
"note": "Update `exchange`, `staking`, `stakingProxy`, `zeroExGovernor`, `assetProxyOwner`, and `erc20BridgeProxy` addresses for each tesnet",
"pr": 2296
}
]
],
"timestamp": 1573001598
},
{
"version": "3.3.0-beta.0",

8
packages/contract-addresses/CHANGELOG.md
View File

@ -5,9 +5,17 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v3.3.0-beta.1 - _November 6, 2019_
* Remove `readOnlyProxy` from addresses interface (#2295)
* Add `zeroExGovernor` and `erc20BridgeProxy` to addresses interface (#2296)
* Update `exchange`, `staking`, `stakingProxy`, `zeroExGovernor`, `assetProxyOwner`, and `erc20BridgeProxy` addresses for each tesnet (#2296)
## v3.3.0-beta.0 - _October 3, 2019_
* Removed `getNetworkIdByExchangeAddressOrThrow`. It's not needed with V3 tooling. (#2170)
* Add `zrxVault`, `readOnlyProxy`, `staking`, and `stakingProxy` schema with addresses for each tesnet (#2224)
* Update `assetProxyOwner` address for each testnet (#2224)
## v3.2.0 - _September 17, 2019_

9
packages/contract-artifacts/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "2.3.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "2.3.0-beta.0",
"changes": [

4
packages/contract-artifacts/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v2.3.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v2.3.0-beta.0 - _October 3, 2019_
* Use V3 contracts (#2181)

9
packages/contract-wrappers/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "12.2.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "12.2.0-beta.0",
"changes": [

4
packages/contract-wrappers/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v12.2.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v12.2.0-beta.0 - _October 3, 2019_
* Use new `Order` and `ZeroExTransaction` structures with `domain` field (#1742)

17730
packages/contract-wrappers/docs/reference.mdx
View File

File diff suppressed because one or more lines are too long

9
packages/contracts-gen/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "1.1.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "1.1.0-beta.0",
"changes": [

4
packages/contracts-gen/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v1.1.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v1.1.0-beta.0 - _October 3, 2019_
* Generate boilerplate for all contracts if none are specified or if all contracts identifier is used (#2055)

9
packages/dev-utils/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "2.4.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "2.4.0-beta.0",
"changes": [

4
packages/dev-utils/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v2.4.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v2.4.0-beta.0 - _October 3, 2019_
* `revertWith` mocha extensions now accept Promise-like objects instead of just Promises (#2031)

9
packages/ethereum-types/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "2.2.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "2.2.0-beta.0",
"changes": [

4
packages/ethereum-types/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v2.2.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v2.2.0-beta.0 - _October 3, 2019_
* Add `RevertErrorAbi` interface as part of `AbiDefinition` types (#1761)

1022
packages/ethereum-types/docs/reference.mdx
View File

File diff suppressed because it is too large Load Diff

9
packages/json-schemas/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "4.1.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "4.1.0-beta.0",
"changes": [

4
packages/json-schemas/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v4.1.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v4.1.0-beta.0 - _October 3, 2019_
* Add `eip712DomainSchema` schema (#1742)

8
packages/json-schemas/docs/reference.mdx
View File

@ -9,7 +9,7 @@ A validator for [JSON-schemas](http://json-schema.org/)
\+ **new SchemaValidator**(): *[SchemaValidator](#class-schemavalidator)*
*Defined in [schema_validator.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/json-schemas/src/schema_validator.ts#L15)*
*Defined in [schema_validator.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/json-schemas/src/schema_validator.ts#L15)*
Instantiates a SchemaValidator instance
@ -21,7 +21,7 @@ Instantiates a SchemaValidator instance
▸ **addSchema**(`schema`: `Schema`): *void*
*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/json-schemas/src/schema_validator.ts#L32)*
*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/json-schemas/src/schema_validator.ts#L32)*
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
@ -41,7 +41,7 @@ ___
▸ **isValid**(`instance`: any, `schema`: `Schema`): *boolean*
*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/json-schemas/src/schema_validator.ts#L57)*
*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/json-schemas/src/schema_validator.ts#L57)*
Check whether an instance properly adheres to a JSON schema
@ -62,7 +62,7 @@ ___
▸ **validate**(`instance`: any, `schema`: `Schema`): *`ValidatorResult`*
*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/json-schemas/src/schema_validator.ts#L46)*
*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/json-schemas/src/schema_validator.ts#L46)*
Validate the JS object conforms to a specific JSON schema

3
packages/migrations/CHANGELOG.json
View File

@ -6,7 +6,8 @@
"note": "Update all contract deployments to pass the actual chain ID (rather than the network ID) via the newly modified @0x/utils/provider_utils",
"pr": 2270
}
]
],
"timestamp": 1573001598
},
{
"version": "4.4.0-beta.0",

4
packages/migrations/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v4.4.0-beta.1 - _November 6, 2019_
* Update all contract deployments to pass the actual chain ID (rather than the network ID) via the newly modified @0x/utils/provider_utils (#2270)
## v4.4.0-beta.0 - _October 3, 2019_
* Update Coordinator and Exchange deployments to pass `chainId` (#1742)

302
packages/migrations/docs/reference.mdx
View File

@ -1,5 +1,25 @@
# Interface: GanacheProvider
## Methods
### sendAsync
▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void*
*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L14)*
**Parameters:**
Name | Type |
------ | ------ |
`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) |
`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) |
**Returns:** *void*
<hr />
@ -17,7 +37,7 @@
• **assetProxyOwner**: *string*
*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L9)*
*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L10)*
___
@ -25,7 +45,7 @@ ___
• **coordinator**: *string*
*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L14)*
*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L16)*
___
@ -33,7 +53,7 @@ ___
• **coordinatorRegistry**: *string*
*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L13)*
*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L15)*
___
@ -41,7 +61,7 @@ ___
• **devUtils**: *string*
*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L18)*
*Defined in [contract-addresses/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L20)*
___
@ -49,7 +69,7 @@ ___
• **dutchAuction**: *string*
*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L12)*
*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L14)*
___
@ -57,7 +77,15 @@ ___
• **erc1155Proxy**: *string*
*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L17)*
*Defined in [contract-addresses/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L19)*
___
### erc20BridgeProxy
• **erc20BridgeProxy**: *string*
*Defined in [contract-addresses/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L24)*
___
@ -65,7 +93,7 @@ ___
• **erc20Proxy**: *string*
*Defined in [contract-addresses/src/index.ts:4](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L4)*
*Defined in [contract-addresses/src/index.ts:4](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L4)*
___
@ -73,7 +101,7 @@ ___
• **erc721Proxy**: *string*
*Defined in [contract-addresses/src/index.ts:5](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L5)*
*Defined in [contract-addresses/src/index.ts:5](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L5)*
___
@ -81,7 +109,7 @@ ___
• **etherToken**: *string*
*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L7)*
*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L7)*
___
@ -89,7 +117,15 @@ ___
• **exchange**: *string*
*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L8)*
*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L9)*
___
### exchangeV2
• **exchangeV2**: *string*
*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L8)*
___
@ -97,7 +133,7 @@ ___
• **forwarder**: *string*
*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L10)*
*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L12)*
___
@ -105,7 +141,7 @@ ___
• **multiAssetProxy**: *string*
*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L15)*
*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L17)*
___
@ -113,7 +149,23 @@ ___
• **orderValidator**: *string*
*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L11)*
*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L13)*
___
### staking
• **staking**: *string*
*Defined in [contract-addresses/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L22)*
___
### stakingProxy
• **stakingProxy**: *string*
*Defined in [contract-addresses/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L23)*
___
@ -121,7 +173,15 @@ ___
• **staticCallProxy**: *string*
*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L16)*
*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L18)*
___
### zeroExGovernor
• **zeroExGovernor**: *string*
*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L11)*
___
@ -129,7 +189,15 @@ ___
• **zrxToken**: *string*
*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L6)*
*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L6)*
___
### zrxVault
• **zrxVault**: *string*
*Defined in [contract-addresses/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L21)*
<hr />
@ -178,7 +246,7 @@ ___
• **isEIP1193**: *boolean*
*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L73)*
*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L73)*
## Methods
@ -186,7 +254,7 @@ ___
▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this*
*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L75)*
*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L75)*
**Parameters:**
@ -210,7 +278,7 @@ ___
▸ **send**(`method`: string, `params?`: any[]): *`Promise<any>`*
*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L74)*
*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L74)*
**Parameters:**
@ -235,28 +303,8 @@ Name | Type |
# Interface: GanacheProvider
## Methods
### sendAsync
▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void*
*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L14)*
**Parameters:**
Name | Type |
------ | ------ |
`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) |
`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) |
**Returns:** *void*
<hr />
# Interface: JSONRPCRequestPayload
@ -268,7 +316,7 @@ Name | Type |
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L330)*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L330)*
___
@ -276,7 +324,7 @@ ___
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L331)*
*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L331)*
___
@ -284,7 +332,7 @@ ___
• **method**: *string*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L329)*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L329)*
___
@ -292,7 +340,7 @@ ___
• **params**: *any[]*
*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L328)*
*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L328)*
<hr />
@ -305,7 +353,7 @@ ___
• **code**: *number*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L336)*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L336)*
___
@ -313,7 +361,7 @@ ___
• **message**: *string*
*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L335)*
*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L335)*
<hr />
@ -326,7 +374,7 @@ ___
• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)*
*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L343)*
*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L343)*
___
@ -334,7 +382,7 @@ ___
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L341)*
*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L341)*
___
@ -342,7 +390,7 @@ ___
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L342)*
*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L342)*
___
@ -350,7 +398,7 @@ ___
• **result**: *any*
*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L340)*
*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L340)*
<hr />
@ -405,7 +453,7 @@ ___
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)*
*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L393)*
*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L393)*
___
@ -413,7 +461,7 @@ ___
• **from**: *string*
*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L398)*
*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L398)*
___
@ -423,7 +471,7 @@ ___
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)*
*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L391)*
*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L391)*
___
@ -433,7 +481,7 @@ ___
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)*
*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L392)*
*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L392)*
___
@ -443,7 +491,7 @@ ___
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)*
*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L394)*
*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L394)*
___
@ -453,7 +501,7 @@ ___
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)*
*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L389)*
*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L389)*
___
@ -463,7 +511,7 @@ ___
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)*
*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L390)*
*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L390)*
<hr />
@ -478,7 +526,7 @@ ___
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)*
*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L393)*
*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L393)*
___
@ -488,7 +536,7 @@ ___
*Inherited from [TxData](#interface-txdata).[from](#from)*
*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L398)*
*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L398)*
___
@ -498,7 +546,7 @@ ___
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)*
*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L391)*
*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L391)*
___
@ -508,7 +556,7 @@ ___
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)*
*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L392)*
*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L392)*
___
@ -518,7 +566,7 @@ ___
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)*
*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L394)*
*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L394)*
___
@ -528,7 +576,7 @@ ___
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)*
*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L389)*
*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L389)*
___
@ -538,7 +586,7 @@ ___
*Overrides [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[value](#optional-value)*
*Defined in [ethereum-types/src/index.ts:442](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L442)*
*Defined in [ethereum-types/src/index.ts:442](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L442)*
<hr />
@ -555,7 +603,7 @@ This interface allowed sending synchonous requests, support for which was later
▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md)): *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)*
*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L45)*
*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L45)*
**Parameters:**
@ -571,7 +619,7 @@ ___
▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void*
*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L44)*
*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L44)*
**Parameters:**
@ -597,7 +645,7 @@ before the first attempts to conform to EIP1193
▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void*
*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L54)*
*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L54)*
**Parameters:**
@ -623,7 +671,7 @@ however it does not conform entirely.
▸ **send**(`method`: string, `params?`: any[]): *`Promise<any>`*
*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L63)*
*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L63)*
**Parameters:**
@ -649,7 +697,7 @@ add here
• **isMetaMask**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L31)*
*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L31)*
___
@ -657,7 +705,7 @@ ___
• **isParity**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L32)*
*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L32)*
___
@ -665,7 +713,7 @@ ___
• **isZeroExProvider**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L30)*
*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L30)*
## Methods
@ -673,7 +721,7 @@ ___
▸ **enable**(): *`Promise<void>`*
*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L34)*
*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L34)*
**Returns:** *`Promise<void>`*
@ -683,7 +731,7 @@ ___
▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void*
*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L35)*
*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L35)*
**Parameters:**
@ -700,7 +748,7 @@ ___
▸ **stop**(): *void*
*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L33)*
*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L33)*
**Returns:** *void*
@ -709,13 +757,63 @@ ___
## Functions
### runMigrationsAsync
▸ **runMigrationsAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `TxData`): *`Promise<ContractAddresses>`*
*Defined in [migrations/src/migration.ts:49](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/migrations/src/migration.ts#L49)*
Creates and deploys all the contracts that are required for the latest
version of the 0x protocol.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider instance. Your provider instance should connect to the testnet you want to deploy to. |
`txDefaults` | `TxData` | Default transaction values to use when deploying contracts (e.g., specify the desired contract creator with the `from` parameter). |
**Returns:** *`Promise<ContractAddresses>`*
The addresses of the contracts that were deployed.
___
### runMigrationsOnceAsync
▸ **runMigrationsOnceAsync**(`provider`: `Web3ProviderEngine`, `txDefaults`: `TxData`): *`Promise<ContractAddresses>`*
*Defined in [migrations/src/migration.ts:317](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/migrations/src/migration.ts#L317)*
Exactly like runMigrationsAsync but will only run the migrations the first
time it is called. Any subsequent calls will return the cached contract
addresses.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`provider` | `Web3ProviderEngine` | Web3 provider instance. Your provider instance should connect to the testnet you want to deploy to. |
`txDefaults` | `TxData` | Default transaction values to use when deploying contracts (e.g., specify the desired contract creator with the `from` parameter). |
**Returns:** *`Promise<ContractAddresses>`*
The addresses of the contracts that were deployed.
<hr />
## Functions
### getContractAddressesForNetworkOrThrow
▸ **getContractAddressesForNetworkOrThrow**(`networkId`: [NetworkId](#enumeration-networkid)): *[ContractAddresses](#interface-contractaddresses)*
*Defined in [contract-addresses/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L128)*
*Defined in [contract-addresses/src/index.ts:164](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L164)*
Used to get addresses of contracts that have been deployed to either the
Ethereum mainnet or a supported testnet. Throws if there are no known
@ -755,7 +853,7 @@ given networkId.
Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"*
*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L70)*
*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L70)*
Interface for providers that conform to EIP 1193
Source: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md
@ -772,7 +870,7 @@ ___
Ƭ **JSONRPCErrorCallback**: *function*
*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L3)*
*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L3)*
#### Type declaration:
@ -801,7 +899,7 @@ ___
Ƭ **SupportedProvider**: *[Web3JsProvider](_ethereum_types_src_index_.md#web3jsprovider) | [GanacheProvider](#interface-ganacheprovider) | [EIP1193Provider](#interface-eip1193provider) | [ZeroExProvider](#interface-zeroexprovider)*
*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L9)*
*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L9)*
Do not create your own provider. Use an existing provider from a Web3 or ProviderEngine library
Read more about Providers in the guides section of the 0x docs.
@ -816,57 +914,7 @@ ___
Ƭ **Web3JsProvider**: *[Web3JsV1Provider](#interface-web3jsv1provider) | [Web3JsV2Provider](#interface-web3jsv2provider) | [Web3JsV3Provider](#interface-web3jsv3provider)*
*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L11)*
<hr />
## Functions
### runMigrationsAsync
▸ **runMigrationsAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `TxData`): *`Promise<ContractAddresses>`*
*Defined in [migrations/src/migration.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/migrations/src/migration.ts#L48)*
Creates and deploys all the contracts that are required for the latest
version of the 0x protocol.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider instance. Your provider instance should connect to the testnet you want to deploy to. |
`txDefaults` | `TxData` | Default transaction values to use when deploying contracts (e.g., specify the desired contract creator with the `from` parameter). |
**Returns:** *`Promise<ContractAddresses>`*
The addresses of the contracts that were deployed.
___
### runMigrationsOnceAsync
▸ **runMigrationsOnceAsync**(`provider`: `Web3ProviderEngine`, `txDefaults`: `TxData`): *`Promise<ContractAddresses>`*
*Defined in [migrations/src/migration.ts:335](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/migrations/src/migration.ts#L335)*
Exactly like runMigrationsAsync but will only run the migrations the first
time it is called. Any subsequent calls will return the cached contract
addresses.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`provider` | `Web3ProviderEngine` | Web3 provider instance. Your provider instance should connect to the testnet you want to deploy to. |
`txDefaults` | `TxData` | Default transaction values to use when deploying contracts (e.g., specify the desired contract creator with the `from` parameter). |
**Returns:** *`Promise<ContractAddresses>`*
The addresses of the contracts that were deployed.
*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L11)*
<hr />

3
packages/order-utils/CHANGELOG.json
View File

@ -6,7 +6,8 @@
"note": "Remove `TransferFailedError` from `ForwarderRevertErrors`.",
"pr": 2309
}
]
],
"timestamp": 1573001598
},
{
"version": "8.5.0-beta.0",

6
packages/order-utils/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v8.5.0-beta.1 - _November 6, 2019_
* Remove `TransferFailedError` from `ForwarderRevertErrors`. (#2309)
## v8.5.0-beta.0 - _October 3, 2019_
* Add `chainId` `OrderValidationUtils`, `OrderFactory` (#1742)
@ -34,6 +38,8 @@ CHANGELOG
* Remove `validateOrderFillableOrThrowAsync`, `simpleValidateOrderFillableOrThrowAsync`, `validateMakerTransferThrowIfInvalidAsync` (#2181)
* Add `PreviousEpochNotFinalizedError` to `StakingRevertErrors`. (#2155)
* Add `InvalidMinimumPoolStake` to `StakingRevertErrors.InvalidParamValueErrorCode`. (#2155)
* Renamed `OnlyCallableByPoolOperatorOrMakerError` to `OnlyCallableByPoolOperatorError`. (#2250)
* Removed protocol fee != 0 error. (#2278)
## v8.4.0 - _September 17, 2019_

859
packages/order-utils/docs/reference.mdx
View File

File diff suppressed because it is too large Load Diff

9
packages/orderbook/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "0.1.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "0.1.0-beta.0",
"changes": [

4
packages/orderbook/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v0.1.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v0.1.0-beta.0 - _October 3, 2019_
* Dependencies updated

9
packages/sol-compiler/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "3.2.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "3.2.0-beta.0",
"changes": [

4
packages/sol-compiler/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v3.2.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v3.2.0-beta.0 - _October 3, 2019_
* Convert `getContractNamesToCompile` to public function of `Compiler` class (#2055)

302
packages/sol-compiler/docs/reference.mdx
View File

@ -1,79 +1,14 @@
# Class: Compiler
The Compiler facilitates compiling Solidity smart contracts and saves the results
to artifact files.
## Constructors
\+ **new Compiler**(`opts?`: [CompilerOptions](#interface-compileroptions)): *[Compiler](#class-compiler)*
*Defined in [sol-compiler/src/compiler.ts:94](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-compiler/src/compiler.ts#L94)*
Instantiates a new instance of the Compiler class.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`opts?` | [CompilerOptions](#interface-compileroptions) | Optional compiler options |
**Returns:** *[Compiler](#class-compiler)*
An instance of the Compiler class.
## Methods
### compileAsync
▸ **compileAsync**(): *`Promise<void>`*
*Defined in [sol-compiler/src/compiler.ts:132](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-compiler/src/compiler.ts#L132)*
Compiles selected Solidity files found in `contractsDir` and writes JSON artifacts to `artifactsDir`.
**Returns:** *`Promise<void>`*
___
### getCompilerOutputsAsync
▸ **getCompilerOutputsAsync**(): *`Promise<StandardOutput[]>`*
*Defined in [sol-compiler/src/compiler.ts:145](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-compiler/src/compiler.ts#L145)*
Compiles Solidity files specified during instantiation, and returns the
compiler output given by solc. Return value is an array of outputs:
Solidity modules are batched together by version required, and each
element of the returned array corresponds to a compiler version, and
each element contains the output for all of the modules compiled with
that version.
**Returns:** *`Promise<StandardOutput[]>`*
___
### getContractNamesToCompile
▸ **getContractNamesToCompile**(): *string[]*
*Defined in [sol-compiler/src/compiler.ts:186](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-compiler/src/compiler.ts#L186)*
Gets a list of contracts to compile.
**Returns:** *string[]*
___
### watchAsync
▸ **watchAsync**(): *`Promise<void>`*
*Defined in [sol-compiler/src/compiler.ts:149](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-compiler/src/compiler.ts#L149)*
**Returns:** *`Promise<void>`*
<hr />
@ -88,14 +23,6 @@ ___
# Interface: CompilerOptions
@ -118,7 +45,7 @@ contracts to compile with the the version specified here.
• **artifactsDir**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:731](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L731)*
*Defined in [ethereum-types/src/index.ts:731](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L731)*
___
@ -126,7 +53,7 @@ ___
• **compilerSettings**? : *[CompilerSettings](#class-compilersettings)*
*Defined in [ethereum-types/src/index.ts:732](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L732)*
*Defined in [ethereum-types/src/index.ts:732](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L732)*
___
@ -134,7 +61,7 @@ ___
• **contracts**? : *string[] | "*"*
*Defined in [ethereum-types/src/index.ts:733](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L733)*
*Defined in [ethereum-types/src/index.ts:733](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L733)*
___
@ -142,7 +69,7 @@ ___
• **contractsDir**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:730](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L730)*
*Defined in [ethereum-types/src/index.ts:730](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L730)*
___
@ -150,7 +77,7 @@ ___
• **isOfflineMode**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:735](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L735)*
*Defined in [ethereum-types/src/index.ts:735](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L735)*
___
@ -158,7 +85,7 @@ ___
• **solcVersion**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:736](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L736)*
*Defined in [ethereum-types/src/index.ts:736](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L736)*
___
@ -166,7 +93,7 @@ ___
• **useDockerisedSolc**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:734](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L734)*
*Defined in [ethereum-types/src/index.ts:734](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L734)*
<hr />
@ -181,7 +108,7 @@ ___
• **evmVersion**? : *"homestead" | "tangerineWhistle" | "spuriousDragon" | "byzantium" | "constantinople"*
*Defined in [ethereum-types/src/index.ts:689](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L689)*
*Defined in [ethereum-types/src/index.ts:689](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L689)*
___
@ -189,7 +116,7 @@ ___
• **libraries**? : *undefined | object*
*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L691)*
*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L691)*
___
@ -197,7 +124,7 @@ ___
• **metadata**? : *[CompilerSettingsMetadata](#class-compilersettingsmetadata)*
*Defined in [ethereum-types/src/index.ts:690](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L690)*
*Defined in [ethereum-types/src/index.ts:690](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L690)*
___
@ -205,7 +132,7 @@ ___
• **optimizer**? : *[OptimizerSettings](#class-optimizersettings)*
*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L688)*
*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L688)*
___
@ -213,7 +140,7 @@ ___
• **outputSelection**: *object*
*Defined in [ethereum-types/src/index.ts:696](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L696)*
*Defined in [ethereum-types/src/index.ts:696](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L696)*
#### Type declaration:
@ -227,7 +154,7 @@ ___
• **remappings**? : *string[]*
*Defined in [ethereum-types/src/index.ts:687](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L687)*
*Defined in [ethereum-types/src/index.ts:687](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L687)*
<hr />
@ -240,7 +167,7 @@ ___
• **useLiteralContent**: *true*
*Defined in [ethereum-types/src/index.ts:704](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L704)*
*Defined in [ethereum-types/src/index.ts:704](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L704)*
<hr />
@ -253,7 +180,7 @@ ___
• **inputs**: *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L103)*
*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L103)*
___
@ -261,7 +188,7 @@ ___
• **payable**: *boolean*
*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L104)*
*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L104)*
___
@ -269,7 +196,7 @@ ___
• **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)*
*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L105)*
*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L105)*
___
@ -277,7 +204,7 @@ ___
• **type**: *string*
*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L102)*
*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L102)*
<hr />
@ -296,7 +223,7 @@ ___
• **components**? : *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L137)*
*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L137)*
___
@ -304,7 +231,7 @@ ___
• **name**: *string*
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L135)*
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L135)*
___
@ -312,7 +239,7 @@ ___
• **type**: *string*
*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L136)*
*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L136)*
<hr />
@ -329,7 +256,7 @@ ___
• **author**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L628)*
*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L628)*
___
@ -337,7 +264,7 @@ ___
• **methods**: *object*
*Defined in [ethereum-types/src/index.ts:629](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L629)*
*Defined in [ethereum-types/src/index.ts:629](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L629)*
#### Type declaration:
@ -349,7 +276,7 @@ ___
• **title**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:627](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L627)*
*Defined in [ethereum-types/src/index.ts:627](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L627)*
<hr />
@ -364,7 +291,7 @@ ___
• **anonymous**: *boolean*
*Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L131)*
*Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L131)*
___
@ -372,7 +299,7 @@ ___
• **inputs**: *[EventParameter](#class-eventparameter)[]*
*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L130)*
*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L130)*
___
@ -380,7 +307,7 @@ ___
• **name**: *string*
*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L129)*
*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L129)*
___
@ -388,7 +315,7 @@ ___
• **type**: *string*
*Defined in [ethereum-types/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L128)*
*Defined in [ethereum-types/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L128)*
<hr />
@ -403,7 +330,7 @@ ___
*Inherited from [DataItem](#interface-dataitem).[components](#optional-components)*
*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L137)*
*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L137)*
___
@ -411,7 +338,7 @@ ___
• **indexed**: *boolean*
*Defined in [ethereum-types/src/index.ts:116](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L116)*
*Defined in [ethereum-types/src/index.ts:116](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L116)*
___
@ -421,7 +348,7 @@ ___
*Inherited from [DataItem](#interface-dataitem).[name](#name)*
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L135)*
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L135)*
___
@ -431,7 +358,7 @@ ___
*Inherited from [DataItem](#interface-dataitem).[type](#type)*
*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L136)*
*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L136)*
<hr />
@ -444,7 +371,7 @@ ___
• **object**: *string*
*Defined in [ethereum-types/src/index.ts:622](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L622)*
*Defined in [ethereum-types/src/index.ts:622](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L622)*
___
@ -452,7 +379,7 @@ ___
• **sourceMap**: *string*
*Defined in [ethereum-types/src/index.ts:623](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L623)*
*Defined in [ethereum-types/src/index.ts:623](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L623)*
<hr />
@ -465,7 +392,7 @@ ___
• **bytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)*
*Defined in [ethereum-types/src/index.ts:617](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L617)*
*Defined in [ethereum-types/src/index.ts:617](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L617)*
___
@ -473,7 +400,7 @@ ___
• **deployedBytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)*
*Defined in [ethereum-types/src/index.ts:618](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L618)*
*Defined in [ethereum-types/src/index.ts:618](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L618)*
<hr />
@ -486,7 +413,7 @@ ___
• **payable**: *boolean*
*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L112)*
*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L112)*
___
@ -494,13 +421,90 @@ ___
• **type**: *string*
*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L111)*
*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L111)*
<hr />
# Class: Compiler
The Compiler facilitates compiling Solidity smart contracts and saves the results
to artifact files.
## Constructors
\+ **new Compiler**(`opts?`: [CompilerOptions](#interface-compileroptions)): *[Compiler](#class-compiler)*
*Defined in [sol-compiler/src/compiler.ts:97](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-compiler/src/compiler.ts#L97)*
Instantiates a new instance of the Compiler class.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`opts?` | [CompilerOptions](#interface-compileroptions) | Optional compiler options |
**Returns:** *[Compiler](#class-compiler)*
An instance of the Compiler class.
## Methods
### compileAsync
▸ **compileAsync**(): *`Promise<void>`*
*Defined in [sol-compiler/src/compiler.ts:138](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-compiler/src/compiler.ts#L138)*
Compiles selected Solidity files found in `contractsDir` and writes JSON artifacts to `artifactsDir`.
**Returns:** *`Promise<void>`*
___
### getCompilerOutputsAsync
▸ **getCompilerOutputsAsync**(): *`Promise<StandardOutput[]>`*
*Defined in [sol-compiler/src/compiler.ts:151](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-compiler/src/compiler.ts#L151)*
Compiles Solidity files specified during instantiation, and returns the
compiler output given by solc. Return value is an array of outputs:
Solidity modules are batched together by version required, and each
element of the returned array corresponds to a compiler version, and
each element contains the output for all of the modules compiled with
that version.
**Returns:** *`Promise<StandardOutput[]>`*
___
### getContractNamesToCompile
▸ **getContractNamesToCompile**(): *string[]*
*Defined in [sol-compiler/src/compiler.ts:192](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-compiler/src/compiler.ts#L192)*
Gets a list of contracts to compile.
**Returns:** *string[]*
___
### watchAsync
▸ **watchAsync**(): *`Promise<void>`*
*Defined in [sol-compiler/src/compiler.ts:155](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-compiler/src/compiler.ts#L155)*
**Returns:** *`Promise<void>`*
<hr />
@ -525,7 +529,7 @@ ___
• **constant**: *boolean*
*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L94)*
*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L94)*
___
@ -533,7 +537,7 @@ ___
• **inputs**: *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L92)*
*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L92)*
___
@ -541,7 +545,7 @@ ___
• **name**: *string*
*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L91)*
*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L91)*
___
@ -549,7 +553,7 @@ ___
• **outputs**: *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L93)*
*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L93)*
___
@ -557,7 +561,7 @@ ___
• **payable**: *boolean*
*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L96)*
*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L96)*
___
@ -565,7 +569,7 @@ ___
• **stateMutability**: *[StateMutability](#statemutability)*
*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L95)*
*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L95)*
___
@ -573,7 +577,7 @@ ___
• **type**: *string*
*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L90)*
*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L90)*
<hr />
@ -586,7 +590,7 @@ ___
• **enabled**: *boolean*
*Defined in [ethereum-types/src/index.ts:708](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L708)*
*Defined in [ethereum-types/src/index.ts:708](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L708)*
___
@ -594,7 +598,7 @@ ___
• **runs**? : *undefined | number*
*Defined in [ethereum-types/src/index.ts:709](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L709)*
*Defined in [ethereum-types/src/index.ts:709](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L709)*
<hr />
@ -611,7 +615,7 @@ ___
• **arguments**? : *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L122)*
*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L122)*
___
@ -619,7 +623,7 @@ ___
• **name**: *string*
*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L121)*
*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L121)*
___
@ -627,7 +631,7 @@ ___
• **type**: *"error"*
*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L120)*
*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L120)*
<hr />
@ -640,7 +644,7 @@ ___
• **component**: *"general" | "ewasm"*
*Defined in [ethereum-types/src/index.ts:604](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L604)*
*Defined in [ethereum-types/src/index.ts:604](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L604)*
___
@ -648,7 +652,7 @@ ___
• **formattedMessage**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:607](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L607)*
*Defined in [ethereum-types/src/index.ts:607](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L607)*
___
@ -656,7 +660,7 @@ ___
• **message**: *string*
*Defined in [ethereum-types/src/index.ts:606](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L606)*
*Defined in [ethereum-types/src/index.ts:606](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L606)*
___
@ -664,7 +668,7 @@ ___
• **severity**: *[ErrorSeverity](#errorseverity)*
*Defined in [ethereum-types/src/index.ts:605](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L605)*
*Defined in [ethereum-types/src/index.ts:605](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L605)*
___
@ -672,7 +676,7 @@ ___
• **sourceLocation**? : *[SourceLocation](#class-sourcelocation)*
*Defined in [ethereum-types/src/index.ts:602](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L602)*
*Defined in [ethereum-types/src/index.ts:602](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L602)*
___
@ -680,7 +684,7 @@ ___
• **type**: *[ErrorType](#errortype)*
*Defined in [ethereum-types/src/index.ts:603](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L603)*
*Defined in [ethereum-types/src/index.ts:603](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L603)*
<hr />
@ -697,7 +701,7 @@ ___
• **abi**: *[ContractAbi](#contractabi)*
*Defined in [ethereum-types/src/index.ts:564](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L564)*
*Defined in [ethereum-types/src/index.ts:564](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L564)*
___
@ -705,7 +709,7 @@ ___
• **devdoc**? : *[DevdocOutput](#class-devdocoutput)*
*Defined in [ethereum-types/src/index.ts:566](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L566)*
*Defined in [ethereum-types/src/index.ts:566](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L566)*
___
@ -713,7 +717,7 @@ ___
• **evm**: *[EvmOutput](#class-evmoutput)*
*Defined in [ethereum-types/src/index.ts:565](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L565)*
*Defined in [ethereum-types/src/index.ts:565](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L565)*
<hr />
@ -726,7 +730,7 @@ ___
• **contracts**: *object*
*Defined in [ethereum-types/src/index.ts:578](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L578)*
*Defined in [ethereum-types/src/index.ts:578](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L578)*
#### Type declaration:
@ -740,7 +744,7 @@ ___
• **errors**: *[SolcError](#class-solcerror)[]*
*Defined in [ethereum-types/src/index.ts:570](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L570)*
*Defined in [ethereum-types/src/index.ts:570](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L570)*
___
@ -748,7 +752,7 @@ ___
• **sources**: *object*
*Defined in [ethereum-types/src/index.ts:571](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L571)*
*Defined in [ethereum-types/src/index.ts:571](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L571)*
#### Type declaration:
@ -779,7 +783,7 @@ ___
*Overrides [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)*
*Defined in [ethereum-types/src/index.ts:141](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L141)*
*Defined in [ethereum-types/src/index.ts:141](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L141)*
___
@ -789,7 +793,7 @@ ___
*Inherited from [DataItem](#interface-dataitem).[name](#name)*
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L135)*
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L135)*
___
@ -799,7 +803,7 @@ ___
*Inherited from [DataItem](#interface-dataitem).[type](#type)*
*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L136)*
*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L136)*
<hr />
@ -824,7 +828,7 @@ ___
Ƭ **AbiDefinition**: *[FunctionAbi](_ethereum_types_src_index_.md#functionabi) | [EventAbi](#interface-eventabi) | [RevertErrorAbi](#interface-reverterrorabi)*
*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L80)*
*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L80)*
___
@ -834,7 +838,7 @@ ___
Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"*
*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L84)*
*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L84)*
___
@ -842,7 +846,7 @@ ___
Ƭ **ContractAbi**: *[AbiDefinition](#abidefinition)[]*
*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L78)*
*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L78)*
___
@ -856,7 +860,7 @@ ___
Ƭ **ErrorSeverity**: *"error" | "warning"*
*Defined in [ethereum-types/src/index.ts:599](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L599)*
*Defined in [ethereum-types/src/index.ts:599](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L599)*
___
@ -864,7 +868,7 @@ ___
Ƭ **ErrorType**: *"JSONError" | "IOError" | "ParserError" | "DocstringParsingError" | "SyntaxError" | "DeclarationError" | "TypeError" | "UnimplementedFeatureError" | "InternalCompilerError" | "Exception" | "CompilerError" | "FatalError" | "Warning"*
*Defined in [ethereum-types/src/index.ts:585](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L585)*
*Defined in [ethereum-types/src/index.ts:585](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L585)*
___
@ -872,7 +876,7 @@ ___
Ƭ **FunctionAbi**: *[MethodAbi](#interface-methodabi) | [ConstructorAbi](#interface-constructorabi) | [FallbackAbi](#interface-fallbackabi)*
*Defined in [ethereum-types/src/index.ts:82](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L82)*
*Defined in [ethereum-types/src/index.ts:82](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L82)*
___
@ -884,7 +888,7 @@ ___
Ƭ **OutputField**: *"*" | "ast" | "legacyAST" | "abi" | "devdoc" | "userdoc" | "metadata" | "ir" | "evm.assembly" | "evm.legacyAssembly" | "evm.bytecode.object" | "evm.bytecode.opcodes" | "evm.bytecode.sourceMap" | "evm.bytecode.linkReferences" | "evm.deployedBytecode.object" | "evm.deployedBytecode.opcodes" | "evm.deployedBytecode.sourceMap" | "evm.deployedBytecode.linkReferences" | "evm.methodIdentifiers" | "evm.gasEstimates" | "ewasm.wast" | "ewasm.wasm"*
*Defined in [ethereum-types/src/index.ts:525](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L525)*
*Defined in [ethereum-types/src/index.ts:525](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L525)*
___
@ -892,7 +896,7 @@ ___
Ƭ **ParamDescription**: *string*
*Defined in [ethereum-types/src/index.ts:561](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L561)*
*Defined in [ethereum-types/src/index.ts:561](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L561)*
___
@ -902,7 +906,7 @@ ___
Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)*
*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L85)*
*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L85)*
___
@ -914,7 +918,3 @@ ___
<hr />

9
packages/sol-coverage/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "3.1.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "3.1.0-beta.0",
"changes": [

4
packages/sol-coverage/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v3.1.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v3.1.0-beta.0 - _October 3, 2019_
* Dependencies updated

768
packages/sol-coverage/docs/reference.mdx
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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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:330](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/packages/ethereum-types/src/index.ts#L340)*
<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/9fe6c196a/packages/sol-coverage/src/coverage_subprovider.ts#L44)*
*Defined in [sol-coverage/src/coverage_subprovider.ts:44](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/9fe6c196a/packages/sol-coverage/src/coverage_subprovider.ts#L78)*
*Defined in [sol-coverage/src/coverage_subprovider.ts:78](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/packages/ethereum-types/src/index.ts#L340)*
<hr />
@ -517,7 +595,7 @@ ___
*Overrides void*
*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L136)*
*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L136)*
___
@ -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/9fe6c196a/packages/sol-coverage/src/coverage_subprovider.ts#L31)*
*Defined in [sol-coverage/src/coverage_subprovider.ts:31](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/9fe6c196a/packages/sol-coverage/src/coverage_subprovider.ts#L33)*
*Defined in [sol-coverage/src/coverage_subprovider.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/9fe6c196a/packages/sol-coverage/src/coverage_subprovider.ts#L35)*
*Defined in [sol-coverage/src/coverage_subprovider.ts:35](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/9fe6c196a/packages/sol-coverage/src/coverage_subprovider.ts#L34)*
*Defined in [sol-coverage/src/coverage_subprovider.ts:34](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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 />

9
packages/sol-doc/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "2.1.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "2.1.0-beta.0",
"changes": [

4
packages/sol-doc/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v2.1.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v2.1.0-beta.0 - _October 3, 2019_
* Dependencies updated

9
packages/sol-profiler/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "3.2.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "3.2.0-beta.0",
"changes": [

4
packages/sol-profiler/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v3.2.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v3.2.0-beta.0 - _October 3, 2019_
* Dependencies updated

762
packages/sol-profiler/docs/reference.mdx
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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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:330](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/packages/ethereum-types/src/index.ts#L340)*
<hr />
# Class: ProfilerSubprovider
This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface.
@ -12,7 +376,7 @@ ProfilerSubprovider is used to profile Solidity code while running tests.
*Overrides void*
*Defined in [sol-profiler/src/profiler_subprovider.ts:30](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-profiler/src/profiler_subprovider.ts#L30)*
*Defined in [sol-profiler/src/profiler_subprovider.ts:30](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-profiler/src/profiler_subprovider.ts#L30)*
Instantiates a ProfilerSubprovider instance
@ -134,7 +498,7 @@ ___
▸ **writeProfilerOutputAsync**(): *`Promise<void>`*
*Defined in [sol-profiler/src/profiler_subprovider.ts:104](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-profiler/src/profiler_subprovider.ts#L104)*
*Defined in [sol-profiler/src/profiler_subprovider.ts:104](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-profiler/src/profiler_subprovider.ts#L104)*
Write the test profiler results to a file in Istanbul format.
@ -142,292 +506,6 @@ Write the test profiler 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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/packages/ethereum-types/src/index.ts#L340)*
<hr />
@ -515,7 +593,7 @@ ___
*Overrides void*
*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L136)*
*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L136)*
___
@ -575,6 +653,19 @@ Defined in ethereum-types/lib/index.d.ts:265
## Type aliases
@ -613,7 +704,7 @@ Defined in ethereum-types/lib/index.d.ts:265
▸ **profilerHandler**(`contractData`: `ContractData`, `subtrace`: [Subtrace](#subtrace), `pcToSourceRange`: object, `fileIndex`: number): *`Coverage`*
*Defined in [sol-profiler/src/profiler_subprovider.ts:118](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-profiler/src/profiler_subprovider.ts#L118)*
*Defined in [sol-profiler/src/profiler_subprovider.ts:118](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-profiler/src/profiler_subprovider.ts#L118)*
Computed partial coverage for a single file & subtrace for the purposes of
gas profiling.
@ -645,94 +736,3 @@ Partial istanbul coverage for that file & subtrace
<hr />
## Type aliases
## Type aliases
### Callback
Ƭ **Callback**: *function*
*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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 />

9
packages/sol-resolver/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "2.1.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "2.1.0-beta.0",
"changes": [

4
packages/sol-resolver/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v2.1.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v2.1.0-beta.0 - _October 3, 2019_
* Dependencies updated

9
packages/sol-trace/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "2.1.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "2.1.0-beta.0",
"changes": [

4
packages/sol-trace/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v2.1.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v2.1.0-beta.0 - _October 3, 2019_
* Dependencies updated

776
packages/sol-trace/docs/reference.mdx
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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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:330](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/packages/ethereum-types/src/index.ts#L340)*
<hr />
# Class: RevertTraceSubprovider
This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface.
@ -12,7 +376,7 @@ It is used to report call stack traces whenever a revert occurs.
*Overrides void*
*Defined in [sol-trace/src/revert_trace_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-trace/src/revert_trace_subprovider.ts#L27)*
*Defined in [sol-trace/src/revert_trace_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-trace/src/revert_trace_subprovider.ts#L27)*
Instantiates a RevertTraceSubprovider instance
@ -130,292 +494,6 @@ Stops trace collection
<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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/packages/ethereum-types/src/index.ts#L340)*
<hr />
@ -503,7 +581,7 @@ ___
*Overrides void*
*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L136)*
*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L136)*
___
@ -563,54 +641,6 @@ Defined in ethereum-types/lib/index.d.ts:265
<hr />
<hr />
<hr />
<hr />
## Type aliases
@ -624,78 +654,48 @@ Defined in ethereum-types/lib/index.d.ts:265
## Type aliases
### Callback
Ƭ **Callback**: *function*
*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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 />
<hr />
<hr />
<hr />

9
packages/sol-tracing-utils/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "6.1.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "6.1.0-beta.0",
"changes": [

4
packages/sol-tracing-utils/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v6.1.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v6.1.0-beta.0 - _October 3, 2019_
* Dependencies updated

9
packages/sra-spec/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "2.1.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "2.1.0-beta.0",
"changes": [

4
packages/sra-spec/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v2.1.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v2.1.0-beta.0 - _October 3, 2019_
* Dependencies updated

9
packages/subproviders/CHANGELOG.json
View File

@ -1,4 +1,13 @@
[
{
"version": "5.1.0-beta.1",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1573001598
},
{
"version": "5.1.0-beta.0",
"changes": [

4
packages/subproviders/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v5.1.0-beta.1 - _November 6, 2019_
* Dependencies updated
## v5.1.0-beta.0 - _October 3, 2019_
* Dependencies updated

562
packages/subproviders/docs/reference.mdx
View File

File diff suppressed because it is too large Load Diff

Some files were not shown because too many files have changed in this diff Show More