Awesome

Scroller bittrex websocket nodejs

version: 0.0.3

Bittrex websocket scroller with docker container and Ansible script to deploy. This scroller is developped with a nodejs application and a mysql container to embeded the storage system. All script to manage or deploy the platform are using

Ansible.

Feel free to improve it or submit your ideas to improve it.

Summary:

• Introduction
• Install
• Start
• Utils
• Deploy on server
• References

Introduction

All of these requirements are needed for a local usage.

Requirements:

• Python3
• Docker
• Docker-compose
• Docker network

For a server deployment you also need Ansible to be installed and remote hosts available to be managed by Ansible.

Server Deployment Requirements:

• Ansible
• Remote available for ansible managing

The server deployment install packages, a list of these packages is available: here

Install

First at all you must install the scroller configuration. The scroller configuration is a list of cryptocurrency markets store in config.yml.

To generate the config file (use python3 script):

# with make
make install

# if you have any failed with make it's probably because of the python location,
# run the python script manually or make the python3 binary works with
# the command `python3 --version`

python3 config/set_markets_configuration/getMarket.py

If this command failed because of missing python3 yaml package install it and retry.

The python script provide the Bittrex python api wrapper but feel free to stars the repository.

That will get all available market from Bittrex broker and set into config.yml, You must now set which markets your scroller's will get.

open config.yml:

target_base_currency_market:
- USDT
baseCurrency:
- BTC
- USDT
- ETH
BTC:
- BTC-LTC
- BTC-DOGE
- BTC-VTC
...

Add these lines 'target_base_currency_market' at the top of your file, target_base_currency_market will be use to chose which market ticker will be insert into the database.

In the case above, I want my scroller target all market with base currency 'USDT'.

Create a docker network for your scroller:

docker network create websocket-scroller;

# verify with :

docker network ls;
NETWORK ID          NAME                               DRIVER              SCOPE
0db2807c2564        websocket-scroller                 bridge              local

Start

For start the scroller you have to:

make

# or

make up

take a look at the Documentation section

Utils

you can extract the data of your scroller by making a dumps. the makefile provide a command for it:

make dumps

then it generate a mysql-dumps on the root directory at backup.sql.

Deploy on servers

The project provide on the server_deploy/ directory a full Ansible script for being able to make a fast deploy on your servers.

little instruction for beginer with ansible

Ansible is a sofware which make the managing of remote server easy, Ansible is an agentless software, that mean you doesn't need something to be installed on the remote host to use it(except a /bin/python).

The install with ansible will be provide by push ssh.

Take a look on the Ansible website and documentation to understand the basic usage of the technologie.

set your host configuration.

You must set where you want to deploy, let's open the server_deploy/inventory file.

It contain a [scroller] section, below this section you can add all remote host you want to provide with the script.

[scroller]
scroller.servera.com
scroller.serverb.com
scroller.serverc.com

You can test if your inventory file can be target by ansible with a ping like :

$ ansible -m ping scroller
scroller.servera.com | FAILED! => {
    "changed": false,
    "module_stderr": "Shared connection to scroller.servera.com closed.\r\n",
    "module_stdout": "/bin/sh: /usr/bin/python: No such file or directory\r\n",
    "msg": "MODULE FAILURE",
    "rc": 0
}
scroller.serverb.com | FAILED! => {
...

If you have the same error you have to install python.

install ansible roles:

ansible-galaxy install geerlingguy.docker

the script use galaxy role from greerlingguy because its use good practice and it's easy to use.

You can found more information about Ansible Galaxy here and the github of geerlingguy here.

Change directory to server_deploy:

cd server_deploy

Next you have to set the location of your bot on your remote hosts:

vi inventory;
...
[scroller:vars]
scroller_path=/path/to/your/bot/tickerBot/

Before runing script you have to know what it does:

1. install docker with the external role from geerlingguy
2. install python3 and python3-pip + upgrade pip
3. clone the platform repository, then make it 2 time one for init mysql, seconde for run bot.

Run script:

ansible-playbook deploy_bot.yml  -K

The option -K is for the packages installation, the script need the root permission to run package manager, so the -K option ask what is the sudo password.(its possible to specifying in the hosts file, take a look at the Ansible documentation)

to get the sql dump you have to connect to your remote hosts to run the command make dumps, then use scp to get it locally.

 scp username@remotehost.com:mydump.sql /some/local/directory 

logs

you can verify your module is up with:

  make ps

for logs:

  # all logs
  make logs

Documentation

Makefile commands available:

Tricks:

Troubles possible:

make logs failed: if the commands failed use the docker-compose command: docker-compose logs -f

Reference

• Mysql compose hub
• Mysql documentation
• Docker website
• Docker-compose documentation
• Git documentation
• Docker network documentation

Ansible install packages

• docker
• docker-compose
• websocket-scroller (by github clonging)

version