Last updated
Was this helpful?
This class includes all the functionality related to interacting with a Mesh JSON RPC websocket endpoint.
WSClient
Instantiates a new WSClient instance
Parameters:
Name
Type
Description
url
string
WS server endpoint
wsOpts?
WebSocket options
An instance of WSClient
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.
validation results
â–¸ destroy(): void
destroy unsubscribes all active subscriptions, closes the websocket connection and stops the internal heartbeat connection liveness check.
Returns: void
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
the snapshotID, snapshotTimestamp and all orders, their hashes and fillableTakerAssetAmounts
Get page of 0x signed orders stored on the Mesh node at the specified snapshot
Parameters:
Name
Type
Default
Description
page
number
-
Page index at which to retrieve orders
perPage
number
200
number of signedOrders to fetch per paginated request
snapshotID?
undefined | string
-
The DB snapshot at which to fetch orders. If omitted, a new snapshot is created
the snapshotID, snapshotTimestamp and all orders, their hashes and fillableTakerAssetAmounts
â–¸ onClose(cb: function): void
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(cb: function): void
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(cb: function): Promise‹string›
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
Parameters:
Name
Type
orderEvents
Returns: Promise‹string›
subscriptionId
▸ unsubscribeAsync(subscriptionId: string): Promise‹void›
Unsubscribe from a subscription
Parameters:
Name
Type
Description
subscriptionId
string
identifier of the subscription to cancel
Returns: Promise‹void›
• 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"
• Added: = "ADDED"
• Cancelled: = "CANCELLED"
• Expired: = "EXPIRED"
• FillabilityIncreased: = "FILLABILITY_INCREASED"
• Filled: = "FILLED"
• FullyFilled: = "FULLY_FILLED"
• Invalid: = "INVALID"
• StoppedWatching: = "STOPPED_WATCHING"
• Unexpired: = "UNEXPIRED"
• Unfunded: = "UNFUNDED"
• 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"
• MeshError: = "MESH_ERROR"
• MeshValidation: = "MESH_VALIDATION"
• ZeroexValidation: = "ZEROEX_VALIDATION"
AcceptedOrderInfo
• fillableTakerAssetAmount: BigNumber
• isNew: boolean
• orderHash: string
• signedOrder: SignedOrder
ClientConfig
Optional assembleFragments• assembleFragments? : undefined | false | true
Optional closeTimeout• closeTimeout? : undefined | number
Optional fragmentOutgoingMessages• fragmentOutgoingMessages? : undefined | false | true
Optional fragmentationThreshold• fragmentationThreshold? : undefined | number
Optional maxReceivedFrameSize• maxReceivedFrameSize? : undefined | number
Optional maxReceivedMessageSize• maxReceivedMessageSize? : undefined | number
Optional tlsOptions• tlsOptions? : any
Optional webSocketVersion• webSocketVersion? : undefined | number
ContractEvent
• address: string
• blockHash: string
• isRemoved: string
• logIndex: number
• txHash: string
• txIndex: number
ERC1155ApprovalForAllEvent
• approved: boolean
• operator: string
• owner: string
ERC1155TransferBatchEvent
• from: string
• ids: BigNumber[]
• operator: string
• to: string
• values: BigNumber[]
ERC1155TransferSingleEvent
• from: string
• id: BigNumber
• operator: string
• to: string
• value: BigNumber
ERC20ApprovalEvent
• owner: string
• spender: string
• value: BigNumber
ERC20TransferEvent
• from: string
• to: string
• value: BigNumber
ERC721ApprovalEvent
• approved: string
• owner: string
• tokenId: BigNumber
ERC721ApprovalForAllEvent
• approved: boolean
• operator: string
• owner: string
ERC721TransferEvent
• from: string
• to: string
• tokenId: BigNumber
ExchangeCancelEvent
• feeRecipientAddress: string
• makerAddress: string
• makerAssetData: string
• orderHash: string
• senderAddress: string
• takerAssetData: string
ExchangeCancelUpToEvent
• makerAddress: string
• orderEpoch: BigNumber
• senderAddress: string
ExchangeFillEvent
• feeRecipientAddress: string
• makerAddress: string
• makerAssetData: string
• makerAssetFilledAmount: BigNumber
• makerFeePaid: BigNumber
• orderHash: string
• senderAddress: string
• takerAddress: string
• takerAssetData: string
• takerAssetFilledAmount: BigNumber
• takerFeePaid: BigNumber
GetOrdersResponse
• snapshotID: string
• snapshotTimestamp: number
GetStatsResponse
• ethRPCRateLimitExpiredRequests: number
• ethRPCRequestsSentInCurrentUTCDay: number
• ethereumChainID: number
• maxExpirationTime: string
• numOrders: number
• numOrdersIncludingRemoved: number
• numPeers: number
• numPinnedOrders: number
• peerID: string
• pubSubTopic: string
• rendezvous: string
• startOfCurrentUTCDay: string
• version: string
HeartbeatEventPayload
• result: string
• subscription: string
LatestBlock
• hash: string
• number: number
OrderEvent
• fillableTakerAssetAmount: BigNumber
• orderHash: string
• signedOrder: SignedOrder
• timestampMs: number
OrderEventPayload
• subscription: string
OrderInfo
• fillableTakerAssetAmount: BigNumber
• orderHash: string
• signedOrder: SignedOrder
RawAcceptedOrderInfo
• fillableTakerAssetAmount: string
• isNew: boolean
• orderHash: string
RawGetOrdersResponse
• snapshotID: string
• snapshotTimestamp: string
RawOrderEvent
• fillableTakerAssetAmount: string
• orderHash: string
• timestamp: string
RawOrderInfo
• fillableTakerAssetAmount: string
• orderHash: string
RawRejectedOrderInfo
• orderHash: string
RawValidationResults
RejectedOrderInfo
• orderHash: string
• signedOrder: SignedOrder
RejectedStatus
• message: string
StringifiedContractEvent
• address: string
• blockHash: string
• isRemoved: string
• kind: string
• logIndex: number
• txHash: string
• txIndex: number
StringifiedERC1155TransferBatchEvent
• from: string
• ids: string[]
• operator: string
• to: string
• values: string[]
StringifiedERC1155TransferSingleEvent
• from: string
• id: string
• operator: string
• to: string
• value: string
StringifiedERC20ApprovalEvent
• owner: string
• spender: string
• value: string
StringifiedERC20TransferEvent
• from: string
• to: string
• value: string
StringifiedERC721ApprovalEvent
• approved: string
• owner: string
• tokenId: string
StringifiedERC721TransferEvent
• from: string
• to: string
• tokenId: string
StringifiedExchangeCancelUpToEvent
• makerAddress: string
• orderEpoch: string
• senderAddress: string
StringifiedExchangeFillEvent
• feeRecipientAddress: string
• makerAddress: string
• makerAssetData: string
• makerAssetFilledAmount: string
• makerFeePaid: string
• orderHash: string
• senderAddress: string
• takerAddress: string
• takerAssetData: string
• takerAssetFilledAmount: string
• takerFeePaid: string
StringifiedSignedOrder
• exchangeAddress: string
• expirationTimeSeconds: string
• feeRecipientAddress: string
• makerAddress: string
• makerAssetAmount: string
• makerAssetData: string
• makerFee: string
• salt: string
• senderAddress: string
• signature: string
• takerAddress: string
• takerAssetAmount: string
• takerAssetData: string
• takerFee: string
StringifiedWethDepositEvent
• owner: string
• value: string
StringifiedWethWithdrawalEvent
• owner: string
• value: string
ValidationResults
WethDepositEvent
• owner: string
• value: BigNumber
WethWithdrawalEvent
• owner: string
• value: BigNumber
WSMessage
• type: string
• utf8Data: string
WSOpts
Optional clientConfigOptional headers• headers? : undefined | __type
Optional protocol• protocol? : undefined | string
Optional reconnectDelay• reconnectDelay? : undefined | number
Optional timeout• timeout? : undefined | number
+ new WSClient(url: string, wsOpts?: ):
Defined in
Returns:
▸ addOrdersAsync(signedOrders: SignedOrder[], pinned: boolean): Promise‹›
Defined in
Returns: Promise‹›
Defined in
▸ getOrdersAsync(perPage: number): Promise‹›
Defined in
Returns: Promise‹›
▸ getOrdersForPageAsync(page: number, perPage: number, snapshotID?: undefined | string): Promise‹›
Defined in
Returns: Promise‹›
▸ getStatsAsync(): Promise‹›
Defined in
Returns: Promise‹›
Defined in
Defined in
Defined in
â–¸ (orderEvents: []): void
[]
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
WebSocketClient configs Source:
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
• kind:
Defined in
Defined in
• parameters:
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
• ordersInfos: []
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
• latestBlock:
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
• contractEvents: []
Defined in
• endState:
Defined in
Defined in
Defined in
Defined in
Defined in
• result: []
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
• signedOrder:
Defined in
• ordersInfos: []
Defined in
Defined in
Defined in
• contractEvents: []
Defined in
• endState:
Defined in
Defined in
Defined in
• signedOrder:
Defined in
Defined in
Defined in
Defined in
• signedOrder:
Defined in
• kind:
Defined in
Defined in
• signedOrder:
Defined in
• status:
Defined in
• accepted: []
Defined in
• rejected: []
Defined in
• kind:
Defined in
Defined in
Defined in
• status:
Defined in
• code:
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
• parameters:
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
• accepted: []
Defined in
• rejected: []
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
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: reconnectDelay: time in milliseconds after which to attempt to reconnect to WS server after an error occurred (default: 5000)
• clientConfig? :
Defined in
Defined in
Defined in
Defined in
Defined in