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

Update doc references

Browse Source
This commit is contained in:
fabioberger
2019-08-29 00:09:27 +02:00
parent 6b20c9a542
commit 1a73daf82a
14 changed files with 6068 additions and 4795 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

@@ -1,237 +1,74 @@
# Class: HttpClient
<hr />
This class includes all the functionality related to interacting with a set of HTTP endpoints
that implement the standard relayer API v2
<hr />
### Hierarchy
<hr />
* **HttpClient**
<hr />
### Implements
<hr />
* [Client](#interface-client)
<hr />
### Constructors
<hr />
## constructer
<hr />
\+ **new HttpClient**(`url`: string): *[HttpClient](#class-httpclient)*
<hr />
*Defined in [connect/src/http_client.ts:44](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/connect/src/http_client.ts#L44)*
<hr />
Instantiates a new HttpClient instance
<hr />
**Parameters:**
<hr />
Name | Type | Description |
------ | ------ | ------ |
`url` | string | The relayer API base HTTP url you would like to interact with |
# External module: "types/src/index"
**Returns:** *[HttpClient](#class-httpclient)*
### Type aliases
An instance of HttpClient
#___
### Methods
#___
## getAssetPairsAsync
## AssetPairsResponse
▸ **getAssetPairsAsync**(`requestOpts?`: `RequestOpts` & `AssetPairsRequestOpts` & `PagedRequestOpts`): *`Promise<AssetPairsResponse>`*
Ƭ **AssetPairsResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*[AssetPairsItem](#interface-assetpairsitem)*›*
*Defined in [connect/src/http_client.ts:59](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/connect/src/http_client.ts#L59)*
Retrieve assetData pair info from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`requestOpts?` | `RequestOpts` & `AssetPairsRequestOpts` & `PagedRequestOpts` | Options specifying assetData information to retrieve, page information, and network id. |
**Returns:** *`Promise<AssetPairsResponse>`*
The resulting AssetPairsResponse that match the request
*Defined in [types/src/index.ts:403](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L403)*
___
## getFeeRecipientsAsync
#___
▸ **getFeeRecipientsAsync**(`requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise<FeeRecipientsResponse>`*
#___
*Defined in [connect/src/http_client.ts:160](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/connect/src/http_client.ts#L160)*
## FeeRecipientsResponse
Retrieve the list of fee recipient addresses used by the relayer.
Ƭ **FeeRecipientsResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*string*›*
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`requestOpts?` | `RequestOpts` & `PagedRequestOpts` | Options specifying page information, and network id. |
**Returns:** *`Promise<FeeRecipientsResponse>`*
The resulting FeeRecipientsResponse
*Defined in [types/src/index.ts:467](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L467)*
___
## 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/30946ac11/packages/connect/src/http_client.ts#L99)*
## OrdersResponse
Retrieve a specific order from the API
Ƭ **OrdersResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*[APIOrder](#interface-apiorder)*›*
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orderHash` | string | An orderHash generated from the desired order |
`requestOpts?` | [RequestOpts](#interface-requestopts) | - |
**Returns:** *`Promise<APIOrder>`*
The APIOrder that matches the supplied orderHash
*Defined in [types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L391)*
___
## 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/30946ac11/packages/connect/src/http_client.ts#L139)*
Retrieve fee information from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`request` | `OrderConfigRequest` | A OrderConfigRequest instance describing the specific fees to retrieve |
`requestOpts?` | [RequestOpts](#interface-requestopts) | Options specifying network id. |
**Returns:** *`Promise<OrderConfigResponse>`*
The resulting OrderConfigResponse that matches the request
___
## getOrderbookAsync
▸ **getOrderbookAsync**(`request`: `OrderbookRequest`, `requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise<OrderbookResponse>`*
*Defined in [connect/src/http_client.ts:117](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/connect/src/http_client.ts#L117)*
Retrieve an orderbook from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`request` | `OrderbookRequest` | An OrderbookRequest instance describing the specific orderbook to retrieve |
`requestOpts?` | `RequestOpts` & `PagedRequestOpts` | Options specifying page information, and network id. |
**Returns:** *`Promise<OrderbookResponse>`*
The resulting OrderbookResponse that matches the request
___
## getOrdersAsync
▸ **getOrdersAsync**(`requestOpts?`: `RequestOpts` & `OrdersRequestOpts` & `PagedRequestOpts`): *`Promise<OrdersResponse>`*
*Defined in [connect/src/http_client.ts:79](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/connect/src/http_client.ts#L79)*
Retrieve orders from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`requestOpts?` | `RequestOpts` & `OrdersRequestOpts` & `PagedRequestOpts` | Options specifying orders to retrieve and page information, page information, and network id. |
**Returns:** *`Promise<OrdersResponse>`*
The resulting OrdersResponse that match the request
___
## submitOrderAsync
▸ **submitOrderAsync**(`signedOrder`: `SignedOrder`, `requestOpts?`: [RequestOpts](#interface-requestopts)): *`Promise<void>`*
*Defined in [connect/src/http_client.ts:177](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/connect/src/http_client.ts#L177)*
Submit a signed order to the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`signedOrder` | `SignedOrder` | A SignedOrder instance to submit |
`requestOpts?` | [RequestOpts](#interface-requestopts) | Options specifying network id. |
**Returns:** *`Promise<void>`*
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
# Interface: Client
### Hierarchy
* **Client**
### Implemented by
* [HttpClient](#class-httpclient)
### Properties
## getAssetPairsAsync
• **getAssetPairsAsync**: *function*
*Defined in [connect/src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/connect/src/types.ts#L18)*
#### Type declaration:
▸ (`requestOpts?`: `AssetPairsRequestOpts` & `PagedRequestOpts`): *`Promise<PaginatedCollection<AssetPairsItem>>`*
**Parameters:**
Name | Type |
------ | ------ |
`requestOpts?` | `AssetPairsRequestOpts` & `PagedRequestOpts` |
___
#___
## getFeeRecipientsAsync
• **getFeeRecipientsAsync**: *function*
*Defined in [connect/src/types.ts:25](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/connect/src/types.ts#L25)*
*Defined in [connect/src/types.ts:25](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/connect/src/types.ts#L25)*
#### Type declaration:
@@ -249,7 +86,7 @@ ___
• **getOrderAsync**: *function*
*Defined in [connect/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/connect/src/types.ts#L22)*
*Defined in [connect/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/connect/src/types.ts#L22)*
#### Type declaration:
@@ -267,7 +104,7 @@ ___
• **getOrderConfigAsync**: *function*
*Defined in [connect/src/types.ts:24](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/connect/src/types.ts#L24)*
*Defined in [connect/src/types.ts:24](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/connect/src/types.ts#L24)*
#### Type declaration:
@@ -285,7 +122,7 @@ ___
• **getOrderbookAsync**: *function*
*Defined in [connect/src/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/connect/src/types.ts#L23)*
*Defined in [connect/src/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/connect/src/types.ts#L23)*
#### Type declaration:
@@ -304,7 +141,7 @@ ___
• **getOrdersAsync**: *function*
*Defined in [connect/src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/connect/src/types.ts#L21)*
*Defined in [connect/src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/connect/src/types.ts#L21)*
#### Type declaration:
@@ -322,7 +159,7 @@ ___
• **submitOrderAsync**: *function*
*Defined in [connect/src/types.ts:26](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/connect/src/types.ts#L26)*
*Defined in [connect/src/types.ts:26](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/connect/src/types.ts#L26)*
#### Type declaration:
@@ -354,7 +191,7 @@ Name | Type |
• **metaData**: *object*
*Defined in [types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L395)*
*Defined in [types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L395)*
___
@@ -362,7 +199,7 @@ ___
• **order**: *[SignedOrder](#class-signedorder)*
*Defined in [types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L394)*
*Defined in [types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L394)*
<hr />
@@ -428,6 +265,181 @@ ___
<hr />
# Class: HttpClient
This class includes all the functionality related to interacting with a set of HTTP endpoints
that implement the standard relayer API v2
### Hierarchy
* **HttpClient**
### Implements
* [Client](#interface-client)
### Constructors
## constructer
\+ **new HttpClient**(`url`: string): *[HttpClient](#class-httpclient)*
*Defined in [connect/src/http_client.ts:44](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/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/6b20c9a54/packages/connect/src/http_client.ts#L59)*
Retrieve assetData pair info from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`requestOpts?` | `RequestOpts` & `AssetPairsRequestOpts` & `PagedRequestOpts` | Options specifying assetData information to retrieve, page information, and network id. |
**Returns:** *`Promise<AssetPairsResponse>`*
The resulting AssetPairsResponse that match the request
___
## getFeeRecipientsAsync
▸ **getFeeRecipientsAsync**(`requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise<FeeRecipientsResponse>`*
*Defined in [connect/src/http_client.ts:160](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/connect/src/http_client.ts#L160)*
Retrieve the list of fee recipient addresses used by the relayer.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`requestOpts?` | `RequestOpts` & `PagedRequestOpts` | Options specifying page information, and network id. |
**Returns:** *`Promise<FeeRecipientsResponse>`*
The resulting FeeRecipientsResponse
___
## 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/6b20c9a54/packages/connect/src/http_client.ts#L99)*
Retrieve a specific order from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orderHash` | string | An orderHash generated from the desired order |
`requestOpts?` | [RequestOpts](#interface-requestopts) | - |
**Returns:** *`Promise<APIOrder>`*
The APIOrder that matches the supplied orderHash
___
## 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/6b20c9a54/packages/connect/src/http_client.ts#L139)*
Retrieve fee information from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`request` | `OrderConfigRequest` | A OrderConfigRequest instance describing the specific fees to retrieve |
`requestOpts?` | [RequestOpts](#interface-requestopts) | Options specifying network id. |
**Returns:** *`Promise<OrderConfigResponse>`*
The resulting OrderConfigResponse that matches the request
___
## getOrderbookAsync
▸ **getOrderbookAsync**(`request`: `OrderbookRequest`, `requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise<OrderbookResponse>`*
*Defined in [connect/src/http_client.ts:117](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/connect/src/http_client.ts#L117)*
Retrieve an orderbook from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`request` | `OrderbookRequest` | An OrderbookRequest instance describing the specific orderbook to retrieve |
`requestOpts?` | `RequestOpts` & `PagedRequestOpts` | Options specifying page information, and network id. |
**Returns:** *`Promise<OrderbookResponse>`*
The resulting OrderbookResponse that matches the request
___
## getOrdersAsync
▸ **getOrdersAsync**(`requestOpts?`: `RequestOpts` & `OrdersRequestOpts` & `PagedRequestOpts`): *`Promise<OrdersResponse>`*
*Defined in [connect/src/http_client.ts:79](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/connect/src/http_client.ts#L79)*
Retrieve orders from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`requestOpts?` | `RequestOpts` & `OrdersRequestOpts` & `PagedRequestOpts` | Options specifying orders to retrieve and page information, page information, and network id. |
**Returns:** *`Promise<OrdersResponse>`*
The resulting OrdersResponse that match the request
___
## submitOrderAsync
▸ **submitOrderAsync**(`signedOrder`: `SignedOrder`, `requestOpts?`: [RequestOpts](#interface-requestopts)): *`Promise<void>`*
*Defined in [connect/src/http_client.ts:177](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/connect/src/http_client.ts#L177)*
Submit a signed order to the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`signedOrder` | `SignedOrder` | A SignedOrder instance to submit |
`requestOpts?` | [RequestOpts](#interface-requestopts) | Options specifying network id. |
**Returns:** *`Promise<void>`*
<hr />
<hr />
@@ -472,7 +484,7 @@ ___
• **page**? : *undefined | number*
*Defined in [types/src/index.ts:474](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L474)*
*Defined in [types/src/index.ts:474](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L474)*
___
@@ -480,7 +492,7 @@ ___
• **perPage**? : *undefined | number*
*Defined in [types/src/index.ts:475](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L475)*
*Defined in [types/src/index.ts:475](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L475)*
<hr />
@@ -500,7 +512,7 @@ ___
• **page**: *number*
*Defined in [types/src/index.ts:444](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L444)*
*Defined in [types/src/index.ts:444](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L444)*
___
@@ -508,7 +520,7 @@ ___
• **perPage**: *number*
*Defined in [types/src/index.ts:445](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L445)*
*Defined in [types/src/index.ts:445](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L445)*
___
@@ -516,7 +528,7 @@ ___
• **records**: *`T`[]*
*Defined in [types/src/index.ts:446](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L446)*
*Defined in [types/src/index.ts:446](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L446)*
___
@@ -524,7 +536,7 @@ ___
• **total**: *number*
*Defined in [types/src/index.ts:443](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L443)*
*Defined in [types/src/index.ts:443](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L443)*
<hr />
@@ -544,7 +556,7 @@ ___
• **networkId**? : *undefined | number*
*Defined in [types/src/index.ts:470](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L470)*
*Defined in [types/src/index.ts:470](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L470)*
<hr />
@@ -564,7 +576,7 @@ ___
*Inherited from [Order](_types_src_index_.order.md).[exchangeAddress](#exchangeaddress)*
*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L20)*
*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L20)*
___
@@ -574,7 +586,7 @@ ___
*Inherited from [Order](_types_src_index_.order.md).[expirationTimeSeconds](#expirationtimeseconds)*
*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L22)*
*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L22)*
___
@@ -584,7 +596,7 @@ ___
*Inherited from [Order](_types_src_index_.order.md).[feeRecipientAddress](#feerecipientaddress)*
*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L21)*
*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L21)*
___
@@ -594,7 +606,7 @@ ___
*Inherited from [Order](_types_src_index_.order.md).[makerAddress](#makeraddress)*
*Defined in [types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L11)*
*Defined in [types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L11)*
___
@@ -604,7 +616,7 @@ ___
*Inherited from [Order](_types_src_index_.order.md).[makerAssetAmount](#makerassetamount)*
*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L15)*
*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L15)*
___
@@ -614,7 +626,7 @@ ___
*Inherited from [Order](_types_src_index_.order.md).[makerAssetData](#makerassetdata)*
*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L17)*
*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L17)*
___
@@ -624,7 +636,7 @@ ___
*Inherited from [Order](_types_src_index_.order.md).[makerFee](#makerfee)*
*Defined in [types/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L13)*
*Defined in [types/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L13)*
___
@@ -634,7 +646,7 @@ ___
*Inherited from [Order](_types_src_index_.order.md).[salt](#salt)*
*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L19)*
*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L19)*
___
@@ -644,7 +656,7 @@ ___
*Inherited from [Order](_types_src_index_.order.md).[senderAddress](#senderaddress)*
*Defined in [types/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L10)*
*Defined in [types/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L10)*
___
@@ -652,7 +664,7 @@ ___
• **signature**: *string*
*Defined in [types/src/index.ts:41](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L41)*
*Defined in [types/src/index.ts:41](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L41)*
___
@@ -662,7 +674,7 @@ ___
*Inherited from [Order](_types_src_index_.order.md).[takerAddress](#takeraddress)*
*Defined in [types/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L12)*
*Defined in [types/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L12)*
___
@@ -672,7 +684,7 @@ ___
*Inherited from [Order](_types_src_index_.order.md).[takerAssetAmount](#takerassetamount)*
*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L16)*
*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L16)*
___
@@ -682,7 +694,7 @@ ___
*Inherited from [Order](_types_src_index_.order.md).[takerAssetData](#takerassetdata)*
*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L18)*
*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L18)*
___
@@ -692,7 +704,7 @@ ___
*Inherited from [Order](_types_src_index_.order.md).[takerFee](#takerfee)*
*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L14)*
*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/types/src/index.ts#L14)*
<hr />
@@ -744,6 +756,10 @@ ___
<hr />
# External module: "connect/src/types"
<hr />
# External module: "connect/src/http_client"
<hr />
@@ -756,13 +772,13 @@ ___
## ▪ **ordersChannelFactory**: *object*
*Defined in [connect/src/orders_channel_factory.ts:7](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/connect/src/orders_channel_factory.ts#L7)*
*Defined in [connect/src/orders_channel_factory.ts:7](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/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/30946ac11/packages/connect/src/orders_channel_factory.ts#L15)*
*Defined in [connect/src/orders_channel_factory.ts:15](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/connect/src/orders_channel_factory.ts#L15)*
Instantiates a new WebSocketOrdersChannel instance
@@ -779,55 +795,3 @@ An OrdersChannel Promise
<hr />
# External module: "connect/src/types"
<hr />
# External module: "types/src/index"
### Type aliases
#___
#___
## AssetPairsResponse
Ƭ **AssetPairsResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*[AssetPairsItem](#interface-assetpairsitem)*›*
*Defined in [types/src/index.ts:403](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L403)*
___
#___
#___
## FeeRecipientsResponse
Ƭ **FeeRecipientsResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*string*›*
*Defined in [types/src/index.ts:467](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L467)*
___
#___
#___
## OrdersResponse
Ƭ **OrdersResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*[APIOrder](#interface-apiorder)*›*
*Defined in [types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L391)*
___
## SingleAssetData
Ƭ **SingleAssetData**: *[ERC20AssetData](#interface-erc20assetdata) | [ERC721AssetData](#interface-erc721assetdata) | [ERC1155AssetData](#interface-erc1155assetdata) | [StaticCallAssetData](#interface-staticcallassetdata)*
*Defined in [types/src/index.ts:208](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/types/src/index.ts#L208)*
<hr />

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

File diff suppressed because it is too large Load Diff

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

@@ -12,7 +12,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/30946ac11/packages/json-schemas/src/schema_validator.ts#L15)*
*Defined in [schema_validator.ts:15](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/json-schemas/src/schema_validator.ts#L15)*
Instantiates a SchemaValidator instance
@@ -24,7 +24,7 @@ Instantiates a SchemaValidator instance
▸ **addSchema**(`schema`: `Schema`): *void*
*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/json-schemas/src/schema_validator.ts#L32)*
*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/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
@@ -44,7 +44,7 @@ ___
▸ **isValid**(`instance`: any, `schema`: `Schema`): *boolean*
*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/json-schemas/src/schema_validator.ts#L57)*
*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/json-schemas/src/schema_validator.ts#L57)*
Check whether an instance properly adheres to a JSON schema
@@ -65,7 +65,7 @@ ___
▸ **validate**(`instance`: any, `schema`: `Schema`): *`ValidatorResult`*
*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/json-schemas/src/schema_validator.ts#L46)*
*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/json-schemas/src/schema_validator.ts#L46)*
Validate the JS object conforms to a specific JSON schema

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

@@ -1,3 +1,26 @@
# Interface: GanacheProvider
### Hierarchy
* **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/6b20c9a54/packages/ethereum-types/src/index.ts#L14)*
**Parameters:**
Name | Type |
------ | ------ |
`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) |
`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) |
**Returns:** *void*
<hr />
<hr />
@@ -20,7 +43,7 @@
• **assetProxyOwner**: *string*
*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/contract-addresses/src/index.ts#L9)*
*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/contract-addresses/src/index.ts#L9)*
___
@@ -28,7 +51,7 @@ ___
• **coordinator**: *string*
*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/contract-addresses/src/index.ts#L14)*
*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/contract-addresses/src/index.ts#L14)*
___
@@ -36,7 +59,7 @@ ___
• **coordinatorRegistry**: *string*
*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/contract-addresses/src/index.ts#L13)*
*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/contract-addresses/src/index.ts#L13)*
___
@@ -44,7 +67,7 @@ ___
• **devUtils**: *string*
*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/contract-addresses/src/index.ts#L18)*
*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/contract-addresses/src/index.ts#L18)*
___
@@ -52,7 +75,7 @@ ___
• **dutchAuction**: *string*
*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/contract-addresses/src/index.ts#L12)*
*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/contract-addresses/src/index.ts#L12)*
___
@@ -60,7 +83,7 @@ ___
• **erc1155Proxy**: *string*
*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/contract-addresses/src/index.ts#L17)*
*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/contract-addresses/src/index.ts#L17)*
___
@@ -68,7 +91,7 @@ ___
• **erc20Proxy**: *string*
*Defined in [contract-addresses/src/index.ts:4](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/contract-addresses/src/index.ts#L4)*
*Defined in [contract-addresses/src/index.ts:4](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/contract-addresses/src/index.ts#L4)*
___
@@ -76,7 +99,7 @@ ___
• **erc721Proxy**: *string*
*Defined in [contract-addresses/src/index.ts:5](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/contract-addresses/src/index.ts#L5)*
*Defined in [contract-addresses/src/index.ts:5](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/contract-addresses/src/index.ts#L5)*
___
@@ -84,7 +107,7 @@ ___
• **etherToken**: *string*
*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/contract-addresses/src/index.ts#L7)*
*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/contract-addresses/src/index.ts#L7)*
___
@@ -92,7 +115,7 @@ ___
• **exchange**: *string*
*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/contract-addresses/src/index.ts#L8)*
*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/contract-addresses/src/index.ts#L8)*
___
@@ -100,7 +123,7 @@ ___
• **forwarder**: *string*
*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/contract-addresses/src/index.ts#L10)*
*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/contract-addresses/src/index.ts#L10)*
___
@@ -108,7 +131,7 @@ ___
• **multiAssetProxy**: *string*
*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/contract-addresses/src/index.ts#L15)*
*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/contract-addresses/src/index.ts#L15)*
___
@@ -116,7 +139,7 @@ ___
• **orderValidator**: *string*
*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/contract-addresses/src/index.ts#L11)*
*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/contract-addresses/src/index.ts#L11)*
___
@@ -124,7 +147,7 @@ ___
• **staticCallProxy**: *string*
*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/contract-addresses/src/index.ts#L16)*
*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/contract-addresses/src/index.ts#L16)*
___
@@ -132,7 +155,7 @@ ___
• **zrxToken**: *string*
*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/contract-addresses/src/index.ts#L6)*
*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/contract-addresses/src/index.ts#L6)*
<hr />
@@ -186,7 +209,7 @@ ___
• **isEIP1193**: *boolean*
*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L73)*
*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L73)*
### Methods
@@ -194,7 +217,7 @@ ___
▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this*
*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L75)*
*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L75)*
**Parameters:**
@@ -218,7 +241,7 @@ ___
▸ **send**(`method`: string, `params?`: any[]): *`Promise<any>`*
*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L74)*
*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L74)*
**Parameters:**
@@ -243,29 +266,6 @@ Name | Type |
<hr />
# Interface: GanacheProvider
### Hierarchy
* **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/30946ac11/packages/ethereum-types/src/index.ts#L14)*
**Parameters:**
Name | Type |
------ | ------ |
`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) |
`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) |
**Returns:** *void*
<hr />
<hr />
@@ -282,7 +282,7 @@ Name | Type |
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:324](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L324)*
*Defined in [ethereum-types/src/index.ts:324](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L324)*
___
@@ -290,7 +290,7 @@ ___
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:325](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L325)*
*Defined in [ethereum-types/src/index.ts:325](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L325)*
___
@@ -298,7 +298,7 @@ ___
• **method**: *string*
*Defined in [ethereum-types/src/index.ts:323](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L323)*
*Defined in [ethereum-types/src/index.ts:323](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L323)*
___
@@ -306,7 +306,7 @@ ___
• **params**: *any[]*
*Defined in [ethereum-types/src/index.ts:322](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L322)*
*Defined in [ethereum-types/src/index.ts:322](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L322)*
<hr />
@@ -322,7 +322,7 @@ ___
• **code**: *number*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L330)*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L330)*
___
@@ -330,7 +330,7 @@ ___
• **message**: *string*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L329)*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L329)*
<hr />
@@ -346,7 +346,7 @@ ___
• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)*
*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L337)*
*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L337)*
___
@@ -354,7 +354,7 @@ ___
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L335)*
*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L335)*
___
@@ -362,7 +362,7 @@ ___
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L336)*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L336)*
___
@@ -370,7 +370,7 @@ ___
• **result**: *any*
*Defined in [ethereum-types/src/index.ts:334](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L334)*
*Defined in [ethereum-types/src/index.ts:334](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L334)*
<hr />
@@ -430,7 +430,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[data](#optional-data)*
*Defined in [ethereum-types/src/index.ts:387](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L387)*
*Defined in [ethereum-types/src/index.ts:387](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L387)*
___
@@ -438,7 +438,7 @@ ___
• **from**: *string*
*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L392)*
*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L392)*
___
@@ -448,7 +448,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[gas](#optional-gas)*
*Defined in [ethereum-types/src/index.ts:385](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L385)*
*Defined in [ethereum-types/src/index.ts:385](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L385)*
___
@@ -458,7 +458,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[gasPrice](#optional-gasprice)*
*Defined in [ethereum-types/src/index.ts:386](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L386)*
*Defined in [ethereum-types/src/index.ts:386](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L386)*
___
@@ -468,7 +468,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[nonce](#optional-nonce)*
*Defined in [ethereum-types/src/index.ts:388](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L388)*
*Defined in [ethereum-types/src/index.ts:388](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L388)*
___
@@ -478,7 +478,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[to](#optional-to)*
*Defined in [ethereum-types/src/index.ts:383](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L383)*
*Defined in [ethereum-types/src/index.ts:383](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L383)*
___
@@ -488,7 +488,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[value](#optional-value)*
*Defined in [ethereum-types/src/index.ts:384](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L384)*
*Defined in [ethereum-types/src/index.ts:384](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L384)*
<hr />
@@ -508,7 +508,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[data](#optional-data)*
*Defined in [ethereum-types/src/index.ts:387](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L387)*
*Defined in [ethereum-types/src/index.ts:387](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L387)*
___
@@ -518,7 +518,7 @@ ___
*Inherited from [TxData](_ethereum_types_src_index_.txdata.md).[from](#from)*
*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L392)*
*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L392)*
___
@@ -528,7 +528,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[gas](#optional-gas)*
*Defined in [ethereum-types/src/index.ts:385](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L385)*
*Defined in [ethereum-types/src/index.ts:385](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L385)*
___
@@ -538,7 +538,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[gasPrice](#optional-gasprice)*
*Defined in [ethereum-types/src/index.ts:386](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L386)*
*Defined in [ethereum-types/src/index.ts:386](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L386)*
___
@@ -548,7 +548,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[nonce](#optional-nonce)*
*Defined in [ethereum-types/src/index.ts:388](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L388)*
*Defined in [ethereum-types/src/index.ts:388](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L388)*
___
@@ -558,7 +558,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[to](#optional-to)*
*Defined in [ethereum-types/src/index.ts:383](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L383)*
*Defined in [ethereum-types/src/index.ts:383](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L383)*
___
@@ -568,7 +568,7 @@ ___
*Overrides [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[value](#optional-value)*
*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L434)*
*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L434)*
<hr />
@@ -588,7 +588,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/30946ac11/packages/ethereum-types/src/index.ts#L45)*
*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L45)*
**Parameters:**
@@ -604,7 +604,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/30946ac11/packages/ethereum-types/src/index.ts#L44)*
*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L44)*
**Parameters:**
@@ -633,7 +633,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/30946ac11/packages/ethereum-types/src/index.ts#L54)*
*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L54)*
**Parameters:**
@@ -662,7 +662,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/30946ac11/packages/ethereum-types/src/index.ts#L63)*
*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L63)*
**Parameters:**
@@ -691,7 +691,7 @@ add here
• **isMetaMask**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L31)*
*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L31)*
___
@@ -699,7 +699,7 @@ ___
• **isParity**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L32)*
*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L32)*
___
@@ -707,7 +707,7 @@ ___
• **isZeroExProvider**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L30)*
*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L30)*
### Methods
@@ -715,7 +715,7 @@ ___
▸ **enable**(): *`Promise<void>`*
*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L34)*
*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L34)*
**Returns:** *`Promise<void>`*
@@ -725,7 +725,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/30946ac11/packages/ethereum-types/src/index.ts#L35)*
*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L35)*
**Parameters:**
@@ -742,12 +742,61 @@ ___
▸ **stop**(): *void*
*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L33)*
*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L33)*
**Returns:** *void*
<hr />
# External module: "migrations/src/migration"
### Functions
## runMigrationsAsync
▸ **runMigrationsAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `TxData`): *`Promise<ContractAddresses>`*
*Defined in [migrations/src/migration.ts:20](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/migrations/src/migration.ts#L20)*
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:296](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/migrations/src/migration.ts#L296)*
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 />
# External module: "contract-addresses/src/index"
### Functions
@@ -756,7 +805,7 @@ ___
▸ **getContractAddressesForNetworkOrThrow**(`networkId`: [NetworkId](#enumeration-networkid)): *[ContractAddresses](#interface-contractaddresses)*
*Defined in [contract-addresses/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/contract-addresses/src/index.ts#L128)*
*Defined in [contract-addresses/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/contract-addresses/src/index.ts#L128)*
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
@@ -793,7 +842,7 @@ given networkId.
Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"*
*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L70)*
*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/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
@@ -810,7 +859,7 @@ ___
Ƭ **JSONRPCErrorCallback**: *function*
*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L3)*
*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L3)*
#### Type declaration:
@@ -839,7 +888,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/30946ac11/packages/ethereum-types/src/index.ts#L9)*
*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/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.
@@ -854,56 +903,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/30946ac11/packages/ethereum-types/src/index.ts#L11)*
<hr />
# External module: "migrations/src/migration"
### Functions
## runMigrationsAsync
▸ **runMigrationsAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `TxData`): *`Promise<ContractAddresses>`*
*Defined in [migrations/src/migration.ts:20](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/migrations/src/migration.ts#L20)*
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:296](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/migrations/src/migration.ts#L296)*
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/6b20c9a54/packages/ethereum-types/src/index.ts#L11)*
<hr />

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

File diff suppressed because it is too large Load Diff

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

@@ -1,71 +1,3 @@
# Class: Compiler
The Compiler facilitates compiling Solidity smart contracts and saves the results
to artifact files.
### Hierarchy
* **Compiler**
### Constructors
## constructer
\+ **new Compiler**(`opts?`: [CompilerOptions](#interface-compileroptions)): *[Compiler](#class-compiler)*
*Defined in [sol-compiler/src/compiler.ts:94](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-compiler/src/compiler.ts#L94)*
Instantiates a new instance of the Compiler class.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`opts?` | [CompilerOptions](#interface-compileroptions) | Optional compiler options |
**Returns:** *[Compiler](#class-compiler)*
An instance of the Compiler class.
### Methods
## compileAsync
▸ **compileAsync**(): *`Promise<void>`*
*Defined in [sol-compiler/src/compiler.ts:132](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-compiler/src/compiler.ts#L132)*
Compiles selected Solidity files found in `contractsDir` and writes JSON artifacts to `artifactsDir`.
**Returns:** *`Promise<void>`*
___
## getCompilerOutputsAsync
▸ **getCompilerOutputsAsync**(): *`Promise<StandardOutput[]>`*
*Defined in [sol-compiler/src/compiler.ts:145](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-compiler/src/compiler.ts#L145)*
Compiles Solidity files specified during instantiation, and returns the
compiler output given by solc. Return value is an array of outputs:
Solidity modules are batched together by version required, and each
element of the returned array corresponds to a compiler version, and
each element contains the output for all of the modules compiled with
that version.
**Returns:** *`Promise<StandardOutput[]>`*
___
## watchAsync
▸ **watchAsync**(): *`Promise<void>`*
*Defined in [sol-compiler/src/compiler.ts:149](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-compiler/src/compiler.ts#L149)*
**Returns:** *`Promise<void>`*
<hr />
<hr />
@@ -76,6 +8,10 @@ ___
<hr />
# External module: "sol-compiler/src/compiler"
<hr />
<hr />
<hr />
@@ -110,7 +46,7 @@ contracts to compile with the the version specified here.
• **artifactsDir**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:723](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L723)*
*Defined in [ethereum-types/src/index.ts:723](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L723)*
___
@@ -118,7 +54,7 @@ ___
• **compilerSettings**? : *[CompilerSettings](#class-compilersettings)*
*Defined in [ethereum-types/src/index.ts:724](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L724)*
*Defined in [ethereum-types/src/index.ts:724](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L724)*
___
@@ -126,7 +62,7 @@ ___
• **contracts**? : *string[] | "*"*
*Defined in [ethereum-types/src/index.ts:725](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L725)*
*Defined in [ethereum-types/src/index.ts:725](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L725)*
___
@@ -134,7 +70,7 @@ ___
• **contractsDir**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:722](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L722)*
*Defined in [ethereum-types/src/index.ts:722](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L722)*
___
@@ -142,7 +78,7 @@ ___
• **isOfflineMode**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:727](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L727)*
*Defined in [ethereum-types/src/index.ts:727](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L727)*
___
@@ -150,7 +86,7 @@ ___
• **solcVersion**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:728](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L728)*
*Defined in [ethereum-types/src/index.ts:728](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L728)*
___
@@ -158,7 +94,7 @@ ___
• **useDockerisedSolc**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:726](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L726)*
*Defined in [ethereum-types/src/index.ts:726](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L726)*
<hr />
@@ -176,7 +112,7 @@ ___
• **evmVersion**? : *"homestead" | "tangerineWhistle" | "spuriousDragon" | "byzantium" | "constantinople"*
*Defined in [ethereum-types/src/index.ts:681](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L681)*
*Defined in [ethereum-types/src/index.ts:681](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L681)*
___
@@ -184,7 +120,7 @@ ___
• **libraries**? : *undefined | object*
*Defined in [ethereum-types/src/index.ts:683](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L683)*
*Defined in [ethereum-types/src/index.ts:683](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L683)*
___
@@ -192,7 +128,7 @@ ___
• **metadata**? : *[CompilerSettingsMetadata](#class-compilersettingsmetadata)*
*Defined in [ethereum-types/src/index.ts:682](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L682)*
*Defined in [ethereum-types/src/index.ts:682](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L682)*
___
@@ -200,7 +136,7 @@ ___
• **optimizer**? : *[OptimizerSettings](#class-optimizersettings)*
*Defined in [ethereum-types/src/index.ts:680](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L680)*
*Defined in [ethereum-types/src/index.ts:680](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L680)*
___
@@ -208,7 +144,7 @@ ___
• **outputSelection**: *object*
*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L688)*
*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L688)*
#### Type declaration:
@@ -222,7 +158,7 @@ ___
• **remappings**? : *string[]*
*Defined in [ethereum-types/src/index.ts:679](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L679)*
*Defined in [ethereum-types/src/index.ts:679](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L679)*
<hr />
@@ -238,7 +174,7 @@ ___
• **useLiteralContent**: *true*
*Defined in [ethereum-types/src/index.ts:696](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L696)*
*Defined in [ethereum-types/src/index.ts:696](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L696)*
<hr />
@@ -254,7 +190,7 @@ ___
• **inputs**: *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L103)*
*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L103)*
___
@@ -262,7 +198,7 @@ ___
• **payable**: *boolean*
*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L104)*
*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L104)*
___
@@ -270,7 +206,7 @@ ___
• **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)*
*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L105)*
*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L105)*
___
@@ -278,7 +214,7 @@ ___
• **type**: *string*
*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L102)*
*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L102)*
<hr />
@@ -306,7 +242,7 @@ ___
• **components**? : *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L131)*
*Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L131)*
___
@@ -314,7 +250,7 @@ ___
• **name**: *string*
*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L129)*
*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L129)*
___
@@ -322,7 +258,7 @@ ___
• **type**: *string*
*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L130)*
*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L130)*
<hr />
@@ -344,7 +280,7 @@ ___
• **author**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:620](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L620)*
*Defined in [ethereum-types/src/index.ts:620](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L620)*
___
@@ -352,7 +288,7 @@ ___
• **methods**: *object*
*Defined in [ethereum-types/src/index.ts:621](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L621)*
*Defined in [ethereum-types/src/index.ts:621](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L621)*
#### Type declaration:
@@ -364,7 +300,7 @@ ___
• **title**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:619](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L619)*
*Defined in [ethereum-types/src/index.ts:619](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L619)*
<hr />
@@ -382,7 +318,7 @@ ___
• **anonymous**: *boolean*
*Defined in [ethereum-types/src/index.ts:125](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L125)*
*Defined in [ethereum-types/src/index.ts:125](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L125)*
___
@@ -390,7 +326,7 @@ ___
• **inputs**: *[EventParameter](#class-eventparameter)[]*
*Defined in [ethereum-types/src/index.ts:124](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L124)*
*Defined in [ethereum-types/src/index.ts:124](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L124)*
___
@@ -398,7 +334,7 @@ ___
• **name**: *string*
*Defined in [ethereum-types/src/index.ts:123](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L123)*
*Defined in [ethereum-types/src/index.ts:123](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L123)*
___
@@ -406,7 +342,7 @@ ___
• **type**: *string*
*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L122)*
*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L122)*
<hr />
@@ -426,7 +362,7 @@ ___
*Inherited from [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)*
*Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L131)*
*Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L131)*
___
@@ -434,7 +370,7 @@ ___
• **indexed**: *boolean*
*Defined in [ethereum-types/src/index.ts:116](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L116)*
*Defined in [ethereum-types/src/index.ts:116](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L116)*
___
@@ -444,7 +380,7 @@ ___
*Inherited from [DataItem](_ethereum_types_src_index_.dataitem.md).[name](#name)*
*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L129)*
*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L129)*
___
@@ -454,7 +390,7 @@ ___
*Inherited from [DataItem](_ethereum_types_src_index_.dataitem.md).[type](#type)*
*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L130)*
*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L130)*
<hr />
@@ -470,7 +406,7 @@ ___
• **object**: *string*
*Defined in [ethereum-types/src/index.ts:614](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L614)*
*Defined in [ethereum-types/src/index.ts:614](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L614)*
___
@@ -478,7 +414,7 @@ ___
• **sourceMap**: *string*
*Defined in [ethereum-types/src/index.ts:615](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L615)*
*Defined in [ethereum-types/src/index.ts:615](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L615)*
<hr />
@@ -494,7 +430,7 @@ ___
• **bytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)*
*Defined in [ethereum-types/src/index.ts:609](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L609)*
*Defined in [ethereum-types/src/index.ts:609](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L609)*
___
@@ -502,7 +438,7 @@ ___
• **deployedBytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)*
*Defined in [ethereum-types/src/index.ts:610](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L610)*
*Defined in [ethereum-types/src/index.ts:610](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L610)*
<hr />
@@ -518,7 +454,7 @@ ___
• **payable**: *boolean*
*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L112)*
*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L112)*
___
@@ -526,12 +462,80 @@ ___
• **type**: *string*
*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L111)*
*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L111)*
<hr />
<hr />
# Class: Compiler
The Compiler facilitates compiling Solidity smart contracts and saves the results
to artifact files.
### Hierarchy
* **Compiler**
### Constructors
## constructer
\+ **new Compiler**(`opts?`: [CompilerOptions](#interface-compileroptions)): *[Compiler](#class-compiler)*
*Defined in [sol-compiler/src/compiler.ts:94](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-compiler/src/compiler.ts#L94)*
Instantiates a new instance of the Compiler class.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`opts?` | [CompilerOptions](#interface-compileroptions) | Optional compiler options |
**Returns:** *[Compiler](#class-compiler)*
An instance of the Compiler class.
### Methods
## compileAsync
▸ **compileAsync**(): *`Promise<void>`*
*Defined in [sol-compiler/src/compiler.ts:132](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-compiler/src/compiler.ts#L132)*
Compiles selected Solidity files found in `contractsDir` and writes JSON artifacts to `artifactsDir`.
**Returns:** *`Promise<void>`*
___
## getCompilerOutputsAsync
▸ **getCompilerOutputsAsync**(): *`Promise<StandardOutput[]>`*
*Defined in [sol-compiler/src/compiler.ts:145](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-compiler/src/compiler.ts#L145)*
Compiles Solidity files specified during instantiation, and returns the
compiler output given by solc. Return value is an array of outputs:
Solidity modules are batched together by version required, and each
element of the returned array corresponds to a compiler version, and
each element contains the output for all of the modules compiled with
that version.
**Returns:** *`Promise<StandardOutput[]>`*
___
## watchAsync
▸ **watchAsync**(): *`Promise<void>`*
*Defined in [sol-compiler/src/compiler.ts:149](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-compiler/src/compiler.ts#L149)*
**Returns:** *`Promise<void>`*
<hr />
<hr />
@@ -560,7 +564,7 @@ ___
• **constant**: *boolean*
*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L94)*
*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L94)*
___
@@ -568,7 +572,7 @@ ___
• **inputs**: *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L92)*
*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L92)*
___
@@ -576,7 +580,7 @@ ___
• **name**: *string*
*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L91)*
*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L91)*
___
@@ -584,7 +588,7 @@ ___
• **outputs**: *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L93)*
*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L93)*
___
@@ -592,7 +596,7 @@ ___
• **payable**: *boolean*
*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L96)*
*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L96)*
___
@@ -600,7 +604,7 @@ ___
• **stateMutability**: *[StateMutability](#statemutability)*
*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L95)*
*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L95)*
___
@@ -608,7 +612,7 @@ ___
• **type**: *string*
*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L90)*
*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L90)*
<hr />
@@ -624,7 +628,7 @@ ___
• **enabled**: *boolean*
*Defined in [ethereum-types/src/index.ts:700](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L700)*
*Defined in [ethereum-types/src/index.ts:700](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L700)*
___
@@ -632,7 +636,7 @@ ___
• **runs**? : *undefined | number*
*Defined in [ethereum-types/src/index.ts:701](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L701)*
*Defined in [ethereum-types/src/index.ts:701](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L701)*
<hr />
@@ -652,7 +656,7 @@ ___
• **component**: *"general" | "ewasm"*
*Defined in [ethereum-types/src/index.ts:596](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L596)*
*Defined in [ethereum-types/src/index.ts:596](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L596)*
___
@@ -660,7 +664,7 @@ ___
• **formattedMessage**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:599](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L599)*
*Defined in [ethereum-types/src/index.ts:599](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L599)*
___
@@ -668,7 +672,7 @@ ___
• **message**: *string*
*Defined in [ethereum-types/src/index.ts:598](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L598)*
*Defined in [ethereum-types/src/index.ts:598](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L598)*
___
@@ -676,7 +680,7 @@ ___
• **severity**: *[ErrorSeverity](#errorseverity)*
*Defined in [ethereum-types/src/index.ts:597](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L597)*
*Defined in [ethereum-types/src/index.ts:597](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L597)*
___
@@ -684,7 +688,7 @@ ___
• **sourceLocation**? : *[SourceLocation](#class-sourcelocation)*
*Defined in [ethereum-types/src/index.ts:594](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L594)*
*Defined in [ethereum-types/src/index.ts:594](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L594)*
___
@@ -692,7 +696,7 @@ ___
• **type**: *[ErrorType](#errortype)*
*Defined in [ethereum-types/src/index.ts:595](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L595)*
*Defined in [ethereum-types/src/index.ts:595](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L595)*
<hr />
@@ -712,7 +716,7 @@ ___
• **abi**: *[ContractAbi](#contractabi)*
*Defined in [ethereum-types/src/index.ts:556](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L556)*
*Defined in [ethereum-types/src/index.ts:556](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L556)*
___
@@ -720,7 +724,7 @@ ___
• **devdoc**? : *[DevdocOutput](#class-devdocoutput)*
*Defined in [ethereum-types/src/index.ts:558](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L558)*
*Defined in [ethereum-types/src/index.ts:558](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L558)*
___
@@ -728,7 +732,7 @@ ___
• **evm**: *[EvmOutput](#class-evmoutput)*
*Defined in [ethereum-types/src/index.ts:557](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L557)*
*Defined in [ethereum-types/src/index.ts:557](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L557)*
<hr />
@@ -744,7 +748,7 @@ ___
• **contracts**: *object*
*Defined in [ethereum-types/src/index.ts:570](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L570)*
*Defined in [ethereum-types/src/index.ts:570](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L570)*
#### Type declaration:
@@ -758,7 +762,7 @@ ___
• **errors**: *[SolcError](#class-solcerror)[]*
*Defined in [ethereum-types/src/index.ts:562](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L562)*
*Defined in [ethereum-types/src/index.ts:562](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L562)*
___
@@ -766,7 +770,7 @@ ___
• **sources**: *object*
*Defined in [ethereum-types/src/index.ts:563](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L563)*
*Defined in [ethereum-types/src/index.ts:563](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L563)*
#### Type declaration:
@@ -802,7 +806,7 @@ ___
*Overrides [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)*
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L135)*
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L135)*
___
@@ -812,7 +816,7 @@ ___
*Inherited from [DataItem](_ethereum_types_src_index_.dataitem.md).[name](#name)*
*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L129)*
*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L129)*
___
@@ -822,7 +826,7 @@ ___
*Inherited from [DataItem](_ethereum_types_src_index_.dataitem.md).[type](#type)*
*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L130)*
*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L130)*
<hr />
@@ -846,7 +850,7 @@ ___
Ƭ **AbiDefinition**: *[FunctionAbi](_ethereum_types_src_index_.md#functionabi) | [EventAbi](#interface-eventabi)*
*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L80)*
*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L80)*
___
@@ -856,7 +860,7 @@ ___
Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"*
*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L84)*
*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L84)*
___
@@ -864,7 +868,7 @@ ___
Ƭ **ContractAbi**: *[AbiDefinition](#abidefinition)[]*
*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L78)*
*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L78)*
___
@@ -876,7 +880,7 @@ ___
Ƭ **ErrorSeverity**: *"error" | "warning"*
*Defined in [ethereum-types/src/index.ts:591](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L591)*
*Defined in [ethereum-types/src/index.ts:591](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L591)*
___
@@ -884,7 +888,7 @@ ___
Ƭ **ErrorType**: *"JSONError" | "IOError" | "ParserError" | "DocstringParsingError" | "SyntaxError" | "DeclarationError" | "TypeError" | "UnimplementedFeatureError" | "InternalCompilerError" | "Exception" | "CompilerError" | "FatalError" | "Warning"*
*Defined in [ethereum-types/src/index.ts:577](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L577)*
*Defined in [ethereum-types/src/index.ts:577](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L577)*
___
@@ -892,7 +896,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/30946ac11/packages/ethereum-types/src/index.ts#L82)*
*Defined in [ethereum-types/src/index.ts:82](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L82)*
___
@@ -904,7 +908,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:517](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L517)*
*Defined in [ethereum-types/src/index.ts:517](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L517)*
___
@@ -912,7 +916,7 @@ ___
Ƭ **ParamDescription**: *string*
*Defined in [ethereum-types/src/index.ts:553](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L553)*
*Defined in [ethereum-types/src/index.ts:553](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L553)*
___
@@ -922,7 +926,7 @@ ___
Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)*
*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L85)*
*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L85)*
___
@@ -936,11 +940,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/30946ac11/packages/ethereum-types/src/index.ts#L11)*
*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L11)*
<hr />
# External module: "sol-compiler/src/compiler"
<hr />

