Skip to content
SDK to build a Decentralized Exchange on TomoX protocol
Go Other
  1. Go 98.7%
  2. Other 1.3%
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app add log level to config Nov 12, 2019
config add log level to config Nov 12, 2019
contracts remove stop order Oct 23, 2019
crons fix price_board usd Dec 4, 2019
daos fix bug api get orders Dec 9, 2019
endpoints fix notification ws nill pointer Nov 27, 2019
engine fix unitest, rm stop order Oct 23, 2019
errors run go fmt Oct 5, 2019
ethereum pending false Nov 6, 2019
interfaces Merge branch 'master' of github.com:tomochain/tomox-sdk Nov 4, 2019
middlewares run go fmt Oct 5, 2019
rabbitmq replace fiat token price coinmarketcap Nov 4, 2019
relayer if can not get relayer Nov 1, 2019
server add log level to config Nov 12, 2019
services fix market according with trade pairs Dec 3, 2019
swaggerui add base path Dec 9, 2019
tomox remove status new Oct 23, 2019
types remove redundant file Nov 27, 2019
utils add log level to config Nov 12, 2019
ws run go fmt Oct 5, 2019
.dockerignore update log msg Oct 30, 2019
.gitattributes add tab to space Sep 28, 2019
.gitignore replace fiat token price coinmarketcap Nov 4, 2019
.travis.yml remove stop order Oct 23, 2019
Dockerfile update travis Oct 23, 2019
LICENSE first commit Nov 16, 2018
Makefile chore: docker to travis Sep 6, 2019
README.md update README Nov 18, 2019
WEBSOCKET_API.md remove raw_orderbook channel Oct 27, 2019
docker-compose.yml change mongo replica uri Jun 28, 2019
go.mod add order to lru cache Oct 9, 2019
go.sum add status type to new order Oct 8, 2019
main.go run go fmt Oct 5, 2019
package.json Change Package Name: dex-server To tomodex Apr 16, 2019

README.md

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 to know how to run a DEX on Testnet

REST API

TomoX API Document https://apidocs.tomochain.com/#tomodex-apis

Websocket API

See WEBSOCKET_API.md

You also can test create/cancel order by using TomoXJS SDK and 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)

You can’t perform that action at this time.