Last updated
The main class for this package. Has methods for receiving order events and sending orders through the 0x Mesh network.
Mesh
+ new Mesh(config: Config): Mesh
Defined in index.ts:565
Instantiates a new Mesh instance.
Parameters:
Returns: Mesh
An instance of Mesh
▸ addOrdersAsync(orders: SignedOrder[], pinned: boolean): Promise‹ValidationResults›
Defined in index.ts:639
Validates and adds the given orders to Mesh. If an order is successfully added, Mesh will share it with any peers in the network and start watching it for changes (e.g. filled, canceled, expired). The returned promise will only be rejected if there was an error validating or adding the order; it will not be rejected for any invalid orders (check results.rejected instead).
Parameters:
Returns: Promise‹ValidationResults›
Validation results for the given orders, indicating which orders were accepted and which were rejected.
▸ onError(handler: function): void
Defined in index.ts:585
Registers a handler which will be called in the event of a critical error. Note that the handler will not be called for non-critical errors. In order to ensure no errors are missed, this should be called before startAsync.
Parameters:
▪ handler: function
The handler to be called.
▸ (err: Error): void
Parameters:
Returns: void
▸ onOrderEvents(handler: function): void
Defined in index.ts:600
Registers a handler which will be called for any incoming order events. Order events are fired whenver an order is added, canceled, expired, or filled. In order to ensure no events are missed, this should be called before startAsync.
Parameters:
▪ handler: function
The handler to be called.
▸ (events: OrderEvent[]): void
Parameters:
Returns: void
▸ startAsync(): Promise‹void›
Defined in index.ts:611
Starts the Mesh node in the background. Mesh will automatically find peers in the network and begin receiving orders from them.
Returns: Promise‹void›
• Added: = "ADDED"
Defined in index.ts:430
• Cancelled: = "CANCELLED"
Defined in index.ts:433
• Expired: = "EXPIRED"
Defined in index.ts:434
• FillabilityIncreased: = "FILLABILITY_INCREASED"
Defined in index.ts:437
• Filled: = "FILLED"
Defined in index.ts:431
• FullyFilled: = "FULLY_FILLED"
Defined in index.ts:432
• Invalid: = "INVALID"
Defined in index.ts:429
• StoppedWatching: = "STOPPED_WATCHING"
Defined in index.ts:438
• Unexpired: = "UNEXPIRED"
Defined in index.ts:435
• Unfunded: = "UNFUNDED"
Defined in index.ts:436
A set of categories for rejected orders.
• CoordinatorError: = "COORDINATOR_ERROR"
Defined in index.ts:519
• MeshError: = "MESH_ERROR"
Defined in index.ts:517
• MeshValidation: = "MESH_VALIDATION"
Defined in index.ts:518
• ZeroExValidation: = "ZEROEX_VALIDATION"
Defined in index.ts:516
• Debug: = 5
Defined in index.ts:141
• Error: = 2
Defined in index.ts:138
• Fatal: = 1
Defined in index.ts:137
• Info: = 4
Defined in index.ts:140
• Panic: = 0
Defined in index.ts:136
• Trace: = 6
Defined in index.ts:142
• Warn: = 3
Defined in index.ts:139
Info for any orders that were accepted.
AcceptedOrderInfo
• fillableTakerAssetAmount: BigNumber
Defined in index.ts:497
• isNew: boolean
Defined in index.ts:498
• orderHash: string
Defined in index.ts:495
• signedOrder: SignedOrder
Defined in index.ts:496
A set of configuration options for Mesh.
Config
Optional blockPollingIntervalSeconds• blockPollingIntervalSeconds? : undefined | number
Defined in index.ts:79
Optional bootstrapList• bootstrapList? : string[]
Defined in index.ts:72
Optional customContractAddresses• customContractAddresses? : ContractAddresses
Defined in index.ts:115
• ethereumChainID: number
Defined in index.ts:64
Optional ethereumRPCMaxContentLength• ethereumRPCMaxContentLength? : undefined | number
Defined in index.ts:88
Optional ethereumRPCMaxRequestsPer24HrUTC• ethereumRPCMaxRequestsPer24HrUTC? : undefined | number
Defined in index.ts:93
Optional ethereumRPCMaxRequestsPerSecond• ethereumRPCMaxRequestsPerSecond? : undefined | number
Defined in index.ts:99
• ethereumRPCURL: string
Defined in index.ts:61
Optional maxOrdersInStorage• maxOrdersInStorage? : undefined | number
Defined in index.ts:120
Optional useBootstrapList• useBootstrapList? : undefined | false | true
Defined in index.ts:67
Optional verbosity• verbosity? : Verbosity
Defined in index.ts:58
ContractAddresses
Optional coordinator• coordinator? : undefined | string
Defined in index.ts:129
Optional coordinatorRegistry• coordinatorRegistry? : undefined | string
Defined in index.ts:130
• devUtils: string
Defined in index.ts:125
• erc1155Proxy: string
Defined in index.ts:128
• erc20Proxy: string
Defined in index.ts:126
• erc721Proxy: string
Defined in index.ts:127
• exchange: string
Defined in index.ts:124
Optional weth9• weth9? : undefined | string
Defined in index.ts:131
Optional zrxToken• zrxToken? : undefined | string
Defined in index.ts:132
ContractEvent
• address: string
Defined in index.ts:411
• blockHash: string
Defined in index.ts:406
• isRemoved: string
Defined in index.ts:410
• kind: ContractEventKind
Defined in index.ts:412
• logIndex: number
Defined in index.ts:409
• parameters: ContractEventParameters
Defined in index.ts:413
• txHash: string
Defined in index.ts:407
• txIndex: number
Defined in index.ts:408
ERC1155ApprovalForAllEvent
• approved: boolean
Defined in index.ts:287
• operator: string
Defined in index.ts:286
• owner: string
Defined in index.ts:285
ERC1155TransferBatchEvent
• from: string
Defined in index.ts:270
• ids: BigNumber[]
Defined in index.ts:272
• operator: string
Defined in index.ts:269
• to: string
Defined in index.ts:271
• values: BigNumber[]
Defined in index.ts:273
ERC1155TransferSingleEvent
• from: string
Defined in index.ts:254
• id: BigNumber
Defined in index.ts:256
• operator: string
Defined in index.ts:253
• to: string
Defined in index.ts:255
• value: BigNumber
Defined in index.ts:257
ERC20ApprovalEvent
• owner: string
Defined in index.ts:211
• spender: string
Defined in index.ts:212
• value: BigNumber
Defined in index.ts:213
ERC20TransferEvent
• from: string
Defined in index.ts:199
• to: string
Defined in index.ts:200
• value: BigNumber
Defined in index.ts:201
ERC721ApprovalEvent
• approved: string
Defined in index.ts:236
• owner: string
Defined in index.ts:235
• tokenId: BigNumber
Defined in index.ts:237
ERC721ApprovalForAllEvent
• approved: boolean
Defined in index.ts:249
• operator: string
Defined in index.ts:248
• owner: string
Defined in index.ts:247
ERC721TransferEvent
• from: string
Defined in index.ts:223
• to: string
Defined in index.ts:224
• tokenId: BigNumber
Defined in index.ts:225
ExchangeCancelEvent
• feeRecipientAddress: string
Defined in index.ts:321
• makerAddress: string
Defined in index.ts:319
• makerAssetData: string
Defined in index.ts:323
• orderHash: string
Defined in index.ts:322
• senderAddress: string
Defined in index.ts:320
• takerAssetData: string
Defined in index.ts:324
ExchangeCancelUpToEvent
• makerAddress: string
Defined in index.ts:328
• orderEpoch: BigNumber
Defined in index.ts:330
• senderAddress: string
Defined in index.ts:329
ExchangeFillEvent
• feeRecipientAddress: string
Defined in index.ts:294
• makerAddress: string
Defined in index.ts:291
• makerAssetData: string
Defined in index.ts:300
• makerAssetFilledAmount: BigNumber
Defined in index.ts:295
• makerFeePaid: BigNumber
Defined in index.ts:297
• orderHash: string
Defined in index.ts:299
• senderAddress: string
Defined in index.ts:293
• takerAddress: string
Defined in index.ts:292
• takerAssetData: string
Defined in index.ts:301
• takerAssetFilledAmount: BigNumber
Defined in index.ts:296
• takerFeePaid: BigNumber
Defined in index.ts:298
Order events are fired by Mesh whenever an order is added, canceled, expired, or filled.
OrderEvent
• contractEvents: ContractEvent[]
Defined in index.ts:458
• endState: OrderEventEndState
Defined in index.ts:456
• fillableTakerAssetAmount: BigNumber
Defined in index.ts:457
• orderHash: string
Defined in index.ts:454
• signedOrder: SignedOrder
Defined in index.ts:455
Info for any orders that were rejected, including the reason they were rejected.
RejectedOrderInfo
• kind: RejectedOrderKind
Defined in index.ts:508
• orderHash: string
Defined in index.ts:506
• signedOrder: SignedOrder
Defined in index.ts:507
• status: RejectedOrderStatus
Defined in index.ts:509
Provides more information about why an order was rejected.
RejectedOrderStatus
• code: string
Defined in index.ts:526
• message: string
Defined in index.ts:527
Indicates which orders where accepted, which were rejected, and why.
ValidationResults
• accepted: AcceptedOrderInfo[]
Defined in index.ts:487
• rejected: RejectedOrderInfo[]
Defined in index.ts:488
WethDepositEvent
• owner: string
Defined in index.ts:350
• value: BigNumber
Defined in index.ts:351
WethWithdrawalEvent
• owner: string
Defined in index.ts:340
• value: BigNumber
Defined in index.ts:341
Name
Type
Description
config
Configuration options for Mesh
Name
Type
Default
Description
orders
SignedOrder[]
-
An array of orders 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.
Name
Type
err
Error
Name
Type
events