836
packages/sol-coverage/docs/reference.mdx
View File

@@ -1,3 +1,394 @@
<hr />
# Class: AbstractArtifactAdapter
### Hierarchy
* **AbstractArtifactAdapter**
* [SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)
* [TruffleArtifactAdapter](#class-truffleartifactadapter)
### 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/6b20c9a54/packages/sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts#L4)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: SolCompilerArtifactAdapter
### Hierarchy
* [AbstractArtifactAdapter](#class-abstractartifactadapter)
* **SolCompilerArtifactAdapter**
### Constructors
## constructer
\+ **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/6b20c9a54/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/6b20c9a54/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: TruffleArtifactAdapter
### Hierarchy
* [AbstractArtifactAdapter](#class-abstractartifactadapter)
* **TruffleArtifactAdapter**
### Constructors
## constructer
\+ **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/6b20c9a54/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/6b20c9a54/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
# External module: "subproviders/src/types"
### Type aliases
## Callback
Ƭ **Callback**: *function*
*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/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/6b20c9a54/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/6b20c9a54/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/6b20c9a54/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 />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
# Interface: JSONRPCRequestPayload
### Hierarchy
* **JSONRPCRequestPayload**
### Properties
## id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:324](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L324)*
___
## jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:325](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L325)*
___
## method
• **method**: *string*
*Defined in [ethereum-types/src/index.ts:323](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L323)*
___
## params
• **params**: *any[]*
*Defined in [ethereum-types/src/index.ts:322](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L322)*
<hr />
# Interface: JSONRPCResponseError
### Hierarchy
* **JSONRPCResponseError**
### Properties
## code
• **code**: *number*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L330)*
___
## message
• **message**: *string*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L329)*
<hr />
# Interface: JSONRPCResponsePayload
### Hierarchy
* **JSONRPCResponsePayload**
### Properties
## `Optional` error
• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)*
*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L337)*
___
## id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L335)*
___
## jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L336)*
___
## result
• **result**: *any*
*Defined in [ethereum-types/src/index.ts:334](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L334)*
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
# Class: CoverageSubprovider
This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface.
@@ -13,11 +404,11 @@ It's used to compute your code coverage while running solidity tests.
## constructer
\+ **new CoverageSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `partialConfig`: [CoverageSubproviderPartialConfig](../modules/_sol_coverage_src_coverage_subprovider_.md#coveragesubproviderpartialconfig)): *[CoverageSubprovider](#class-coveragesubprovider)*
\+ **new CoverageSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `partialConfig`: [CoverageSubproviderPartialConfig](#coveragesubproviderpartialconfig)): *[CoverageSubprovider](#class-coveragesubprovider)*
*Overrides void*
*Defined in [sol-coverage/src/coverage_subprovider.ts:44](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-coverage/src/coverage_subprovider.ts#L44)*
*Defined in [sol-coverage/src/coverage_subprovider.ts:44](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-coverage/src/coverage_subprovider.ts#L44)*
Instantiates a CoverageSubprovider instance
@@ -59,7 +450,7 @@ ___
## handleRequest
▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [NextCallback](../modules/_subproviders_src_types_.md#nextcallback), `_end`: [ErrorCallback](#errorcallback)): *`Promise<void>`*
▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [NextCallback](#nextcallback), `_end`: [ErrorCallback](#errorcallback)): *`Promise<void>`*
@@ -139,7 +530,7 @@ ___
▸ **writeCoverageAsync**(): *`Promise<void>`*
*Defined in [sol-coverage/src/coverage_subprovider.ts:78](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-coverage/src/coverage_subprovider.ts#L78)*
*Defined in [sol-coverage/src/coverage_subprovider.ts:78](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-coverage/src/coverage_subprovider.ts#L78)*
Write the test coverage results to a file in Istanbul format.
@@ -147,320 +538,6 @@ Write the test coverage results to a file in Istanbul format.
<hr />
# Class: AbstractArtifactAdapter
### Hierarchy
* **AbstractArtifactAdapter**
* [SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)
* [TruffleArtifactAdapter](#class-truffleartifactadapter)
### 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/30946ac11/packages/sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts#L4)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: SolCompilerArtifactAdapter
### Hierarchy
* [AbstractArtifactAdapter](#class-abstractartifactadapter)
* **SolCompilerArtifactAdapter**
### Constructors
## constructer
\+ **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/30946ac11/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/30946ac11/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: TruffleArtifactAdapter
### Hierarchy
* [AbstractArtifactAdapter](#class-abstractartifactadapter)
* **TruffleArtifactAdapter**
### Constructors
## constructer
\+ **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/30946ac11/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/30946ac11/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
# Interface: JSONRPCRequestPayload
### Hierarchy
* **JSONRPCRequestPayload**
### Properties
## id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:324](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L324)*
___
## jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:325](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L325)*
___
## method
• **method**: *string*
*Defined in [ethereum-types/src/index.ts:323](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L323)*
___
## params
• **params**: *any[]*
*Defined in [ethereum-types/src/index.ts:322](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L322)*
<hr />
# Interface: JSONRPCResponseError
### Hierarchy
* **JSONRPCResponseError**
### Properties
## code
• **code**: *number*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L330)*
___
## message
• **message**: *string*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L329)*
<hr />
# Interface: JSONRPCResponsePayload
### Hierarchy
* **JSONRPCResponsePayload**
### Properties
## `Optional` error
• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)*
*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L337)*
___
## id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L335)*
___
## jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L336)*
___
## result
• **result**: *any*
*Defined in [ethereum-types/src/index.ts:334](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L334)*
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
@@ -497,7 +574,7 @@ ___
• **bytecode**: *string*
*Defined in [sol-tracing-utils/src/types.ts:87](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-tracing-utils/src/types.ts#L87)*
*Defined in [sol-tracing-utils/src/types.ts:87](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-tracing-utils/src/types.ts#L87)*
___
@@ -505,7 +582,7 @@ ___
• **name**: *string*
*Defined in [sol-tracing-utils/src/types.ts:86](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-tracing-utils/src/types.ts#L86)*
*Defined in [sol-tracing-utils/src/types.ts:86](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-tracing-utils/src/types.ts#L86)*
___
@@ -513,7 +590,7 @@ ___
• **runtimeBytecode**: *string*
*Defined in [sol-tracing-utils/src/types.ts:89](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-tracing-utils/src/types.ts#L89)*
*Defined in [sol-tracing-utils/src/types.ts:89](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-tracing-utils/src/types.ts#L89)*
___
@@ -521,7 +598,7 @@ ___
• **sourceCodes**: *[SourceCodes](#class-sourcecodes)*
*Defined in [sol-tracing-utils/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-tracing-utils/src/types.ts#L91)*
*Defined in [sol-tracing-utils/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-tracing-utils/src/types.ts#L91)*
___
@@ -529,7 +606,7 @@ ___
• **sourceMap**: *string*
*Defined in [sol-tracing-utils/src/types.ts:88](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-tracing-utils/src/types.ts#L88)*
*Defined in [sol-tracing-utils/src/types.ts:88](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-tracing-utils/src/types.ts#L88)*
___
@@ -537,7 +614,7 @@ ___
• **sourceMapRuntime**: *string*
*Defined in [sol-tracing-utils/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-tracing-utils/src/types.ts#L90)*
*Defined in [sol-tracing-utils/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-tracing-utils/src/types.ts#L90)*
___
@@ -545,7 +622,7 @@ ___
• **sources**: *[Sources](#class-sources)*
*Defined in [sol-tracing-utils/src/types.ts:92](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-tracing-utils/src/types.ts#L92)*
*Defined in [sol-tracing-utils/src/types.ts:92](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-tracing-utils/src/types.ts#L92)*
<hr />
@@ -633,7 +710,7 @@ ___
*Overrides void*
*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/subproviders/src/types.ts#L136)*
*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/subproviders/src/types.ts#L136)*
___
@@ -677,7 +754,7 @@ Defined in ethereum-types/lib/index.d.ts:260
<hr />
# External module: "ethereum-types/src/index"
# External module: "sol-tracing-utils/src/types"
### Type aliases
@@ -723,66 +800,55 @@ Defined in ethereum-types/lib/index.d.ts:260
#___
#___
## Web3JsProvider
#___
Ƭ **Web3JsProvider**: *[Web3JsV1Provider](#interface-web3jsv1provider) | [Web3JsV2Provider](#interface-web3jsv2provider) | [Web3JsV3Provider](#interface-web3jsv3provider)*
## ErrorCallback
Ƭ **ErrorCallback**: *function*
*Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/30946ac11/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/30946ac11/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/30946ac11/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) |
*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L11)*
<hr />
# External module: "sol-coverage/src/coverage_subprovider"
### Type aliases
## CoverageSubproviderPartialConfig
Ƭ **CoverageSubproviderPartialConfig**: *`Partial<CoverageSubproviderConfig>`*
*Defined in [sol-coverage/src/coverage_subprovider.ts:31](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-coverage/src/coverage_subprovider.ts#L31)*
### Object literals
## `Const` DEFAULT_COVERAGE_SUBPROVIDER_CONFIG
## ▪ **DEFAULT_COVERAGE_SUBPROVIDER_CONFIG**: *object*
*Defined in [sol-coverage/src/coverage_subprovider.ts:33](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/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/6b20c9a54/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/6b20c9a54/packages/sol-coverage/src/coverage_subprovider.ts#L34)*
<hr />
# External module: "sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter"
<hr />
# External module: "sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter"
<hr />
# External module: "sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter"
<hr />

830
packages/sol-profiler/docs/reference.mdx
View File

@@ -1,3 +1,394 @@
<hr />
# Class: AbstractArtifactAdapter
### Hierarchy
* **AbstractArtifactAdapter**
* [SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)
* [TruffleArtifactAdapter](#class-truffleartifactadapter)
### 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/6b20c9a54/packages/sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts#L4)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: SolCompilerArtifactAdapter
### Hierarchy
* [AbstractArtifactAdapter](#class-abstractartifactadapter)
* **SolCompilerArtifactAdapter**
### Constructors
## constructer
\+ **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/6b20c9a54/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/6b20c9a54/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: TruffleArtifactAdapter
### Hierarchy
* [AbstractArtifactAdapter](#class-abstractartifactadapter)
* **TruffleArtifactAdapter**
### Constructors
## constructer
\+ **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/6b20c9a54/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/6b20c9a54/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
# External module: "subproviders/src/types"
### Type aliases
## Callback
Ƭ **Callback**: *function*
*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/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/6b20c9a54/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/6b20c9a54/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/6b20c9a54/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 />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
# Interface: JSONRPCRequestPayload
### Hierarchy
* **JSONRPCRequestPayload**
### Properties
## id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:324](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L324)*
___
## jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:325](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L325)*
___
## method
• **method**: *string*
*Defined in [ethereum-types/src/index.ts:323](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L323)*
___
## params
• **params**: *any[]*
*Defined in [ethereum-types/src/index.ts:322](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L322)*
<hr />
# Interface: JSONRPCResponseError
### Hierarchy
* **JSONRPCResponseError**
### Properties
## code
• **code**: *number*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L330)*
___
## message
• **message**: *string*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L329)*
<hr />
# Interface: JSONRPCResponsePayload
### Hierarchy
* **JSONRPCResponsePayload**
### Properties
## `Optional` error
• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)*
*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L337)*
___
## id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L335)*
___
## jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L336)*
___
## result
• **result**: *any*
*Defined in [ethereum-types/src/index.ts:334](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L334)*
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
# Class: ProfilerSubprovider
This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface.
@@ -17,7 +408,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/30946ac11/packages/sol-profiler/src/profiler_subprovider.ts#L30)*
*Defined in [sol-profiler/src/profiler_subprovider.ts:30](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-profiler/src/profiler_subprovider.ts#L30)*
Instantiates a ProfilerSubprovider instance
@@ -59,7 +450,7 @@ ___
## handleRequest
▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [NextCallback](../modules/_subproviders_src_types_.md#nextcallback), `_end`: [ErrorCallback](#errorcallback)): *`Promise<void>`*
▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [NextCallback](#nextcallback), `_end`: [ErrorCallback](#errorcallback)): *`Promise<void>`*
@@ -139,7 +530,7 @@ ___
▸ **writeProfilerOutputAsync**(): *`Promise<void>`*
*Defined in [sol-profiler/src/profiler_subprovider.ts:104](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-profiler/src/profiler_subprovider.ts#L104)*
*Defined in [sol-profiler/src/profiler_subprovider.ts:104](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-profiler/src/profiler_subprovider.ts#L104)*
Write the test profiler results to a file in Istanbul format.
@@ -147,320 +538,6 @@ Write the test profiler results to a file in Istanbul format.
<hr />
# Class: AbstractArtifactAdapter
### Hierarchy
* **AbstractArtifactAdapter**
* [SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)
* [TruffleArtifactAdapter](#class-truffleartifactadapter)
### 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/30946ac11/packages/sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts#L4)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: SolCompilerArtifactAdapter
### Hierarchy
* [AbstractArtifactAdapter](#class-abstractartifactadapter)
* **SolCompilerArtifactAdapter**
### Constructors
## constructer
\+ **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/30946ac11/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/30946ac11/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: TruffleArtifactAdapter
### Hierarchy
* [AbstractArtifactAdapter](#class-abstractartifactadapter)
* **TruffleArtifactAdapter**
### Constructors
## constructer
\+ **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/30946ac11/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/30946ac11/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
# Interface: JSONRPCRequestPayload
### Hierarchy
* **JSONRPCRequestPayload**
### Properties
## id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:324](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L324)*
___
## jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:325](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L325)*
___
## method
• **method**: *string*
*Defined in [ethereum-types/src/index.ts:323](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L323)*
___
## params
• **params**: *any[]*
*Defined in [ethereum-types/src/index.ts:322](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L322)*
<hr />
# Interface: JSONRPCResponseError
### Hierarchy
* **JSONRPCResponseError**
### Properties
## code
• **code**: *number*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L330)*
___
## message
• **message**: *string*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L329)*
<hr />
# Interface: JSONRPCResponsePayload
### Hierarchy
* **JSONRPCResponsePayload**
### Properties
## `Optional` error
• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)*
*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L337)*
___
## id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L335)*
___
## jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L336)*
___
## result
• **result**: *any*
*Defined in [ethereum-types/src/index.ts:334](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L334)*
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
@@ -495,7 +572,7 @@ ___
• **bytecode**: *string*
*Defined in [sol-tracing-utils/src/types.ts:87](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-tracing-utils/src/types.ts#L87)*
*Defined in [sol-tracing-utils/src/types.ts:87](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-tracing-utils/src/types.ts#L87)*
___
@@ -503,7 +580,7 @@ ___
• **name**: *string*
*Defined in [sol-tracing-utils/src/types.ts:86](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-tracing-utils/src/types.ts#L86)*
*Defined in [sol-tracing-utils/src/types.ts:86](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-tracing-utils/src/types.ts#L86)*
___
@@ -511,7 +588,7 @@ ___
• **runtimeBytecode**: *string*
*Defined in [sol-tracing-utils/src/types.ts:89](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-tracing-utils/src/types.ts#L89)*
*Defined in [sol-tracing-utils/src/types.ts:89](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-tracing-utils/src/types.ts#L89)*
___
@@ -519,7 +596,7 @@ ___
• **sourceCodes**: *[SourceCodes](#class-sourcecodes)*
*Defined in [sol-tracing-utils/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-tracing-utils/src/types.ts#L91)*
*Defined in [sol-tracing-utils/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-tracing-utils/src/types.ts#L91)*
___
@@ -527,7 +604,7 @@ ___
• **sourceMap**: *string*
*Defined in [sol-tracing-utils/src/types.ts:88](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-tracing-utils/src/types.ts#L88)*
*Defined in [sol-tracing-utils/src/types.ts:88](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-tracing-utils/src/types.ts#L88)*
___
@@ -535,7 +612,7 @@ ___
• **sourceMapRuntime**: *string*
*Defined in [sol-tracing-utils/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-tracing-utils/src/types.ts#L90)*
*Defined in [sol-tracing-utils/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-tracing-utils/src/types.ts#L90)*
___
@@ -543,7 +620,7 @@ ___
• **sources**: *[Sources](#class-sources)*
*Defined in [sol-tracing-utils/src/types.ts:92](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-tracing-utils/src/types.ts#L92)*
*Defined in [sol-tracing-utils/src/types.ts:92](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-tracing-utils/src/types.ts#L92)*
<hr />
@@ -631,7 +708,7 @@ ___
*Overrides void*
*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/subproviders/src/types.ts#L136)*
*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/subproviders/src/types.ts#L136)*
___
@@ -675,7 +752,7 @@ Defined in ethereum-types/lib/index.d.ts:260
<hr />
# External module: "ethereum-types/src/index"
# External module: "sol-tracing-utils/src/types"
### Type aliases
@@ -721,66 +798,51 @@ Defined in ethereum-types/lib/index.d.ts:260
#___
#___
## Web3JsProvider
#___
Ƭ **Web3JsProvider**: *[Web3JsV1Provider](#interface-web3jsv1provider) | [Web3JsV2Provider](#interface-web3jsv2provider) | [Web3JsV3Provider](#interface-web3jsv3provider)*
## ErrorCallback
Ƭ **ErrorCallback**: *function*
*Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/30946ac11/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/30946ac11/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/30946ac11/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) |
*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L11)*
<hr />
# External module: "sol-profiler/src/profiler_subprovider"
### Functions
## `Const` profilerHandler
▸ **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/6b20c9a54/packages/sol-profiler/src/profiler_subprovider.ts#L118)*
Computed partial coverage for a single file & subtrace for the purposes of
gas profiling.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`contractData` | `ContractData` | Contract metadata (source, srcMap, bytecode) |
`subtrace` | [Subtrace](#subtrace) | A subset of a transcation/call trace that was executed within that contract |
`pcToSourceRange` | object | A mapping from program counters to source ranges |
`fileIndex` | number | Index of a file to compute coverage for |
**Returns:** *`Coverage`*
Partial istanbul coverage for that file & subtrace
<hr />
# External module: "sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter"
<hr />
# External module: "sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter"
<hr />
# External module: "sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter"
<hr />

804
packages/sol-trace/docs/reference.mdx
View File

@@ -1,3 +1,394 @@
<hr />
# Class: AbstractArtifactAdapter
### Hierarchy
* **AbstractArtifactAdapter**
* [SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)
* [TruffleArtifactAdapter](#class-truffleartifactadapter)
### 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/6b20c9a54/packages/sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts#L4)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: SolCompilerArtifactAdapter
### Hierarchy
* [AbstractArtifactAdapter](#class-abstractartifactadapter)
* **SolCompilerArtifactAdapter**
### Constructors
## constructer
\+ **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/6b20c9a54/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/6b20c9a54/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: TruffleArtifactAdapter
### Hierarchy
* [AbstractArtifactAdapter](#class-abstractartifactadapter)
* **TruffleArtifactAdapter**
### Constructors
## constructer
\+ **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/6b20c9a54/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/6b20c9a54/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
# External module: "subproviders/src/types"
### Type aliases
## Callback
Ƭ **Callback**: *function*
*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/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/6b20c9a54/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/6b20c9a54/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/6b20c9a54/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 />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
# Interface: JSONRPCRequestPayload
### Hierarchy
* **JSONRPCRequestPayload**
### Properties
## id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:324](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L324)*
___
## jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:325](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L325)*
___
## method
• **method**: *string*
*Defined in [ethereum-types/src/index.ts:323](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L323)*
___
## params
• **params**: *any[]*
*Defined in [ethereum-types/src/index.ts:322](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L322)*
<hr />
# Interface: JSONRPCResponseError
### Hierarchy
* **JSONRPCResponseError**
### Properties
## code
• **code**: *number*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L330)*
___
## message
• **message**: *string*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L329)*
<hr />
# Interface: JSONRPCResponsePayload
### Hierarchy
* **JSONRPCResponsePayload**
### Properties
## `Optional` error
• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)*
*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L337)*
___
## id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L335)*
___
## jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L336)*
___
## result
• **result**: *any*
*Defined in [ethereum-types/src/index.ts:334](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L334)*
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
# Class: RevertTraceSubprovider
This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface.
@@ -17,7 +408,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/30946ac11/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/6b20c9a54/packages/sol-trace/src/revert_trace_subprovider.ts#L27)*
Instantiates a RevertTraceSubprovider instance
@@ -59,7 +450,7 @@ ___
## handleRequest
▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [NextCallback](../modules/_subproviders_src_types_.md#nextcallback), `_end`: [ErrorCallback](#errorcallback)): *`Promise<void>`*
▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [NextCallback](#nextcallback), `_end`: [ErrorCallback](#errorcallback)): *`Promise<void>`*
@@ -135,320 +526,6 @@ Stops trace collection
<hr />
# Class: AbstractArtifactAdapter
### Hierarchy
* **AbstractArtifactAdapter**
* [SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)
* [TruffleArtifactAdapter](#class-truffleartifactadapter)
### 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/30946ac11/packages/sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts#L4)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: SolCompilerArtifactAdapter
### Hierarchy
* [AbstractArtifactAdapter](#class-abstractartifactadapter)
* **SolCompilerArtifactAdapter**
### Constructors
## constructer
\+ **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/30946ac11/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/30946ac11/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
# Class: TruffleArtifactAdapter
### Hierarchy
* [AbstractArtifactAdapter](#class-abstractartifactadapter)
* **TruffleArtifactAdapter**
### Constructors
## constructer
\+ **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/30946ac11/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/30946ac11/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)*
**Returns:** *`Promise<ContractData[]>`*
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
# Interface: JSONRPCRequestPayload
### Hierarchy
* **JSONRPCRequestPayload**
### Properties
## id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:324](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L324)*
___
## jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:325](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L325)*
___
## method
• **method**: *string*
*Defined in [ethereum-types/src/index.ts:323](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L323)*
___
## params
• **params**: *any[]*
*Defined in [ethereum-types/src/index.ts:322](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L322)*
<hr />
# Interface: JSONRPCResponseError
### Hierarchy
* **JSONRPCResponseError**
### Properties
## code
• **code**: *number*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L330)*
___
## message
• **message**: *string*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L329)*
<hr />
# Interface: JSONRPCResponsePayload
### Hierarchy
* **JSONRPCResponsePayload**
### Properties
## `Optional` error
• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)*
*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L337)*
___
## id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L335)*
___
## jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L336)*
___
## result
• **result**: *any*
*Defined in [ethereum-types/src/index.ts:334](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/ethereum-types/src/index.ts#L334)*
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
<hr />
@@ -483,7 +560,7 @@ ___
• **bytecode**: *string*
*Defined in [sol-tracing-utils/src/types.ts:87](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-tracing-utils/src/types.ts#L87)*
*Defined in [sol-tracing-utils/src/types.ts:87](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-tracing-utils/src/types.ts#L87)*
___
@@ -491,7 +568,7 @@ ___
• **name**: *string*
*Defined in [sol-tracing-utils/src/types.ts:86](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-tracing-utils/src/types.ts#L86)*
*Defined in [sol-tracing-utils/src/types.ts:86](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-tracing-utils/src/types.ts#L86)*
___
@@ -499,7 +576,7 @@ ___
• **runtimeBytecode**: *string*
*Defined in [sol-tracing-utils/src/types.ts:89](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-tracing-utils/src/types.ts#L89)*
*Defined in [sol-tracing-utils/src/types.ts:89](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-tracing-utils/src/types.ts#L89)*
___
@@ -507,7 +584,7 @@ ___
• **sourceCodes**: *[SourceCodes](#class-sourcecodes)*
*Defined in [sol-tracing-utils/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-tracing-utils/src/types.ts#L91)*
*Defined in [sol-tracing-utils/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-tracing-utils/src/types.ts#L91)*
___
@@ -515,7 +592,7 @@ ___
• **sourceMap**: *string*
*Defined in [sol-tracing-utils/src/types.ts:88](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-tracing-utils/src/types.ts#L88)*
*Defined in [sol-tracing-utils/src/types.ts:88](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-tracing-utils/src/types.ts#L88)*
___
@@ -523,7 +600,7 @@ ___
• **sourceMapRuntime**: *string*
*Defined in [sol-tracing-utils/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-tracing-utils/src/types.ts#L90)*
*Defined in [sol-tracing-utils/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-tracing-utils/src/types.ts#L90)*
___
@@ -531,7 +608,7 @@ ___
• **sources**: *[Sources](#class-sources)*
*Defined in [sol-tracing-utils/src/types.ts:92](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/sol-tracing-utils/src/types.ts#L92)*
*Defined in [sol-tracing-utils/src/types.ts:92](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/sol-tracing-utils/src/types.ts#L92)*
<hr />
@@ -619,7 +696,7 @@ ___
*Overrides void*
*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/30946ac11/packages/subproviders/src/types.ts#L136)*
*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/subproviders/src/types.ts#L136)*
___
@@ -663,7 +740,7 @@ Defined in ethereum-types/lib/index.d.ts:260
<hr />
# External module: "ethereum-types/src/index"
# External module: "sol-tracing-utils/src/types"
### Type aliases
@@ -709,66 +786,27 @@ Defined in ethereum-types/lib/index.d.ts:260
#___
#___
## Web3JsProvider
#___
Ƭ **Web3JsProvider**: *[Web3JsV1Provider](#interface-web3jsv1provider) | [Web3JsV2Provider](#interface-web3jsv2provider) | [Web3JsV3Provider](#interface-web3jsv3provider)*
## ErrorCallback
Ƭ **ErrorCallback**: *function*
*Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/30946ac11/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/30946ac11/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/30946ac11/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) |
*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/6b20c9a54/packages/ethereum-types/src/index.ts#L11)*
<hr />
# External module: "sol-trace/src/revert_trace_subprovider"
<hr />
# External module: "sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter"
<hr />
# External module: "sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter"
<hr />
# External module: "sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter"
<hr />

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

File diff suppressed because it is too large Load Diff

1212
packages/web3-wrapper/docs/reference.mdx
View File

File diff suppressed because it is too large Load Diff