Guide | API Docs | Consulting | Community

OpenDAX Trading Platform

OpenDAX

OpenDAX is an open-source cloud-native multi-service platform for building a Blockchain/FinTech exchange of digital assets, cryptocurrency and security tokens.

Getting started with OpenDAX

1. Get a VM

Minimum VM requirements for OpenDAX: * 8GB of RAM (12GB recommended) * 4 cores vCPU (6 cores recommended) * 300GB disk space (SSD recommended)

A VM from any cloud provider like DigitalOcean, Vultr, GCP, AWS as well as any dedicated server with Ubuntu, Debian or Centos would work

2. Prepare the VM

2.1 Create Unix user

SSH using root user, then create new user for the application

bash
useradd -g users -s `which bash` -m app

2.2 Install Docker and docker compose

We highly recommend using docker and compose from docker.com install guide instead of the system provided package, which would most likely be deprecated.

Docker follow instruction here: docker Docker compose follow steps: docker compose

2.3 Install ruby in user app

2.3.1 Change user using

su - app

2.3.2 Clone OpenDAX

git clone https://github.com/openware/opendax.git

2.3.3 Install RVM

gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
curl -sSL https://get.rvm.io | bash -s stable
cd opendax
rvm install .

3. Bundle install dependencies

bundle install
rake -T # To see if ruby and lib works

Using

rake -T

lib/tasks

4. Run everything

4.1 Configure your domain

If using a VM you can point your domain name to the VM ip address before this stage. Recommended if you enabled SSL, for local development edit the

/etc/hosts

Insert in file

/etc/hosts

0.0.0.0 www.app.local

4.2 Render all config files

Simply run

rake render:config

4.3 Set up Vault

Note: Everything is persisted on the local filesystem, thus API keys and 2FA tokens are preserved between restarts. However, Vault needs to be unsealed after every stop/restart.

To set up Vault, go through the following steps: -

docker-compose up -d vault

docker-compose exec vault sh

vault operator init

vault operator unseal *unseal_key*

vault login *root_token*

vault secrets enable totp

vault secrets enable transit

vault secrets disable secret

vault secrets enable -path=secret -version=1 kv

Add the Vault root token to

config/app.yml

app

4.4 Bring everything up

rake service:all

You can login on

www.app.local

Seeded users:
Email: [email protected], password: [email protected]
Email: [email protected], password: Am8icnzEI3d!

[Optional] KYCAID

In order to accelerate customer interaction, reduce risks and simplify business processes you can use KYC Verification Service from KYCaid. KYC goal is to prevent fraud and to decline users that don’t fulfill certain standards of credibility. To learn more about KYCaid and pricing you can visit their website - kycaid.com

How to configure KYCAID on the platform?

KYCAID is already integrated into our stack, to use it you'd need to create an account on kycaid.com, and set up authentification creds there.

After that all you have to do is to change several lines in

config/app.yml

kyc:
  provider: kycaid
  authorization_token: changeme             # your production API token from the 'Settings' section of kycaid.com
  sandbox_mode: true                        # 'true' for test environments - documents will be verified/rejected automatically, without payment for verification
  api_endpoint: https://api.kycaid.com/

Additional settings for KYCAID

• Be sure to check

  BARONG_REQUIRED_DOCS_EXPIRE

  ENV value inside

  config/barong.env

  to be

  false

  if you want to include

  address

  verification in your KYC process. You can set it to

  true

  if you need the document check only.
• Check if you have the correct list of

  document_types

  in the

  config/barong/barong.yml

  file:
  • Passport
  • Identity card
  • Driver license
  • Address
• Frontend KYC steps can be configured in

  templates/config/frontend/env.js.erb

  via the

  kycSteps

  field
• Tower KYC labels can be configured in

  templates/config/frontend/tower.js.erb

  via the

  labelSwitcher

  field

Usage

Initial configuration

All the OpenDAX deployment files have their confguration stored in

config/app.yml

app.yml

