Skip to content
master
Go to file
Code
This branch is 2187 commits ahead of xeroc:master.

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
May 21, 2019
Apr 13, 2018

README.md

DEXBot

Build Status (master) Documentation Status

Download the latest release for Windows, OSX and Linux from here!

The Dashboard of the GUI version of DEXBot: GUI

The CLI version of DEXBot in configuration dialog: CLI

A Trading Bot provided with two very flexible Market Making strategies. Works on "vanilla" BitShares and all exchanges built upon it. Can be customized with additional strategies written in Python3.

DEXBot was paid for by the BitShares blockchain (by means of a Worker Proposal), and managed by "The Cabinet", consisting of 6 active BitShares community members. All spending was controlled by an account which requires 3/5 approvals (multisig scheme).

DEXBot can be installed from source or by using the excecutable packages for Windows, OSX, and Linux. Packages include the GUI version, but installation from source provides also the CLI version, which can be used on headless servers and Raspberry Pi's.

The provided strategies can be used to bootstrap new markets, to increase liquidity of an asset, or to try to make profits. The Relative Orders strategy is the one most think of when speaking of Market Making. In most markets it requires tweaking and active monitoring, and is most suitable for sideways markets or Arbitrage Enabling markets (between stable or otherwise equivalent assets). Staggered Orders is a "set and forget" strategy, which thrives in uncertain conditions (before price discovery or otherwise volatile conditions). It requires a long time to realize profits, but is likely to do so if it isn't touched in the mean time. It requires little monitoring and no tweaking. New markets and assets should be bootstrapped with Staggered Orders and later improved with Relative Orders.

Make sure to read strategy documentation from the wiki. Here is a step-by-step guide to get started

Does it make profit?

If you properly predict future market conditions, you can manage to make profit. All strategies rely on assumptions. The strategies that rely on less assumptions are less risky, and more risky strategies can make more profit. During long declines the effect is decreased losses - not actual profits. So we can only say that it can make profit, without forgetting that it can also make losses. Good luck.

Installing and running the software

See instructions in the Wiki for Linux, Windows, OSX. Raspberry Pi. Other users can try downloading the package or following the Linux guide.

Warning: This is highly experimental code! Use at your OWN risk!

Running in docker

By default, local data is stored inside docker volumes. To avoid loosing configs and data, it's advised to mount custom directories inside the container as shown below.

mkdir dexbot-data dexbot-config
docker run -it --rm -v `pwd`/dexbot-data:/home/dexbot/.local/share dexbot/dexbot:latest uptick addkey
docker run -it --rm -v `pwd`/dexbot-config:/home/dexbot/.config/dexbot -v `pwd`/dexbot-data:/home/dexbot/.local/share dexbot/dexbot:latest dexbot-cli configure

To run in unattended mode you need to provide wallet passphrase:

docker run -d --name dexbot -e UNLOCK=pass -v `pwd`/dexbot-config:/home/dexbot/.config/dexbot -v `pwd`/dexbot-data:/home/dexbot/.local/share dexbot/dexbot:latest dexbot-cli run

Assuming you have created a Docker secret named "passphrase" in your swarm, you can also get it from there:

printf <pass> | docker secret create passphrase -
docker run -d --name dexbot -e UNLOCK=/run/secrets/passphrase -v `pwd`/dexbot-config:/home/dexbot/.config/dexbot -v `pwd`/dexbot-data:/home/dexbot/.local/share dexbot/dexbot:latest dexbot-cli run

Getting help

Join the Telegram Chat for DEXBot.

Contributing

Install the software, use it and report any problems by creating a ticket.

Before commiting any changes first time, make sure to install pre-commit hooks!

pip install -r requirements-dev.txt
pre-commit install

IMPORTANT NOTE

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

About

Trading Bot for the BitShares Decentralized Exchange

Topics

Resources

License

Languages

You can’t perform that action at this time.