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-17 18:03:13 -05:00
parent 34538f2ced
commit cb5f9ba97d
110 changed files with 15001 additions and 34373 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -6,7 +6,8 @@
"note": "Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils",
"pr": 2330
}
]
],
"timestamp": 1574030254
},
{
"version": "2.3.0-beta.1",

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

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v2.3.0-beta.2 - _November 17, 2019_
* Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330)
## v2.3.0-beta.1 - _November 7, 2019_
* ERC20Wrapper and ERC1155ProxyWrapper constructors now require an instance of DevUtilsContract (#2034)

3
contracts/coordinator/CHANGELOG.json
View File

@ -14,7 +14,8 @@
"note": "Added dependency on @0x/contracts-utils",
"pr": 2321
}
]
],
"timestamp": 1574030254
},
{
"version": "2.1.0-beta.1",

6
contracts/coordinator/CHANGELOG.md
View File

@ -5,6 +5,12 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v2.1.0-beta.2 - _November 17, 2019_
* Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330)
* Introduced new export CoordinatorRevertErrors (#2321)
* Added dependency on @0x/contracts-utils (#2321)
## v2.1.0-beta.1 - _November 7, 2019_
* Dependencies updated

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

@ -14,7 +14,8 @@
"note": "Add new method getTransactionHash() to DevUtils contract",
"pr": 2321
}
]
],
"timestamp": 1574030254
},
{
"version": "0.1.0-beta.1",

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

@ -5,6 +5,12 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v0.1.0-beta.2 - _November 17, 2019_
* Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330)
* Add new method getOrderHash() to DevUtils contract (#2321)
* Add new method getTransactionHash() to DevUtils contract (#2321)
## v0.1.0-beta.1 - _November 7, 2019_
* Add `encodeStaticCallAssetData` and `decodeStaticCallAssetData` in LibAssetData (#2034)

3
contracts/erc1155/CHANGELOG.json
View File

@ -6,7 +6,8 @@
"note": "Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils",
"pr": 2330
}
]
],
"timestamp": 1574030254
},
{
"version": "1.2.0-beta.1",

4
contracts/erc1155/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v1.2.0-beta.2 - _November 17, 2019_
* Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330)
## v1.2.0-beta.1 - _November 7, 2019_
* Dependencies updated

3
contracts/erc20/CHANGELOG.json
View File

@ -6,7 +6,8 @@
"note": "Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils",
"pr": 2330
}
]
],
"timestamp": 1574030254
},
{
"version": "2.3.0-beta.1",

4
contracts/erc20/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v2.3.0-beta.2 - _November 17, 2019_
* Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330)
## v2.3.0-beta.1 - _November 7, 2019_
* Create `LibERC20Token` (#2309)

3
contracts/erc721/CHANGELOG.json
View File

@ -6,7 +6,8 @@
"note": "Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils",
"pr": 2330
}
]
],
"timestamp": 1574030254
},
{
"version": "2.2.0-beta.1",

4
contracts/erc721/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v2.2.0-beta.2 - _November 17, 2019_
* Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330)
## v2.2.0-beta.1 - _November 7, 2019_
* Dependencies updated

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

@ -10,7 +10,8 @@
"note": "Introduced new export ForwarderRevertErrors",
"pr": 2321
}
]
],
"timestamp": 1574030254
},
{
"version": "3.1.0-beta.1",

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

@ -5,6 +5,11 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v3.1.0-beta.2 - _November 17, 2019_
* Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330)
* Introduced new export ForwarderRevertErrors (#2321)
## v3.1.0-beta.1 - _November 7, 2019_
* Use `LibERC20Token` in `MixinAssets` (#2309)

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

@ -10,7 +10,8 @@
"note": "Introduced new export LibMathRevertErrors",
"pr": 2321
}
]
],
"timestamp": 1574030254
},
{
"version": "3.1.0-beta.1",

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

@ -5,6 +5,11 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v3.1.0-beta.2 - _November 17, 2019_
* Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330)
* Introduced new export LibMathRevertErrors (#2321)
## v3.1.0-beta.1 - _November 7, 2019_
* Dependencies updated

3
contracts/exchange/CHANGELOG.json
View File

@ -14,7 +14,8 @@
"note": "Round up in `marketBuyOrdersNoThrow()` so `marketBuyOrdersFillOrKill()` doesn't throw up.",
"pr": 2338
}
]
],
"timestamp": 1574030254
},
{
"version": "2.2.0-beta.1",

6
contracts/exchange/CHANGELOG.md
View File

@ -5,6 +5,12 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v2.2.0-beta.2 - _November 17, 2019_
* Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330)
* Introduced new export ExchangeRevertErrors (#2321)
* Round up in `marketBuyOrdersNoThrow()` so `marketBuyOrdersFillOrKill()` doesn't throw up. (#2338)
## v2.2.0-beta.1 - _November 7, 2019_
* LocalBalanceStore.create and constructor now require an instance of DevUtilsContract (#2304)

3
contracts/extensions/CHANGELOG.json
View File

@ -6,7 +6,8 @@
"note": "Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils",
"pr": 2330
}
]
],
"timestamp": 1574030254
},
{
"version": "4.1.0-beta.1",

4
contracts/extensions/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v4.1.0-beta.2 - _November 17, 2019_
* Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330)
## v4.1.0-beta.1 - _November 7, 2019_
* Replaced the use of `SafeMath` with `LibSafeMath` (#2254)

9
contracts/integrations/CHANGELOG.json
View File

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

4
contracts/integrations/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v1.0.2 - _November 17, 2019_
* Dependencies updated
## v1.0.1 - _November 7, 2019_
* Dependencies updated

3
contracts/multisig/CHANGELOG.json
View File

@ -6,7 +6,8 @@
"note": "Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils",
"pr": 2330
}
]
],
"timestamp": 1574030254
},
{
"version": "3.2.0-beta.1",

4
contracts/multisig/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v3.2.0-beta.2 - _November 17, 2019_
* Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330)
## v3.2.0-beta.1 - _November 7, 2019_
* Dependencies updated

3
contracts/staking/CHANGELOG.json
View File

