Updated CHANGELOGS & MD docs
This commit is contained in:
xianny
@@ -6,7 +6,8 @@
|
||||
"note": "Removed dependency on @0x/order-utils",
|
||||
"pr": 2321
|
||||
}
|
||||
]
|
||||
],
|
||||
"timestamp": 1574030254
|
||||
},
|
||||
{
|
||||
"version": "5.1.0-beta.1",
|
||||
|
||||
@@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only.
|
||||
|
||||
CHANGELOG
|
||||
|
||||
## v5.1.0-beta.2 - _November 17, 2019_
|
||||
|
||||
* Removed dependency on @0x/order-utils (#2321)
|
||||
|
||||
## v5.1.0-beta.1 - _November 7, 2019_
|
||||
|
||||
* All references to network ID have been removed, and references to chain ID have been introduced instead (#2313)
|
||||
|
||||
@@ -1,196 +1,73 @@
|
||||
# Class: HttpClient
|
||||
|
||||
This class includes all the functionality related to interacting with a set of HTTP endpoints
|
||||
that implement the standard relayer API v2
|
||||
|
||||
|
||||
## Constructors
|
||||
|
||||
|
||||
|
||||
\+ **new HttpClient**(`url`: string): *[HttpClient](#class-httpclient)*
|
||||
|
||||
*Defined in [connect/src/http_client.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/connect/src/http_client.ts#L44)*
|
||||
|
||||
Instantiates a new HttpClient instance
|
||||
|
||||
**Parameters:**
|
||||
|
||||
Name | Type | Description |
|
||||
------ | ------ | ------ |
|
||||
`url` | string | The relayer API base HTTP url you would like to interact with |
|
||||
|
||||
**Returns:** *[HttpClient](#class-httpclient)*
|
||||
|
||||
An instance of HttpClient
|
||||
|
||||
## Methods
|
||||
|
||||
### getAssetPairsAsync
|
||||
|
||||
▸ **getAssetPairsAsync**(`requestOpts?`: `RequestOpts` & `AssetPairsRequestOpts` & `PagedRequestOpts`): *`Promise<AssetPairsResponse>`*
|
||||
|
||||
*Defined in [connect/src/http_client.ts:59](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/connect/src/http_client.ts#L59)*
|
||||
|
||||
Retrieve assetData pair info from the API
|
||||
|
||||
**Parameters:**
|
||||
|
||||
Name | Type | Description |
|
||||
------ | ------ | ------ |
|
||||
`requestOpts?` | `RequestOpts` & `AssetPairsRequestOpts` & `PagedRequestOpts` | Options specifying assetData information to retrieve, page information, and chain id. |
|
||||
|
||||
**Returns:** *`Promise<AssetPairsResponse>`*
|
||||
|
||||
The resulting AssetPairsResponse that match the request
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Type aliases
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### AssetPairsResponse
|
||||
|
||||
Ƭ **AssetPairsResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*[AssetPairsItem](#interface-assetpairsitem)*›*
|
||||
|
||||
*Defined in [types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L416)*
|
||||
|
||||
___
|
||||
|
||||
### getFeeRecipientsAsync
|
||||
|
||||
▸ **getFeeRecipientsAsync**(`requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise<FeeRecipientsResponse>`*
|
||||
|
||||
*Defined in [connect/src/http_client.ts:160](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/connect/src/http_client.ts#L160)*
|
||||
|
||||
Retrieve the list of fee recipient addresses used by the relayer.
|
||||
|
||||
**Parameters:**
|
||||
|
||||
Name | Type | Description |
|
||||
------ | ------ | ------ |
|
||||
`requestOpts?` | `RequestOpts` & `PagedRequestOpts` | Options specifying page information, and chain id. |
|
||||
|
||||
**Returns:** *`Promise<FeeRecipientsResponse>`*
|
||||
### FeeRecipientsResponse
|
||||
|
||||
The resulting FeeRecipientsResponse
|
||||
Ƭ **FeeRecipientsResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*string*›*
|
||||
|
||||
*Defined in [types/src/index.ts:484](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L484)*
|
||||
|
||||
___
|
||||
|
||||
### getOrderAsync
|
||||
|
||||
▸ **getOrderAsync**(`orderHash`: string, `requestOpts?`: [RequestOpts](#interface-requestopts)): *`Promise<APIOrder>`*
|
||||
|
||||
*Defined in [connect/src/http_client.ts:99](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/connect/src/http_client.ts#L99)*
|
||||
|
||||
Retrieve a specific order from the API
|
||||
|
||||
**Parameters:**
|
||||
### OrdersResponse
|
||||
|
||||
Name | Type | Description |
|
||||
------ | ------ | ------ |
|
||||
`orderHash` | string | An orderHash generated from the desired order |
|
||||
`requestOpts?` | [RequestOpts](#interface-requestopts) | - |
|
||||
Ƭ **OrdersResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*[APIOrder](#interface-apiorder)*›*
|
||||
|
||||
**Returns:** *`Promise<APIOrder>`*
|
||||
|
||||
The APIOrder that matches the supplied orderHash
|
||||
*Defined in [types/src/index.ts:404](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L404)*
|
||||
|
||||
___
|
||||
|
||||
### getOrderConfigAsync
|
||||
|
||||
▸ **getOrderConfigAsync**(`request`: `OrderConfigRequest`, `requestOpts?`: [RequestOpts](#interface-requestopts)): *`Promise<OrderConfigResponse>`*
|
||||
|
||||
*Defined in [connect/src/http_client.ts:139](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/connect/src/http_client.ts#L139)*
|
||||
|
||||
Retrieve fee information from the API
|
||||
|
||||
**Parameters:**
|
||||
|
||||
Name | Type | Description |
|
||||
------ | ------ | ------ |
|
||||
`request` | `OrderConfigRequest` | A OrderConfigRequest instance describing the specific fees to retrieve |
|
||||
`requestOpts?` | [RequestOpts](#interface-requestopts) | Options specifying chain id. |
|
||||
|
||||
**Returns:** *`Promise<OrderConfigResponse>`*
|
||||
|
||||
The resulting OrderConfigResponse that matches the request
|
||||
|
||||
___
|
||||
|
||||
### getOrderbookAsync
|
||||
|
||||
▸ **getOrderbookAsync**(`request`: `OrderbookRequest`, `requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise<OrderbookResponse>`*
|
||||
|
||||
*Defined in [connect/src/http_client.ts:117](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/connect/src/http_client.ts#L117)*
|
||||
|
||||
Retrieve an orderbook from the API
|
||||
|
||||
**Parameters:**
|
||||
|
||||
Name | Type | Description |
|
||||
------ | ------ | ------ |
|
||||
`request` | `OrderbookRequest` | An OrderbookRequest instance describing the specific orderbook to retrieve |
|
||||
`requestOpts?` | `RequestOpts` & `PagedRequestOpts` | Options specifying page information, and chain id. |
|
||||
|
||||
**Returns:** *`Promise<OrderbookResponse>`*
|
||||
|
||||
The resulting OrderbookResponse that matches the request
|
||||
|
||||
___
|
||||
|
||||
### getOrdersAsync
|
||||
|
||||
▸ **getOrdersAsync**(`requestOpts?`: `RequestOpts` & `OrdersRequestOpts` & `PagedRequestOpts`): *`Promise<OrdersResponse>`*
|
||||
|
||||
*Defined in [connect/src/http_client.ts:79](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/connect/src/http_client.ts#L79)*
|
||||
|
||||
Retrieve orders from the API
|
||||
|
||||
**Parameters:**
|
||||
|
||||
Name | Type | Description |
|
||||
------ | ------ | ------ |
|
||||
`requestOpts?` | `RequestOpts` & `OrdersRequestOpts` & `PagedRequestOpts` | Options specifying orders to retrieve and page information, page information, and chain id. |
|
||||
|
||||
**Returns:** *`Promise<OrdersResponse>`*
|
||||
|
||||
The resulting OrdersResponse that match the request
|
||||
|
||||
___
|
||||
|
||||
### submitOrderAsync
|
||||
|
||||
▸ **submitOrderAsync**(`signedOrder`: `SignedOrder`, `requestOpts?`: [RequestOpts](#interface-requestopts)): *`Promise<void>`*
|
||||
|
||||
*Defined in [connect/src/http_client.ts:177](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/connect/src/http_client.ts#L177)*
|
||||
|
||||
Submit a signed order to the API
|
||||
|
||||
**Parameters:**
|
||||
|
||||
Name | Type | Description |
|
||||
------ | ------ | ------ |
|
||||
`signedOrder` | `SignedOrder` | A SignedOrder instance to submit |
|
||||
`requestOpts?` | [RequestOpts](#interface-requestopts) | Options specifying chain id. |
|
||||
|
||||
**Returns:** *`Promise<void>`*
|
||||
|
||||
<hr />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -209,7 +86,7 @@ Name | Type | Description |
|
||||
|
||||
• **metaData**: *object*
|
||||
|
||||
*Defined in [types/src/index.ts:408](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L408)*
|
||||
*Defined in [types/src/index.ts:408](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L408)*
|
||||
|
||||
___
|
||||
|
||||
@@ -217,7 +94,7 @@ ___
|
||||
|
||||
• **order**: *[SignedOrder](#class-signedorder)*
|
||||
|
||||
*Defined in [types/src/index.ts:407](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L407)*
|
||||
*Defined in [types/src/index.ts:407](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L407)*
|
||||
|
||||
<hr />
|
||||
|
||||
@@ -269,8 +146,6 @@ ___
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -279,7 +154,172 @@ ___
|
||||
|
||||
|
||||
|
||||
# Class: HttpClient
|
||||
|
||||
This class includes all the functionality related to interacting with a set of HTTP endpoints
|
||||
that implement the standard relayer API v2
|
||||
|
||||
|
||||
## Constructors
|
||||
|
||||
|
||||
|
||||
\+ **new HttpClient**(`url`: string): *[HttpClient](#class-httpclient)*
|
||||
|
||||
*Defined in [connect/src/http_client.ts:43](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L43)*
|
||||
|
||||
Instantiates a new HttpClient instance
|
||||
|
||||
**Parameters:**
|
||||
|
||||
Name | Type | Description |
|
||||
------ | ------ | ------ |
|
||||
`url` | string | The relayer API base HTTP url you would like to interact with |
|
||||
|
||||
**Returns:** *[HttpClient](#class-httpclient)*
|
||||
|
||||
An instance of HttpClient
|
||||
|
||||
## Methods
|
||||
|
||||
### getAssetPairsAsync
|
||||
|
||||
▸ **getAssetPairsAsync**(`requestOpts?`: `AssetPairsRequestOpts` & `PagedRequestOpts`): *`Promise<AssetPairsResponse>`*
|
||||
|
||||
*Defined in [connect/src/http_client.ts:58](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L58)*
|
||||
|
||||
Retrieve assetData pair info from the API
|
||||
|
||||
**Parameters:**
|
||||
|
||||
Name | Type | Description |
|
||||
------ | ------ | ------ |
|
||||
`requestOpts?` | `AssetPairsRequestOpts` & `PagedRequestOpts` | Options specifying assetData information to retrieve, page information. |
|
||||
|
||||
**Returns:** *`Promise<AssetPairsResponse>`*
|
||||
|
||||
The resulting AssetPairsResponse that match the request
|
||||
|
||||
___
|
||||
|
||||
### getFeeRecipientsAsync
|
||||
|
||||
▸ **getFeeRecipientsAsync**(`requestOpts?`: [PagedRequestOpts](#interface-pagedrequestopts)): *`Promise<FeeRecipientsResponse>`*
|
||||
|
||||
*Defined in [connect/src/http_client.ts:140](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L140)*
|
||||
|
||||
Retrieve the list of fee recipient addresses used by the relayer.
|
||||
|
||||
**Parameters:**
|
||||
|
||||
Name | Type | Description |
|
||||
------ | ------ | ------ |
|
||||
`requestOpts?` | [PagedRequestOpts](#interface-pagedrequestopts) | Options specifying page information. |
|
||||
|
||||
**Returns:** *`Promise<FeeRecipientsResponse>`*
|
||||
|
||||
The resulting FeeRecipientsResponse
|
||||
|
||||
___
|
||||
|
||||
### getOrderAsync
|
||||
|
||||
▸ **getOrderAsync**(`orderHash`: string): *`Promise<APIOrder>`*
|
||||
|
||||
*Defined in [connect/src/http_client.ts:94](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L94)*
|
||||
|
||||
Retrieve a specific order from the API
|
||||
|
||||
**Parameters:**
|
||||
|
||||
Name | Type | Description |
|
||||
------ | ------ | ------ |
|
||||
`orderHash` | string | An orderHash generated from the desired order |
|
||||
|
||||
**Returns:** *`Promise<APIOrder>`*
|
||||
|
||||
The APIOrder that matches the supplied orderHash
|
||||
|
||||
___
|
||||
|
||||
### getOrderConfigAsync
|
||||
|
||||
▸ **getOrderConfigAsync**(`request`: `OrderConfigRequest`): *`Promise<OrderConfigResponse>`*
|
||||
|
||||
*Defined in [connect/src/http_client.ts:126](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L126)*
|
||||
|
||||
Retrieve fee information from the API
|
||||
|
||||
**Parameters:**
|
||||
|
||||
Name | Type | Description |
|
||||
------ | ------ | ------ |
|
||||
`request` | `OrderConfigRequest` | A OrderConfigRequest instance describing the specific fees to retrieve |
|
||||
|
||||
**Returns:** *`Promise<OrderConfigResponse>`*
|
||||
|
||||
The resulting OrderConfigResponse that matches the request
|
||||
|
||||
___
|
||||
|
||||
### getOrderbookAsync
|
||||
|
||||
▸ **getOrderbookAsync**(`request`: `OrderbookRequest`, `requestOpts?`: [PagedRequestOpts](#interface-pagedrequestopts)): *`Promise<OrderbookResponse>`*
|
||||
|
||||
*Defined in [connect/src/http_client.ts:106](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L106)*
|
||||
|
||||
Retrieve an orderbook from the API
|
||||
|
||||
**Parameters:**
|
||||
|
||||
Name | Type | Description |
|
||||
------ | ------ | ------ |
|
||||
`request` | `OrderbookRequest` | An OrderbookRequest instance describing the specific orderbook to retrieve |
|
||||
`requestOpts?` | [PagedRequestOpts](#interface-pagedrequestopts) | Options specifying page information. |
|
||||
|
||||
**Returns:** *`Promise<OrderbookResponse>`*
|
||||
|
||||
The resulting OrderbookResponse that matches the request
|
||||
|
||||
___
|
||||
|
||||
### getOrdersAsync
|
||||
|
||||
▸ **getOrdersAsync**(`requestOpts?`: `OrdersRequestOpts` & `PagedRequestOpts`): *`Promise<OrdersResponse>`*
|
||||
|
||||
*Defined in [connect/src/http_client.ts:77](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L77)*
|
||||
|
||||
Retrieve orders from the API
|
||||
|
||||
**Parameters:**
|
||||
|
||||
Name | Type | Description |
|
||||
------ | ------ | ------ |
|
||||
`requestOpts?` | `OrdersRequestOpts` & `PagedRequestOpts` | Options specifying orders to retrieve and page information, page information. |
|
||||
|
||||
**Returns:** *`Promise<OrdersResponse>`*
|
||||
|
||||
The resulting OrdersResponse that match the request
|
||||
|
||||
___
|
||||
|
||||
### submitOrderAsync
|
||||
|
||||
▸ **submitOrderAsync**(`signedOrder`: `SignedOrder`): *`Promise<void>`*
|
||||
|
||||
*Defined in [connect/src/http_client.ts:155](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L155)*
|
||||
|
||||
Submit a signed order to the API
|
||||
|
||||
**Parameters:**
|
||||
|
||||
Name | Type | Description |
|
||||
------ | ------ | ------ |
|
||||
`signedOrder` | `SignedOrder` | A SignedOrder instance to submit |
|
||||
|
||||
**Returns:** *`Promise<void>`*
|
||||
|
||||
<hr />
|
||||
|
||||
|
||||
|
||||
@@ -322,7 +362,7 @@ ___
|
||||
|
||||
• **page**? : *undefined | number*
|
||||
|
||||
*Defined in [types/src/index.ts:491](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L491)*
|
||||
*Defined in [types/src/index.ts:491](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L491)*
|
||||
|
||||
___
|
||||
|
||||
@@ -330,7 +370,7 @@ ___
|
||||
|
||||
• **perPage**? : *undefined | number*
|
||||
|
||||
*Defined in [types/src/index.ts:492](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L492)*
|
||||
*Defined in [types/src/index.ts:492](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L492)*
|
||||
|
||||
<hr />
|
||||
|
||||
@@ -347,7 +387,7 @@ ___
|
||||
|
||||
• **page**: *number*
|
||||
|
||||
*Defined in [types/src/index.ts:459](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L459)*
|
||||
*Defined in [types/src/index.ts:459](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L459)*
|
||||
|
||||
___
|
||||
|
||||
@@ -355,7 +395,7 @@ ___
|
||||
|
||||
• **perPage**: *number*
|
||||
|
||||
*Defined in [types/src/index.ts:460](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L460)*
|
||||
*Defined in [types/src/index.ts:460](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L460)*
|
||||
|
||||
___
|
||||
|
||||
@@ -363,7 +403,7 @@ ___
|
||||
|
||||
• **records**: *`T`[]*
|
||||
|
||||
*Defined in [types/src/index.ts:461](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L461)*
|
||||
*Defined in [types/src/index.ts:461](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L461)*
|
||||
|
||||
___
|
||||
|
||||
@@ -371,7 +411,7 @@ ___
|
||||
|
||||
• **total**: *number*
|
||||
|
||||
*Defined in [types/src/index.ts:458](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L458)*
|
||||
*Defined in [types/src/index.ts:458](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L458)*
|
||||
|
||||
<hr />
|
||||
|
||||
@@ -381,6 +421,8 @@ ___
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# Interface: SignedOrder
|
||||
|
||||
|
||||
@@ -392,7 +434,7 @@ ___
|
||||
|
||||
*Inherited from [Order](#interface-order).[chainId](#chainid)*
|
||||
|
||||
*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L14)*
|
||||
*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L14)*
|
||||
|
||||
___
|
||||
|
||||
@@ -402,7 +444,7 @@ ___
|
||||
|
||||
*Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)*
|
||||
|
||||
*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L15)*
|
||||
*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L15)*
|
||||
|
||||
___
|
||||
|
||||
@@ -412,7 +454,7 @@ ___
|
||||
|
||||
*Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)*
|
||||
|
||||
*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L24)*
|
||||
*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L24)*
|
||||
|
||||
___
|
||||
|
||||
@@ -422,7 +464,7 @@ ___
|
||||
|
||||
*Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)*
|
||||
|
||||
*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L18)*
|
||||
*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L18)*
|
||||
|
||||
___
|
||||
|
||||
@@ -432,7 +474,7 @@ ___
|
||||
|
||||
*Inherited from [Order](#interface-order).[makerAddress](#makeraddress)*
|
||||
|
||||
*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L16)*
|
||||
*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L16)*
|
||||
|
||||
___
|
||||
|
||||
@@ -442,7 +484,7 @@ ___
|
||||
|
||||
*Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)*
|
||||
|
||||
*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L20)*
|
||||
*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L20)*
|
||||
|
||||
___
|
||||
|
||||
@@ -452,7 +494,7 @@ ___
|
||||
|
||||
*Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)*
|
||||
|
||||
*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L26)*
|
||||
*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L26)*
|
||||
|
||||
___
|
||||
|
||||
@@ -462,7 +504,7 @@ ___
|
||||
|
||||
*Inherited from [Order](#interface-order).[makerFee](#makerfee)*
|
||||
|
||||
*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L22)*
|
||||
*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L22)*
|
||||
|
||||
___
|
||||
|
||||
@@ -472,7 +514,7 @@ ___
|
||||
|
||||
*Inherited from [Order](#interface-order).[makerFeeAssetData](#makerfeeassetdata)*
|
||||
|
||||
*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L28)*
|
||||
*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L28)*
|
||||
|
||||
___
|
||||
|
||||
@@ -482,7 +524,7 @@ ___
|
||||
|
||||
*Inherited from [Order](#interface-order).[salt](#salt)*
|
||||
|
||||
*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L25)*
|
||||
*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L25)*
|
||||
|
||||
___
|
||||
|
||||
@@ -492,7 +534,7 @@ ___
|
||||
|
||||
*Inherited from [Order](#interface-order).[senderAddress](#senderaddress)*
|
||||
|
||||
*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L19)*
|
||||
*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L19)*
|
||||
|
||||
___
|
||||
|
||||
@@ -500,7 +542,7 @@ ___
|
||||
|
||||
• **signature**: *string*
|
||||
|
||||
*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L33)*
|
||||
*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L33)*
|
||||
|
||||
___
|
||||
|
||||
@@ -510,7 +552,7 @@ ___
|
||||
|
||||
*Inherited from [Order](#interface-order).[takerAddress](#takeraddress)*
|
||||
|
||||
*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L17)*
|
||||
*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L17)*
|
||||
|
||||
___
|
||||
|
||||
@@ -520,7 +562,7 @@ ___
|
||||
|
||||
*Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)*
|
||||
|
||||
*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L21)*
|
||||
*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L21)*
|
||||
|
||||
___
|
||||
|
||||
@@ -530,7 +572,7 @@ ___
|
||||
|
||||
*Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)*
|
||||
|
||||
*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L27)*
|
||||
*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L27)*
|
||||
|
||||
___
|
||||
|
||||
@@ -540,7 +582,7 @@ ___
|
||||
|
||||
*Inherited from [Order](#interface-order).[takerFee](#takerfee)*
|
||||
|
||||
*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L23)*
|
||||
*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L23)*
|
||||
|
||||
___
|
||||
|
||||
@@ -550,7 +592,7 @@ ___
|
||||
|
||||
*Inherited from [Order](#interface-order).[takerFeeAssetData](#takerfeeassetdata)*
|
||||
|
||||
*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L29)*
|
||||
*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L29)*
|
||||
|
||||
<hr />
|
||||
|
||||
@@ -601,6 +643,10 @@ ___
|
||||
|
||||
|
||||
|
||||
|
||||
<hr />
|
||||
|
||||
|
||||
|
||||
<hr />
|
||||
|
||||
@@ -613,13 +659,13 @@ ___
|
||||
|
||||
#### ▪ **ordersChannelFactory**: *object*
|
||||
|
||||
*Defined in [connect/src/orders_channel_factory.ts:7](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/connect/src/orders_channel_factory.ts#L7)*
|
||||
*Defined in [connect/src/orders_channel_factory.ts:7](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/orders_channel_factory.ts#L7)*
|
||||
|
||||
#### createWebSocketOrdersChannelAsync
|
||||
|
||||
▸ **createWebSocketOrdersChannelAsync**(`url`: string, `handler`: [OrdersChannelHandler](#interface-orderschannelhandler)): *`Promise<OrdersChannel>`*
|
||||
|
||||
*Defined in [connect/src/orders_channel_factory.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/connect/src/orders_channel_factory.ts#L15)*
|
||||
*Defined in [connect/src/orders_channel_factory.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/orders_channel_factory.ts#L15)*
|
||||
|
||||
Instantiates a new WebSocketOrdersChannel instance
|
||||
|
||||
@@ -636,52 +682,3 @@ An OrdersChannel Promise
|
||||
|
||||
<hr />
|
||||
|
||||
|
||||
|
||||
<hr />
|
||||
|
||||
|
||||
|
||||
|
||||
## Type aliases
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### AssetPairsResponse
|
||||
|
||||
Ƭ **AssetPairsResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*[AssetPairsItem](#interface-assetpairsitem)*›*
|
||||
|
||||
*Defined in [types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L416)*
|
||||
|
||||
___
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### FeeRecipientsResponse
|
||||
|
||||
Ƭ **FeeRecipientsResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*string*›*
|
||||
|
||||
*Defined in [types/src/index.ts:484](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L484)*
|
||||
|
||||
___
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### OrdersResponse
|
||||
|
||||
Ƭ **OrdersResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*[APIOrder](#interface-apiorder)*›*
|
||||
|
||||
*Defined in [types/src/index.ts:404](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L404)*
|
||||
|
||||
___
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user