dev1062 / smartdex-trade-backend Goto Github PK

This repository is forked from https://github.com/0xProject/0x-launch-kit-frontend

• Introduction
• Getting started
• Client for your relayers API
• Commands
• Database
• Deployment

Autonio Smartdex backend runs as a forked version of 0x relayer

• Node.js > v8.x
• Yarn > v1.x

To develop the project, follow the following instructions:

1. Fork this repository

2. Clone your fork of this repository

3. Open the config.ts/config.js file and edit the whitelisted tokens

4. Open the .env file and edit the following fields. Defaults are defined in config.ts/config.js. The bash environment takes precedence over the .env file. If you run source .env, changes to the .env file will have no effect until you unset the colliding variables.

   • NETWORK_ID -- the network you'd like your relayer to run on
   • FEE_RECIPIENT -- The Ethereum address which should be specified as the fee recipient in orders your relayer accepts. Defaults to a fake address that helps the 0x core team use anonymous, already public data to understand Launch Kit developer usage.
   • MAKER_FEE_ZRX_UNIT_AMOUNT -- The flat maker fee you'd like to receive for filled orders hosted by you
   • TAKER_FEE_ZRX_UNIT_AMOUNT -- The flat taker fee you'd like to receive for filled orders hosted by you.
   • RPC_URL -- Update with your node url. NOTE: Kovan doesn't work on INFURA with the current version of the OrderWatcher

Instructions for using Launch Kit with Ganache

5. Make sure you have Yarn installed.

6. Install the dependencies:

   yarn

7. Build the project [This step is for Typescript users only]

   yarn build:ts

   or build & watch:

   yarn watch:ts

8. Start the backend

   yarn start:ts

   OR

   yarn start:js

To quickly check if your backend (relayer) is up-and-running, send it this CURL request from the command-line:

curl http://localhost:3000/v2/orders

If everything is working as expected, you should see a similar response:

{
    "total": 0,
    "page": 0,
    "perPage": 20,
    "records": []
}

Since no orders have been added to your backend yet, the records array is empty.

Typescript project commands:

• yarn build:ts - Build the code
• yarn lint:ts - Lint the code
• yarn start:ts - Starts the backend
• yarn watch:ts - Watch the source code and rebuild on change
• yarn prettier:ts - Auto-format the code

Javascript project commands:

• yarn start:js - Start the backend
• yarn prettier:js - Auto-format the code

This project uses TypeORM. It makes it easier for anyone to switch out the backing database used by this project. By default, this project uses an SQLite database.

Because we want to support both Javascript and Typescript codebases, we don't use TypeORM's decorators (since they don't transpile nicely into readable Javascript). TypeORM shines with decorators however, so you might want to use them if you're going to be working in Typescript.

The project also comes with a docker container, to build project using docker:

docker build -t 0x-launch-kit .

You can check that the image was built by running:

docker images

And launch it with

docker run -p 3000:3000 -d 0x-launch-kit

Check that it's working by running

curl http://localhost:3000/v2/asset_pairs