@ -10,7 +10,8 @@
"note": "Introduce new exports FixedMathRevertErrors and StakingRevertErrors",
"pr": 2321
}
]
],
"timestamp": 1574030254
},
{
"version": "1.1.0-beta.1",

16
contracts/staking/CHANGELOG.md
View File

@ -5,8 +5,17 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v1.1.0-beta.2 - _November 17, 2019_
* Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330)
* Introduce new exports FixedMathRevertErrors and StakingRevertErrors (#2321)
## v1.1.0-beta.1 - _November 7, 2019_
* 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)
* Add more overflow safeguards to `LibFixedMath` (#2255)
* Refactored finalization state. (#2276)
* Removed protocol fee != 0 assertion. (#2278)
@ -35,10 +44,3 @@ 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)

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

@ -14,7 +14,8 @@
"note": "Remove TransactionHelper and MutatorContractFunction",
"pr": 2325
}
]
],
"timestamp": 1574030254
},
{
"version": "3.2.0-beta.1",

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

@ -5,6 +5,12 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v3.2.0-beta.2 - _November 17, 2019_
* Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330)
* Add new exports orderHashUtils and transactionHashUtils (#2321)
* Remove TransactionHelper and MutatorContractFunction (#2325)
## v3.2.0-beta.1 - _November 7, 2019_
* OrderFactory default order expiration time increased from ten minutes to fifteen minutes (#2304)

3
contracts/utils/CHANGELOG.json
View File

@ -10,7 +10,8 @@
"note": "Introduced new exports AuthorizableRevertErrors, LibAddressArrayRevertErrors, LibBytesRevertErrors, OwnableRevertErrors, ReentrancyGuardRevertErrors and SafeMathRevertErrors",
"pr": 2321
}
]
],
"timestamp": 1574030254
},
{
"version": "3.3.0-beta.1",

5
contracts/utils/CHANGELOG.md
View File

@ -5,6 +5,11 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v3.3.0-beta.2 - _November 17, 2019_
* Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330)
* Introduced new exports AuthorizableRevertErrors, LibAddressArrayRevertErrors, LibBytesRevertErrors, OwnableRevertErrors, ReentrancyGuardRevertErrors and SafeMathRevertErrors (#2321)
## v3.3.0-beta.1 - _November 7, 2019_
* Dependencies updated

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

@ -26,7 +26,8 @@
"note": "Update BigNumber version to ~9.0.0",
"pr": 2342
}
]
],
"timestamp": 1574030254
},
{
"version": "8.0.0-beta.0",

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

@ -5,6 +5,15 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v8.0.0-beta.1 - _November 17, 2019_
* Remove ZRXToken contract wrapper (#2324)
* ContractWrappers no longer exposes `erc20Proxy`, `erc721Proxy` and `dutchAuction` wrappers (#2324)
* [Breaking] Big refactor of contract wrapper interface. See https://github.com/0xProject/0x-monorepo/pull/2325 for details (#2325)
* Remove IWallet and IValidator contract wrappers (#2337)
* Remove exports orderHashUtils and transactionHashUtils (#2321)
* Update BigNumber version to ~9.0.0 (#2342)
## v8.0.0-beta.0 - _November 7, 2019_
* Exported intefaces changed: from getContractAddressesForNetworkOrThrow to getContractAddressesForChainOrThrow, from NetworkId to ChainId, from ContractNetworks to ContractChains, and from ContractNetworkData to ContractChainData. (#2313)

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

File diff suppressed because it is too large Load Diff

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

@ -14,7 +14,8 @@
"note": "Updated Coordinator + Coordinator Registry wrappers",
"pr": 2346
}
]
],
"timestamp": 1574030254
},
{
"version": "5.4.0-beta.1",

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

@ -5,6 +5,12 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v5.4.0-beta.2 - _November 17, 2019_
* [Breaking] Remove `erc20Proxy`, `multiAssetProxy`, `erc1155Proxy`, `staticCallProxy`, `erc721Proxy`, `assetProxyOwner`, `ZRXToken` and `dutchAuction` wrappers (#2324)
* [Breaking] Big refactor of contract wrapper interface. See https://github.com/0xProject/0x-monorepo/pull/2325 for details (#2325)
* Updated Coordinator + Coordinator Registry wrappers (#2346)
## v5.4.0-beta.1 - _November 7, 2019_
* Remove debug functions `getABIDecodedTransactionData` and `getABIDecodedReturnData` (#2243)

4
packages/abi-gen-wrappers/src/generated-wrappers/staking.ts generated
View File

@ -262,11 +262,11 @@ export class StakingContract extends BaseContract {
{
inputs: [
{
name: 'wethAddress_',
name: 'wethAddress',
type: 'address',
},
{
name: 'zrxVaultAddress_',
name: 'zrxVaultAddress',
type: 'address',
},
],

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

@ -26,7 +26,8 @@
"note": "Python: Changed the names of generated tuples to use the `internalType` field in the ABI, if it's present, resulting in human readable struct names rather than hashes of component field names.",
"pr": 2345
}
]
],
"timestamp": 1574030254
},
{
"version": "4.4.0-beta.1",

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

@ -5,6 +5,15 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v4.4.0-beta.2 - _November 17, 2019_
* Refactored TS wrapper templates to result in a more succint interface. See https://github.com/0xProject/0x-monorepo/pull/2325 for details. (#2284)
* Python: Corrected return types and values for call() interface to generated method wrappers. (Fixes #2298) (#2345)
* Python: Stopped generating send_transaction() interface for constant (view/pure) methods (#2345)
* Python: Added a build_transaction() interface to contract method classes (#2345)
* Python: Removed `validator` argument to contract method classes for methods that don't have any inputs (#2345)
* Python: Changed the names of generated tuples to use the `internalType` field in the ABI, if it's present, resulting in human readable struct names rather than hashes of component field names. (#2345)
## v4.4.0-beta.1 - _November 7, 2019_
* In Python wrappers, accept string arguments to bytes parameters (#2284)

2
packages/abi-gen/test-cli/output/python/lib_dummy/__init__.py
View File

@ -90,7 +90,7 @@ class LibDummy:
try:
for middleware in MIDDLEWARE:
web3.middleware_onion.inject(
middleware["function"], layer=middleware["layer"],
middleware["function"], layer=middleware["layer"]
)
except ValueError as value_error:
if value_error.args == (

3
packages/assert/CHANGELOG.json
View File

@ -5,7 +5,8 @@
{
"note": "Dependencies updated"
}
]
],
"timestamp": 1574030254
},
{
"version": "2.2.0-beta.1",

4
packages/assert/CHANGELOG.md
View File

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

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

@ -5,7 +5,8 @@
{
"note": "Dependencies updated"
}
]
],
"timestamp": 1574030254
},
{
"version": "6.2.0-beta.1",

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.2 - _November 17, 2019_
* Dependencies updated
## v6.2.0-beta.1 - _November 7, 2019_
* All references to network ID have been removed, and references to chain ID have been introduced instead (#2313)

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

@ -6,7 +6,8 @@
"note": "Update BigNumber version to ~9.0.0",
"pr": 2342
}
]
],
"timestamp": 1574030254
},
{
"version": "2.1.0-beta.1",

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.2 - _November 17, 2019_
* Update BigNumber version to ~9.0.0 (#2342)
## v2.1.0-beta.1 - _November 7, 2019_
* All references to network ID have been removed, and references to chain ID have been introduced instead (#2313)

5158
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

@ -5,7 +5,8 @@
{
"note": "Dependencies updated"
}
]
],
"timestamp": 1574030254
},
{
"version": "5.5.0-beta.1",

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

@ -5,10 +5,16 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v5.5.0-beta.2 - _November 17, 2019_
* Dependencies updated
## v5.5.0-beta.1 - _November 7, 2019_
* Make `evmExecAsync` protected and rename to `_evmExecAsync` (#2243)
* Remove duplicate types `IndexedFilterValues`, `DecodedLogEvent`, `EventCallback` (#2243)
* Added ContractFunctionObj type and supporting types (#2325)
* Added AwaitTransactionSuccessOpts and SendTransactionOpts (#2325)
## v5.5.0-beta.0 - _October 3, 2019_

3
packages/connect/CHANGELOG.json
View File

@ -6,7 +6,8 @@
"note": "Removed dependency on @0x/order-utils",
"pr": 2321
}
]
],
"timestamp": 1574030254
},
{
"version": "5.1.0-beta.1",

4
packages/connect/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v5.1.0-beta.2 - _November 17, 2019_
* Removed dependency on @0x/order-utils (#2321)
## v5.1.0-beta.1 - _November 7, 2019_
* All references to network ID have been removed, and references to chain ID have been introduced instead (#2313)

461
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/c93b02d55/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/c93b02d55/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 chain 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/34538f2ce/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/c93b02d55/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 chain 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/34538f2ce/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/c93b02d55/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/34538f2ce/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/c93b02d55/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 chain 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/c93b02d55/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 chain 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/c93b02d55/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 chain 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/c93b02d55/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 chain 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/c93b02d55/packages/types/src/index.ts#L408)*
*Defined in [types/src/index.ts:408](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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/c93b02d55/packages/types/src/index.ts#L407)*
*Defined in [types/src/index.ts:407](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L407)*
<hr />
@ -269,8 +146,6 @@ ___
@ -279,7 +154,172 @@ ___
# 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:43](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L43)*
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?`: `AssetPairsRequestOpts` & `PagedRequestOpts`): *`Promise<AssetPairsResponse>`*
*Defined in [connect/src/http_client.ts:58](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L58)*
Retrieve assetData pair info from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`requestOpts?` | `AssetPairsRequestOpts` & `PagedRequestOpts` | Options specifying assetData information to retrieve, page information. |
**Returns:** *`Promise<AssetPairsResponse>`*
The resulting AssetPairsResponse that match the request
___
### getFeeRecipientsAsync
▸ **getFeeRecipientsAsync**(`requestOpts?`: [PagedRequestOpts](#interface-pagedrequestopts)): *`Promise<FeeRecipientsResponse>`*
*Defined in [connect/src/http_client.ts:140](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L140)*
Retrieve the list of fee recipient addresses used by the relayer.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`requestOpts?` | [PagedRequestOpts](#interface-pagedrequestopts) | Options specifying page information. |
**Returns:** *`Promise<FeeRecipientsResponse>`*
The resulting FeeRecipientsResponse
___
### getOrderAsync
▸ **getOrderAsync**(`orderHash`: string): *`Promise<APIOrder>`*
*Defined in [connect/src/http_client.ts:94](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L94)*
Retrieve a specific order from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orderHash` | string | An orderHash generated from the desired order |
**Returns:** *`Promise<APIOrder>`*
The APIOrder that matches the supplied orderHash
___
### getOrderConfigAsync
▸ **getOrderConfigAsync**(`request`: `OrderConfigRequest`): *`Promise<OrderConfigResponse>`*
*Defined in [connect/src/http_client.ts:126](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L126)*
Retrieve fee information from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`request` | `OrderConfigRequest` | A OrderConfigRequest instance describing the specific fees to retrieve |
**Returns:** *`Promise<OrderConfigResponse>`*
The resulting OrderConfigResponse that matches the request
___
### getOrderbookAsync
▸ **getOrderbookAsync**(`request`: `OrderbookRequest`, `requestOpts?`: [PagedRequestOpts](#interface-pagedrequestopts)): *`Promise<OrderbookResponse>`*
*Defined in [connect/src/http_client.ts:106](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L106)*
Retrieve an orderbook from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`request` | `OrderbookRequest` | An OrderbookRequest instance describing the specific orderbook to retrieve |
`requestOpts?` | [PagedRequestOpts](#interface-pagedrequestopts) | Options specifying page information. |
**Returns:** *`Promise<OrderbookResponse>`*
The resulting OrderbookResponse that matches the request
___
### getOrdersAsync
▸ **getOrdersAsync**(`requestOpts?`: `OrdersRequestOpts` & `PagedRequestOpts`): *`Promise<OrdersResponse>`*
*Defined in [connect/src/http_client.ts:77](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L77)*
Retrieve orders from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`requestOpts?` | `OrdersRequestOpts` & `PagedRequestOpts` | Options specifying orders to retrieve and page information, page information. |
**Returns:** *`Promise<OrdersResponse>`*
The resulting OrdersResponse that match the request
___
### submitOrderAsync
▸ **submitOrderAsync**(`signedOrder`: `SignedOrder`): *`Promise<void>`*
*Defined in [connect/src/http_client.ts:155](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L155)*
Submit a signed order to the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`signedOrder` | `SignedOrder` | A SignedOrder instance to submit |
**Returns:** *`Promise<void>`*
<hr />
@ -322,7 +362,7 @@ ___
• **page**? : *undefined | number*
*Defined in [types/src/index.ts:491](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L491)*
*Defined in [types/src/index.ts:491](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L491)*
___
@ -330,7 +370,7 @@ ___
• **perPage**? : *undefined | number*
*Defined in [types/src/index.ts:492](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L492)*
*Defined in [types/src/index.ts:492](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L492)*
<hr />
@ -347,7 +387,7 @@ ___
• **page**: *number*
*Defined in [types/src/index.ts:459](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L459)*
*Defined in [types/src/index.ts:459](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L459)*
___
@ -355,7 +395,7 @@ ___
• **perPage**: *number*
*Defined in [types/src/index.ts:460](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L460)*
*Defined in [types/src/index.ts:460](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L460)*
___
@ -363,7 +403,7 @@ ___
• **records**: *`T`[]*
*Defined in [types/src/index.ts:461](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L461)*
*Defined in [types/src/index.ts:461](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L461)*
___
@ -371,7 +411,7 @@ ___
• **total**: *number*
*Defined in [types/src/index.ts:458](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L458)*
*Defined in [types/src/index.ts:458](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L458)*
<hr />
@ -381,6 +421,8 @@ ___
# Interface: SignedOrder
@ -392,7 +434,7 @@ ___
*Inherited from [Order](#interface-order).[chainId](#chainid)*
*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L14)*
*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L14)*
___
@ -402,7 +444,7 @@ ___
*Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)*
*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L15)*
*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L15)*
___
@ -412,7 +454,7 @@ ___
*Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)*
*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L24)*
*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L24)*
___
@ -422,7 +464,7 @@ ___
*Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)*
*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L18)*
*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L18)*
___
@ -432,7 +474,7 @@ ___
*Inherited from [Order](#interface-order).[makerAddress](#makeraddress)*
*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L16)*
*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L16)*
___
@ -442,7 +484,7 @@ ___
*Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)*
*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L20)*
*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L20)*
___
@ -452,7 +494,7 @@ ___
*Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)*
*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L26)*
*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L26)*
___
@ -462,7 +504,7 @@ ___
*Inherited from [Order](#interface-order).[makerFee](#makerfee)*
*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L22)*
*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L22)*
___
@ -472,7 +514,7 @@ ___
*Inherited from [Order](#interface-order).[makerFeeAssetData](#makerfeeassetdata)*
*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L28)*
*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L28)*
___
@ -482,7 +524,7 @@ ___
*Inherited from [Order](#interface-order).[salt](#salt)*
*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L25)*
*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L25)*
___
@ -492,7 +534,7 @@ ___
*Inherited from [Order](#interface-order).[senderAddress](#senderaddress)*
*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L19)*
*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L19)*
___
@ -500,7 +542,7 @@ ___
• **signature**: *string*
*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L33)*
*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L33)*
___
@ -510,7 +552,7 @@ ___
*Inherited from [Order](#interface-order).[takerAddress](#takeraddress)*
*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L17)*
*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L17)*
___
@ -520,7 +562,7 @@ ___
*Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)*
*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L21)*
*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L21)*
___
@ -530,7 +572,7 @@ ___
*Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)*
*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L27)*
*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L27)*
___
@ -540,7 +582,7 @@ ___
*Inherited from [Order](#interface-order).[takerFee](#takerfee)*
*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L23)*
*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L23)*
___
@ -550,7 +592,7 @@ ___
*Inherited from [Order](#interface-order).[takerFeeAssetData](#takerfeeassetdata)*
*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L29)*
*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L29)*
<hr />
@ -601,6 +643,10 @@ ___
<hr />
<hr />
@ -613,13 +659,13 @@ ___
#### ▪ **ordersChannelFactory**: *object*
*Defined in [connect/src/orders_channel_factory.ts:7](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/connect/src/orders_channel_factory.ts#L7)*
*Defined in [connect/src/orders_channel_factory.ts:7](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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/c93b02d55/packages/connect/src/orders_channel_factory.ts#L15)*
*Defined in [connect/src/orders_channel_factory.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/orders_channel_factory.ts#L15)*
Instantiates a new WebSocketOrdersChannel instance
@ -636,52 +682,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/c93b02d55/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/c93b02d55/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/c93b02d55/packages/types/src/index.ts#L404)*
___

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

@ -10,7 +10,8 @@
"note": "Update ZeroExGovernor address on all testnets",
"pr": 2322
}
]
],
"timestamp": 1574030254
},
{
"version": "3.3.0-beta.2",

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

@ -5,6 +5,11 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v3.3.0-beta.3 - _November 17, 2019_
* Update all v3 mainnet addresses (#2322)
* Update ZeroExGovernor address on all testnets (#2322)
## v3.3.0-beta.2 - _November 7, 2019_
* Updated devUtils contract addresses on testnets

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

@ -14,7 +14,8 @@
"note": "Updated Coordinator + Coordinator Registry artifacts",
"pr": 2346
}
]
],
"timestamp": 1574030254
},
{
"version": "2.3.0-beta.2",

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

@ -5,6 +5,12 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v2.3.0-beta.3 - _November 17, 2019_
* Replace Staking artifact with TestStaking (#2322)
* Added `ZrxVault` and `ERC20BridgeProxy` artifacts (#2323)
* Updated Coordinator + Coordinator Registry artifacts (#2346)
## v2.3.0-beta.2 - _November 7, 2019_
* Update DevUtils contract artifacts

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

@ -14,7 +14,8 @@
"note": "Export types `ContractFunctionObj` and `ContractTxFunctionObj`",
"pr": 2325
}
]
],
"timestamp": 1574030254
},
{
"version": "12.2.0-beta.1",

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

@ -5,6 +5,12 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v12.2.0-beta.2 - _November 17, 2019_
* [Breaking] Remove `erc20Proxy`, `erc721Proxy` and `dutchAuction` wrappers (#2324)
* [Breaking] Big refactor of contract wrapper interface. See https://github.com/0xProject/0x-monorepo/pull/2325 for details (#2325)
* Export types `ContractFunctionObj` and `ContractTxFunctionObj` (#2325)
## v12.2.0-beta.1 - _November 7, 2019_
* All references to network ID have been removed, and references to chain ID have been introduced instead (#2313)

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

File diff suppressed because it is too large Load Diff

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

@ -5,7 +5,8 @@
{
"note": "Dependencies updated"
}
]
],
"timestamp": 1574030254
},
{
"version": "1.1.0-beta.1",

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.2 - _November 17, 2019_
* Dependencies updated
## v1.1.0-beta.1 - _November 7, 2019_
* Dependencies updated

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

@ -5,7 +5,8 @@
{
"note": "Dependencies updated"
}
]
],
"timestamp": 1574030254
},
{
"version": "2.4.0-beta.1",

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.2 - _November 17, 2019_
* Dependencies updated
## v2.4.0-beta.1 - _November 7, 2019_
* Dependencies updated

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

@ -5,7 +5,8 @@
{
"note": "Dependencies updated"
}
]
],
"timestamp": 1574030254
},
{
"version": "2.2.0-beta.1",

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.2 - _November 17, 2019_
* Dependencies updated
## v2.2.0-beta.1 - _November 7, 2019_
* All references to network ID have been removed, and references to chain ID have been introduced instead (#2313)

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

File diff suppressed because it is too large Load Diff

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

@ -5,7 +5,8 @@
{
"note": "Dependencies updated"
}
]
],
"timestamp": 1574030254
},
{
"version": "4.1.0-beta.1",

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.2 - _November 17, 2019_
* Dependencies updated
## v4.1.0-beta.1 - _November 7, 2019_
* All references to network ID have been removed, and references to chain ID have been introduced instead (#2313)

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/c93b02d55/packages/json-schemas/src/schema_validator.ts#L15)*
*Defined in [schema_validator.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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/c93b02d55/packages/json-schemas/src/schema_validator.ts#L32)*
*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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/c93b02d55/packages/json-schemas/src/schema_validator.ts#L57)*
*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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/c93b02d55/packages/json-schemas/src/schema_validator.ts#L46)*
*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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

@ -10,7 +10,8 @@
"note": "Added `Staking` and `ERC20BridgeProxy` contracts",
"pr": 2323
}
]
],
"timestamp": 1574030254
},
{
"version": "4.4.0-beta.1",

5
packages/migrations/CHANGELOG.md
View File

@ -5,6 +5,11 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v4.4.0-beta.2 - _November 17, 2019_
* Migrations script no longer deploys DutchAuction since it is not yet upgraded for V3 of the protocol (#2324)
* Added `Staking` and `ERC20BridgeProxy` contracts (#2323)
## v4.4.0-beta.1 - _November 7, 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)

266
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/34538f2ce/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:12](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L12)*
*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L12)*
___
@ -25,7 +45,7 @@ ___
• **coordinator**: *string*
*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L18)*
*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L18)*
___
@ -33,7 +53,7 @@ ___
• **coordinatorRegistry**: *string*
*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L17)*
*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L17)*
___
@ -41,7 +61,7 @@ ___
• **devUtils**: *string*
*Defined in [contract-addresses/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L22)*
*Defined in [contract-addresses/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L22)*
___
@ -49,7 +69,7 @@ ___
• **dutchAuction**: *string*
*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L16)*
*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L16)*
___
@ -57,7 +77,7 @@ ___
• **erc1155Proxy**: *string*
*Defined in [contract-addresses/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L21)*
*Defined in [contract-addresses/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L21)*
___
@ -65,7 +85,7 @@ ___
• **erc20BridgeProxy**: *string*
*Defined in [contract-addresses/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L26)*
*Defined in [contract-addresses/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L26)*
___
@ -73,7 +93,7 @@ ___
• **erc20Proxy**: *string*
*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L6)*
*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L6)*
___
@ -81,7 +101,7 @@ ___
• **erc721Proxy**: *string*
*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L7)*
*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L7)*
___
@ -89,7 +109,7 @@ ___
• **etherToken**: *string*
*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L9)*
*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L9)*
___
@ -97,7 +117,7 @@ ___
• **exchange**: *string*
*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L11)*
*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L11)*
___
@ -105,7 +125,7 @@ ___
• **exchangeV2**: *string*
*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L10)*
*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L10)*
___
@ -113,7 +133,7 @@ ___
• **forwarder**: *string*
*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L14)*
*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L14)*
___
@ -121,7 +141,7 @@ ___
• **multiAssetProxy**: *string*
*Defined in [contract-addresses/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L19)*
*Defined in [contract-addresses/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L19)*
___
@ -129,7 +149,7 @@ ___
• **orderValidator**: *string*
*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L15)*
*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L15)*
___
@ -137,7 +157,7 @@ ___
• **staking**: *string*
*Defined in [contract-addresses/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L24)*
*Defined in [contract-addresses/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L24)*
___
@ -145,7 +165,7 @@ ___
• **stakingProxy**: *string*
*Defined in [contract-addresses/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L25)*
*Defined in [contract-addresses/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L25)*
___
@ -153,7 +173,7 @@ ___
• **staticCallProxy**: *string*
*Defined in [contract-addresses/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L20)*
*Defined in [contract-addresses/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L20)*
___
@ -161,7 +181,7 @@ ___
• **zeroExGovernor**: *string*
*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L13)*
*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L13)*
___
@ -169,7 +189,7 @@ ___
• **zrxToken**: *string*
*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L8)*
*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L8)*
___
@ -177,7 +197,7 @@ ___
• **zrxVault**: *string*
*Defined in [contract-addresses/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L23)*
*Defined in [contract-addresses/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L23)*
<hr />
@ -226,7 +246,7 @@ ___
• **isEIP1193**: *boolean*
*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L73)*
*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L73)*
## Methods
@ -234,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/c93b02d55/packages/ethereum-types/src/index.ts#L75)*
*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L75)*
**Parameters:**
@ -258,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/c93b02d55/packages/ethereum-types/src/index.ts#L74)*
*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L74)*
**Parameters:**
@ -283,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/c93b02d55/packages/ethereum-types/src/index.ts#L14)*
**Parameters:**
Name | Type |
------ | ------ |
`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) |
`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) |
**Returns:** *void*
<hr />
# Interface: JSONRPCRequestPayload
@ -316,7 +316,7 @@ Name | Type |
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L330)*
*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L331)*
___
@ -324,7 +324,7 @@ ___
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L331)*
*Defined in [ethereum-types/src/index.ts:332](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L332)*
___
@ -332,7 +332,7 @@ ___
• **method**: *string*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L329)*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L330)*
___
@ -340,7 +340,7 @@ ___
• **params**: *any[]*
*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L328)*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L329)*
<hr />
@ -353,7 +353,7 @@ ___
• **code**: *number*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L336)*
*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L337)*
___
@ -361,7 +361,7 @@ ___
• **message**: *string*
*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L335)*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L336)*
<hr />
@ -374,7 +374,7 @@ ___
• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)*
*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L343)*
*Defined in [ethereum-types/src/index.ts:344](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L344)*
___
@ -382,7 +382,7 @@ ___
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L341)*
*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L342)*
___
@ -390,7 +390,7 @@ ___
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L342)*
*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L343)*
___
@ -398,7 +398,7 @@ ___
• **result**: *any*
*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L340)*
*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L341)*
<hr />
@ -453,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/c93b02d55/packages/ethereum-types/src/index.ts#L393)*
*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)*
___
@ -461,7 +461,7 @@ ___
• **from**: *string*
*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L398)*
*Defined in [ethereum-types/src/index.ts:399](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L399)*
___
@ -471,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/c93b02d55/packages/ethereum-types/src/index.ts#L391)*
*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)*
___
@ -481,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/c93b02d55/packages/ethereum-types/src/index.ts#L392)*
*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)*
___
@ -491,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/c93b02d55/packages/ethereum-types/src/index.ts#L394)*
*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)*
___
@ -501,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/c93b02d55/packages/ethereum-types/src/index.ts#L389)*
*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)*
___
@ -511,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/c93b02d55/packages/ethereum-types/src/index.ts#L390)*
*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L391)*
<hr />
@ -526,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/c93b02d55/packages/ethereum-types/src/index.ts#L393)*
*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)*
___
@ -536,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/c93b02d55/packages/ethereum-types/src/index.ts#L398)*
*Defined in [ethereum-types/src/index.ts:399](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L399)*
___
@ -546,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/c93b02d55/packages/ethereum-types/src/index.ts#L391)*
*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)*
___
@ -556,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/c93b02d55/packages/ethereum-types/src/index.ts#L392)*
*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)*
___
@ -566,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/c93b02d55/packages/ethereum-types/src/index.ts#L394)*
*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)*
___
@ -576,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/c93b02d55/packages/ethereum-types/src/index.ts#L389)*
*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)*
___
@ -586,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/c93b02d55/packages/ethereum-types/src/index.ts#L442)*
*Defined in [ethereum-types/src/index.ts:443](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L443)*
<hr />
@ -603,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/c93b02d55/packages/ethereum-types/src/index.ts#L45)*
*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L45)*
**Parameters:**
@ -619,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/c93b02d55/packages/ethereum-types/src/index.ts#L44)*
*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L44)*
**Parameters:**
@ -645,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/c93b02d55/packages/ethereum-types/src/index.ts#L54)*
*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L54)*
**Parameters:**
@ -671,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/c93b02d55/packages/ethereum-types/src/index.ts#L63)*
*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L63)*
**Parameters:**
@ -697,7 +697,7 @@ add here
• **isMetaMask**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L31)*
*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L31)*
___
@ -705,7 +705,7 @@ ___
• **isParity**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L32)*
*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L32)*
___
@ -713,7 +713,7 @@ ___
• **isZeroExProvider**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L30)*
*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L30)*
## Methods
@ -721,7 +721,7 @@ ___
▸ **enable**(): *`Promise<void>`*
*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L34)*
*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L34)*
**Returns:** *`Promise<void>`*
@ -731,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/c93b02d55/packages/ethereum-types/src/index.ts#L35)*
*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L35)*
**Parameters:**
@ -748,7 +748,7 @@ ___
▸ **stop**(): *void*
*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L33)*
*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L33)*
**Returns:** *void*
@ -757,13 +757,63 @@ ___
## Functions
### runMigrationsAsync
▸ **runMigrationsAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `TxData`): *`Promise<ContractAddresses>`*
*Defined in [migrations/src/migration.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/migrations/src/migration.ts#L63)*
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:321](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/migrations/src/migration.ts#L321)*
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
### getContractAddressesForChainOrThrow
▸ **getContractAddressesForChainOrThrow**(`chainId`: [ChainId](#enumeration-chainid)): *[ContractAddresses](#interface-contractaddresses)*
*Defined in [contract-addresses/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L45)*
*Defined in [contract-addresses/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L45)*
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
@ -803,7 +853,7 @@ given chainId.
Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"*
*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L70)*
*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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
@ -820,7 +870,7 @@ ___
Ƭ **JSONRPCErrorCallback**: *function*
*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L3)*
*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L3)*
#### Type declaration:
@ -849,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/c93b02d55/packages/ethereum-types/src/index.ts#L9)*
*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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.
@ -864,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/c93b02d55/packages/ethereum-types/src/index.ts#L11)*
<hr />
## Functions
### runMigrationsAsync
▸ **runMigrationsAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `TxData`): *`Promise<ContractAddresses>`*
*Defined in [migrations/src/migration.ts:49](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/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/c93b02d55/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.
*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L11)*
<hr />

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

