Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/BuildOnViction/tomox-sdk
SDK to build a Decentralized Exchange on TomoX protocol
https://github.com/BuildOnViction/tomox-sdk
cryptocurrency decentralized-exchange sdk tomochain tomox
Last synced: 3 months ago
JSON representation
SDK to build a Decentralized Exchange on TomoX protocol
- Host: GitHub
- URL: https://github.com/BuildOnViction/tomox-sdk
- Owner: BuildOnViction
- License: mit
- Created: 2018-10-26T09:50:27.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-24T17:33:55.000Z (almost 2 years ago)
- Last Synced: 2024-06-19T02:04:31.269Z (8 months ago)
- Topics: cryptocurrency, decentralized-exchange, sdk, tomochain, tomox
- Language: Go
- Homepage:
- Size: 75.7 MB
- Stars: 36
- Watchers: 11
- Forks: 18
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DEX backend
Official decentralized exchange backend base on TomoX Protocol
# Getting Started
### Requirements
- **golang** 1.12+
- **mongoDB** version 3.6 or newer
- **rabbitmq** version 3.7.7 or newer
- **Go Modules** latest
### Install & build
Get packages
```
go mod download
```
Create config file
```
cp config/config.yaml.example config/config.yaml
```
Then you update `config.yaml` to be correct with your enviroment.
Build binary file
```
go build
```
Run
```
./tomox-sdk
```
You also can follow [TomoX Testnet Guide](https://docs.tomochain.com/masternode/tomox-sdk/) to know how to run a DEX on Testnet
## REST API
TomoX API Document [https://apidocs.tomochain.com/#tomodex-apis](https://apidocs.tomochain.com/#tomodex-apis)
## Websocket API
See [WEBSOCKET_API.md](WEBSOCKET_API.md)
You also can test create/cancel order by using [TomoXJS SDK](https://github.com/tomochain/tomoxjs) and [TomoX Market Maker](https://github.com/tomochain/tomox-market-maker)
## Types
### Orders
Orders contain the information that is required to register an order in the orderbook as a "Maker".
- **id** is the primary ID of the order (possibly deprecated)
- **orderType** is either BUY or SELL. It is currently not parsed by the server and compute directly from buyToken, sellToken, buyAmount, sellAmount
- **exchangeAddress** is the exchange smart contract address
- **maker** is the maker (usually sender) ethereum account address
- **buyToken** is the BUY token ethereum address
- **sellToken** is the SELL token ethereum address
- **buyAmount** is the BUY amount (in BUY_TOKEN units)
- **sellAmount** is the SELL amount (in SELL_TOKEN units)
- **expires** is the order expiration timestamp
- **nonce** is the nonce that corresponds to
- **type** Limit order or Maket order LO/MO
- **status** NEW/CANCELLED
- **pairID** is a hash of the corresponding
- **hash** is a hash of the order details (see details below)
- **signature** is a signature of the order hash. The signer must equal to the maker address for the order to be valid.
- **price** corresponds to the pricepoint computed by the matching engine (not parsed)
- **amount** corresponds to the amount computed by the matching engine (not parsed)
**Order Price and Amount**
There are two ways to describe the amount of tokens being bought/sold. The smart-contract requires (buyToken, sellToken, buyAmount, sellAmount) while the
orderbook requires (pairID, amount, price).
The conversion between both systems can be found in the engine.ComputeOrderPrice
function
**Order Hash**
The order hash is a sha-256 hash of the following elements:
- Exchange address
- Token Buy address
- Amount Buy
- Token Sell Address
- Amount Sell
- Expires
- Nonce
- Type
- Status
- Maker Address
### Trades
When an order matches another order in the orderbook, the "taker" is required
to sign a trade object that matches an order.
- **orderHash** is the hash of the matching order
- **amount** is the amount of tokens that will be traded
- **trade nonce** is a unique integer to distinguish successive but identical orders (note: can probably be renamed to nonce)
- **taker** is the taker ethereum account address
- **pairID** is a hash identifying the token pair that will be traded
- **hash** is a unique identifier hash of the trade details (see details below)
- **signature** is a signature of the trade hash
Trade Hash:
The trade hash is a sha-256 hash of the following elements:
- Order Hash
- Amount
- Taker Address
- Trade Nonce
The (Order, Trade) tuple can then be used to perform an on-chain transaction for this trade.
### Quote Tokens and Token Pairs
In the same way as traditional exchanges function with the idea of base
currencies and quote currencies, the decentralized exchange works with
base tokens and quote tokens under the following principles:
- Only the exchange operator can register a quote token
- Anybody can register a token pair (but the quote token needs to be registered)
Token pairs are identified by an ID (a hash of both token addresses)