Browser-Lite API documentation
The main class for this package. Has methods for receiving order events and sending orders through the 0x Mesh network.
- Mesh
Instantiates a new Mesh instance.
Parameters:
Name | Type | Description |
config | Configuration options for Mesh |
An instance of Mesh
• wrapper? : MeshWrapper
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:
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. |
Validation results for the given orders, indicating which orders were accepted and which were rejected.
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
▸ getOrdersForPageAsync(
perPage: number, minOrderHash?: undefined | string): Promise‹GetOrdersResponse›Get page of 0x signed orders stored on the Mesh node at the specified snapshot
Parameters:
Name | Type | Description |
perPage | number | Number of signedOrders to fetch per paginated request |
minOrderHash? | undefined | string | The minimum order hash for the returned orders. Should be set based on the last hash from the previous response. |
Up to perPage orders with hash greater than minOrderHash, including order hashes and fillableTakerAssetAmounts
Returns various stats about Mesh, including the total number of orders and the number of peers Mesh is connected to.
▸ onError(
handler: function): voidRegisters 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): voidParameters:
Name | Type |
err | Error |
Returns: void
▸ onOrderEvents(
handler: function): voidRegisters 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.
Parameters:
Name | Type |
events |
Returns: void
▸ startAsync(): Promise‹void›
Starts the Mesh node in the background. Mesh will automatically find peers in the network and begin receiving orders from them.
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"
A set of categories for rejected orders.
• MeshError: = "MESH_ERROR"
• MeshValidation: = "MESH_VALIDATION"
• ZeroExValidation: = "ZEROEX_VALIDATION"
• Debug: = 5
• Error: = 2
• Fatal: = 1
• Info: = 4
• Panic: = 0
• Trace: = 6
• Warn: = 3
Info for any orders that were accepted.
- AcceptedOrderInfo
• fillableTakerAssetAmount: BigNumber
• isNew: boolean
• orderHash: string
• signedOrder: SignedOrder
A set of configuration options for Mesh.
- Config
• blockPollingIntervalSeconds? : undefined | number
• bootstrapList? : string[]
• enableEthereumRPCRateLimiting? : undefined | false | true
• ethereumChainID: number
• ethereumRPCMaxContentLength? : undefined | number
• ethereumRPCMaxRequestsPer24HrUTC? : undefined | number
• ethereumRPCMaxRequestsPerSecond? : undefined | number
• ethereumRPCURL? : undefined | string
• maxBytesPerSecond? : undefined | number
• maxOrdersInStorage? : undefined | number
• useBootstrapList? : undefined | false | true
• web3Provider? : SupportedProvider
- ContractAddresses
• devUtils: string
• erc1155Proxy: string
• erc20Proxy: string
• erc721Proxy: string
• exchange: string
• weth9? : undefined | string
• zrxToken? : undefined | string
- ContractEvent
• address: string
• blockHash: string
• isRemoved: boolean
• logIndex: number
• parameters: ContractEventParameters
• 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
• orderSenderAddress: string
- ExchangeFillEvent
• feeRecipientAddress: string
• makerAddress: string
• makerAssetData: string
• makerAssetFilledAmount: BigNumber
• makerFeeAssetData: string
• makerFeePaid: BigNumber
• orderHash: string
• protocolFeePaid: BigNumber
• senderAddress: string
• takerAddress: string
• takerAssetData: string
• takerAssetFilledAmount: BigNumber
• takerFeeAssetData: string
• takerFeePaid: BigNumber
- GetOrdersResponse
• timestamp: number
An interface for JSON schema types, which are used for custom order filters.
- JsonSchema
• $ref? : undefined | string
• $schema? : undefined | string
• const? : any
• definitions? : undefined | object
• dependencies? : undefined | object