@ -18,7 +18,8 @@
"note": "Removed function isValidOrderHash from export orderHashUtils",
"pr": 2321
}
]
],
"timestamp": 1574030254
},
{
"version": "8.5.0-beta.1",

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

@ -5,6 +5,13 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v8.5.0-beta.2 - _November 17, 2019_
* [Breaking] Removed `OrderStateUtils`, `OrderValidationUtils`, `ExchangeTransferSimulator` and all abstract and store classes. For order validation, please use the `DevUtils` contract wrapper method `getOrderRelevantState`|`getOrderRelevantStates` (#2324)
* Removed exports CoordinatorRevertErrors, ExchangeRevertErrors, ForwarderRevertErrors, LibMathRevertErrors, orderHashUtils, orderParsingUtils, StakingRevertErrors and transactionHashUtils (#2321)
* Removed many functions from export signatureUtils (#2321)
* Removed function isValidOrderHash from export orderHashUtils (#2321)
## v8.5.0-beta.1 - _November 7, 2019_
* Remove `TransferFailedError` from `ForwarderRevertErrors`. (#2309)

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

File diff suppressed because it is too large Load Diff

3
packages/orderbook/CHANGELOG.json
View File

@ -10,7 +10,8 @@
"note": "Update Mesh RPC logic to v6.0.1-beta",
"pr": 2325
}
]
],
"timestamp": 1574030254
},
{
"version": "0.1.0-beta.1",

5
packages/orderbook/CHANGELOG.md
View File

@ -5,6 +5,11 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v0.1.0-beta.2 - _November 17, 2019_
* Added dependency on @0x/contracts-dev-utils (#2321)
* Update Mesh RPC logic to v6.0.1-beta (#2325)
## v0.1.0-beta.1 - _November 7, 2019_
* All references to network ID have been removed, and references to chain ID have been introduced instead (#2313)

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

@ -6,7 +6,8 @@
"note": "Add `shouldSaveStandardInput` config",
"pr": 2322
}
]
],
"timestamp": 1574030254
},
{
"version": "3.2.0-beta.1",

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.2 - _November 17, 2019_
* Add `shouldSaveStandardInput` config (#2322)
## v3.2.0-beta.1 - _November 7, 2019_
* Output artifacts now include a 'chains' attribute rather than 'networks' (#2313)

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

@ -1,81 +1,3 @@
# 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/c93b02d55/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/c93b02d55/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/c93b02d55/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/c93b02d55/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/c93b02d55/packages/sol-compiler/src/compiler.ts#L155)*
**Returns:** *`Promise<void>`*
<hr />
@ -88,6 +10,11 @@ ___
<hr />
@ -110,6 +37,7 @@ useDockerisedSolc: If set to true - sol-compiler will try calling a dockerized i
isOfflineMode: If set to true - sol-compiler will not fetch the list of solc releases from github. It will use the hardcoded list. Defaults to false.
solcVersion: If you don't want to compile each contract with the Solidity version specified in-file, you can force all
contracts to compile with the the version specified here.
shouldSaveStandardInput: Write the standard JSON input in ${contractsDir}/${contractName}.input.json
## Properties
@ -118,7 +46,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/c93b02d55/packages/ethereum-types/src/index.ts#L731)*
*Defined in [ethereum-types/src/index.ts:733](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L733)*
___
@ -126,7 +54,7 @@ ___
• **compilerSettings**? : *[CompilerSettings](#class-compilersettings)*
*Defined in [ethereum-types/src/index.ts:732](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L732)*
*Defined in [ethereum-types/src/index.ts:734](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L734)*
___
@ -134,7 +62,7 @@ ___
• **contracts**? : *string[] | "*"*
*Defined in [ethereum-types/src/index.ts:733](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L733)*
*Defined in [ethereum-types/src/index.ts:735](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L735)*
___
@ -142,7 +70,7 @@ ___
• **contractsDir**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:730](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L730)*
*Defined in [ethereum-types/src/index.ts:732](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L732)*
___
@ -150,7 +78,15 @@ ___
• **isOfflineMode**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:735](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L735)*
*Defined in [ethereum-types/src/index.ts:737](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L737)*
___
### `Optional` shouldSaveStandardInput
• **shouldSaveStandardInput**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:739](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L739)*
___
@ -158,7 +94,7 @@ ___
• **solcVersion**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:736](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L736)*
*Defined in [ethereum-types/src/index.ts:738](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L738)*
___
@ -166,7 +102,7 @@ ___
• **useDockerisedSolc**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:734](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L734)*
*Defined in [ethereum-types/src/index.ts:736](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L736)*
<hr />
@ -181,7 +117,7 @@ ___
• **evmVersion**? : *"homestead" | "tangerineWhistle" | "spuriousDragon" | "byzantium" | "constantinople"*
*Defined in [ethereum-types/src/index.ts:689](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L689)*
*Defined in [ethereum-types/src/index.ts:690](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L690)*
___
@ -189,7 +125,7 @@ ___
• **libraries**? : *undefined | object*
*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L691)*
*Defined in [ethereum-types/src/index.ts:692](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L692)*
___
@ -197,7 +133,7 @@ ___
• **metadata**? : *[CompilerSettingsMetadata](#class-compilersettingsmetadata)*
*Defined in [ethereum-types/src/index.ts:690](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L690)*
*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L691)*
___
@ -205,7 +141,7 @@ ___
• **optimizer**? : *[OptimizerSettings](#class-optimizersettings)*
*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L688)*
*Defined in [ethereum-types/src/index.ts:689](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L689)*
___
@ -213,7 +149,7 @@ ___
• **outputSelection**: *object*
*Defined in [ethereum-types/src/index.ts:696](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L696)*
*Defined in [ethereum-types/src/index.ts:697](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L697)*
#### Type declaration:
@ -227,7 +163,7 @@ ___
• **remappings**? : *string[]*
*Defined in [ethereum-types/src/index.ts:687](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L687)*
*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L688)*
<hr />
@ -240,7 +176,7 @@ ___
• **useLiteralContent**: *true*
*Defined in [ethereum-types/src/index.ts:704](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L704)*
*Defined in [ethereum-types/src/index.ts:705](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L705)*
<hr />
@ -253,7 +189,7 @@ ___
• **inputs**: *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L103)*
*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L103)*
___
@ -261,7 +197,7 @@ ___
• **payable**: *boolean*
*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L104)*
*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L104)*
___
@ -269,7 +205,7 @@ ___
• **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)*
*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L105)*
*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L105)*
___
@ -277,7 +213,7 @@ ___
• **type**: *string*
*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L102)*
*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L102)*
<hr />
@ -296,7 +232,15 @@ ___
• **components**? : *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L137)*
*Defined in [ethereum-types/src/index.ts:138](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L138)*
___
### `Optional` internalType
• **internalType**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)*
___
@ -304,7 +248,7 @@ ___
• **name**: *string*
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L135)*
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)*
___
@ -312,7 +256,7 @@ ___
• **type**: *string*
*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L136)*
*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)*
<hr />
@ -329,7 +273,7 @@ ___
• **author**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L628)*
*Defined in [ethereum-types/src/index.ts:629](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L629)*
___
@ -337,7 +281,7 @@ ___
• **methods**: *object*
*Defined in [ethereum-types/src/index.ts:629](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L629)*
*Defined in [ethereum-types/src/index.ts:630](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L630)*
#### Type declaration:
@ -349,7 +293,7 @@ ___
• **title**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:627](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L627)*
*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L628)*
<hr />
@ -364,7 +308,7 @@ ___
• **anonymous**: *boolean*
*Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L131)*
*Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L131)*
___
@ -372,7 +316,7 @@ ___
• **inputs**: *[EventParameter](#class-eventparameter)[]*
*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L130)*
*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L130)*
___
@ -380,7 +324,7 @@ ___
• **name**: *string*
*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L129)*
*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L129)*
___
@ -388,7 +332,7 @@ ___
• **type**: *string*
*Defined in [ethereum-types/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L128)*
*Defined in [ethereum-types/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L128)*
<hr />
@ -403,7 +347,7 @@ ___
*Inherited from [DataItem](#interface-dataitem).[components](#optional-components)*
*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L137)*
*Defined in [ethereum-types/src/index.ts:138](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L138)*
___
@ -411,7 +355,17 @@ ___
• **indexed**: *boolean*
*Defined in [ethereum-types/src/index.ts:116](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L116)*
*Defined in [ethereum-types/src/index.ts:116](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L116)*
___
### `Optional` internalType
• **internalType**? : *undefined | string*
*Inherited from [DataItem](#interface-dataitem).[internalType](#optional-internaltype)*
*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)*
___
@ -421,7 +375,7 @@ ___
*Inherited from [DataItem](#interface-dataitem).[name](#name)*
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L135)*
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)*
___
@ -431,7 +385,7 @@ ___
*Inherited from [DataItem](#interface-dataitem).[type](#type)*
*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L136)*
*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)*
<hr />
@ -444,7 +398,7 @@ ___
• **object**: *string*
*Defined in [ethereum-types/src/index.ts:622](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L622)*
*Defined in [ethereum-types/src/index.ts:623](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L623)*
___
@ -452,7 +406,7 @@ ___
• **sourceMap**: *string*
*Defined in [ethereum-types/src/index.ts:623](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L623)*
*Defined in [ethereum-types/src/index.ts:624](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L624)*
<hr />
@ -465,7 +419,7 @@ ___
• **bytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)*
*Defined in [ethereum-types/src/index.ts:617](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L617)*
*Defined in [ethereum-types/src/index.ts:618](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L618)*
___
@ -473,7 +427,7 @@ ___
• **deployedBytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)*
*Defined in [ethereum-types/src/index.ts:618](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L618)*
*Defined in [ethereum-types/src/index.ts:619](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L619)*
<hr />
@ -486,7 +440,7 @@ ___
• **payable**: *boolean*
*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L112)*
*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L112)*
___
@ -494,13 +448,90 @@ ___
• **type**: *string*
*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L111)*
*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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:100](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-compiler/src/compiler.ts#L100)*
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:143](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-compiler/src/compiler.ts#L143)*
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:156](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-compiler/src/compiler.ts#L156)*
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:197](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-compiler/src/compiler.ts#L197)*
Gets a list of contracts to compile.
**Returns:** *string[]*
___
### watchAsync
▸ **watchAsync**(): *`Promise<void>`*
*Defined in [sol-compiler/src/compiler.ts:160](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-compiler/src/compiler.ts#L160)*
**Returns:** *`Promise<void>`*
<hr />
@ -525,7 +556,7 @@ ___
• **constant**: *boolean*
*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L94)*
*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L94)*
___
@ -533,7 +564,7 @@ ___
• **inputs**: *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L92)*
*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L92)*
___
@ -541,7 +572,7 @@ ___
• **name**: *string*
*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L91)*
*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L91)*
___
@ -549,7 +580,7 @@ ___
• **outputs**: *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L93)*
*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L93)*
___
@ -557,7 +588,7 @@ ___
• **payable**: *boolean*
*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L96)*
*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L96)*
___
@ -565,7 +596,7 @@ ___
• **stateMutability**: *[StateMutability](#statemutability)*
*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L95)*
*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L95)*
___
@ -573,7 +604,7 @@ ___
• **type**: *string*
*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L90)*
*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L90)*
<hr />
@ -586,7 +617,7 @@ ___
• **enabled**: *boolean*
*Defined in [ethereum-types/src/index.ts:708](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L708)*
*Defined in [ethereum-types/src/index.ts:709](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L709)*
___
@ -594,7 +625,7 @@ ___
• **runs**? : *undefined | number*
*Defined in [ethereum-types/src/index.ts:709](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L709)*
*Defined in [ethereum-types/src/index.ts:710](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L710)*
<hr />
@ -611,7 +642,7 @@ ___
• **arguments**? : *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L122)*
*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L122)*
___
@ -619,7 +650,7 @@ ___
• **name**: *string*
*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L121)*
*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L121)*
___
@ -627,7 +658,7 @@ ___
• **type**: *"error"*
*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L120)*
*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L120)*
<hr />
@ -640,7 +671,7 @@ ___
• **component**: *"general" | "ewasm"*
*Defined in [ethereum-types/src/index.ts:604](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L604)*
*Defined in [ethereum-types/src/index.ts:605](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L605)*
___
@ -648,7 +679,7 @@ ___
• **formattedMessage**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:607](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L607)*
*Defined in [ethereum-types/src/index.ts:608](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L608)*
___
@ -656,7 +687,7 @@ ___
• **message**: *string*
*Defined in [ethereum-types/src/index.ts:606](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L606)*
*Defined in [ethereum-types/src/index.ts:607](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L607)*
___
@ -664,7 +695,7 @@ ___
• **severity**: *[ErrorSeverity](#errorseverity)*
*Defined in [ethereum-types/src/index.ts:605](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L605)*
*Defined in [ethereum-types/src/index.ts:606](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L606)*
___
@ -672,7 +703,7 @@ ___
• **sourceLocation**? : *[SourceLocation](#class-sourcelocation)*
*Defined in [ethereum-types/src/index.ts:602](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L602)*
*Defined in [ethereum-types/src/index.ts:603](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L603)*
___
@ -680,7 +711,7 @@ ___
• **type**: *[ErrorType](#errortype)*
*Defined in [ethereum-types/src/index.ts:603](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L603)*
*Defined in [ethereum-types/src/index.ts:604](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L604)*
<hr />
@ -697,7 +728,7 @@ ___
• **abi**: *[ContractAbi](#contractabi)*
*Defined in [ethereum-types/src/index.ts:564](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L564)*
*Defined in [ethereum-types/src/index.ts:565](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L565)*
___
@ -705,7 +736,7 @@ ___
• **devdoc**? : *[DevdocOutput](#class-devdocoutput)*
*Defined in [ethereum-types/src/index.ts:566](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L566)*
*Defined in [ethereum-types/src/index.ts:567](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L567)*
___
@ -713,7 +744,7 @@ ___
• **evm**: *[EvmOutput](#class-evmoutput)*
*Defined in [ethereum-types/src/index.ts:565](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L565)*
*Defined in [ethereum-types/src/index.ts:566](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L566)*
<hr />
@ -726,7 +757,7 @@ ___
• **contracts**: *object*
*Defined in [ethereum-types/src/index.ts:578](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L578)*
*Defined in [ethereum-types/src/index.ts:579](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L579)*
#### Type declaration:
@ -740,7 +771,7 @@ ___
• **errors**: *[SolcError](#class-solcerror)[]*
*Defined in [ethereum-types/src/index.ts:570](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L570)*
*Defined in [ethereum-types/src/index.ts:571](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L571)*
___
@ -748,7 +779,7 @@ ___
• **sources**: *object*
*Defined in [ethereum-types/src/index.ts:571](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L571)*
*Defined in [ethereum-types/src/index.ts:572](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L572)*
#### Type declaration:
@ -779,7 +810,17 @@ ___
*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/c93b02d55/packages/ethereum-types/src/index.ts#L141)*
*Defined in [ethereum-types/src/index.ts:142](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L142)*
___
### `Optional` internalType
• **internalType**? : *undefined | string*
*Inherited from [DataItem](#interface-dataitem).[internalType](#optional-internaltype)*
*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)*
___
@ -789,7 +830,7 @@ ___
*Inherited from [DataItem](#interface-dataitem).[name](#name)*
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L135)*
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)*
___
@ -799,7 +840,7 @@ ___
*Inherited from [DataItem](#interface-dataitem).[type](#type)*
*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L136)*
*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)*
<hr />
@ -824,7 +865,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/c93b02d55/packages/ethereum-types/src/index.ts#L80)*
*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L80)*
___
@ -834,7 +875,7 @@ ___
Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"*
*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L84)*
*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L84)*
___
@ -842,7 +883,7 @@ ___
Ƭ **ContractAbi**: *[AbiDefinition](#abidefinition)[]*
*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L78)*
*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L78)*
___
@ -856,7 +897,7 @@ ___
Ƭ **ErrorSeverity**: *"error" | "warning"*
*Defined in [ethereum-types/src/index.ts:599](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L599)*
*Defined in [ethereum-types/src/index.ts:600](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L600)*
___
@ -864,7 +905,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/c93b02d55/packages/ethereum-types/src/index.ts#L585)*
*Defined in [ethereum-types/src/index.ts:586](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L586)*
___
@ -872,7 +913,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/c93b02d55/packages/ethereum-types/src/index.ts#L82)*
*Defined in [ethereum-types/src/index.ts:82](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L82)*
___
@ -884,7 +925,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/c93b02d55/packages/ethereum-types/src/index.ts#L525)*
*Defined in [ethereum-types/src/index.ts:526](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L526)*
___
@ -892,7 +933,7 @@ ___
Ƭ **ParamDescription**: *string*
*Defined in [ethereum-types/src/index.ts:561](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L561)*
*Defined in [ethereum-types/src/index.ts:562](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L562)*
___
@ -902,7 +943,7 @@ ___
Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)*
*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L85)*
*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L85)*
___
@ -914,7 +955,3 @@ ___
<hr />

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

