# Doc reference

> ## Class: WSClient

This class includes all the functionality related to interacting with a Mesh JSON RPC websocket endpoint.

### Hierarchy

* **WSClient**

### Index

#### Constructors

* [constructor](#constructor)

#### Methods

* [addOrdersAsync](#addordersasync)
* [destroy](#destroy)
* [getOrdersAsync](#getordersasync)
* [getStatsAsync](#getstatsasync)
* [onClose](#onclose)
* [onReconnected](#onreconnected)
* [subscribeToOrdersAsync](#subscribetoordersasync)
* [unsubscribeAsync](#unsubscribeasync)

### Constructors

#### constructor

\+ **new WSClient**(`url`: string, `wsOpts?`: [WSOpts](#interface-wsopts)): [*WSClient*](#class-wsclient)

*Defined in* [*ws\_client.ts:252*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/ws_client.ts#L252)

Instantiates a new WSClient instance

**Parameters:**

| Name      | Type                        | Description        |
| --------- | --------------------------- | ------------------ |
| `url`     | string                      | WS server endpoint |
| `wsOpts?` | [WSOpts](#interface-wsopts) | WebSocket options  |

**Returns:** [*WSClient*](#class-wsclient)

An instance of WSClient

### Methods

#### addOrdersAsync

▸ **addOrdersAsync**(`signedOrders`: `SignedOrder`\[], `pinned`: boolean): *`Promise<ValidationResults>`*

*Defined in* [*ws\_client.ts:281*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/ws_client.ts#L281)

Adds an array of 0x signed orders to the Mesh node.

**Parameters:**

| Name           | Type             | Default | Description                                                                                                                                                                                      |
| -------------- | ---------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `signedOrders` | `SignedOrder`\[] | -       | signedOrders to add                                                                                                                                                                              |
| `pinned`       | boolean          | true    | Whether or not the orders should be pinned. Pinned orders will not be affected by any DDoS prevention or incentive mechanisms and will always stay in storage until they are no longer fillable. |

**Returns:** *`Promise<ValidationResults>`*

validation results

#### destroy

▸ **destroy**(): *void*

*Defined in* [*ws\_client.ts:403*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/ws_client.ts#L403)

destroy unsubscribes all active subscriptions, closes the websocket connection and stops the internal heartbeat connection liveness check.

**Returns:** *void*

#### getOrdersAsync

▸ **getOrdersAsync**(`perPage`: number): *`Promise<GetOrdersResponse>`*

*Defined in* [*ws\_client.ts:311*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/ws_client.ts#L311)

Get all 0x signed orders currently stored in the Mesh node

**Parameters:**

| Name      | Type   | Default | Description                                           |
| --------- | ------ | ------- | ----------------------------------------------------- |
| `perPage` | number | 200     | number of signedOrders to fetch per paginated request |

**Returns:** *`Promise<GetOrdersResponse>`*

all orders, their hash and their fillableTakerAssetAmount

#### getStatsAsync

▸ **getStatsAsync**(): *`Promise<GetStatsResponse>`*

*Defined in* [*ws\_client.ts:302*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/ws_client.ts#L302)

**Returns:** *`Promise<GetStatsResponse>`*

#### onClose

▸ **onClose**(`cb`: function): *void*

*Defined in* [*ws\_client.ts:385*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/ws_client.ts#L385)

Get notified when the underlying WS connection closes normally. If it closes with an error, WSClient automatically attempts to re-connect without emitting a `close` event.

**Parameters:**

▪ **cb**: *function*

callback to call when WS connection closes

▸ (): *void*

**Returns:** *void*

#### onReconnected

▸ **onReconnected**(`cb`: function): *void*

*Defined in* [*ws\_client.ts:394*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/ws_client.ts#L394)

Get notified when a connection to the underlying WS connection is re-established

**Parameters:**

▪ **cb**: *function*

callback to call with the error when it occurs

▸ (): *void*

**Returns:** *void*

#### subscribeToOrdersAsync

▸ **subscribeToOrdersAsync**(`cb`: function): *`Promise<string>`*

*Defined in* [*ws\_client.ts:345*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/ws_client.ts#L345)

Subscribe to the 'orders' topic and receive order events from Mesh. This method returns a subscriptionId that can be used to `unsubscribe()` from this subscription.

**Parameters:**

▪ **cb**: *function*

callback function where you'd like to get notified about order events

▸ (`orderEvents`: [OrderEvent](#interface-orderevent)\[]): *void*

**Parameters:**

| Name          | Type                                   |
| ------------- | -------------------------------------- |
| `orderEvents` | [OrderEvent](#interface-orderevent)\[] |

**Returns:** *`Promise<string>`*

subscriptionId

#### unsubscribeAsync

▸ **unsubscribeAsync**(`subscriptionId`: string): *`Promise<void>`*

*Defined in* [*ws\_client.ts:375*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/ws_client.ts#L375)

Unsubscribe from a subscription

**Parameters:**

| Name             | Type   | Description                              |
| ---------------- | ------ | ---------------------------------------- |
| `subscriptionId` | string | identifier of the subscription to cancel |

**Returns:** *`Promise<void>`*

> ## Enumeration: ContractEventKind

### Index

#### Enumeration members

* [ERC1155ApprovalForAllEvent](#erc1155approvalforallevent)
* [ERC1155TransferBatchEvent](#erc1155transferbatchevent)
* [ERC1155TransferSingleEvent](#erc1155transfersingleevent)
* [ERC20ApprovalEvent](#erc20approvalevent)
* [ERC20TransferEvent](#erc20transferevent)
* [ERC721ApprovalEvent](#erc721approvalevent)
* [ERC721ApprovalForAllEvent](#erc721approvalforallevent)
* [ERC721TransferEvent](#erc721transferevent)
* [ExchangeCancelEvent](#exchangecancelevent)
* [ExchangeCancelUpToEvent](#exchangecanceluptoevent)
* [ExchangeFillEvent](#exchangefillevent)
* [WethDepositEvent](#wethdepositevent)
* [WethWithdrawalEvent](#wethwithdrawalevent)

### Enumeration members

#### ERC1155ApprovalForAllEvent

• **ERC1155ApprovalForAllEvent**: = "ERC1155ApprovalForAllEvent"

*Defined in* [*types.ts:222*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L222)

#### ERC1155TransferBatchEvent

• **ERC1155TransferBatchEvent**: = "ERC1155TransferBatchEvent"

*Defined in* [*types.ts:224*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L224)

#### ERC1155TransferSingleEvent

• **ERC1155TransferSingleEvent**: = "ERC1155TransferSingleEvent"

*Defined in* [*types.ts:223*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L223)

#### ERC20ApprovalEvent

• **ERC20ApprovalEvent**: = "ERC20ApprovalEvent"

*Defined in* [*types.ts:218*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L218)

#### ERC20TransferEvent

• **ERC20TransferEvent**: = "ERC20TransferEvent"

*Defined in* [*types.ts:217*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L217)

#### ERC721ApprovalEvent

• **ERC721ApprovalEvent**: = "ERC721ApprovalEvent"

*Defined in* [*types.ts:220*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L220)

#### ERC721ApprovalForAllEvent

• **ERC721ApprovalForAllEvent**: = "ERC721ApprovalForAllEvent"

*Defined in* [*types.ts:221*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L221)

#### ERC721TransferEvent

• **ERC721TransferEvent**: = "ERC721TransferEvent"

*Defined in* [*types.ts:219*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L219)

#### ExchangeCancelEvent

• **ExchangeCancelEvent**: = "ExchangeCancelEvent"

*Defined in* [*types.ts:226*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L226)

#### ExchangeCancelUpToEvent

• **ExchangeCancelUpToEvent**: = "ExchangeCancelUpToEvent"

*Defined in* [*types.ts:227*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L227)

#### ExchangeFillEvent

• **ExchangeFillEvent**: = "ExchangeFillEvent"

*Defined in* [*types.ts:225*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L225)

#### WethDepositEvent

• **WethDepositEvent**: = "WethDepositEvent"

*Defined in* [*types.ts:228*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L228)

#### WethWithdrawalEvent

• **WethWithdrawalEvent**: = "WethWithdrawalEvent"

*Defined in* [*types.ts:229*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L229)

> ## Enumeration: OrderEventEndState

### Index

#### Enumeration members

* [Added](#added)
* [Cancelled](#cancelled)
* [Expired](#expired)
* [FillabilityIncreased](#fillabilityincreased)
* [Filled](#filled)
* [FullyFilled](#fullyfilled)
* [Invalid](#invalid)
* [StoppedWatching](#stoppedwatching)
* [Unexpired](#unexpired)
* [Unfunded](#unfunded)

### Enumeration members

#### Added

• **Added**: = "ADDED"

*Defined in* [*types.ts:286*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L286)

#### Cancelled

• **Cancelled**: = "CANCELLED"

*Defined in* [*types.ts:289*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L289)

#### Expired

• **Expired**: = "EXPIRED"

*Defined in* [*types.ts:290*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L290)

#### FillabilityIncreased

• **FillabilityIncreased**: = "FILLABILITY\_INCREASED"

*Defined in* [*types.ts:294*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L294)

#### Filled

• **Filled**: = "FILLED"

*Defined in* [*types.ts:287*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L287)

#### FullyFilled

• **FullyFilled**: = "FULLY\_FILLED"

*Defined in* [*types.ts:288*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L288)

#### Invalid

• **Invalid**: = "INVALID"

*Defined in* [*types.ts:285*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L285)

#### StoppedWatching

• **StoppedWatching**: = "STOPPED\_WATCHING"

*Defined in* [*types.ts:292*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L292)

#### Unexpired

• **Unexpired**: = "UNEXPIRED"

*Defined in* [*types.ts:291*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L291)

#### Unfunded

• **Unfunded**: = "UNFUNDED"

*Defined in* [*types.ts:293*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L293)

> ## Enumeration: RejectedCode

### Index

#### Enumeration members

* [InternalError](#internalerror)
* [MaxOrderSizeExceeded](#maxordersizeexceeded)
* [NetworkRequestFailed](#networkrequestfailed)
* [OrderAlreadyStored](#orderalreadystored)
* [OrderCancelled](#ordercancelled)
* [OrderExpired](#orderexpired)
* [OrderForIncorrectChain](#orderforincorrectchain)
* [OrderFullyFilled](#orderfullyfilled)
* [OrderHasInvalidMakerAssetAmount](#orderhasinvalidmakerassetamount)
* [OrderHasInvalidMakerAssetData](#orderhasinvalidmakerassetdata)
* [OrderHasInvalidSignature](#orderhasinvalidsignature)
* [OrderHasInvalidTakerAssetAmount](#orderhasinvalidtakerassetamount)
* [OrderHasInvalidTakerAssetData](#orderhasinvalidtakerassetdata)
* [OrderUnfunded](#orderunfunded)

### Enumeration members

#### InternalError

• **InternalError**: = "InternalError"

*Defined in* [*types.ts:358*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L358)

#### MaxOrderSizeExceeded

• **MaxOrderSizeExceeded**: = "MaxOrderSizeExceeded"

*Defined in* [*types.ts:359*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L359)

#### NetworkRequestFailed

• **NetworkRequestFailed**: = "NetworkRequestFailed"

*Defined in* [*types.ts:362*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L362)

#### OrderAlreadyStored

• **OrderAlreadyStored**: = "OrderAlreadyStored"

*Defined in* [*types.ts:360*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L360)

#### OrderCancelled

• **OrderCancelled**: = "OrderCancelled"

*Defined in* [*types.ts:367*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L367)

#### OrderExpired

• **OrderExpired**: = "OrderExpired"

*Defined in* [*types.ts:365*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L365)

#### OrderForIncorrectChain

• **OrderForIncorrectChain**: = "OrderForIncorrectChain"

*Defined in* [*types.ts:361*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L361)

#### OrderFullyFilled

• **OrderFullyFilled**: = "OrderFullyFilled"

*Defined in* [*types.ts:366*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L366)

#### OrderHasInvalidMakerAssetAmount

• **OrderHasInvalidMakerAssetAmount**: = "OrderHasInvalidMakerAssetAmount"

*Defined in* [*types.ts:363*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L363)

#### OrderHasInvalidMakerAssetData

• **OrderHasInvalidMakerAssetData**: = "OrderHasInvalidMakerAssetData"

*Defined in* [*types.ts:369*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L369)

#### OrderHasInvalidSignature

• **OrderHasInvalidSignature**: = "OrderHasInvalidSignature"

*Defined in* [*types.ts:371*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L371)

#### OrderHasInvalidTakerAssetAmount

• **OrderHasInvalidTakerAssetAmount**: = "OrderHasInvalidTakerAssetAmount"

*Defined in* [*types.ts:364*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L364)

#### OrderHasInvalidTakerAssetData

• **OrderHasInvalidTakerAssetData**: = "OrderHasInvalidTakerAssetData"

*Defined in* [*types.ts:370*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L370)

#### OrderUnfunded

• **OrderUnfunded**: = "OrderUnfunded"

*Defined in* [*types.ts:368*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L368)

> ## Enumeration: RejectedKind

### Index

#### Enumeration members

* [MeshError](#mesherror)
* [MeshValidation](#meshvalidation)
* [ZeroexValidation](#zeroexvalidation)

### Enumeration members

#### MeshError

• **MeshError**: = "MESH\_ERROR"

*Defined in* [*types.ts:353*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L353)

#### MeshValidation

• **MeshValidation**: = "MESH\_VALIDATION"

*Defined in* [*types.ts:354*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L354)

#### ZeroexValidation

• **ZeroexValidation**: = "ZEROEX\_VALIDATION"

*Defined in* [*types.ts:352*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L352)

> ## Interface: AcceptedOrderInfo

### Hierarchy

* **AcceptedOrderInfo**

### Index

#### Properties

* [fillableTakerAssetAmount](#fillabletakerassetamount)
* [isNew](#isnew)
* [orderHash](#orderhash)
* [signedOrder](#signedorder)

### Properties

#### fillableTakerAssetAmount

• **fillableTakerAssetAmount**: *`BigNumber`*

*Defined in* [*types.ts:335*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L335)

#### isNew

• **isNew**: *boolean*

*Defined in* [*types.ts:336*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L336)

#### orderHash

• **orderHash**: *string*

*Defined in* [*types.ts:333*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L333)

#### signedOrder

• **signedOrder**: *`SignedOrder`*

*Defined in* [*types.ts:334*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L334)

> ## Interface: ClientConfig

WebSocketClient configs Source: <https://github.com/theturtle32/WebSocket-Node/blob/master/docs/WebSocketClient.md#client-config-options>

### Hierarchy

* **ClientConfig**

### Index

#### Properties

* [assembleFragments](#optional-assemblefragments)
* [closeTimeout](#optional-closetimeout)
* [fragmentOutgoingMessages](#optional-fragmentoutgoingmessages)
* [fragmentationThreshold](#optional-fragmentationthreshold)
* [maxReceivedFrameSize](#optional-maxreceivedframesize)
* [maxReceivedMessageSize](#optional-maxreceivedmessagesize)
* [tlsOptions](#optional-tlsoptions)
* [webSocketVersion](#optional-websocketversion)

### Properties

#### `Optional` assembleFragments

• **assembleFragments**? : *undefined | false | true*

*Defined in* [*types.ts:16*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L16)

#### `Optional` closeTimeout

• **closeTimeout**? : *undefined | number*

*Defined in* [*types.ts:17*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L17)

#### `Optional` fragmentOutgoingMessages

• **fragmentOutgoingMessages**? : *undefined | false | true*

*Defined in* [*types.ts:14*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L14)

#### `Optional` fragmentationThreshold

• **fragmentationThreshold**? : *undefined | number*

*Defined in* [*types.ts:15*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L15)

#### `Optional` maxReceivedFrameSize

• **maxReceivedFrameSize**? : *undefined | number*

*Defined in* [*types.ts:12*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L12)

#### `Optional` maxReceivedMessageSize

• **maxReceivedMessageSize**? : *undefined | number*

*Defined in* [*types.ts:13*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L13)

#### `Optional` tlsOptions

• **tlsOptions**? : *any*

*Defined in* [*types.ts:18*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L18)

#### `Optional` webSocketVersion

• **webSocketVersion**? : *undefined | number*

*Defined in* [*types.ts:11*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L11)

> ## Interface: ContractEvent

### Hierarchy

* **ContractEvent**

### Index

#### Properties

* [address](#address)
* [blockHash](#blockhash)
* [isRemoved](#isremoved)
* [kind](#kind)
* [logIndex](#logindex)
* [parameters](#parameters)
* [txHash](#txhash)
* [txIndex](#txindex)

### Properties

#### address

• **address**: *string*

*Defined in* [*types.ts:279*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L279)

#### blockHash

• **blockHash**: *string*

*Defined in* [*types.ts:274*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L274)

#### isRemoved

• **isRemoved**: *string*

*Defined in* [*types.ts:278*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L278)

#### kind

• **kind**: [*ContractEventKind*](#enumeration-contracteventkind)

*Defined in* [*types.ts:280*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L280)

#### logIndex

• **logIndex**: *number*

*Defined in* [*types.ts:277*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L277)

#### parameters

• **parameters**: [*ContractEventParameters*](#contracteventparameters)

*Defined in* [*types.ts:281*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L281)

#### txHash

• **txHash**: *string*

*Defined in* [*types.ts:275*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L275)

#### txIndex

• **txIndex**: *number*

*Defined in* [*types.ts:276*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L276)

> ## Interface: ERC1155ApprovalForAllEvent

### Hierarchy

* **ERC1155ApprovalForAllEvent**

### Index

#### Properties

* [approved](#approved)
* [operator](#operator)
* [owner](#owner)

### Properties

#### approved

• **approved**: *boolean*

*Defined in* [*types.ts:144*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L144)

#### operator

• **operator**: *string*

*Defined in* [*types.ts:143*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L143)

#### owner

• **owner**: *string*

*Defined in* [*types.ts:142*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L142)

> ## Interface: ERC1155TransferBatchEvent

### Hierarchy

* **ERC1155TransferBatchEvent**

### Index

#### Properties

* [from](#from)
* [ids](#ids)
* [operator](#operator)
* [to](#to)
* [values](#values)

### Properties

#### from

• **from**: *string*

*Defined in* [*types.ts:127*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L127)

#### ids

• **ids**: *`BigNumber`\[]*

*Defined in* [*types.ts:129*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L129)

#### operator

• **operator**: *string*

*Defined in* [*types.ts:126*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L126)

#### to

• **to**: *string*

*Defined in* [*types.ts:128*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L128)

#### values

• **values**: *`BigNumber`\[]*

*Defined in* [*types.ts:130*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L130)

> ## Interface: ERC1155TransferSingleEvent

### Hierarchy

* **ERC1155TransferSingleEvent**

### Index

#### Properties

* [from](#from)
* [id](#id)
* [operator](#operator)
* [to](#to)
* [value](#value)

### Properties

#### from

• **from**: *string*

*Defined in* [*types.ts:111*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L111)

#### id

• **id**: *`BigNumber`*

*Defined in* [*types.ts:113*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L113)

#### operator

• **operator**: *string*

*Defined in* [*types.ts:110*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L110)

#### to

• **to**: *string*

*Defined in* [*types.ts:112*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L112)

#### value

• **value**: *`BigNumber`*

*Defined in* [*types.ts:114*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L114)

> ## Interface: ERC20ApprovalEvent

### Hierarchy

* **ERC20ApprovalEvent**

### Index

#### Properties

* [owner](#owner)
* [spender](#spender)
* [value](#value)

### Properties

#### owner

• **owner**: *string*

*Defined in* [*types.ts:68*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L68)

#### spender

• **spender**: *string*

*Defined in* [*types.ts:69*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L69)

#### value

• **value**: *`BigNumber`*

*Defined in* [*types.ts:70*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L70)

> ## Interface: ERC20TransferEvent

### Hierarchy

* **ERC20TransferEvent**

### Index

#### Properties

* [from](#from)
* [to](#to)
* [value](#value)

### Properties

#### from

• **from**: *string*

*Defined in* [*types.ts:56*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L56)

#### to

• **to**: *string*

*Defined in* [*types.ts:57*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L57)

#### value

• **value**: *`BigNumber`*

*Defined in* [*types.ts:58*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L58)

> ## Interface: ERC721ApprovalEvent

### Hierarchy

* **ERC721ApprovalEvent**

### Index

#### Properties

* [approved](#approved)
* [owner](#owner)
* [tokenId](#tokenid)

### Properties

#### approved

• **approved**: *string*

*Defined in* [*types.ts:93*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L93)

#### owner

• **owner**: *string*

*Defined in* [*types.ts:92*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L92)

#### tokenId

• **tokenId**: *`BigNumber`*

*Defined in* [*types.ts:94*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L94)

> ## Interface: ERC721ApprovalForAllEvent

### Hierarchy

* **ERC721ApprovalForAllEvent**

### Index

#### Properties

* [approved](#approved)
* [operator](#operator)
* [owner](#owner)

### Properties

#### approved

• **approved**: *boolean*

*Defined in* [*types.ts:106*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L106)

#### operator

• **operator**: *string*

*Defined in* [*types.ts:105*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L105)

#### owner

• **owner**: *string*

*Defined in* [*types.ts:104*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L104)

> ## Interface: ERC721TransferEvent

### Hierarchy

* **ERC721TransferEvent**

### Index

#### Properties

* [from](#from)
* [to](#to)
* [tokenId](#tokenid)

### Properties

#### from

• **from**: *string*

*Defined in* [*types.ts:80*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L80)

#### to

• **to**: *string*

*Defined in* [*types.ts:81*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L81)

#### tokenId

• **tokenId**: *`BigNumber`*

*Defined in* [*types.ts:82*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L82)

> ## Interface: ExchangeCancelEvent

### Hierarchy

* **ExchangeCancelEvent**

### Index

#### Properties

* [feeRecipientAddress](#feerecipientaddress)
* [makerAddress](#makeraddress)
* [makerAssetData](#makerassetdata)
* [orderHash](#orderhash)
* [senderAddress](#senderaddress)
* [takerAssetData](#takerassetdata)

### Properties

#### feeRecipientAddress

• **feeRecipientAddress**: *string*

*Defined in* [*types.ts:178*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L178)

#### makerAddress

• **makerAddress**: *string*

*Defined in* [*types.ts:176*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L176)

#### makerAssetData

• **makerAssetData**: *string*

*Defined in* [*types.ts:180*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L180)

#### orderHash

• **orderHash**: *string*

*Defined in* [*types.ts:179*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L179)

#### senderAddress

• **senderAddress**: *string*

*Defined in* [*types.ts:177*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L177)

#### takerAssetData

• **takerAssetData**: *string*

*Defined in* [*types.ts:181*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L181)

> ## Interface: ExchangeCancelUpToEvent

### Hierarchy

* **ExchangeCancelUpToEvent**

### Index

#### Properties

* [makerAddress](#makeraddress)
* [orderEpoch](#orderepoch)
* [senderAddress](#senderaddress)

### Properties

#### makerAddress

• **makerAddress**: *string*

*Defined in* [*types.ts:185*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L185)

#### orderEpoch

• **orderEpoch**: *`BigNumber`*

*Defined in* [*types.ts:187*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L187)

#### senderAddress

• **senderAddress**: *string*

*Defined in* [*types.ts:186*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L186)

> ## Interface: ExchangeFillEvent

### Hierarchy

* **ExchangeFillEvent**

### Index

#### Properties

* [feeRecipientAddress](#feerecipientaddress)
* [makerAddress](#makeraddress)
* [makerAssetData](#makerassetdata)
* [makerAssetFilledAmount](#makerassetfilledamount)
* [makerFeePaid](#makerfeepaid)
* [orderHash](#orderhash)
* [senderAddress](#senderaddress)
* [takerAddress](#takeraddress)
* [takerAssetData](#takerassetdata)
* [takerAssetFilledAmount](#takerassetfilledamount)
* [takerFeePaid](#takerfeepaid)

### Properties

#### feeRecipientAddress

• **feeRecipientAddress**: *string*

*Defined in* [*types.ts:151*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L151)

#### makerAddress

• **makerAddress**: *string*

*Defined in* [*types.ts:148*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L148)

#### makerAssetData

• **makerAssetData**: *string*

*Defined in* [*types.ts:157*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L157)

#### makerAssetFilledAmount

• **makerAssetFilledAmount**: *`BigNumber`*

*Defined in* [*types.ts:152*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L152)

#### makerFeePaid

• **makerFeePaid**: *`BigNumber`*

*Defined in* [*types.ts:154*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L154)

#### orderHash

• **orderHash**: *string*

*Defined in* [*types.ts:156*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L156)

#### senderAddress

• **senderAddress**: *string*

*Defined in* [*types.ts:150*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L150)

#### takerAddress

• **takerAddress**: *string*

*Defined in* [*types.ts:149*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L149)

#### takerAssetData

• **takerAssetData**: *string*

*Defined in* [*types.ts:158*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L158)

#### takerAssetFilledAmount

• **takerAssetFilledAmount**: *`BigNumber`*

*Defined in* [*types.ts:153*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L153)

#### takerFeePaid

• **takerFeePaid**: *`BigNumber`*

*Defined in* [*types.ts:155*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L155)

> ## Interface: GetOrdersResponse

### Hierarchy

* **GetOrdersResponse**

### Index

#### Properties

* [ordersInfos](#ordersinfos)
* [snapshotID](#snapshotid)
* [snapshotTimestamp](#snapshottimestamp)

### Properties

#### ordersInfos

• **ordersInfos**: [*OrderInfo*](#interface-orderinfo)*\[]*

*Defined in* [*types.ts:415*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L415)

#### snapshotID

• **snapshotID**: *string*

*Defined in* [*types.ts:413*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L413)

#### snapshotTimestamp

• **snapshotTimestamp**: *number*

*Defined in* [*types.ts:414*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L414)

> ## Interface: GetStatsResponse

### Hierarchy

* **GetStatsResponse**

### Index

#### Properties

* [ethRPCRateLimitExpiredRequests](#ethrpcratelimitexpiredrequests)
* [ethRPCRequestsSentInCurrentUTCDay](#ethrpcrequestssentincurrentutcday)
* [ethereumChainID](#ethereumchainid)
* [latestBlock](#latestblock)
* [maxExpirationTime](#maxexpirationtime)
* [numOrders](#numorders)
* [numOrdersIncludingRemoved](#numordersincludingremoved)
* [numPeers](#numpeers)
* [numPinnedOrders](#numpinnedorders)
* [peerID](#peerid)
* [pubSubTopic](#pubsubtopic)
* [rendezvous](#rendezvous)
* [startOfCurrentUTCDay](#startofcurrentutcday)
* [version](#version)

### Properties

#### ethRPCRateLimitExpiredRequests

• **ethRPCRateLimitExpiredRequests**: *number*

*Defined in* [*types.ts:442*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L442)

#### ethRPCRequestsSentInCurrentUTCDay

• **ethRPCRequestsSentInCurrentUTCDay**: *number*

*Defined in* [*types.ts:441*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L441)

#### ethereumChainID

• **ethereumChainID**: *number*

*Defined in* [*types.ts:433*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L433)

#### latestBlock

• **latestBlock**: [*LatestBlock*](#interface-latestblock)

*Defined in* [*types.ts:434*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L434)

#### maxExpirationTime

• **maxExpirationTime**: *string*

*Defined in* [*types.ts:439*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L439)

#### numOrders

• **numOrders**: *number*

*Defined in* [*types.ts:436*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L436)

#### numOrdersIncludingRemoved

• **numOrdersIncludingRemoved**: *number*

*Defined in* [*types.ts:437*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L437)

#### numPeers

• **numPeers**: *number*

*Defined in* [*types.ts:435*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L435)

#### numPinnedOrders

• **numPinnedOrders**: *number*

*Defined in* [*types.ts:438*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L438)

#### peerID

• **peerID**: *string*

*Defined in* [*types.ts:432*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L432)

#### pubSubTopic

• **pubSubTopic**: *string*

*Defined in* [*types.ts:430*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L430)

#### rendezvous

• **rendezvous**: *string*

*Defined in* [*types.ts:431*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L431)

#### startOfCurrentUTCDay

• **startOfCurrentUTCDay**: *string*

*Defined in* [*types.ts:440*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L440)

#### version

• **version**: *string*

*Defined in* [*types.ts:429*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L429)

> ## Interface: HeartbeatEventPayload

### Hierarchy

* **HeartbeatEventPayload**

### Index

#### Properties

* [result](#result)
* [subscription](#subscription)

### Properties

#### result

• **result**: *string*

*Defined in* [*types.ts:304*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L304)

#### subscription

• **subscription**: *string*

*Defined in* [*types.ts:303*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L303)

> ## Interface: LatestBlock

### Hierarchy

* **LatestBlock**

### Index

#### Properties

* [hash](#hash)
* [number](#number)

### Properties

#### hash

• **hash**: *string*

*Defined in* [*types.ts:425*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L425)

#### number

• **number**: *number*

*Defined in* [*types.ts:424*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L424)

> ## Interface: OrderEvent

### Hierarchy

* **OrderEvent**

### Index

#### Properties

* [contractEvents](#contractevents)
* [endState](#endstate)
* [fillableTakerAssetAmount](#fillabletakerassetamount)
* [orderHash](#orderhash)
* [signedOrder](#signedorder)
* [timestampMs](#timestampms)

### Properties

#### contractEvents

• **contractEvents**: [*ContractEvent*](#interface-contractevent)*\[]*

*Defined in* [*types.ts:322*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L322)

#### endState

• **endState**: [*OrderEventEndState*](#enumeration-ordereventendstate)

*Defined in* [*types.ts:320*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L320)

#### fillableTakerAssetAmount

• **fillableTakerAssetAmount**: *`BigNumber`*

*Defined in* [*types.ts:321*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L321)

#### orderHash

• **orderHash**: *string*

*Defined in* [*types.ts:318*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L318)

#### signedOrder

• **signedOrder**: *`SignedOrder`*

*Defined in* [*types.ts:319*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L319)

#### timestampMs

• **timestampMs**: *number*

*Defined in* [*types.ts:317*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L317)

> ## Interface: OrderEventPayload

### Hierarchy

* **OrderEventPayload**

### Index

#### Properties

* [result](#result)
* [subscription](#subscription)

### Properties

#### result

• **result**: [*RawOrderEvent*](#interface-raworderevent)*\[]*

*Defined in* [*types.ts:299*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L299)

#### subscription

• **subscription**: *string*

*Defined in* [*types.ts:298*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L298)

> ## Interface: OrderInfo

### Hierarchy

* **OrderInfo**

### Index

#### Properties

* [fillableTakerAssetAmount](#fillabletakerassetamount)
* [orderHash](#orderhash)
* [signedOrder](#signedorder)

### Properties

#### fillableTakerAssetAmount

• **fillableTakerAssetAmount**: *`BigNumber`*

*Defined in* [*types.ts:348*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L348)

#### orderHash

• **orderHash**: *string*

*Defined in* [*types.ts:346*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L346)

#### signedOrder

• **signedOrder**: *`SignedOrder`*

*Defined in* [*types.ts:347*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L347)

> ## Interface: RawAcceptedOrderInfo

### Hierarchy

* **RawAcceptedOrderInfo**

### Index

#### Properties

* [fillableTakerAssetAmount](#fillabletakerassetamount)
* [isNew](#isnew)
* [orderHash](#orderhash)
* [signedOrder](#signedorder)

### Properties

#### fillableTakerAssetAmount

• **fillableTakerAssetAmount**: *string*

*Defined in* [*types.ts:328*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L328)

#### isNew

• **isNew**: *boolean*

*Defined in* [*types.ts:329*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L329)

#### orderHash

• **orderHash**: *string*

*Defined in* [*types.ts:326*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L326)

#### signedOrder

• **signedOrder**: [*StringifiedSignedOrder*](#interface-stringifiedsignedorder)

*Defined in* [*types.ts:327*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L327)

> ## Interface: RawGetOrdersResponse

### Hierarchy

* **RawGetOrdersResponse**

### Index

#### Properties

* [ordersInfos](#ordersinfos)
* [snapshotID](#snapshotid)
* [snapshotTimestamp](#snapshottimestamp)

### Properties

#### ordersInfos

• **ordersInfos**: [*RawAcceptedOrderInfo*](#interface-rawacceptedorderinfo)*\[]*

*Defined in* [*types.ts:406*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L406)

#### snapshotID

• **snapshotID**: *string*

*Defined in* [*types.ts:404*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L404)

#### snapshotTimestamp

• **snapshotTimestamp**: *string*

*Defined in* [*types.ts:405*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L405)

> ## Interface: RawOrderEvent

### Hierarchy

* **RawOrderEvent**

### Index

#### Properties

* [contractEvents](#contractevents)
* [endState](#endstate)
* [fillableTakerAssetAmount](#fillabletakerassetamount)
* [orderHash](#orderhash)
* [signedOrder](#signedorder)
* [timestamp](#timestamp)

### Properties

#### contractEvents

• **contractEvents**: [*StringifiedContractEvent*](#interface-stringifiedcontractevent)*\[]*

*Defined in* [*types.ts:313*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L313)

#### endState

• **endState**: [*OrderEventEndState*](#enumeration-ordereventendstate)

*Defined in* [*types.ts:311*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L311)

#### fillableTakerAssetAmount

• **fillableTakerAssetAmount**: *string*

*Defined in* [*types.ts:312*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L312)

#### orderHash

• **orderHash**: *string*

*Defined in* [*types.ts:309*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L309)

#### signedOrder

• **signedOrder**: [*StringifiedSignedOrder*](#interface-stringifiedsignedorder)

*Defined in* [*types.ts:310*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L310)

#### timestamp

• **timestamp**: *string*

*Defined in* [*types.ts:308*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L308)

> ## Interface: RawOrderInfo

### Hierarchy

* **RawOrderInfo**

### Index

#### Properties

* [fillableTakerAssetAmount](#fillabletakerassetamount)
* [orderHash](#orderhash)
* [signedOrder](#signedorder)

### Properties

#### fillableTakerAssetAmount

• **fillableTakerAssetAmount**: *string*

*Defined in* [*types.ts:342*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L342)

#### orderHash

• **orderHash**: *string*

*Defined in* [*types.ts:340*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L340)

#### signedOrder

• **signedOrder**: [*StringifiedSignedOrder*](#interface-stringifiedsignedorder)

*Defined in* [*types.ts:341*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L341)

> ## Interface: RawRejectedOrderInfo

### Hierarchy

* **RawRejectedOrderInfo**

### Index

#### Properties

* [kind](#kind)
* [orderHash](#orderhash)
* [signedOrder](#signedorder)
* [status](#status)

### Properties

#### kind

• **kind**: [*RejectedKind*](#enumeration-rejectedkind)

*Defined in* [*types.ts:382*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L382)

#### orderHash

• **orderHash**: *string*

*Defined in* [*types.ts:380*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L380)

#### signedOrder

• **signedOrder**: [*StringifiedSignedOrder*](#interface-stringifiedsignedorder)

*Defined in* [*types.ts:381*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L381)

#### status

• **status**: [*RejectedStatus*](#interface-rejectedstatus)

*Defined in* [*types.ts:383*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L383)

> ## Interface: RawValidationResults

### Hierarchy

* **RawValidationResults**

### Index

#### Properties

* [accepted](#accepted)
* [rejected](#rejected)

### Properties

#### accepted

• **accepted**: [*RawAcceptedOrderInfo*](#interface-rawacceptedorderinfo)*\[]*

*Defined in* [*types.ts:394*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L394)

#### rejected

• **rejected**: [*RawRejectedOrderInfo*](#interface-rawrejectedorderinfo)*\[]*

*Defined in* [*types.ts:395*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L395)

> ## Interface: RejectedOrderInfo

### Hierarchy

* **RejectedOrderInfo**

### Index

#### Properties

* [kind](#kind)
* [orderHash](#orderhash)
* [signedOrder](#signedorder)
* [status](#status)

### Properties

#### kind

• **kind**: [*RejectedKind*](#enumeration-rejectedkind)

*Defined in* [*types.ts:389*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L389)

#### orderHash

• **orderHash**: *string*

*Defined in* [*types.ts:387*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L387)

#### signedOrder

• **signedOrder**: *`SignedOrder`*

*Defined in* [*types.ts:388*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L388)

#### status

• **status**: [*RejectedStatus*](#interface-rejectedstatus)

*Defined in* [*types.ts:390*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L390)

> ## Interface: RejectedStatus

### Hierarchy

* **RejectedStatus**

### Index

#### Properties

* [code](#code)
* [message](#message)

### Properties

#### code

• **code**: [*RejectedCode*](#enumeration-rejectedcode)

*Defined in* [*types.ts:375*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L375)

#### message

• **message**: *string*

*Defined in* [*types.ts:376*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L376)

> ## Interface: StringifiedContractEvent

### Hierarchy

* **StringifiedContractEvent**

### Index

#### Properties

* [address](#address)
* [blockHash](#blockhash)
* [isRemoved](#isremoved)
* [kind](#kind)
* [logIndex](#logindex)
* [parameters](#parameters)
* [txHash](#txhash)
* [txIndex](#txindex)

### Properties

#### address

• **address**: *string*

*Defined in* [*types.ts:253*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L253)

#### blockHash

• **blockHash**: *string*

*Defined in* [*types.ts:248*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L248)

#### isRemoved

• **isRemoved**: *string*

*Defined in* [*types.ts:252*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L252)

#### kind

• **kind**: *string*

*Defined in* [*types.ts:254*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L254)

#### logIndex

• **logIndex**: *number*

*Defined in* [*types.ts:251*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L251)

#### parameters

• **parameters**: [*StringifiedContractEventParameters*](#stringifiedcontracteventparameters)

*Defined in* [*types.ts:255*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L255)

#### txHash

• **txHash**: *string*

*Defined in* [*types.ts:249*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L249)

#### txIndex

• **txIndex**: *number*

*Defined in* [*types.ts:250*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L250)

> ## Interface: StringifiedERC1155TransferBatchEvent

### Hierarchy

* **StringifiedERC1155TransferBatchEvent**

### Index

#### Properties

* [from](#from)
* [ids](#ids)
* [operator](#operator)
* [to](#to)
* [values](#values)

### Properties

#### from

• **from**: *string*

*Defined in* [*types.ts:135*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L135)

#### ids

• **ids**: *string\[]*

*Defined in* [*types.ts:137*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L137)

#### operator

• **operator**: *string*

*Defined in* [*types.ts:134*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L134)

#### to

• **to**: *string*

*Defined in* [*types.ts:136*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L136)

#### values

• **values**: *string\[]*

*Defined in* [*types.ts:138*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L138)

> ## Interface: StringifiedERC1155TransferSingleEvent

### Hierarchy

* **StringifiedERC1155TransferSingleEvent**

### Index

#### Properties

* [from](#from)
* [id](#id)
* [operator](#operator)
* [to](#to)
* [value](#value)

### Properties

#### from

• **from**: *string*

*Defined in* [*types.ts:119*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L119)

#### id

• **id**: *string*

*Defined in* [*types.ts:121*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L121)

#### operator

• **operator**: *string*

*Defined in* [*types.ts:118*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L118)

#### to

• **to**: *string*

*Defined in* [*types.ts:120*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L120)

#### value

• **value**: *string*

*Defined in* [*types.ts:122*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L122)

> ## Interface: StringifiedERC20ApprovalEvent

### Hierarchy

* **StringifiedERC20ApprovalEvent**

### Index

#### Properties

* [owner](#owner)
* [spender](#spender)
* [value](#value)

### Properties

#### owner

• **owner**: *string*

*Defined in* [*types.ts:74*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L74)

#### spender

• **spender**: *string*

*Defined in* [*types.ts:75*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L75)

#### value

• **value**: *string*

*Defined in* [*types.ts:76*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L76)

> ## Interface: StringifiedERC20TransferEvent

### Hierarchy

* **StringifiedERC20TransferEvent**

### Index

#### Properties

* [from](#from)
* [to](#to)
* [value](#value)

### Properties

#### from

• **from**: *string*

*Defined in* [*types.ts:62*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L62)

#### to

• **to**: *string*

*Defined in* [*types.ts:63*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L63)

#### value

• **value**: *string*

*Defined in* [*types.ts:64*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L64)

> ## Interface: StringifiedERC721ApprovalEvent

### Hierarchy

* **StringifiedERC721ApprovalEvent**

### Index

#### Properties

* [approved](#approved)
* [owner](#owner)
* [tokenId](#tokenid)

### Properties

#### approved

• **approved**: *string*

*Defined in* [*types.ts:99*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L99)

#### owner

• **owner**: *string*

*Defined in* [*types.ts:98*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L98)

#### tokenId

• **tokenId**: *string*

*Defined in* [*types.ts:100*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L100)

> ## Interface: StringifiedERC721TransferEvent

### Hierarchy

* **StringifiedERC721TransferEvent**

### Index

#### Properties

* [from](#from)
* [to](#to)
* [tokenId](#tokenid)

### Properties

#### from

• **from**: *string*

*Defined in* [*types.ts:86*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L86)

#### to

• **to**: *string*

*Defined in* [*types.ts:87*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L87)

#### tokenId

• **tokenId**: *string*

*Defined in* [*types.ts:88*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L88)

> ## Interface: StringifiedExchangeCancelUpToEvent

### Hierarchy

* **StringifiedExchangeCancelUpToEvent**

### Index

#### Properties

* [makerAddress](#makeraddress)
* [orderEpoch](#orderepoch)
* [senderAddress](#senderaddress)

### Properties

#### makerAddress

• **makerAddress**: *string*

*Defined in* [*types.ts:191*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L191)

#### orderEpoch

• **orderEpoch**: *string*

*Defined in* [*types.ts:193*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L193)

#### senderAddress

• **senderAddress**: *string*

*Defined in* [*types.ts:192*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L192)

> ## Interface: StringifiedExchangeFillEvent

### Hierarchy

* **StringifiedExchangeFillEvent**

### Index

#### Properties

* [feeRecipientAddress](#feerecipientaddress)
* [makerAddress](#makeraddress)
* [makerAssetData](#makerassetdata)
* [makerAssetFilledAmount](#makerassetfilledamount)
* [makerFeePaid](#makerfeepaid)
* [orderHash](#orderhash)
* [senderAddress](#senderaddress)
* [takerAddress](#takeraddress)
* [takerAssetData](#takerassetdata)
* [takerAssetFilledAmount](#takerassetfilledamount)
* [takerFeePaid](#takerfeepaid)

### Properties

#### feeRecipientAddress

• **feeRecipientAddress**: *string*

*Defined in* [*types.ts:165*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L165)

#### makerAddress

• **makerAddress**: *string*

*Defined in* [*types.ts:162*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L162)

#### makerAssetData

• **makerAssetData**: *string*

*Defined in* [*types.ts:171*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L171)

#### makerAssetFilledAmount

• **makerAssetFilledAmount**: *string*

*Defined in* [*types.ts:166*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L166)

#### makerFeePaid

• **makerFeePaid**: *string*

*Defined in* [*types.ts:168*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L168)

#### orderHash

• **orderHash**: *string*

*Defined in* [*types.ts:170*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L170)

#### senderAddress

• **senderAddress**: *string*

*Defined in* [*types.ts:164*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L164)

#### takerAddress

• **takerAddress**: *string*

*Defined in* [*types.ts:163*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L163)

#### takerAssetData

• **takerAssetData**: *string*

*Defined in* [*types.ts:172*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L172)

#### takerAssetFilledAmount

• **takerAssetFilledAmount**: *string*

*Defined in* [*types.ts:167*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L167)

#### takerFeePaid

• **takerFeePaid**: *string*

*Defined in* [*types.ts:169*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L169)

> ## Interface: StringifiedSignedOrder

### Hierarchy

* **StringifiedSignedOrder**

### Index

#### Properties

* [exchangeAddress](#exchangeaddress)
* [expirationTimeSeconds](#expirationtimeseconds)
* [feeRecipientAddress](#feerecipientaddress)
* [makerAddress](#makeraddress)
* [makerAssetAmount](#makerassetamount)
* [makerAssetData](#makerassetdata)
* [makerFee](#makerfee)
* [salt](#salt)
* [senderAddress](#senderaddress)
* [signature](#signature)
* [takerAddress](#takeraddress)
* [takerAssetAmount](#takerassetamount)
* [takerAssetData](#takerassetdata)
* [takerFee](#takerfee)

### Properties

#### exchangeAddress

• **exchangeAddress**: *string*

*Defined in* [*types.ts:49*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L49)

#### expirationTimeSeconds

• **expirationTimeSeconds**: *string*

*Defined in* [*types.ts:51*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L51)

#### feeRecipientAddress

• **feeRecipientAddress**: *string*

*Defined in* [*types.ts:50*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L50)

#### makerAddress

• **makerAddress**: *string*

*Defined in* [*types.ts:40*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L40)

#### makerAssetAmount

• **makerAssetAmount**: *string*

*Defined in* [*types.ts:44*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L44)

#### makerAssetData

• **makerAssetData**: *string*

*Defined in* [*types.ts:46*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L46)

#### makerFee

• **makerFee**: *string*

*Defined in* [*types.ts:42*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L42)

#### salt

• **salt**: *string*

*Defined in* [*types.ts:48*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L48)

#### senderAddress

• **senderAddress**: *string*

*Defined in* [*types.ts:39*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L39)

#### signature

• **signature**: *string*

*Defined in* [*types.ts:52*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L52)

#### takerAddress

• **takerAddress**: *string*

*Defined in* [*types.ts:41*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L41)

#### takerAssetAmount

• **takerAssetAmount**: *string*

*Defined in* [*types.ts:45*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L45)

#### takerAssetData

• **takerAssetData**: *string*

*Defined in* [*types.ts:47*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L47)

#### takerFee

• **takerFee**: *string*

*Defined in* [*types.ts:43*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L43)

> ## Interface: StringifiedWethDepositEvent

### Hierarchy

* **StringifiedWethDepositEvent**

### Index

#### Properties

* [owner](#owner)
* [value](#value)

### Properties

#### owner

• **owner**: *string*

*Defined in* [*types.ts:212*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L212)

#### value

• **value**: *string*

*Defined in* [*types.ts:213*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L213)

> ## Interface: StringifiedWethWithdrawalEvent

### Hierarchy

* **StringifiedWethWithdrawalEvent**

### Index

#### Properties

* [owner](#owner)
* [value](#value)

### Properties

#### owner

• **owner**: *string*

*Defined in* [*types.ts:202*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L202)

#### value

• **value**: *string*

*Defined in* [*types.ts:203*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L203)

> ## Interface: ValidationResults

### Hierarchy

* **ValidationResults**

### Index

#### Properties

* [accepted](#accepted)
* [rejected](#rejected)

### Properties

#### accepted

• **accepted**: [*AcceptedOrderInfo*](#interface-acceptedorderinfo)*\[]*

*Defined in* [*types.ts:399*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L399)

#### rejected

• **rejected**: [*RejectedOrderInfo*](#interface-rejectedorderinfo)*\[]*

*Defined in* [*types.ts:400*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L400)

> ## Interface: WethDepositEvent

### Hierarchy

* **WethDepositEvent**

### Index

#### Properties

* [owner](#owner)
* [value](#value)

### Properties

#### owner

• **owner**: *string*

*Defined in* [*types.ts:207*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L207)

#### value

• **value**: *`BigNumber`*

*Defined in* [*types.ts:208*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L208)

> ## Interface: WethWithdrawalEvent

### Hierarchy

* **WethWithdrawalEvent**

### Index

#### Properties

* [owner](#owner)
* [value](#value)

### Properties

#### owner

• **owner**: *string*

*Defined in* [*types.ts:197*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L197)

#### value

• **value**: *`BigNumber`*

*Defined in* [*types.ts:198*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L198)

> ## Interface: WSMessage

### Hierarchy

* **WSMessage**

### Index

#### Properties

* [type](#type)
* [utf8Data](#utf8data)

### Properties

#### type

• **type**: *string*

*Defined in* [*types.ts:419*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L419)

#### utf8Data

• **utf8Data**: *string*

*Defined in* [*types.ts:420*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L420)

> ## Interface: WSOpts

timeout: timeout in milliseconds to enforce on every WS request that expects a response headers: Request headers (e.g., authorization) protocol: requestOptions should be either null or an object specifying additional configuration options to be passed to http.request or https.request. This can be used to pass a custom agent to enable WebSocketClient usage from behind an HTTP or HTTPS proxy server using koichik/node-tunnel or similar. clientConfig: The client configs documented here: <https://github.com/theturtle32/WebSocket-Node/blob/master/docs/WebSocketClient.md> reconnectDelay: time in milliseconds after which to attempt to reconnect to WS server after an error occurred (default: 5000)

### Hierarchy

* **WSOpts**

### Index

#### Properties

* [clientConfig](#optional-clientconfig)
* [headers](#optional-headers)
* [protocol](#optional-protocol)
* [reconnectDelay](#optional-reconnectdelay)
* [timeout](#optional-timeout)

### Properties

#### `Optional` clientConfig

• **clientConfig**? : [*ClientConfig*](#interface-clientconfig)

*Defined in* [*types.ts:34*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L34)

#### `Optional` headers

• **headers**? : *undefined | `__type`*

*Defined in* [*types.ts:32*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L32)

#### `Optional` protocol

• **protocol**? : *undefined | string*

*Defined in* [*types.ts:33*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L33)

#### `Optional` reconnectDelay

• **reconnectDelay**? : *undefined | number*

*Defined in* [*types.ts:35*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L35)

#### `Optional` timeout

• **timeout**? : *undefined | number*

*Defined in* [*types.ts:31*](https://github.com/0xProject/0x-mesh/blob/1593c46/rpc/clients/typescript/src/types.ts#L31)
