Update docs to latest format
This commit is contained in:
fabioberger
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -1,39 +1,24 @@
|
||||
> # Class: HttpClient
|
||||
# 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
|
||||
### Hierarchy
|
||||
|
||||
* **HttpClient**
|
||||
|
||||
## Implements
|
||||
### Implements
|
||||
|
||||
* [Client](#interface-client)
|
||||
|
||||
## Index
|
||||
|
||||
### Constructors
|
||||
|
||||
* [constructor](#constructor)
|
||||
|
||||
### Methods
|
||||
|
||||
* [getAssetPairsAsync](#getassetpairsasync)
|
||||
* [getFeeRecipientsAsync](#getfeerecipientsasync)
|
||||
* [getOrderAsync](#getorderasync)
|
||||
* [getOrderConfigAsync](#getorderconfigasync)
|
||||
* [getOrderbookAsync](#getorderbookasync)
|
||||
* [getOrdersAsync](#getordersasync)
|
||||
* [submitOrderAsync](#submitorderasync)
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
## constructer
|
||||
|
||||
\+ **new HttpClient**(`url`: string): *[HttpClient](#class-httpclient)*
|
||||
|
||||
*Defined in [http_client.ts:44](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/http_client.ts#L44)*
|
||||
*Defined in [http_client.ts:44](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/http_client.ts#L44)*
|
||||
|
||||
Instantiates a new HttpClient instance
|
||||
|
||||
@@ -47,13 +32,13 @@ Name | Type | Description |
|
||||
|
||||
An instance of HttpClient
|
||||
|
||||
## Methods
|
||||
### Methods
|
||||
|
||||
### getAssetPairsAsync
|
||||
## getAssetPairsAsync
|
||||
|
||||
▸ **getAssetPairsAsync**(`requestOpts?`: `RequestOpts` & `AssetPairsRequestOpts` & `PagedRequestOpts`): *`Promise<AssetPairsResponse>`*
|
||||
|
||||
*Defined in [http_client.ts:59](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/http_client.ts#L59)*
|
||||
*Defined in [http_client.ts:59](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/http_client.ts#L59)*
|
||||
|
||||
Retrieve assetData pair info from the API
|
||||
|
||||
@@ -69,11 +54,11 @@ The resulting AssetPairsResponse that match the request
|
||||
|
||||
___
|
||||
|
||||
### getFeeRecipientsAsync
|
||||
## getFeeRecipientsAsync
|
||||
|
||||
▸ **getFeeRecipientsAsync**(`requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise<FeeRecipientsResponse>`*
|
||||
|
||||
*Defined in [http_client.ts:160](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/http_client.ts#L160)*
|
||||
*Defined in [http_client.ts:160](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/http_client.ts#L160)*
|
||||
|
||||
Retrieve the list of fee recipient addresses used by the relayer.
|
||||
|
||||
@@ -89,11 +74,11 @@ The resulting FeeRecipientsResponse
|
||||
|
||||
___
|
||||
|
||||
### getOrderAsync
|
||||
## getOrderAsync
|
||||
|
||||
▸ **getOrderAsync**(`orderHash`: string, `requestOpts?`: `RequestOpts`): *`Promise<APIOrder>`*
|
||||
|
||||
*Defined in [http_client.ts:99](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/http_client.ts#L99)*
|
||||
*Defined in [http_client.ts:99](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/http_client.ts#L99)*
|
||||
|
||||
Retrieve a specific order from the API
|
||||
|
||||
@@ -110,11 +95,11 @@ The APIOrder that matches the supplied orderHash
|
||||
|
||||
___
|
||||
|
||||
### getOrderConfigAsync
|
||||
## getOrderConfigAsync
|
||||
|
||||
▸ **getOrderConfigAsync**(`request`: `OrderConfigRequest`, `requestOpts?`: `RequestOpts`): *`Promise<OrderConfigResponse>`*
|
||||
|
||||
*Defined in [http_client.ts:139](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/http_client.ts#L139)*
|
||||
*Defined in [http_client.ts:139](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/http_client.ts#L139)*
|
||||
|
||||
Retrieve fee information from the API
|
||||
|
||||
@@ -131,11 +116,11 @@ The resulting OrderConfigResponse that matches the request
|
||||
|
||||
___
|
||||
|
||||
### getOrderbookAsync
|
||||
## getOrderbookAsync
|
||||
|
||||
▸ **getOrderbookAsync**(`request`: `OrderbookRequest`, `requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise<OrderbookResponse>`*
|
||||
|
||||
*Defined in [http_client.ts:117](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/http_client.ts#L117)*
|
||||
*Defined in [http_client.ts:117](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/http_client.ts#L117)*
|
||||
|
||||
Retrieve an orderbook from the API
|
||||
|
||||
@@ -152,11 +137,11 @@ The resulting OrderbookResponse that matches the request
|
||||
|
||||
___
|
||||
|
||||
### getOrdersAsync
|
||||
## getOrdersAsync
|
||||
|
||||
▸ **getOrdersAsync**(`requestOpts?`: `RequestOpts` & `OrdersRequestOpts` & `PagedRequestOpts`): *`Promise<OrdersResponse>`*
|
||||
|
||||
*Defined in [http_client.ts:79](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/http_client.ts#L79)*
|
||||
*Defined in [http_client.ts:79](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/http_client.ts#L79)*
|
||||
|
||||
Retrieve orders from the API
|
||||
|
||||
@@ -172,11 +157,11 @@ The resulting OrdersResponse that match the request
|
||||
|
||||
___
|
||||
|
||||
### submitOrderAsync
|
||||
## submitOrderAsync
|
||||
|
||||
▸ **submitOrderAsync**(`signedOrder`: `SignedOrder`, `requestOpts?`: `RequestOpts`): *`Promise<void>`*
|
||||
|
||||
*Defined in [http_client.ts:177](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/http_client.ts#L177)*
|
||||
*Defined in [http_client.ts:177](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/http_client.ts#L177)*
|
||||
|
||||
Submit a signed order to the API
|
||||
|
||||
@@ -191,37 +176,27 @@ Name | Type | Description |
|
||||
|
||||
<hr />
|
||||
|
||||
> # Class: WebSocketOrdersChannel
|
||||
# Class: WebSocketOrdersChannel
|
||||
|
||||
This class includes all the functionality related to interacting with a websocket endpoint
|
||||
that implements the standard relayer API v0
|
||||
|
||||
## Hierarchy
|
||||
### Hierarchy
|
||||
|
||||
* **WebSocketOrdersChannel**
|
||||
|
||||
## Implements
|
||||
### Implements
|
||||
|
||||
* [OrdersChannel](#interface-orderschannel)
|
||||
|
||||
## Index
|
||||
|
||||
### Constructors
|
||||
|
||||
* [constructor](#constructor)
|
||||
|
||||
### Methods
|
||||
|
||||
* [close](#close)
|
||||
* [subscribe](#subscribe)
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
## constructer
|
||||
|
||||
\+ **new WebSocketOrdersChannel**(`client`: `w3cwebsocket`, `handler`: [OrdersChannelHandler](#interface-orderschannelhandler)): *[WebSocketOrdersChannel](#class-websocketorderschannel)*
|
||||
|
||||
*Defined in [ws_orders_channel.ts:21](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/ws_orders_channel.ts#L21)*
|
||||
*Defined in [ws_orders_channel.ts:21](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/ws_orders_channel.ts#L21)*
|
||||
|
||||
Instantiates a new WebSocketOrdersChannel instance
|
||||
|
||||
@@ -236,13 +211,13 @@ Name | Type | Description |
|
||||
|
||||
An instance of WebSocketOrdersChannel
|
||||
|
||||
## Methods
|
||||
### Methods
|
||||
|
||||
### close
|
||||
## close
|
||||
|
||||
▸ **close**(): *void*
|
||||
|
||||
*Defined in [ws_orders_channel.ts:66](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/ws_orders_channel.ts#L66)*
|
||||
*Defined in [ws_orders_channel.ts:66](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/ws_orders_channel.ts#L66)*
|
||||
|
||||
Close the websocket and stop receiving updates
|
||||
|
||||
@@ -250,11 +225,11 @@ Close the websocket and stop receiving updates
|
||||
|
||||
___
|
||||
|
||||
### subscribe
|
||||
## subscribe
|
||||
|
||||
▸ **subscribe**(`subscriptionOpts`: `OrdersChannelSubscriptionOpts`): *void*
|
||||
|
||||
*Defined in [ws_orders_channel.ts:50](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/ws_orders_channel.ts#L50)*
|
||||
*Defined in [ws_orders_channel.ts:50](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/ws_orders_channel.ts#L50)*
|
||||
|
||||
Subscribe to orderbook snapshots and updates from the websocket
|
||||
|
||||
@@ -268,62 +243,45 @@ Name | Type | Description |
|
||||
|
||||
<hr />
|
||||
|
||||
> # Enumeration: HttpRequestType
|
||||
# Enumeration: HttpRequestType
|
||||
|
||||
## Index
|
||||
|
||||
### Enumeration members
|
||||
|
||||
* [Get](#get)
|
||||
* [Post](#post)
|
||||
|
||||
## Enumeration members
|
||||
|
||||
### Get
|
||||
## Get
|
||||
|
||||
• **Get**: = "GET"
|
||||
|
||||
*Defined in [types.ts:46](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/types.ts#L46)*
|
||||
*Defined in [types.ts:46](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L46)*
|
||||
|
||||
___
|
||||
|
||||
### Post
|
||||
## Post
|
||||
|
||||
• **Post**: = "POST"
|
||||
|
||||
*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/types.ts#L47)*
|
||||
*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L47)*
|
||||
|
||||
<hr />
|
||||
|
||||
> # Interface: Client
|
||||
# Interface: Client
|
||||
|
||||
## Hierarchy
|
||||
### Hierarchy
|
||||
|
||||
* **Client**
|
||||
|
||||
## Implemented by
|
||||
### Implemented by
|
||||
|
||||
* [HttpClient](#class-httpclient)
|
||||
|
||||
## Index
|
||||
|
||||
### Properties
|
||||
|
||||
* [getAssetPairsAsync](#getassetpairsasync)
|
||||
* [getFeeRecipientsAsync](#getfeerecipientsasync)
|
||||
* [getOrderAsync](#getorderasync)
|
||||
* [getOrderConfigAsync](#getorderconfigasync)
|
||||
* [getOrderbookAsync](#getorderbookasync)
|
||||
* [getOrdersAsync](#getordersasync)
|
||||
* [submitOrderAsync](#submitorderasync)
|
||||
|
||||
## Properties
|
||||
|
||||
### getAssetPairsAsync
|
||||
## getAssetPairsAsync
|
||||
|
||||
• **getAssetPairsAsync**: *function*
|
||||
|
||||
*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/types.ts#L18)*
|
||||
*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L18)*
|
||||
|
||||
#### Type declaration:
|
||||
|
||||
@@ -337,11 +295,11 @@ Name | Type |
|
||||
|
||||
___
|
||||
|
||||
### getFeeRecipientsAsync
|
||||
## getFeeRecipientsAsync
|
||||
|
||||
• **getFeeRecipientsAsync**: *function*
|
||||
|
||||
*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/types.ts#L25)*
|
||||
*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L25)*
|
||||
|
||||
#### Type declaration:
|
||||
|
||||
@@ -355,11 +313,11 @@ Name | Type |
|
||||
|
||||
___
|
||||
|
||||
### getOrderAsync
|
||||
## getOrderAsync
|
||||
|
||||
• **getOrderAsync**: *function*
|
||||
|
||||
*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/types.ts#L22)*
|
||||
*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L22)*
|
||||
|
||||
#### Type declaration:
|
||||
|
||||
@@ -373,11 +331,11 @@ Name | Type |
|
||||
|
||||
___
|
||||
|
||||
### getOrderConfigAsync
|
||||
## getOrderConfigAsync
|
||||
|
||||
• **getOrderConfigAsync**: *function*
|
||||
|
||||
*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/types.ts#L24)*
|
||||
*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L24)*
|
||||
|
||||
#### Type declaration:
|
||||
|
||||
@@ -391,11 +349,11 @@ Name | Type |
|
||||
|
||||
___
|
||||
|
||||
### getOrderbookAsync
|
||||
## getOrderbookAsync
|
||||
|
||||
• **getOrderbookAsync**: *function*
|
||||
|
||||
*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/types.ts#L23)*
|
||||
*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L23)*
|
||||
|
||||
#### Type declaration:
|
||||
|
||||
@@ -410,11 +368,11 @@ Name | Type |
|
||||
|
||||
___
|
||||
|
||||
### getOrdersAsync
|
||||
## getOrdersAsync
|
||||
|
||||
• **getOrdersAsync**: *function*
|
||||
|
||||
*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/types.ts#L21)*
|
||||
*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L21)*
|
||||
|
||||
#### Type declaration:
|
||||
|
||||
@@ -428,11 +386,11 @@ Name | Type |
|
||||
|
||||
___
|
||||
|
||||
### submitOrderAsync
|
||||
## submitOrderAsync
|
||||
|
||||
• **submitOrderAsync**: *function*
|
||||
|
||||
*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/types.ts#L26)*
|
||||
*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L26)*
|
||||
|
||||
#### Type declaration:
|
||||
|
||||
@@ -446,61 +404,49 @@ Name | Type |
|
||||
|
||||
<hr />
|
||||
|
||||
> # Interface: HttpRequestOptions
|
||||
# Interface: HttpRequestOptions
|
||||
|
||||
## Hierarchy
|
||||
### Hierarchy
|
||||
|
||||
* **HttpRequestOptions**
|
||||
|
||||
## Index
|
||||
|
||||
### Properties
|
||||
|
||||
* [params](#optional-params)
|
||||
* [payload](#optional-payload)
|
||||
|
||||
## Properties
|
||||
|
||||
### `Optional` params
|
||||
## `Optional` params
|
||||
|
||||
• **params**? : *undefined | object*
|
||||
|
||||
*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/types.ts#L41)*
|
||||
*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L41)*
|
||||
|
||||
___
|
||||
|
||||
### `Optional` payload
|
||||
## `Optional` payload
|
||||
|
||||
• **payload**? : *undefined | object*
|
||||
|
||||
*Defined in [types.ts:42](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/types.ts#L42)*
|
||||
*Defined in [types.ts:42](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L42)*
|
||||
|
||||
<hr />
|
||||
|
||||
> # Interface: OrdersChannel
|
||||
# Interface: OrdersChannel
|
||||
|
||||
## Hierarchy
|
||||
### Hierarchy
|
||||
|
||||
* **OrdersChannel**
|
||||
|
||||
## Implemented by
|
||||
### Implemented by
|
||||
|
||||
* [WebSocketOrdersChannel](#class-websocketorderschannel)
|
||||
|
||||
## Index
|
||||
|
||||
### Properties
|
||||
|
||||
* [close](#close)
|
||||
* [subscribe](#subscribe)
|
||||
|
||||
## Properties
|
||||
|
||||
### close
|
||||
## close
|
||||
|
||||
• **close**: *function*
|
||||
|
||||
*Defined in [types.ts:31](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/types.ts#L31)*
|
||||
*Defined in [types.ts:31](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L31)*
|
||||
|
||||
#### Type declaration:
|
||||
|
||||
@@ -508,11 +454,11 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### subscribe
|
||||
## subscribe
|
||||
|
||||
• **subscribe**: *function*
|
||||
|
||||
*Defined in [types.ts:30](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/types.ts#L30)*
|
||||
*Defined in [types.ts:30](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L30)*
|
||||
|
||||
#### Type declaration:
|
||||
|
||||
@@ -526,27 +472,20 @@ Name | Type |
|
||||
|
||||
<hr />
|
||||
|
||||
> # Interface: OrdersChannelHandler
|
||||
# Interface: OrdersChannelHandler
|
||||
|
||||
## Hierarchy
|
||||
### Hierarchy
|
||||
|
||||
* **OrdersChannelHandler**
|
||||
|
||||
## Index
|
||||
|
||||
### Properties
|
||||
|
||||
* [onClose](#onclose)
|
||||
* [onError](#onerror)
|
||||
* [onUpdate](#onupdate)
|
||||
|
||||
## Properties
|
||||
|
||||
### onClose
|
||||
## onClose
|
||||
|
||||
• **onClose**: *function*
|
||||
|
||||
*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/types.ts#L37)*
|
||||
*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L37)*
|
||||
|
||||
#### Type declaration:
|
||||
|
||||
@@ -560,11 +499,11 @@ Name | Type |
|
||||
|
||||
___
|
||||
|
||||
### onError
|
||||
## onError
|
||||
|
||||
• **onError**: *function*
|
||||
|
||||
*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/types.ts#L36)*
|
||||
*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L36)*
|
||||
|
||||
#### Type declaration:
|
||||
|
||||
@@ -580,11 +519,11 @@ Name | Type |
|
||||
|
||||
___
|
||||
|
||||
### onUpdate
|
||||
## onUpdate
|
||||
|
||||
• **onUpdate**: *function*
|
||||
|
||||
*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/types.ts#L35)*
|
||||
*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L35)*
|
||||
|
||||
#### Type declaration:
|
||||
|
||||
@@ -600,13 +539,13 @@ Name | Type |
|
||||
|
||||
<hr />
|
||||
|
||||
> # Interface: OrdersChannelSubscriptionOptsMap
|
||||
# Interface: OrdersChannelSubscriptionOptsMap
|
||||
|
||||
## Hierarchy
|
||||
### Hierarchy
|
||||
|
||||
* **OrdersChannelSubscriptionOptsMap**
|
||||
|
||||
## Indexable
|
||||
### Indexable
|
||||
|
||||
● \[▪ **key**: *string*\]: `OrdersChannelSubscriptionOpts`
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -1,42 +1,31 @@
|
||||
> # Class: SchemaValidator
|
||||
# Class: SchemaValidator
|
||||
|
||||
A validator for [JSON-schemas](http://json-schema.org/)
|
||||
|
||||
## Hierarchy
|
||||
### Hierarchy
|
||||
|
||||
* **SchemaValidator**
|
||||
|
||||
## Index
|
||||
|
||||
### Constructors
|
||||
|
||||
* [constructor](#constructor)
|
||||
|
||||
### Methods
|
||||
|
||||
* [addSchema](#addschema)
|
||||
* [isValid](#isvalid)
|
||||
* [validate](#validate)
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
## constructer
|
||||
|
||||
\+ **new SchemaValidator**(): *[SchemaValidator](#class-schemavalidator)*
|
||||
|
||||
*Defined in [schema_validator.ts:15](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/json-schemas/src/schema_validator.ts#L15)*
|
||||
*Defined in [schema_validator.ts:15](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/json-schemas/src/schema_validator.ts#L15)*
|
||||
|
||||
Instantiates a SchemaValidator instance
|
||||
|
||||
**Returns:** *[SchemaValidator](#class-schemavalidator)*
|
||||
|
||||
## Methods
|
||||
### Methods
|
||||
|
||||
### addSchema
|
||||
## addSchema
|
||||
|
||||
▸ **addSchema**(`schema`: `Schema`): *void*
|
||||
|
||||
*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/json-schemas/src/schema_validator.ts#L32)*
|
||||
*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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
|
||||
@@ -52,11 +41,11 @@ Name | Type | Description |
|
||||
|
||||
___
|
||||
|
||||
### isValid
|
||||
## isValid
|
||||
|
||||
▸ **isValid**(`instance`: any, `schema`: `Schema`): *boolean*
|
||||
|
||||
*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/json-schemas/src/schema_validator.ts#L57)*
|
||||
*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/json-schemas/src/schema_validator.ts#L57)*
|
||||
|
||||
Check whether an instance properly adheres to a JSON schema
|
||||
|
||||
@@ -73,11 +62,11 @@ Whether or not the instance adheres to the schema
|
||||
|
||||
___
|
||||
|
||||
### validate
|
||||
## validate
|
||||
|
||||
▸ **validate**(`instance`: any, `schema`: `Schema`): *`ValidatorResult`*
|
||||
|
||||
*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/json-schemas/src/schema_validator.ts#L46)*
|
||||
*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/json-schemas/src/schema_validator.ts#L46)*
|
||||
|
||||
Validate the JS object conforms to a specific JSON schema
|
||||
|
||||
|
||||
@@ -1,206 +1,175 @@
|
||||
> # Enumeration: ContractName
|
||||
# Enumeration: ContractName
|
||||
|
||||
## Index
|
||||
|
||||
### Enumeration members
|
||||
|
||||
* [AccountLevels](#accountlevels)
|
||||
* [Arbitrage](#arbitrage)
|
||||
* [DummyToken](#dummytoken)
|
||||
* [EtherDelta](#etherdelta)
|
||||
* [Exchange](#exchange)
|
||||
* [MultiSigWalletWithTimeLock](#multisigwalletwithtimelock)
|
||||
* [MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress](#multisigwalletwithtimelockexceptremoveauthorizedaddress)
|
||||
* [TokenRegistry](#tokenregistry)
|
||||
* [TokenTransferProxy](#tokentransferproxy)
|
||||
* [WETH9](#weth9)
|
||||
* [ZRXToken](#zrxtoken)
|
||||
|
||||
## Enumeration members
|
||||
|
||||
### AccountLevels
|
||||
## AccountLevels
|
||||
|
||||
• **AccountLevels**: = "AccountLevels"
|
||||
|
||||
*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L26)*
|
||||
*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L26)*
|
||||
|
||||
___
|
||||
|
||||
### Arbitrage
|
||||
## Arbitrage
|
||||
|
||||
• **Arbitrage**: = "Arbitrage"
|
||||
|
||||
*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L28)*
|
||||
*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L28)*
|
||||
|
||||
___
|
||||
|
||||
### DummyToken
|
||||
## DummyToken
|
||||
|
||||
• **DummyToken**: = "DummyToken"
|
||||
|
||||
*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L23)*
|
||||
*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L23)*
|
||||
|
||||
___
|
||||
|
||||
### EtherDelta
|
||||
## EtherDelta
|
||||
|
||||
• **EtherDelta**: = "EtherDelta"
|
||||
|
||||
*Defined in [types.ts:27](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L27)*
|
||||
*Defined in [types.ts:27](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L27)*
|
||||
|
||||
___
|
||||
|
||||
### Exchange
|
||||
## Exchange
|
||||
|
||||
• **Exchange**: = "Exchange"
|
||||
|
||||
*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L21)*
|
||||
*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L21)*
|
||||
|
||||
___
|
||||
|
||||
### MultiSigWalletWithTimeLock
|
||||
## MultiSigWalletWithTimeLock
|
||||
|
||||
• **MultiSigWalletWithTimeLock**: = "MultiSigWalletWithTimeLock"
|
||||
|
||||
*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L20)*
|
||||
*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L20)*
|
||||
|
||||
___
|
||||
|
||||
### MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress
|
||||
## MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress
|
||||
|
||||
• **MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress**: = "MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress"
|
||||
|
||||
*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L25)*
|
||||
*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L25)*
|
||||
|
||||
___
|
||||
|
||||
### TokenRegistry
|
||||
## TokenRegistry
|
||||
|
||||
• **TokenRegistry**: = "TokenRegistry"
|
||||
|
||||
*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L19)*
|
||||
*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L19)*
|
||||
|
||||
___
|
||||
|
||||
### TokenTransferProxy
|
||||
## TokenTransferProxy
|
||||
|
||||
• **TokenTransferProxy**: = "TokenTransferProxy"
|
||||
|
||||
*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L18)*
|
||||
*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L18)*
|
||||
|
||||
___
|
||||
|
||||
### WETH9
|
||||
## WETH9
|
||||
|
||||
• **WETH9**: = "WETH9"
|
||||
|
||||
*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L24)*
|
||||
*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L24)*
|
||||
|
||||
___
|
||||
|
||||
### ZRXToken
|
||||
## ZRXToken
|
||||
|
||||
• **ZRXToken**: = "ZRXToken"
|
||||
|
||||
*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L22)*
|
||||
*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L22)*
|
||||
|
||||
<hr />
|
||||
|
||||
> # Interface: ERC20Token
|
||||
# Interface: ERC20Token
|
||||
|
||||
## Hierarchy
|
||||
### Hierarchy
|
||||
|
||||
* **ERC20Token**
|
||||
|
||||
## Index
|
||||
|
||||
### Properties
|
||||
|
||||
* [address](#optional-address)
|
||||
* [decimals](#decimals)
|
||||
* [ipfsHash](#ipfshash)
|
||||
* [name](#name)
|
||||
* [swarmHash](#swarmhash)
|
||||
* [symbol](#symbol)
|
||||
|
||||
## Properties
|
||||
|
||||
### `Optional` address
|
||||
## `Optional` address
|
||||
|
||||
• **address**? : *undefined | string*
|
||||
|
||||
*Defined in [types.ts:4](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L4)*
|
||||
*Defined in [types.ts:4](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L4)*
|
||||
|
||||
___
|
||||
|
||||
### decimals
|
||||
## decimals
|
||||
|
||||
• **decimals**: *`BigNumber`*
|
||||
|
||||
*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L7)*
|
||||
*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L7)*
|
||||
|
||||
___
|
||||
|
||||
### ipfsHash
|
||||
## ipfsHash
|
||||
|
||||
• **ipfsHash**: *string*
|
||||
|
||||
*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L8)*
|
||||
*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L8)*
|
||||
|
||||
___
|
||||
|
||||
### name
|
||||
## name
|
||||
|
||||
• **name**: *string*
|
||||
|
||||
*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L5)*
|
||||
*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L5)*
|
||||
|
||||
___
|
||||
|
||||
### swarmHash
|
||||
## swarmHash
|
||||
|
||||
• **swarmHash**: *string*
|
||||
|
||||
*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L9)*
|
||||
*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L9)*
|
||||
|
||||
___
|
||||
|
||||
### symbol
|
||||
## symbol
|
||||
|
||||
• **symbol**: *string*
|
||||
|
||||
*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L6)*
|
||||
*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L6)*
|
||||
|
||||
<hr />
|
||||
|
||||
> # Interface: ERC721Token
|
||||
# Interface: ERC721Token
|
||||
|
||||
## Hierarchy
|
||||
### Hierarchy
|
||||
|
||||
* **ERC721Token**
|
||||
|
||||
## Index
|
||||
|
||||
### Properties
|
||||
|
||||
* [name](#name)
|
||||
* [symbol](#symbol)
|
||||
|
||||
## Properties
|
||||
|
||||
### name
|
||||
## name
|
||||
|
||||
• **name**: *string*
|
||||
|
||||
*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L13)*
|
||||
*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L13)*
|
||||
|
||||
___
|
||||
|
||||
### symbol
|
||||
## symbol
|
||||
|
||||
• **symbol**: *string*
|
||||
|
||||
*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L14)*
|
||||
*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L14)*
|
||||
|
||||
<hr />
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,31 +1,20 @@
|
||||
> # Class: Compiler
|
||||
# Class: Compiler
|
||||
|
||||
The Compiler facilitates compiling Solidity smart contracts and saves the results
|
||||
to artifact files.
|
||||
|
||||
## Hierarchy
|
||||
### Hierarchy
|
||||
|
||||
* **Compiler**
|
||||
|
||||
## Index
|
||||
|
||||
### Constructors
|
||||
|
||||
* [constructor](#constructor)
|
||||
|
||||
### Methods
|
||||
|
||||
* [compileAsync](#compileasync)
|
||||
* [getCompilerOutputsAsync](#getcompileroutputsasync)
|
||||
* [watchAsync](#watchasync)
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
## constructer
|
||||
|
||||
\+ **new Compiler**(`opts?`: `CompilerOptions`): *[Compiler](#class-compiler)*
|
||||
|
||||
*Defined in [compiler.ts:94](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-compiler/src/compiler.ts#L94)*
|
||||
*Defined in [compiler.ts:94](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/compiler.ts#L94)*
|
||||
|
||||
Instantiates a new instance of the Compiler class.
|
||||
|
||||
@@ -39,13 +28,13 @@ Name | Type | Description |
|
||||
|
||||
An instance of the Compiler class.
|
||||
|
||||
## Methods
|
||||
### Methods
|
||||
|
||||
### compileAsync
|
||||
## compileAsync
|
||||
|
||||
▸ **compileAsync**(): *`Promise<void>`*
|
||||
|
||||
*Defined in [compiler.ts:132](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-compiler/src/compiler.ts#L132)*
|
||||
*Defined in [compiler.ts:132](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/compiler.ts#L132)*
|
||||
|
||||
Compiles selected Solidity files found in `contractsDir` and writes JSON artifacts to `artifactsDir`.
|
||||
|
||||
@@ -53,11 +42,11 @@ Compiles selected Solidity files found in `contractsDir` and writes JSON artifac
|
||||
|
||||
___
|
||||
|
||||
### getCompilerOutputsAsync
|
||||
## getCompilerOutputsAsync
|
||||
|
||||
▸ **getCompilerOutputsAsync**(): *`Promise<StandardOutput[]>`*
|
||||
|
||||
*Defined in [compiler.ts:145](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-compiler/src/compiler.ts#L145)*
|
||||
*Defined in [compiler.ts:145](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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:
|
||||
@@ -70,46 +59,32 @@ that version.
|
||||
|
||||
___
|
||||
|
||||
### watchAsync
|
||||
## watchAsync
|
||||
|
||||
▸ **watchAsync**(): *`Promise<void>`*
|
||||
|
||||
*Defined in [compiler.ts:149](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-compiler/src/compiler.ts#L149)*
|
||||
*Defined in [compiler.ts:149](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/compiler.ts#L149)*
|
||||
|
||||
**Returns:** *`Promise<void>`*
|
||||
|
||||
<hr />
|
||||
|
||||
> # Class: CompilationError
|
||||
# Class: CompilationError
|
||||
|
||||
## Hierarchy
|
||||
### Hierarchy
|
||||
|
||||
* `Error`
|
||||
|
||||
* **CompilationError**
|
||||
|
||||
## Index
|
||||
|
||||
### Constructors
|
||||
|
||||
* [constructor](#constructor)
|
||||
|
||||
### Properties
|
||||
|
||||
* [errorsCount](#errorscount)
|
||||
* [message](#message)
|
||||
* [name](#name)
|
||||
* [stack](#optional-stack)
|
||||
* [typeName](#typename)
|
||||
* [Error](#static-error)
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
## constructer
|
||||
|
||||
\+ **new CompilationError**(`errorsCount`: number): *[CompilationError](#class-compilationerror)*
|
||||
|
||||
*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-compiler/src/utils/types.ts#L39)*
|
||||
*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L39)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -119,41 +94,41 @@ Name | Type |
|
||||
|
||||
**Returns:** *[CompilationError](#class-compilationerror)*
|
||||
|
||||
## Properties
|
||||
### Properties
|
||||
|
||||
### errorsCount
|
||||
## errorsCount
|
||||
|
||||
• **errorsCount**: *number*
|
||||
|
||||
*Defined in [utils/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-compiler/src/utils/types.ts#L38)*
|
||||
*Defined in [utils/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L38)*
|
||||
|
||||
___
|
||||
|
||||
### message
|
||||
## message
|
||||
|
||||
• **message**: *string*
|
||||
|
||||
*Inherited from void*
|
||||
|
||||
|
||||
|
||||
|
||||
___
|
||||
|
||||
### name
|
||||
## name
|
||||
|
||||
• **name**: *string*
|
||||
|
||||
*Inherited from void*
|
||||
|
||||
|
||||
|
||||
|
||||
___
|
||||
|
||||
### `Optional` stack
|
||||
## `Optional` stack
|
||||
|
||||
• **stack**? : *undefined | string*
|
||||
|
||||
*Inherited from void*
|
||||
|
||||
|
||||
*Overrides void*
|
||||
|
||||
@@ -161,15 +136,15 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### typeName
|
||||
## typeName
|
||||
|
||||
• **typeName**: *string* = "CompilationError"
|
||||
|
||||
*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-compiler/src/utils/types.ts#L39)*
|
||||
*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L39)*
|
||||
|
||||
___
|
||||
|
||||
### `Static` Error
|
||||
## `Static` Error
|
||||
|
||||
▪ **Error**: *`ErrorConstructor`*
|
||||
|
||||
@@ -177,191 +152,145 @@ ___
|
||||
|
||||
<hr />
|
||||
|
||||
> # Enumeration: AbiType
|
||||
# Enumeration: AbiType
|
||||
|
||||
## Index
|
||||
|
||||
### Enumeration members
|
||||
|
||||
* [Constructor](#constructor)
|
||||
* [Event](#event)
|
||||
* [Fallback](#fallback)
|
||||
* [Function](#function)
|
||||
|
||||
## Enumeration members
|
||||
|
||||
### Constructor
|
||||
## Constructor
|
||||
|
||||
• **Constructor**: = "constructor"
|
||||
|
||||
*Defined in [utils/types.ts:3](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-compiler/src/utils/types.ts#L3)*
|
||||
*Defined in [utils/types.ts:3](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L3)*
|
||||
|
||||
___
|
||||
|
||||
### Event
|
||||
## Event
|
||||
|
||||
• **Event**: = "event"
|
||||
|
||||
*Defined in [utils/types.ts:4](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-compiler/src/utils/types.ts#L4)*
|
||||
*Defined in [utils/types.ts:4](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L4)*
|
||||
|
||||
___
|
||||
|
||||
### Fallback
|
||||
## Fallback
|
||||
|
||||
• **Fallback**: = "fallback"
|
||||
|
||||
*Defined in [utils/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-compiler/src/utils/types.ts#L5)*
|
||||
*Defined in [utils/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L5)*
|
||||
|
||||
___
|
||||
|
||||
### Function
|
||||
## Function
|
||||
|
||||
• **Function**: = "function"
|
||||
|
||||
*Defined in [utils/types.ts:2](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-compiler/src/utils/types.ts#L2)*
|
||||
*Defined in [utils/types.ts:2](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L2)*
|
||||
|
||||
<hr />
|
||||
|
||||
> # Interface: BinaryPaths
|
||||
# Interface: BinaryPaths
|
||||
|
||||
## Hierarchy
|
||||
### Hierarchy
|
||||
|
||||
* **BinaryPaths**
|
||||
|
||||
## Indexable
|
||||
|
||||
● \[▪ **key**: *string*\]: string
|
||||
|
||||
<hr />
|
||||
|
||||
> # Interface: ContractSourceData
|
||||
|
||||
## Hierarchy
|
||||
### Hierarchy
|
||||
|
||||
* **ContractSourceData**
|
||||
|
||||
## Indexable
|
||||
|
||||
● \[▪ **contractName**: *string*\]: [ContractSpecificSourceData](#class-contractspecificsourcedata)
|
||||
|
||||
<hr />
|
||||
|
||||
> # Interface: ContractSpecificSourceData
|
||||
|
||||
## Hierarchy
|
||||
### Hierarchy
|
||||
|
||||
* **ContractSpecificSourceData**
|
||||
|
||||
## Index
|
||||
|
||||
### Properties
|
||||
|
||||
* [solcVersionRange](#solcversionrange)
|
||||
* [sourceHash](#sourcehash)
|
||||
* [sourceTreeHash](#sourcetreehash)
|
||||
|
||||
## Properties
|
||||
|
||||
### solcVersionRange
|
||||
## solcVersionRange
|
||||
|
||||
• **solcVersionRange**: *string*
|
||||
|
||||
*Defined in [utils/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-compiler/src/utils/types.ts#L21)*
|
||||
*Defined in [utils/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L21)*
|
||||
|
||||
___
|
||||
|
||||
### sourceHash
|
||||
## sourceHash
|
||||
|
||||
• **sourceHash**: *`Buffer`*
|
||||
|
||||
*Defined in [utils/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-compiler/src/utils/types.ts#L22)*
|
||||
*Defined in [utils/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L22)*
|
||||
|
||||
___
|
||||
|
||||
### sourceTreeHash
|
||||
## sourceTreeHash
|
||||
|
||||
• **sourceTreeHash**: *`Buffer`*
|
||||
|
||||
*Defined in [utils/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-compiler/src/utils/types.ts#L23)*
|
||||
*Defined in [utils/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L23)*
|
||||
|
||||
<hr />
|
||||
|
||||
> # Interface: SolcErrors
|
||||
# Interface: SolcErrors
|
||||
|
||||
## Hierarchy
|
||||
### Hierarchy
|
||||
|
||||
* **SolcErrors**
|
||||
|
||||
## Indexable
|
||||
|
||||
● \[▪ **key**: *string*\]: boolean
|
||||
|
||||
<hr />
|
||||
|
||||
> # Interface: Token
|
||||
|
||||
## Hierarchy
|
||||
### Hierarchy
|
||||
|
||||
* **Token**
|
||||
|
||||
## Index
|
||||
|
||||
### Properties
|
||||
|
||||
* [address](#optional-address)
|
||||
* [decimals](#decimals)
|
||||
* [ipfsHash](#ipfshash)
|
||||
* [name](#name)
|
||||
* [swarmHash](#swarmhash)
|
||||
* [symbol](#symbol)
|
||||
|
||||
## Properties
|
||||
|
||||
### `Optional` address
|
||||
## `Optional` address
|
||||
|
||||
• **address**? : *undefined | string*
|
||||
|
||||
*Defined in [utils/types.ts:27](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-compiler/src/utils/types.ts#L27)*
|
||||
*Defined in [utils/types.ts:27](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L27)*
|
||||
|
||||
___
|
||||
|
||||
### decimals
|
||||
## decimals
|
||||
|
||||
• **decimals**: *number*
|
||||
|
||||
*Defined in [utils/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-compiler/src/utils/types.ts#L30)*
|
||||
*Defined in [utils/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L30)*
|
||||
|
||||
___
|
||||
|
||||
### ipfsHash
|
||||
## ipfsHash
|
||||
|
||||
• **ipfsHash**: *string*
|
||||
|
||||
*Defined in [utils/types.ts:31](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-compiler/src/utils/types.ts#L31)*
|
||||
*Defined in [utils/types.ts:31](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L31)*
|
||||
|
||||
___
|
||||
|
||||
### name
|
||||
## name
|
||||
|
||||
• **name**: *string*
|
||||
|
||||
*Defined in [utils/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-compiler/src/utils/types.ts#L28)*
|
||||
*Defined in [utils/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L28)*
|
||||
|
||||
___
|
||||
|
||||
### swarmHash
|
||||
## swarmHash
|
||||
|
||||
• **swarmHash**: *string*
|
||||
|
||||
*Defined in [utils/types.ts:32](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-compiler/src/utils/types.ts#L32)*
|
||||
*Defined in [utils/types.ts:32](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L32)*
|
||||
|
||||
___
|
||||
|
||||
### symbol
|
||||
## symbol
|
||||
|
||||
• **symbol**: *string*
|
||||
|
||||
*Defined in [utils/types.ts:29](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-compiler/src/utils/types.ts#L29)*
|
||||
*Defined in [utils/types.ts:29](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L29)*
|
||||
|
||||
<hr />
|
||||
|
||||
|
||||
@@ -1,38 +1,24 @@
|
||||
> # Class: CoverageSubprovider
|
||||
# Class: CoverageSubprovider
|
||||
|
||||
This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface.
|
||||
It's used to compute your code coverage while running solidity tests.
|
||||
|
||||
## Hierarchy
|
||||
### Hierarchy
|
||||
|
||||
* `TraceInfoSubprovider`
|
||||
|
||||
* **CoverageSubprovider**
|
||||
|
||||
## Index
|
||||
|
||||
### Constructors
|
||||
|
||||
* [constructor](#constructor)
|
||||
|
||||
### Methods
|
||||
|
||||
* [emitPayloadAsync](#emitpayloadasync)
|
||||
* [handleRequest](#handlerequest)
|
||||
* [setEngine](#setengine)
|
||||
* [start](#start)
|
||||
* [stop](#stop)
|
||||
* [writeCoverageAsync](#writecoverageasync)
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
## constructer
|
||||
|
||||
\+ **new CoverageSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `partialConfig`: [CoverageSubproviderPartialConfig](#coveragesubproviderpartialconfig)): *[CoverageSubprovider](#class-coveragesubprovider)*
|
||||
|
||||
*Overrides void*
|
||||
|
||||
*Defined in [coverage_subprovider.ts:44](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-coverage/src/coverage_subprovider.ts#L44)*
|
||||
*Defined in [coverage_subprovider.ts:44](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-coverage/src/coverage_subprovider.ts#L44)*
|
||||
|
||||
Instantiates a CoverageSubprovider instance
|
||||
|
||||
@@ -46,13 +32,13 @@ Name | Type | Default | Description |
|
||||
|
||||
**Returns:** *[CoverageSubprovider](#class-coveragesubprovider)*
|
||||
|
||||
## Methods
|
||||
### Methods
|
||||
|
||||
### emitPayloadAsync
|
||||
## emitPayloadAsync
|
||||
|
||||
▸ **emitPayloadAsync**(`payload`: `Partial<JSONRPCRequestPayloadWithMethod>`): *`Promise<JSONRPCResponsePayload>`*
|
||||
|
||||
*Inherited from void*
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -72,11 +58,11 @@ JSON RPC response payload
|
||||
|
||||
___
|
||||
|
||||
### handleRequest
|
||||
## handleRequest
|
||||
|
||||
▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: `NextCallback`, `_end`: `ErrorCallback`): *`Promise<void>`*
|
||||
|
||||
*Inherited from void*
|
||||
|
||||
|
||||
*Overrides void*
|
||||
|
||||
@@ -98,11 +84,11 @@ Name | Type | Description |
|
||||
|
||||
___
|
||||
|
||||
### setEngine
|
||||
## setEngine
|
||||
|
||||
▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void*
|
||||
|
||||
*Inherited from void*
|
||||
|
||||
|
||||
*Overrides void*
|
||||
|
||||
@@ -122,11 +108,11 @@ Name | Type | Description |
|
||||
|
||||
___
|
||||
|
||||
### start
|
||||
## start
|
||||
|
||||
▸ **start**(): *void*
|
||||
|
||||
*Inherited from void*
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -136,11 +122,11 @@ Starts trace collection
|
||||
|
||||
___
|
||||
|
||||
### stop
|
||||
## stop
|
||||
|
||||
▸ **stop**(): *void*
|
||||
|
||||
*Inherited from void*
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -150,11 +136,11 @@ Stops trace collection
|
||||
|
||||
___
|
||||
|
||||
### writeCoverageAsync
|
||||
## writeCoverageAsync
|
||||
|
||||
▸ **writeCoverageAsync**(): *`Promise<void>`*
|
||||
|
||||
*Defined in [coverage_subprovider.ts:78](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-coverage/src/coverage_subprovider.ts#L78)*
|
||||
*Defined in [coverage_subprovider.ts:78](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-coverage/src/coverage_subprovider.ts#L78)*
|
||||
|
||||
Write the test coverage results to a file in Istanbul format.
|
||||
|
||||
@@ -162,38 +148,32 @@ Write the test coverage results to a file in Istanbul format.
|
||||
|
||||
<hr />
|
||||
|
||||
> # Interface: CoverageSubproviderConfig
|
||||
# Interface: CoverageSubproviderConfig
|
||||
|
||||
This type defines the schema of the config object that could be passed to CoverageSubprovider
|
||||
isVerbose: If true - will log any unknown transactions. Defaults to true.
|
||||
ignoreFilesGlobs: The list of globs matching the file names of the files we want to ignore coverage for. Defaults to [].
|
||||
|
||||
## Hierarchy
|
||||
### Hierarchy
|
||||
|
||||
* **CoverageSubproviderConfig**
|
||||
|
||||
## Index
|
||||
|
||||
### Properties
|
||||
|
||||
* [ignoreFilesGlobs](#ignorefilesglobs)
|
||||
* [isVerbose](#isverbose)
|
||||
|
||||
## Properties
|
||||
|
||||
### ignoreFilesGlobs
|
||||
## ignoreFilesGlobs
|
||||
|
||||
• **ignoreFilesGlobs**: *string[]*
|
||||
|
||||
*Defined in [coverage_subprovider.ts:28](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-coverage/src/coverage_subprovider.ts#L28)*
|
||||
*Defined in [coverage_subprovider.ts:28](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-coverage/src/coverage_subprovider.ts#L28)*
|
||||
|
||||
___
|
||||
|
||||
### isVerbose
|
||||
## isVerbose
|
||||
|
||||
• **isVerbose**: *boolean*
|
||||
|
||||
*Defined in [coverage_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-coverage/src/coverage_subprovider.ts#L27)*
|
||||
*Defined in [coverage_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-coverage/src/coverage_subprovider.ts#L27)*
|
||||
|
||||
<hr />
|
||||
|
||||
|
||||
@@ -1,38 +1,24 @@
|
||||
> # Class: ProfilerSubprovider
|
||||
# Class: ProfilerSubprovider
|
||||
|
||||
This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface.
|
||||
ProfilerSubprovider is used to profile Solidity code while running tests.
|
||||
|
||||
## Hierarchy
|
||||
### Hierarchy
|
||||
|
||||
* `TraceInfoSubprovider`
|
||||
|
||||
* **ProfilerSubprovider**
|
||||
|
||||
## Index
|
||||
|
||||
### Constructors
|
||||
|
||||
* [constructor](#constructor)
|
||||
|
||||
### Methods
|
||||
|
||||
* [emitPayloadAsync](#emitpayloadasync)
|
||||
* [handleRequest](#handlerequest)
|
||||
* [setEngine](#setengine)
|
||||
* [start](#start)
|
||||
* [stop](#stop)
|
||||
* [writeProfilerOutputAsync](#writeprofileroutputasync)
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
## constructer
|
||||
|
||||
\+ **new ProfilerSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `isVerbose`: boolean): *[ProfilerSubprovider](#class-profilersubprovider)*
|
||||
|
||||
*Overrides void*
|
||||
|
||||
*Defined in [profiler_subprovider.ts:30](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-profiler/src/profiler_subprovider.ts#L30)*
|
||||
*Defined in [profiler_subprovider.ts:30](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-profiler/src/profiler_subprovider.ts#L30)*
|
||||
|
||||
Instantiates a ProfilerSubprovider instance
|
||||
|
||||
@@ -46,13 +32,13 @@ Name | Type | Default | Description |
|
||||
|
||||
**Returns:** *[ProfilerSubprovider](#class-profilersubprovider)*
|
||||
|
||||
## Methods
|
||||
### Methods
|
||||
|
||||
### emitPayloadAsync
|
||||
## emitPayloadAsync
|
||||
|
||||
▸ **emitPayloadAsync**(`payload`: `Partial<JSONRPCRequestPayloadWithMethod>`): *`Promise<JSONRPCResponsePayload>`*
|
||||
|
||||
*Inherited from void*
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -72,11 +58,11 @@ JSON RPC response payload
|
||||
|
||||
___
|
||||
|
||||
### handleRequest
|
||||
## handleRequest
|
||||
|
||||
▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: `NextCallback`, `_end`: `ErrorCallback`): *`Promise<void>`*
|
||||
|
||||
*Inherited from void*
|
||||
|
||||
|
||||
*Overrides void*
|
||||
|
||||
@@ -98,11 +84,11 @@ Name | Type | Description |
|
||||
|
||||
___
|
||||
|
||||
### setEngine
|
||||
## setEngine
|
||||
|
||||
▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void*
|
||||
|
||||
*Inherited from void*
|
||||
|
||||
|
||||
*Overrides void*
|
||||
|
||||
@@ -122,11 +108,11 @@ Name | Type | Description |
|
||||
|
||||
___
|
||||
|
||||
### start
|
||||
## start
|
||||
|
||||
▸ **start**(): *void*
|
||||
|
||||
*Inherited from void*
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -136,11 +122,11 @@ Starts trace collection
|
||||
|
||||
___
|
||||
|
||||
### stop
|
||||
## stop
|
||||
|
||||
▸ **stop**(): *void*
|
||||
|
||||
*Inherited from void*
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -150,11 +136,11 @@ Stops trace collection
|
||||
|
||||
___
|
||||
|
||||
### writeProfilerOutputAsync
|
||||
## writeProfilerOutputAsync
|
||||
|
||||
▸ **writeProfilerOutputAsync**(): *`Promise<void>`*
|
||||
|
||||
*Defined in [profiler_subprovider.ts:104](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-profiler/src/profiler_subprovider.ts#L104)*
|
||||
*Defined in [profiler_subprovider.ts:104](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-profiler/src/profiler_subprovider.ts#L104)*
|
||||
|
||||
Write the test profiler results to a file in Istanbul format.
|
||||
|
||||
|
||||
@@ -1,37 +1,24 @@
|
||||
> # Class: RevertTraceSubprovider
|
||||
# Class: RevertTraceSubprovider
|
||||
|
||||
This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface.
|
||||
It is used to report call stack traces whenever a revert occurs.
|
||||
|
||||
## Hierarchy
|
||||
### Hierarchy
|
||||
|
||||
* `TraceCollectionSubprovider`
|
||||
|
||||
* **RevertTraceSubprovider**
|
||||
|
||||
## Index
|
||||
|
||||
### Constructors
|
||||
|
||||
* [constructor](#constructor)
|
||||
|
||||
### Methods
|
||||
|
||||
* [emitPayloadAsync](#emitpayloadasync)
|
||||
* [handleRequest](#handlerequest)
|
||||
* [setEngine](#setengine)
|
||||
* [start](#start)
|
||||
* [stop](#stop)
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
## constructer
|
||||
|
||||
\+ **new RevertTraceSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `isVerbose`: boolean): *[RevertTraceSubprovider](#class-reverttracesubprovider)*
|
||||
|
||||
*Overrides void*
|
||||
|
||||
*Defined in [revert_trace_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-trace/src/revert_trace_subprovider.ts#L27)*
|
||||
*Defined in [revert_trace_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-trace/src/revert_trace_subprovider.ts#L27)*
|
||||
|
||||
Instantiates a RevertTraceSubprovider instance
|
||||
|
||||
@@ -45,13 +32,13 @@ Name | Type | Default | Description |
|
||||
|
||||
**Returns:** *[RevertTraceSubprovider](#class-reverttracesubprovider)*
|
||||
|
||||
## Methods
|
||||
### Methods
|
||||
|
||||
### emitPayloadAsync
|
||||
## emitPayloadAsync
|
||||
|
||||
▸ **emitPayloadAsync**(`payload`: `Partial<JSONRPCRequestPayloadWithMethod>`): *`Promise<JSONRPCResponsePayload>`*
|
||||
|
||||
*Inherited from void*
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -71,11 +58,11 @@ JSON RPC response payload
|
||||
|
||||
___
|
||||
|
||||
### handleRequest
|
||||
## handleRequest
|
||||
|
||||
▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: `NextCallback`, `_end`: `ErrorCallback`): *`Promise<void>`*
|
||||
|
||||
*Inherited from void*
|
||||
|
||||
|
||||
*Overrides void*
|
||||
|
||||
@@ -97,11 +84,11 @@ Name | Type | Description |
|
||||
|
||||
___
|
||||
|
||||
### setEngine
|
||||
## setEngine
|
||||
|
||||
▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void*
|
||||
|
||||
*Inherited from void*
|
||||
|
||||
|
||||
*Overrides void*
|
||||
|
||||
@@ -121,11 +108,11 @@ Name | Type | Description |
|
||||
|
||||
___
|
||||
|
||||
### start
|
||||
## start
|
||||
|
||||
▸ **start**(): *void*
|
||||
|
||||
*Inherited from void*
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -135,11 +122,11 @@ Starts trace collection
|
||||
|
||||
___
|
||||
|
||||
### stop
|
||||
## stop
|
||||
|
||||
▸ **stop**(): *void*
|
||||
|
||||
*Inherited from void*
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user