@ -5,7 +5,8 @@
{
"note": "Dependencies updated"
}
]
],
"timestamp": 1574030254
},
{
"version": "3.1.0-beta.1",

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.2 - _November 17, 2019_
* Dependencies updated
## v3.1.0-beta.1 - _November 7, 2019_
* Dependencies updated

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

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

@ -5,7 +5,8 @@
{
"note": "Dependencies updated"
}
]
],
"timestamp": 1574030254
},
{
"version": "2.1.0-beta.1",

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.2 - _November 17, 2019_
* Dependencies updated
## v2.1.0-beta.1 - _November 7, 2019_
* Dependencies updated

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

@ -5,7 +5,8 @@
{
"note": "Dependencies updated"
}
]
],
"timestamp": 1574030254
},
{
"version": "3.2.0-beta.1",

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.2 - _November 17, 2019_
* Dependencies updated
## v3.2.0-beta.1 - _November 7, 2019_
* Dependencies updated

768
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/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts#L4)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: SolCompilerArtifactAdapter
## Constructors
\+ **new SolCompilerArtifactAdapter**(`artifactsPath?`: undefined | string, `sourcesPath?`: undefined | string): *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)*
*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L18)*
Instantiates a SolCompilerArtifactAdapter
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`artifactsPath?` | undefined \| string | Path to your artifacts directory |
`sourcesPath?` | undefined \| string | Path to your contract sources directory |
**Returns:** *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)*
## Methods
### collectContractsDataAsync
▸ **collectContractsDataAsync**(): *`Promise<ContractData[]>`*
*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)*
*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: TruffleArtifactAdapter
## Constructors
\+ **new TruffleArtifactAdapter**(`projectRoot`: string, `solcVersion`: string): *[TruffleArtifactAdapter](#class-truffleartifactadapter)*
*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:29](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L29)*
Instantiates a TruffleArtifactAdapter
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`projectRoot` | string | Path to the truffle project's root directory |
`solcVersion` | string | Solidity version with which to compile all the contracts |
**Returns:** *[TruffleArtifactAdapter](#class-truffleartifactadapter)*
## Methods
### collectContractsDataAsync
▸ **collectContractsDataAsync**(): *`Promise<ContractData[]>`*
*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)*
*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
## Type aliases
### Callback
Ƭ **Callback**: *function*
*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L131)*
#### Type declaration:
▸ (): *void*
___
### ErrorCallback
Ƭ **ErrorCallback**: *function*
*Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L130)*
#### Type declaration:
▸ (`err`: `Error` | null, `data?`: any): *void*
**Parameters:**
Name | Type |
------ | ------ |
`err` | `Error` \| null |
`data?` | any |
___
### NextCallback
Ƭ **NextCallback**: *function*
*Defined in [subproviders/src/types.ts:133](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L133)*
#### Type declaration:
▸ (`callback?`: [OnNextCompleted](#onnextcompleted)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`callback?` | [OnNextCompleted](#onnextcompleted) |
___
### OnNextCompleted
Ƭ **OnNextCompleted**: *function*
*Defined in [subproviders/src/types.ts:132](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L132)*
#### Type declaration:
▸ (`err`: `Error` | null, `result`: any, `cb`: [Callback](#callback)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`err` | `Error` \| null |
`result` | any |
`cb` | [Callback](#callback) |
<hr />
# Interface: JSONRPCRequestPayload
## Properties
### id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L331)*
___
### jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:332](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L332)*
___
### method
• **method**: *string*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L330)*
___
### params
• **params**: *any[]*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L329)*
<hr />
# Interface: JSONRPCResponseError
## Properties
### code
• **code**: *number*
*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L337)*
___
### message
• **message**: *string*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L336)*
<hr />
# Interface: JSONRPCResponsePayload
## Properties
### `Optional` error
• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)*
*Defined in [ethereum-types/src/index.ts:344](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L344)*
___
### id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L342)*
___
### jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L343)*
___
### result
• **result**: *any*
*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L341)*
<hr />
# Class: 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/c93b02d55/packages/sol-profiler/src/profiler_subprovider.ts#L30)*
*Defined in [sol-profiler/src/profiler_subprovider.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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/c93b02d55/packages/sol-profiler/src/profiler_subprovider.ts#L104)*
*Defined in [sol-profiler/src/profiler_subprovider.ts:104](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts#L4)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: SolCompilerArtifactAdapter
## Constructors
\+ **new SolCompilerArtifactAdapter**(`artifactsPath?`: undefined | string, `sourcesPath?`: undefined | string): *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)*
*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L18)*
Instantiates a SolCompilerArtifactAdapter
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`artifactsPath?` | undefined \| string | Path to your artifacts directory |
`sourcesPath?` | undefined \| string | Path to your contract sources directory |
**Returns:** *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)*
## Methods
### collectContractsDataAsync
▸ **collectContractsDataAsync**(): *`Promise<ContractData[]>`*
*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)*
*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: TruffleArtifactAdapter
## Constructors
\+ **new TruffleArtifactAdapter**(`projectRoot`: string, `solcVersion`: string): *[TruffleArtifactAdapter](#class-truffleartifactadapter)*
*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:29](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L29)*
Instantiates a TruffleArtifactAdapter
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`projectRoot` | string | Path to the truffle project's root directory |
`solcVersion` | string | Solidity version with which to compile all the contracts |
**Returns:** *[TruffleArtifactAdapter](#class-truffleartifactadapter)*
## Methods
### collectContractsDataAsync
▸ **collectContractsDataAsync**(): *`Promise<ContractData[]>`*
*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)*
*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:40](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Interface: JSONRPCRequestPayload
## Properties
### id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L330)*
___
### jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L331)*
___
### method
• **method**: *string*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L329)*
___
### params
• **params**: *any[]*
*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L328)*
<hr />
# Interface: JSONRPCResponseError
## Properties
### code
• **code**: *number*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L336)*
___
### message
• **message**: *string*
*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L335)*
<hr />
# Interface: JSONRPCResponsePayload
## Properties
### `Optional` error
• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)*
*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L343)*
___
### id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L341)*
___
### jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L342)*
___
### result
• **result**: *any*
*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L340)*
<hr />
@ -495,7 +573,7 @@ ___
Defined in ethereum-types/lib/index.d.ts:267
Defined in ethereum-types/lib/index.d.ts:268
___
@ -505,7 +583,7 @@ ___
Defined in ethereum-types/lib/index.d.ts:268
Defined in ethereum-types/lib/index.d.ts:269
___
@ -515,7 +593,7 @@ ___
*Overrides void*
*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L136)*
*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L136)*
___
@ -525,7 +603,7 @@ ___
Defined in ethereum-types/lib/index.d.ts:265
Defined in ethereum-types/lib/index.d.ts:266
<hr />
@ -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/c93b02d55/packages/sol-profiler/src/profiler_subprovider.ts#L118)*
*Defined in [sol-profiler/src/profiler_subprovider.ts:118](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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/c93b02d55/packages/subproviders/src/types.ts#L131)*
#### Type declaration:
▸ (): *void*
___
### ErrorCallback
Ƭ **ErrorCallback**: *function*
*Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L130)*
#### Type declaration:
▸ (`err`: `Error` | null, `data?`: any): *void*
**Parameters:**
Name | Type |
------ | ------ |
`err` | `Error` \| null |
`data?` | any |
___
### NextCallback
Ƭ **NextCallback**: *function*
*Defined in [subproviders/src/types.ts:133](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L133)*
#### Type declaration:
▸ (`callback?`: [OnNextCompleted](#onnextcompleted)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`callback?` | [OnNextCompleted](#onnextcompleted) |
___
### OnNextCompleted
Ƭ **OnNextCompleted**: *function*
*Defined in [subproviders/src/types.ts:132](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L132)*
#### Type declaration:
▸ (`err`: `Error` | null, `result`: any, `cb`: [Callback](#callback)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`err` | `Error` \| null |
`result` | any |
`cb` | [Callback](#callback) |
<hr />

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

@ -5,7 +5,8 @@
{
"note": "Dependencies updated"
}
]
],
"timestamp": 1574030254
},
{
"version": "2.1.0-beta.1",

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.2 - _November 17, 2019_
* Dependencies updated
## v2.1.0-beta.1 - _November 7, 2019_
* Dependencies updated

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

@ -5,7 +5,8 @@
{
"note": "Dependencies updated"
}
]
],
"timestamp": 1574030254
},
{
"version": "2.1.0-beta.1",

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.2 - _November 17, 2019_
* Dependencies updated
## v2.1.0-beta.1 - _November 7, 2019_
* Dependencies updated

784
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/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts#L4)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: SolCompilerArtifactAdapter
## Constructors
\+ **new SolCompilerArtifactAdapter**(`artifactsPath?`: undefined | string, `sourcesPath?`: undefined | string): *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)*
*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L18)*
Instantiates a SolCompilerArtifactAdapter
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`artifactsPath?` | undefined \| string | Path to your artifacts directory |
`sourcesPath?` | undefined \| string | Path to your contract sources directory |
**Returns:** *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)*
## Methods
### collectContractsDataAsync
▸ **collectContractsDataAsync**(): *`Promise<ContractData[]>`*
*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)*
*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: TruffleArtifactAdapter
## Constructors
\+ **new TruffleArtifactAdapter**(`projectRoot`: string, `solcVersion`: string): *[TruffleArtifactAdapter](#class-truffleartifactadapter)*
*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:29](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L29)*
Instantiates a TruffleArtifactAdapter
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`projectRoot` | string | Path to the truffle project's root directory |
`solcVersion` | string | Solidity version with which to compile all the contracts |
**Returns:** *[TruffleArtifactAdapter](#class-truffleartifactadapter)*
## Methods
### collectContractsDataAsync
▸ **collectContractsDataAsync**(): *`Promise<ContractData[]>`*
*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)*
*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
## Type aliases
### Callback
Ƭ **Callback**: *function*
*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L131)*
#### Type declaration:
▸ (): *void*
___
### ErrorCallback
Ƭ **ErrorCallback**: *function*
*Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L130)*
#### Type declaration:
▸ (`err`: `Error` | null, `data?`: any): *void*
**Parameters:**
Name | Type |
------ | ------ |
`err` | `Error` \| null |
`data?` | any |
___
### NextCallback
Ƭ **NextCallback**: *function*
*Defined in [subproviders/src/types.ts:133](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L133)*
#### Type declaration:
▸ (`callback?`: [OnNextCompleted](#onnextcompleted)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`callback?` | [OnNextCompleted](#onnextcompleted) |
___
### OnNextCompleted
Ƭ **OnNextCompleted**: *function*
*Defined in [subproviders/src/types.ts:132](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L132)*
#### Type declaration:
▸ (`err`: `Error` | null, `result`: any, `cb`: [Callback](#callback)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`err` | `Error` \| null |
`result` | any |
`cb` | [Callback](#callback) |
<hr />
# Interface: JSONRPCRequestPayload
## Properties
### id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L331)*
___
### jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:332](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L332)*
___
### method
• **method**: *string*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L330)*
___
### params
• **params**: *any[]*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L329)*
<hr />
# Interface: JSONRPCResponseError
## Properties
### code
• **code**: *number*
*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L337)*
___
### message
• **message**: *string*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L336)*
<hr />
# Interface: JSONRPCResponsePayload
## Properties
### `Optional` error
• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)*
*Defined in [ethereum-types/src/index.ts:344](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L344)*
___
### id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L342)*
___
### jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L343)*
___
### result
• **result**: *any*
*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L341)*
<hr />
# Class: 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/c93b02d55/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/34538f2ce/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/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts#L4)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: SolCompilerArtifactAdapter
## Constructors
\+ **new SolCompilerArtifactAdapter**(`artifactsPath?`: undefined | string, `sourcesPath?`: undefined | string): *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)*
*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L18)*
Instantiates a SolCompilerArtifactAdapter
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`artifactsPath?` | undefined \| string | Path to your artifacts directory |
`sourcesPath?` | undefined \| string | Path to your contract sources directory |
**Returns:** *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)*
## Methods
### collectContractsDataAsync
▸ **collectContractsDataAsync**(): *`Promise<ContractData[]>`*
*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)*
*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: TruffleArtifactAdapter
## Constructors
\+ **new TruffleArtifactAdapter**(`projectRoot`: string, `solcVersion`: string): *[TruffleArtifactAdapter](#class-truffleartifactadapter)*
*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:29](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L29)*
Instantiates a TruffleArtifactAdapter
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`projectRoot` | string | Path to the truffle project's root directory |
`solcVersion` | string | Solidity version with which to compile all the contracts |
**Returns:** *[TruffleArtifactAdapter](#class-truffleartifactadapter)*
## Methods
### collectContractsDataAsync
▸ **collectContractsDataAsync**(): *`Promise<ContractData[]>`*
*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)*
*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:40](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Interface: JSONRPCRequestPayload
## Properties
### id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L330)*
___
### jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L331)*
___
### method
• **method**: *string*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L329)*
___
### params
• **params**: *any[]*
*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L328)*
<hr />
# Interface: JSONRPCResponseError
## Properties
### code
• **code**: *number*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L336)*
___
### message
• **message**: *string*
*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L335)*
<hr />
# Interface: JSONRPCResponsePayload
## Properties
### `Optional` error
• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)*
*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L343)*
___
### id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L341)*
___
### jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L342)*
___
### result
• **result**: *any*
*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L340)*
<hr />
@ -483,7 +561,7 @@ ___
Defined in ethereum-types/lib/index.d.ts:267
Defined in ethereum-types/lib/index.d.ts:268
___
@ -493,7 +571,7 @@ ___
Defined in ethereum-types/lib/index.d.ts:268
Defined in ethereum-types/lib/index.d.ts:269
___
@ -503,7 +581,7 @@ ___
*Overrides void*
*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L136)*
*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L136)*
___
@ -513,7 +591,7 @@ ___
Defined in ethereum-types/lib/index.d.ts:265
Defined in ethereum-types/lib/index.d.ts:266
<hr />
@ -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/c93b02d55/packages/subproviders/src/types.ts#L131)*
#### Type declaration:
▸ (): *void*
___
### ErrorCallback
Ƭ **ErrorCallback**: *function*
*Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L130)*
#### Type declaration:
▸ (`err`: `Error` | null, `data?`: any): *void*
**Parameters:**
Name | Type |
------ | ------ |
`err` | `Error` \| null |
`data?` | any |
___
### NextCallback
Ƭ **NextCallback**: *function*
*Defined in [subproviders/src/types.ts:133](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L133)*
#### Type declaration:
▸ (`callback?`: [OnNextCompleted](#onnextcompleted)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`callback?` | [OnNextCompleted](#onnextcompleted) |
___
### OnNextCompleted
Ƭ **OnNextCompleted**: *function*
*Defined in [subproviders/src/types.ts:132](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L132)*
#### Type declaration:
▸ (`err`: `Error` | null, `result`: any, `cb`: [Callback](#callback)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`err` | `Error` \| null |
`result` | any |
`cb` | [Callback](#callback) |
<hr />
<hr />
<hr />
<hr />
<hr />

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

@ -5,7 +5,8 @@
{
"note": "Dependencies updated"
}
]
],
"timestamp": 1574030254
},
{
"version": "6.1.0-beta.1",

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.2 - _November 17, 2019_
* Dependencies updated
## v6.1.0-beta.1 - _November 7, 2019_
* Dependencies updated

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

@ -5,7 +5,8 @@
{
"note": "Dependencies updated"
}
]
],
"timestamp": 1574030254
},
{
"version": "2.1.0-beta.1",

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.2 - _November 17, 2019_
* Dependencies updated
## v2.1.0-beta.1 - _November 7, 2019_
* All references to network ID have been removed, and references to chain ID have been introduced instead (#2313)

3
packages/subproviders/CHANGELOG.json
View File

@ -6,7 +6,8 @@
"note": "Adds DebugSubprovider",
"pr": 2329
}
]
],
"timestamp": 1574030254
},
{
"version": "5.1.0-beta.1",

4
packages/subproviders/CHANGELOG.md
View File

@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
CHANGELOG
## v5.1.0-beta.2 - _November 17, 2019_
* Adds DebugSubprovider (#2329)
## v5.1.0-beta.1 - _November 7, 2019_
* Dependencies updated

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

File diff suppressed because it is too large Load Diff

3
packages/tslint-config/CHANGELOG.json
View File

@ -5,7 +5,8 @@
{
"note": "Dependencies updated"
}
]
],
"timestamp": 1574030254
},
{
"version": "3.1.0-beta.1",

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