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. ⛔
Versions
You are looking at the documentation for version 1.0.4-beta. To see the
documentation for a different version, visit the
Releases Page.
Deployment
The Deployment Guide will walk you through how to configure and deploy your own 0x Mesh node.
Usage
Once you have deployed a 0x Mesh node, the Usage Guide explains how to interact with it using the JSON-RPC API.
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 |
|---|---|
|
cmd
|
|
|
db-integrity-check
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
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/add_peer
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. |
|
demo/subscribe_to_orders
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
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
mesh-bootstrap is a separate executable for bootstrap nodes.
|
mesh-bootstrap is a separate executable for bootstrap nodes. |
|
mesh-keygen
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. |