README
¶
0x Mesh
0x Mesh is a peer-to-peer network for sharing orders that adhere to the 0x order message format.
WARNING: This project is still under active development. Expect breaking changes before the official release.
Overview
0x Mesh has a lot of different use cases for different categories of users:
- Relayers can use Mesh to share orders with one another and to receive orders from market makers. This allows them to increase the depth of their order books and provide a better user experience.
- Market makers can use Mesh to reach a broader audience. Their orders will be sent throughout the network and are more likely to be filled.
- Mesh allows for a new type of relayer called a "serverless relayer". In the serverless relayer model, each user runs Mesh in their browser and there is no backend server or database. Instead, peers share orders directly with one another. (There are pros and cons to this approach and it is probably not suitable for all markets).
Both Relayers and Market makers can use Mesh to watch a set of orders for changes in fillability (e.g., cancellations, fills, expirations, etc...).
0x Mesh is intended to be entirely automatic. It takes care of all the work of receiving, sharing, and validating orders so that you can focus on building your application. When you run a 0x Mesh node, it will automatically discover peers in the network and begin receiving orders from and sending orders to them. You do not need to know the identities (e.g., IP address or domain name) of any peers in the network ahead of time and they do not need to know about you.
Developers can use the JSON-RPC API to interact with a Mesh node that they control. The API allows you to send orders into the network, receive any new orders, and get notified when the status of an existing order changes (e.g. when it is filled, canceled, or expired). Under the hood, Mesh performs efficient order validation and order book pruning, which takes out a lot of the hard work for developers.
Documentation
You can find documentation and guides for 0x Mesh at https://0x-org.gitbook.io/mesh.
Development
We love receiving contributions from the community 😄 If you are interested in helping develop 0x Mesh, please read the Development Guide. If you are looking for a place to start, take a look at the issues page and don't hesitate to reach out to us on Discord.
Additional Background
Directories
¶
| Path | Synopsis |
|---|---|
|
browser
|
|
|
go
command
|
|
|
scripts
command
|
|
|
cmd
|
|
|
add_peer
command
demo/add_peer is a short program that adds a new peer to 0x Mesh via RPC.
|
demo/add_peer is a short program that adds a new peer to 0x Mesh via RPC. |
|
cut-release
command
|
|
|
db-integrity-check
command
package db-integrity-check is an executable that can be used to check the integrity of the database used internally by 0x Mesh.
|
package db-integrity-check is an executable that can be used to check the integrity of the database used internally by 0x Mesh. |
|
demo/add_order
command
demo/add_order is a short program that adds an order to 0x Mesh via RPC
|
demo/add_order is a short program that adds an order to 0x Mesh via RPC |
|
demo/subscribe_to_orders
command
demo/add_order is a short program that adds an order to 0x Mesh via RPC
|
demo/add_order is a short program that adds an order to 0x Mesh via RPC |
|
mesh
command
package mesh is a standalone 0x Mesh node that can be run from the command line.
|
package mesh is a standalone 0x Mesh node that can be run from the command line. |
|
mesh-bootstrap
command
mesh-bootstrap is a separate executable for bootstrap nodes.
|
mesh-bootstrap is a separate executable for bootstrap nodes. |
|
mesh-keygen
command
mesh-keygen is a short program that can be used to generate private keys.
|
mesh-keygen is a short program that can be used to generate private keys. |
|
Package core contains everything needed to configure and run a 0x Mesh node.
|
Package core contains everything needed to configure and run a 0x Mesh node. |
|
package p2p is a low-level library responsible for peer discovery and sending/receiving messages.
|
package p2p is a low-level library responsible for peer discovery and sending/receiving messages. |