The following table lists the configurable parameters of the config/app.yml configuration file and its default values.

app.name

"OpenDax"

app.domain

app.local

subdomain

www

render_protect

false

csrfEnabled

false

ssl.enabled

false

ssl.email

"[email protected]"

images

vendor.frontend

[email protected]:openware/baseapp.git

kyc.provider

kycaid

local

kycaid

kyc.authorization_token

changeme

kyc.sandbox

true

kyc.api_endpoint

https://api.kycaid.com/

vault.token

changeme

database.host

db

database.port

3306

database.user

root

database.password

changeme

storage.provider

"Google"

storage.bucketname

"opendax-barong-docs-bucket"

storage.endpoint

"https://fra1.digitaloceanspaces.com"

storage.region

"fra1"

storage.signatureVersion

"fra1"

storage.secretkey

storage.accesskey

"changeme"

twilio

gaTrackerKey

smtp

captcha

wallets

parity

bitcoind

litecoind

terraform.credentials

"~/safe/opendax.json"

terraform.project

"example-opendax"

utils.yml

The following table lists configurable parameters of the

config/utils.yml

Once you're done with the configuration, render the files using

rake render:config

Note: be sure to append all the subdomains based on app.domain to your
/etc/hosts file if you're running OpenDax locally

Bringing up the stack

The OpenDAX stack can be brought up using two ways:

1. Bootstrap all the components at once using

   rake service:all[start]

2. Start every component one-by-one using

   rake service:*component*[start]

The components included in the stack are:

• proxy

  - Traefik, a robust cloud-native edge router/reverse proxy written in Go

• backend

  - Vault, MySQL, Redis and RabbitMQ grouped together

• cryptonodes

  - cryptocurrency nodes such as parity [Optional]

• daemons

  - Peatio and Ranger daemons [Optional]

• setup

  - setup hooks for Peatio and Barong to run before the application starts (DB migration etc.)

• app

  - Peatio is the crypto exchange software, Barong and the Ambassador API gateway

• frontend

  - the frontend application located at

  vendor/frontend

• tower

  - the Tower admin panel application located at

  vendor/tower

• monitoring

  - cAdvisor and Node Exporter monitoring tools [Optional]

For example, to start the

backend

rake service:backend[start]

Note: all the components marked as [Optional] need to be installed using
rake service:*component*[start] explicitly

Go ahead and try your own OpenDAX exchange deployment!

Stopping and restarting components

Any component from the stack can be easily stopped or restarted using

rake service:*component*[stop]

rake service:*component*[restart]

For example,

rake service:frontend[stop]

rake service:proxy[restart]

Managing component deployments

Each component has a config file (ex.

config/frontend/tower.js

compose/frontend.yaml

All config files are mounted into respective component container, except from

config/app.yml

Compose files contain component images, environment configuration etc.

These files get rendered from their respective templates that are located under

templates

How to update component image?

Modify

config/app.yml

rake service:all

templates

Alternitavely you can update the following files: *

config/app.yml

templates/compose/*component*.yml

compose/*component*.yml

rake service:component[start]

How to update component config?

Modify

config/*component*/*config*

rake service:component[start]

templates/config/*components*/*config*

Render compose file

# Delete all generated files
git clean -fdx

Re-generate config from config/app.yml values
rake render:config
Restart the container you need to reload config
docker-compose up frontend -Vd

Clone the vendors and start

source ./bin/set-env.sh
rake vendor:clone
docker-compose -f compose/vendor.yaml up -d

Terraform Infrastructure as Code Provisioning

You can easily deploy OpenDAX from scratch on Google Cloud Platform using Terraform!

To do this, just follow these simple steps: - Fill

app.yml

rake terraform:apply

To destroy the provisioned infrastructure, just run

rake terraform:destroy

Installer tool

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/openware/opendax/master/bin/install)"

Happy trading with OpenDAX!

If you have any comments, feedback and suggestions, we are happy to hear from you here at GitHub or here: crypto exchange software