Doc reference
Class: WSClient
This class includes all the functionality related to interacting with a Mesh JSON RPC websocket endpoint.
Hierarchy
WSClient
Index
Constructors
Methods
Constructors
constructor
+ new WSClient(url: string, wsOpts?: WSOpts): WSClient
Defined in ws_client.ts:241
Instantiates a new WSClient instance
Parameters:
Name | Type | Description |
| string | WS server endpoint |
| WebSocket options |
Returns: WSClient
An instance of WSClient
Methods
addOrdersAsync
▸ addOrdersAsync(signedOrders: SignedOrder[], pinned: boolean): Promise<ValidationResults>
Defined in ws_client.ts:270
Adds an array of 0x signed orders to the Mesh node.
Parameters:
Name | Type | Default | Description |
|
| - | signedOrders to add |
| 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:385
destroy unsubscribes all active subscriptions, closes the websocket connection and stops the internal heartbeat connection liveness check.
Returns: void
getOrdersAsync
▸ getOrdersAsync(perPage: number): Promise<OrderInfo[]>
Defined in ws_client.ts:300
Get all 0x signed orders currently stored in the Mesh node
Parameters:
Name | Type | Default | Description |
| number | 200 | number of signedOrders to fetch per paginated request |
Returns: Promise<OrderInfo[]>
all orders, their hash and their fillableTakerAssetAmount
getStatsAsync
▸ getStatsAsync(): Promise<GetStatsResponse>
Defined in ws_client.ts:291
Returns: Promise<GetStatsResponse>
onClose
▸ onClose(cb: function): void
Defined in ws_client.ts:367
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:376
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:328
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[]): void
Parameters:
Name | Type |
|
Returns: Promise<string>
subscriptionId
unsubscribeAsync
▸ unsubscribeAsync(subscriptionId: string): Promise<void>
Defined in ws_client.ts:357
Unsubscribe from a subscription
Parameters:
Name | Type | Description |
| string | identifier of the subscription to cancel |
Returns: Promise<void>
Enumeration: ContractEventKind
Index
Enumeration members
Enumeration members
ERC1155ApprovalForAllEvent
• ERC1155ApprovalForAllEvent: = "ERC1155ApprovalForAllEvent"
Defined in types.ts:221
ERC1155TransferBatchEvent
• ERC1155TransferBatchEvent: = "ERC1155TransferBatchEvent"
Defined in types.ts:223
ERC1155TransferSingleEvent
• ERC1155TransferSingleEvent: = "ERC1155TransferSingleEvent"
Defined in types.ts:222
ERC20ApprovalEvent
• ERC20ApprovalEvent: = "ERC20ApprovalEvent"
Defined in types.ts:217
ERC20TransferEvent
• ERC20TransferEvent: = "ERC20TransferEvent"
Defined in types.ts:216
ERC721ApprovalEvent
• ERC721ApprovalEvent: = "ERC721ApprovalEvent"
Defined in types.ts:219
ERC721ApprovalForAllEvent
• ERC721ApprovalForAllEvent: = "ERC721ApprovalForAllEvent"
Defined in types.ts:220
ERC721TransferEvent
• ERC721TransferEvent: = "ERC721TransferEvent"
Defined in types.ts:218
ExchangeCancelEvent
• ExchangeCancelEvent: = "ExchangeCancelEvent"
Defined in types.ts:225
ExchangeCancelUpToEvent
• ExchangeCancelUpToEvent: = "ExchangeCancelUpToEvent"
Defined in types.ts:226
ExchangeFillEvent
• ExchangeFillEvent: = "ExchangeFillEvent"
Defined in types.ts:224
WethDepositEvent
• WethDepositEvent: = "WethDepositEvent"
Defined in types.ts:227
WethWithdrawalEvent
• WethWithdrawalEvent: = "WethWithdrawalEvent"
Defined in types.ts:228
Enumeration: OrderEventEndState
Index
Enumeration members
Enumeration members
Added
• Added: = "ADDED"
Defined in types.ts:285
Cancelled
• Cancelled: = "CANCELLED"
Defined in types.ts:288
Expired
• Expired: = "EXPIRED"
Defined in types.ts:289
FillabilityIncreased
• FillabilityIncreased: = "FILLABILITY_INCREASED"
Defined in types.ts:293
Filled
• Filled: = "FILLED"
Defined in types.ts:286
FullyFilled
• FullyFilled: = "FULLY_FILLED"
Defined in types.ts:287
Invalid
• Invalid: = "INVALID"
Defined in types.ts:284
StoppedWatching
• StoppedWatching: = "STOPPED_WATCHING"
Defined in types.ts:291
Unexpired
• Unexpired: = "UNEXPIRED"
Defined in types.ts:290
Unfunded
• Unfunded: = "UNFUNDED"
Defined in types.ts:292
Enumeration: RejectedCode
Index
Enumeration members
Enumeration members
InternalError
• InternalError: = "InternalError"
Defined in types.ts:355
MaxOrderSizeExceeded
• MaxOrderSizeExceeded: = "MaxOrderSizeExceeded"
Defined in types.ts:356
NetworkRequestFailed
• NetworkRequestFailed: = "NetworkRequestFailed"
Defined in types.ts:359
OrderAlreadyStored
• OrderAlreadyStored: = "OrderAlreadyStored"
Defined in types.ts:357
OrderCancelled
• OrderCancelled: = "OrderCancelled"
Defined in types.ts:364
OrderExpired
• OrderExpired: = "OrderExpired"
Defined in types.ts:362
OrderForIncorrectChain
• OrderForIncorrectChain: = "OrderForIncorrectChain"
Defined in types.ts:358
OrderFullyFilled
• OrderFullyFilled: = "OrderFullyFilled"
Defined in types.ts:363
OrderHasInvalidMakerAssetAmount
• OrderHasInvalidMakerAssetAmount: = "OrderHasInvalidMakerAssetAmount"
Defined in types.ts:360
OrderHasInvalidMakerAssetData
• OrderHasInvalidMakerAssetData: = "OrderHasInvalidMakerAssetData"
Defined in types.ts:366
OrderHasInvalidSignature
• OrderHasInvalidSignature: = "OrderHasInvalidSignature"
Defined in types.ts:368
OrderHasInvalidTakerAssetAmount
• OrderHasInvalidTakerAssetAmount: = "OrderHasInvalidTakerAssetAmount"
Defined in types.ts:361
OrderHasInvalidTakerAssetData
• OrderHasInvalidTakerAssetData: = "OrderHasInvalidTakerAssetData"
Defined in types.ts:367
OrderUnfunded
• OrderUnfunded: = "OrderUnfunded"
Defined in types.ts:365
Enumeration: RejectedKind
Index
Enumeration members
Enumeration members
MeshError
• MeshError: = "MESH_ERROR"
Defined in types.ts:350
MeshValidation
• MeshValidation: = "MESH_VALIDATION"
Defined in types.ts:351
ZeroexValidation
• ZeroexValidation: = "ZEROEX_VALIDATION"
Defined in types.ts:349
Interface: AcceptedOrderInfo
Hierarchy
AcceptedOrderInfo
Index
Properties
Properties
fillableTakerAssetAmount
• fillableTakerAssetAmount: BigNumber
Defined in types.ts:332
isNew
• isNew: boolean
Defined in types.ts:333
orderHash
• orderHash: string
Defined in types.ts:330
signedOrder
• signedOrder: SignedOrder
Defined in types.ts:331
Interface: ClientConfig
WebSocketClient configs Source: https://github.com/theturtle32/WebSocket-Node/blob/master/docs/WebSocketClient.md#client-config-options
Hierarchy
ClientConfig
Index
Properties
Properties
Optional assembleFragments
Optional assembleFragments• assembleFragments? : undefined | false | true
Defined in types.ts:15
Optional closeTimeout
Optional closeTimeout• closeTimeout? : undefined | number
Defined in types.ts:16
Optional fragmentOutgoingMessages
Optional fragmentOutgoingMessages• fragmentOutgoingMessages? : undefined | false | true
Defined in types.ts:13
Optional fragmentationThreshold
Optional fragmentationThreshold• fragmentationThreshold? : undefined | number
Defined in types.ts:14
Optional maxReceivedFrameSize
Optional maxReceivedFrameSize• maxReceivedFrameSize? : undefined | number
Defined in types.ts:11
Optional maxReceivedMessageSize
Optional maxReceivedMessageSize• maxReceivedMessageSize? : undefined | number
Defined in types.ts:12
Optional tlsOptions
Optional tlsOptions• tlsOptions? : any
Defined in types.ts:17
Optional webSocketVersion
Optional webSocketVersion• webSocketVersion? : undefined | number
Defined in types.ts:10
Interface: ContractEvent
Hierarchy
ContractEvent
Index
Properties
Properties
address
• address: string
Defined in types.ts:278
blockHash
• blockHash: string
Defined in types.ts:273
isRemoved
• isRemoved: string
Defined in types.ts:277
kind
• kind: ContractEventKind
Defined in types.ts:279
logIndex
• logIndex: number
Defined in types.ts:276
parameters
• parameters: ContractEventParameters
Defined in types.ts:280
txHash
• txHash: string
Defined in types.ts:274
txIndex
• txIndex: number
Defined in types.ts:275
Interface: ERC1155ApprovalForAllEvent
Hierarchy
ERC1155ApprovalForAllEvent
Index
Properties
Properties
approved
• approved: boolean
Defined in types.ts:143
operator
• operator: string
Defined in types.ts:142
owner
• owner: string
Defined in types.ts:141
Interface: ERC1155TransferBatchEvent
Hierarchy
ERC1155TransferBatchEvent
Index
Properties
Properties
from
• from: string
Defined in types.ts:126
ids
• ids: BigNumber[]
Defined in types.ts:128
operator
• operator: string
Defined in types.ts:125
to
• to: string
Defined in types.ts:127
values
• values: BigNumber[]
Defined in types.ts:129
Interface: ERC1155TransferSingleEvent
Hierarchy
ERC1155TransferSingleEvent
Index
Properties
Properties
from
• from: string
Defined in types.ts:110
id
• id: BigNumber
Defined in types.ts:112
operator
• operator: string
Defined in types.ts:109
to
• to: string
Defined in types.ts:111
value
• value: BigNumber
Defined in types.ts:113
Interface: ERC20ApprovalEvent
Hierarchy
ERC20ApprovalEvent
Index
Properties
Properties
owner
• owner: string
Defined in types.ts:67
spender
• spender: string
Defined in types.ts:68
value
• value: BigNumber
Defined in types.ts:69
Interface: ERC20TransferEvent
Hierarchy
ERC20TransferEvent
Index
Properties
Properties
from
• from: string
Defined in types.ts:55
to
• to: string
Defined in types.ts:56
value
• value: BigNumber
Defined in types.ts:57
Interface: ERC721ApprovalEvent
Hierarchy
ERC721ApprovalEvent
Index
Properties
Properties
approved
• approved: string
Defined in types.ts:92
owner
• owner: string
Defined in types.ts:91
tokenId
• tokenId: BigNumber
Defined in types.ts:93
Interface: ERC721ApprovalForAllEvent
Hierarchy
ERC721ApprovalForAllEvent
Index
Properties
Properties
approved
• approved: boolean
Defined in types.ts:105
operator
• operator: string
Defined in types.ts:104
owner
• owner: string
Defined in types.ts:103
Interface: ERC721TransferEvent
Hierarchy
ERC721TransferEvent
Index
Properties
Properties
from
• from: string
Defined in types.ts:79
to
• to: string
Defined in types.ts:80
tokenId
• tokenId: BigNumber
Defined in types.ts:81
Interface: ExchangeCancelEvent
Hierarchy
ExchangeCancelEvent
Index
Properties
Properties
feeRecipientAddress
• feeRecipientAddress: string
Defined in types.ts:177
makerAddress
• makerAddress: string
Defined in types.ts:175
makerAssetData
• makerAssetData: string
Defined in types.ts:179
orderHash
• orderHash: string
Defined in types.ts:178
senderAddress
• senderAddress: string
Defined in types.ts:176
takerAssetData
• takerAssetData: string
Defined in types.ts:180
Interface: ExchangeCancelUpToEvent
Hierarchy
ExchangeCancelUpToEvent
Index
Properties
Properties
makerAddress
• makerAddress: string
Defined in types.ts:184
orderEpoch
• orderEpoch: BigNumber
Defined in types.ts:186
senderAddress
• senderAddress: string
Defined in types.ts:185
Interface: ExchangeFillEvent
Hierarchy
ExchangeFillEvent
Index
Properties
Properties
feeRecipientAddress
• feeRecipientAddress: string
Defined in types.ts:150
makerAddress
• makerAddress: string
Defined in types.ts:147
makerAssetData
• makerAssetData: string
Defined in types.ts:156
makerAssetFilledAmount
• makerAssetFilledAmount: BigNumber
Defined in types.ts:151
makerFeePaid
• makerFeePaid: BigNumber
Defined in types.ts:153
orderHash
• orderHash: string
Defined in types.ts:155
senderAddress
• senderAddress: string
Defined in types.ts:149
takerAddress
• takerAddress: string
Defined in types.ts:148
takerAssetData
• takerAssetData: string
Defined in types.ts:157
takerAssetFilledAmount
• takerAssetFilledAmount: BigNumber
Defined in types.ts:152
takerFeePaid
• takerFeePaid: BigNumber
Defined in types.ts:154
Interface: GetOrdersResponse
Hierarchy
GetOrdersResponse
Index
Properties
Properties
ordersInfos
• ordersInfos: RawAcceptedOrderInfo[]
Defined in types.ts:402
snapshotID
• snapshotID: string
Defined in types.ts:401
Interface: GetStatsResponse
Hierarchy
GetStatsResponse
Index
Properties
Properties
ethRPCRateLimitExpiredRequests
• ethRPCRateLimitExpiredRequests: number
Defined in types.ts:429
ethRPCRequestsSentInCurrentUTCDay
• ethRPCRequestsSentInCurrentUTCDay: number
Defined in types.ts:428
ethereumChainID
• ethereumChainID: number
Defined in types.ts:420
latestBlock
• latestBlock: LatestBlock
Defined in types.ts:421
maxExpirationTime
• maxExpirationTime: string
Defined in types.ts:426
numOrders
• numOrders: number
Defined in types.ts:423
numOrdersIncludingRemoved
• numOrdersIncludingRemoved: number
Defined in types.ts:424
numPeers
• numPeers: number
Defined in types.ts:422
numPinnedOrders
• numPinnedOrders: number
Defined in types.ts:425
peerID
• peerID: string
Defined in types.ts:419
pubSubTopic
• pubSubTopic: string
Defined in types.ts:417
rendezvous
• rendezvous: string
Defined in types.ts:418
startOfCurrentUTCDay
• startOfCurrentUTCDay: string
Defined in types.ts:427
version
• version: string
Defined in types.ts:416
Interface: HeartbeatEventPayload
Hierarchy
HeartbeatEventPayload
Index
Properties
Properties
result
• result: string
Defined in types.ts:303
subscription
• subscription: string
Defined in types.ts:302
Interface: LatestBlock
Hierarchy
LatestBlock
Index
Properties
Properties
hash
• hash: string
Defined in types.ts:412
number
• number: number
Defined in types.ts:411
Interface: OrderEvent
Hierarchy
OrderEvent
Index
Properties
Properties
contractEvents
• contractEvents: ContractEvent[]
Defined in types.ts:319
endState
• endState: OrderEventEndState
Defined in types.ts:317
fillableTakerAssetAmount
• fillableTakerAssetAmount: BigNumber
Defined in types.ts:318
orderHash
• orderHash: string
Defined in types.ts:315
signedOrder
• signedOrder: SignedOrder
Defined in types.ts:316
Interface: OrderEventPayload
Hierarchy
OrderEventPayload
Index
Properties
Properties
result
• result: RawOrderEvent[]
Defined in types.ts:298
subscription
• subscription: string
Defined in types.ts:297
Interface: OrderInfo
Hierarchy
OrderInfo
Index
Properties
Properties
fillableTakerAssetAmount
• fillableTakerAssetAmount: BigNumber
Defined in types.ts:345
orderHash
• orderHash: string
Defined in types.ts:343
signedOrder
• signedOrder: SignedOrder
Defined in types.ts:344
Interface: RawAcceptedOrderInfo
Hierarchy
RawAcceptedOrderInfo
Index
Properties
Properties
fillableTakerAssetAmount
• fillableTakerAssetAmount: string
Defined in types.ts:325
isNew
• isNew: boolean
Defined in types.ts:326
orderHash
• orderHash: string
Defined in types.ts:323
signedOrder
• signedOrder: StringifiedSignedOrder
Defined in types.ts:324
Interface: RawOrderEvent
Hierarchy
RawOrderEvent
Index
Properties
Properties
contractEvents
• contractEvents: StringifiedContractEvent[]
Defined in types.ts:311
endState
• endState: OrderEventEndState
Defined in types.ts:309
fillableTakerAssetAmount
• fillableTakerAssetAmount: string
Defined in types.ts:310
orderHash
• orderHash: string
Defined in types.ts:307
signedOrder
• signedOrder: StringifiedSignedOrder
Defined in types.ts:308
Interface: RawOrderInfo
Hierarchy
RawOrderInfo
Index
Properties
Properties
fillableTakerAssetAmount
• fillableTakerAssetAmount: string
Defined in types.ts:339
orderHash
• orderHash: string
Defined in types.ts:337
signedOrder
• signedOrder: StringifiedSignedOrder
Defined in types.ts:338
Interface: RawRejectedOrderInfo
Hierarchy
RawRejectedOrderInfo
Index
Properties
Properties
kind
• kind: RejectedKind
Defined in types.ts:379
orderHash
• orderHash: string
Defined in types.ts:377
signedOrder
• signedOrder: StringifiedSignedOrder
Defined in types.ts:378
status
• status: RejectedStatus
Defined in types.ts:380
Interface: RawValidationResults
Hierarchy
RawValidationResults
Index
Properties
Properties
accepted
• accepted: RawAcceptedOrderInfo[]
Defined in types.ts:391
rejected
• rejected: RawRejectedOrderInfo[]
Defined in types.ts:392
Interface: RejectedOrderInfo
Hierarchy
RejectedOrderInfo
Index
Properties
Properties
kind
• kind: RejectedKind
Defined in types.ts:386
orderHash
• orderHash: string
Defined in types.ts:384
signedOrder
• signedOrder: SignedOrder
Defined in types.ts:385
status
• status: RejectedStatus
Defined in types.ts:387
Interface: RejectedStatus
Hierarchy
RejectedStatus
Index
Properties
Properties
code
• code: RejectedCode
Defined in types.ts:372
message
• message: string
Defined in types.ts:373
Interface: StringifiedContractEvent
Hierarchy
StringifiedContractEvent
Index
Properties
Properties
address
• address: string
Defined in types.ts:252
blockHash
• blockHash: string
Defined in types.ts:247
isRemoved
• isRemoved: string
Defined in types.ts:251
kind
• kind: string
Defined in types.ts:253
logIndex
• logIndex: number
Defined in types.ts:250
parameters
• parameters: StringifiedContractEventParameters
Defined in types.ts:254
txHash
• txHash: string
Defined in types.ts:248
txIndex
• txIndex: number
Defined in types.ts:249
Interface: StringifiedERC1155TransferBatchEvent
Hierarchy
StringifiedERC1155TransferBatchEvent
Index
Properties
Properties
from
• from: string
Defined in types.ts:134
ids
• ids: string[]
Defined in types.ts:136
operator
• operator: string
Defined in types.ts:133
to
• to: string
Defined in types.ts:135
values
• values: string[]
Defined in types.ts:137
Interface: StringifiedERC1155TransferSingleEvent
Hierarchy
StringifiedERC1155TransferSingleEvent
Index
Properties
Properties
from
• from: string
Defined in types.ts:118
id
• id: string
Defined in types.ts:120
operator
• operator: string
Defined in types.ts:117
to
• to: string
Defined in types.ts:119
value
• value: string
Defined in types.ts:121
Interface: StringifiedERC20ApprovalEvent
Hierarchy
StringifiedERC20ApprovalEvent
Index
Properties
Properties
owner
• owner: string
Defined in types.ts:73
spender
• spender: string
Defined in types.ts:74
value
• value: string
Defined in types.ts:75
Interface: StringifiedERC20TransferEvent
Hierarchy
StringifiedERC20TransferEvent
Index
Properties
Properties
from
• from: string
Defined in types.ts:61
to
• to: string
Defined in types.ts:62
value
• value: string
Defined in types.ts:63
Interface: StringifiedERC721ApprovalEvent
Hierarchy
StringifiedERC721ApprovalEvent
Index
Properties
Properties
approved
• approved: string
Defined in types.ts:98
owner
• owner: string
Defined in types.ts:97
tokenId
• tokenId: string
Defined in types.ts:99
Interface: StringifiedERC721TransferEvent
Hierarchy
StringifiedERC721TransferEvent
Index
Properties
Properties
from
• from: string
Defined in types.ts:85
to
• to: string
Defined in types.ts:86
tokenId
• tokenId: string
Defined in types.ts:87
Interface: StringifiedExchangeCancelUpToEvent
Hierarchy
StringifiedExchangeCancelUpToEvent
Index
Properties
Properties
makerAddress
• makerAddress: string
Defined in types.ts:190
orderEpoch
• orderEpoch: string
Defined in types.ts:192
senderAddress
• senderAddress: string
Defined in types.ts:191
Interface: StringifiedExchangeFillEvent
Hierarchy
StringifiedExchangeFillEvent
Index
Properties
Properties
feeRecipientAddress
• feeRecipientAddress: string
Defined in types.ts:164
makerAddress
• makerAddress: string
Defined in types.ts:161
makerAssetData
• makerAssetData: string
Defined in types.ts:170
makerAssetFilledAmount
• makerAssetFilledAmount: string
Defined in types.ts:165
makerFeePaid
• makerFeePaid: string
Defined in types.ts:167
orderHash
• orderHash: string
Defined in types.ts:169
senderAddress
• senderAddress: string
Defined in types.ts:163
takerAddress
• takerAddress: string
Defined in types.ts:162
takerAssetData
• takerAssetData: string
Defined in types.ts:171
takerAssetFilledAmount
• takerAssetFilledAmount: string
Defined in types.ts:166
takerFeePaid
• takerFeePaid: string
Defined in types.ts:168
Interface: StringifiedSignedOrder
Hierarchy
StringifiedSignedOrder
Index
Properties
Properties
exchangeAddress
• exchangeAddress: string
Defined in types.ts:48
expirationTimeSeconds
• expirationTimeSeconds: string
Defined in types.ts:50
feeRecipientAddress
• feeRecipientAddress: string
Defined in types.ts:49
makerAddress
• makerAddress: string
Defined in types.ts:39
makerAssetAmount
• makerAssetAmount: string
Defined in types.ts:43
makerAssetData
• makerAssetData: string
Defined in types.ts:45
makerFee
• makerFee: string
Defined in types.ts:41
salt
• salt: string
Defined in types.ts:47
senderAddress
• senderAddress: string
Defined in types.ts:38
signature
• signature: string
Defined in types.ts:51
takerAddress
• takerAddress: string
Defined in types.ts:40
takerAssetAmount
• takerAssetAmount: string
Defined in types.ts:44
takerAssetData
• takerAssetData: string
Defined in types.ts:46
takerFee
• takerFee: string
Defined in types.ts:42
Interface: StringifiedWethDepositEvent
Hierarchy
StringifiedWethDepositEvent
Index
Properties
Properties
owner
• owner: string
Defined in types.ts:211
value
• value: string
Defined in types.ts:212
Interface: StringifiedWethWithdrawalEvent
Hierarchy
StringifiedWethWithdrawalEvent
Index
Properties
Properties
owner
• owner: string
Defined in types.ts:201
value
• value: string
Defined in types.ts:202
Interface: ValidationResults
Hierarchy
ValidationResults
Index
Properties
Properties
accepted
• accepted: AcceptedOrderInfo[]
Defined in types.ts:396
rejected
• rejected: RejectedOrderInfo[]
Defined in types.ts:397
Interface: WethDepositEvent
Hierarchy
WethDepositEvent
Index
Properties
Properties
owner
• owner: string
Defined in types.ts:206
value
• value: BigNumber
Defined in types.ts:207
Interface: WethWithdrawalEvent
Hierarchy
WethWithdrawalEvent
Index
Properties
Properties
owner
• owner: string
Defined in types.ts:196
value
• value: BigNumber
Defined in types.ts:197
Interface: WSMessage
Hierarchy
WSMessage
Index
Properties
Properties
type
• type: string
Defined in types.ts:406
utf8Data
• utf8Data: string
Defined in types.ts:407
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 reconnectAfter: time in milliseconds after which to attempt to reconnect to WS server after an error occurred (default: 5000)
Hierarchy
WSOpts
Index
Properties
Properties
Optional clientConfig
Optional clientConfig• clientConfig? : ClientConfig
Defined in types.ts:33
Optional headers
Optional headers• headers? : undefined | __type
Defined in types.ts:31
Optional protocol
Optional protocol• protocol? : undefined | string
Defined in types.ts:32
Optional reconnectAfter
Optional reconnectAfter• reconnectAfter? : undefined | number
Defined in types.ts:34
Optional timeout
Optional timeout• timeout? : undefined | number
Defined in types.ts:30
Last updated