Skip to content

Latest commit

 

History

History
451 lines (285 loc) · 24.2 KB

README.md

File metadata and controls

451 lines (285 loc) · 24.2 KB
Raw

self reminder:
patience is the mother of science


*** REFUGEES WELCOME! ***
     *** FATAL ROUTES? ***

Release Platform g0t0 Counter Code Size Software License Software License

K is a family of (very customizable) very low latency market making trading bots with a fully featured web interface.
It can place and cancel orders on one of the several compatible exchanges in less than a few milliseconds per order on a decent machine.

If you don't want to configure or hardcode your own trading strategies in your own machine,
you can run strategies from someone else at kryll.io (or at any other trading community out there).

If you don't want to run a bot at all,
you can fund liquidity pools at tinyman.org (or at any other defi out there).

Latest version at https://github.com/ctubio/Krypto-trading-bot

Build Status Coverage Status Quality Status Open Issues Last Commit Downloads Last Releases

Our bots run on unix-like systems. Persistence is achieved through a built-in server-less SQLite C++ interface.
Data transfers are directly done from your machine to the exchange using the latest CURL and OpenSSL versions.
Installation in a dedicated Debian, Raspberry, Red Hat, CentOS or macOS instance without Docker is recommended.

Web UI Preview

The web UI is compatible with most web browsers/resolutions, but Brave or Firefox at 1600px are recommended. Doesn't require configuration of any web server (unless installed behind your own reverse proxy).

Compatible Exchanges

with Post-Only Orders support without Post-Only
with Maker and Taker fees Coinbase (fees)
⟿ REST + WebSocket + FIX

Binance (fees)
⟿ REST + WebSocket

Kraken (fees)
⟿ REST + WebSocket²

KuCoin (fees)
⟿ REST + WebSocket

Bitfinex (fees)
Ethfinex (fees)
⟿ REST + WebSocket

Gate.io (fees)
⟿ REST + WebSocket

HitBTC (fees)
Bequant (fees)
⟿ REST + WebSocket²

Poloniex (fees)
⟿ REST + WebSocket		 none
without Maker fees BitMEX (fees)
⟿ REST + WebSocket		 none

All currency pairs are supported (use --list argument to see all currently tradable pairs on a given exchange).

README

Docker Installation

See etc/Dockerfile file.

Windows Installation

Before starting with a manual installation, ensure your target machine has Windows 7 or greater and MSYS2 installed.

Use MSYS2 Terminal to install make (with command pacman -S make), and then proceed as usual with the installation.

Manual GIT Installation

  1. Ensure you agree to install collaborative non-free software (see Unlock section).

  2. Ensure your target machine has git and make installed.

  3. Download it wherever you want (feel free to customize the suggested folder name K) and execute the installer:

 $ git clone ssh://[email protected]/ctubio/Krypto-trading-bot K
 $ cd K
 $ make install
  1. Open and edit the config file K.sh in your favorite text editor:
 $ vim K.sh

To upgrade anytime see Upgrade to the latest commit section.

Manual ZIP Installation

  1. Ensure you agree to install collaborative non-free software (see Unlock section).

  2. Ensure your target machine has curl and make installed.

  3. Download it wherever you want (feel free to customize the suggested folder name K) and execute the installer:

 $ mkdir K
 $ cd K
 $ curl -O krypto.ninja/Makefile
 $ make install
  1. Open and edit the config file K.sh in your favorite text editor:
 $ vim K.sh

To upgrade anytime to the latest release just run make reinstall.

Configuration After Manual Installation

See etc/K.sh.dist file or better your own copy of K.sh file located in the top level path.

It just contains a few variables with examples. The very end of the file contains the code that starts the bot.

Once your config file is ready, you can execute it to start the bot:

 $ ./K.sh

Alternatively use make start to run K.sh in the background using screen (to see the output, attach the screen with make screen [or run all at once with make start screen]).

Feel free to run make stop or make restart anytime, and don't forget to read the fucking manual.

Troubleshooting:

  • If there is no wallet data on a given exchange, double-check the currency symbols with --list argument.

Optional:

  • See at least once ./K.sh --help to trade or make help to develop.

  • Use your own HTTP Basic Authentication credentials with --user and --pass arguments.

  • Use your own SSL certificate with --ssl-crt and --ssl-key arguments.
    Otherwise, the insecure built-in certificate is fully featured, but you may need to authorise it in your browser.
    If you want to generate your own certificate see SSL for internal usage.
    In case you really want to use plain HTTP, use --without-ssl argument.

Upgrade to the latest commit

If you upgrade while having any instance running in the background, you will need to manually restart it using make restart or make restartall to start using the latest version.

Upgrade under Manual ZIP Installation:

Please run make reinstall to download the upgraded source and executable files.

Upgrade under Manual GIT Installation:

Feel free anytime to check if there are new upgrades with make diff.

Once you decide that it is time to upgrade, execute make upgrade (or directly make reinstall to skip the validation of new commits).

If you only use git to pull the latest source files from the remote branch, you will still need to upgrade or recompile your executable files.

To not upgrade but instead recompile your own modified source files, use make lib K or just make (see Build notes).

Multiple instances party time

Please note, an "instance" is in fact a *.sh config file; using a single machine with a single installation, you can run as many instances as *.sh files you have (limited by the available free RAM).

You can list the current running instances with make list.

If you haven't defined a config file, make start, make screen, make stop and make restart will use the default config file K.sh.

To run multiple instances using a collection of config files:

  1. Create a new config file with cp etc/K.sh.dist X.sh && chmod +x X.sh (use X.sh or any name but keep .sh extension).

  2. Edit the new config file vim X.sh

  3. Run the new instance with ./X.sh or to run in the background, use K=X.sh make start. To attach to the new instance's screen, use K=X.sh make screen. To stop the new instance, use K=X.sh make stop and to restart it, use K=X.sh make restart. The environment variable K specifies the filename of the config file that you want to use.

  4. Open in the web browser the different pages of the ports of the different running instances, or display the UI of all instances together in a single page using the MATRYOSHKA link in the footer (that can be predefined using the optional argument --matryoshka=URL).

After multiple config files are setup, to control them all together instead of one by one, the commands make startall, make stopall and make restartall are also available, just remember that config files with a filename starting with underscore symbol "_" will be skipped.

Application Usage

  1. Open your web browser to connect to port 3000 (or your configured port number) of the machine running K. Using localhost or one of the public or private IPs of your machine (if you're running on Docker, use the IP address returned by boot2docker ip).

  2. Read up on how to use K and market making in the manual.

  3. Use the web UI to change the quoting parameters. Click the big "BTC/USD" button to start making markets. Click it again to stop. When the button is green, the bot is actively placing orders.

Web UI

Once K is up and running, visit port 3000 (or your configured port number) to access the UI (i.e. https://localhost:3000). There are inputs for quoting parameters, grids to display market orders, market trades, your trades, your order history, your positions, and a big button with the currency pair you are trading. When you're ready, click that button green to begin sending out quotes. The UI uses angularjs hydrated with websockets observed with reactivexjs.

Databases

Each currency pair of each exchange will use a different sqlite database file with WAL mode enabled.

All database files are located at /var/lib/K/db/K-*.db*, outside the download folder to survive wild rm -rf path/to/K or reinstalls.

You can copy any group of *.db* files to another machine when migrating or as a backup.

If a database does not exist, the application will create it on boot; otherwise, it will use the existing one.

To explore each database you can use https://github.com/sqlitebrowser/sqlitebrowser or a similar tool.

To set a different database filename or to set an in-memory database, use --database=FILE argument (see --help).

Even if using an in-memory database, the quoting parameters are always loaded from and saved into the file database.

Charts

The metrics are not saved anywhere, it is just UI data collected with a visibility retention of n hours (where n is the value of profit quoting parameter), to display over time:

  • Market Fair Value with High and Low Prices
  • Trades Complete
  • Target Position for BTC currency (TBP)
  • Target Position for Fiat currency
  • STDEV and EWMA values for Quote Protection and APR
  • Amount available in wallet for buy
  • Amount held in open trades for buy
  • Amount available in wallet for sell
  • Amount held in open trades for sell
  • Total amount available and held at both sides in BTC currency
  • Total amount available and held at both sides in Fiat currency

Cloud Hosting

If you ask me, is a very nice web hosting company (awesome support team, awesome servers). Feel free to use this referral link to get a discount subtracted from my referral earnings (i'm a user since 2008).

Build notes

Make sure your build machine has node installed, also ensure make lib provides all dependencies without errors.

To rebuild the application, see make help and choose a target (just make may be what you are looking for).

Test units are executed before the application exits, only if the application was compiled with KUNITS=1 make.

Otherwise, just make without the environment var KUNITS produces an application that simply exits on exit.

A quick test runner therefore is ./K.sh --version or the alias make test or all at once with KUNITS=1 make K test.

To pipe the output to stdout, execute the application in the foreground with --naked argument.

For more information consider to follow the white rabbit, but its dangerous to go alone, take this:

c sandbox: wandbox.org

js sandbox: jsfiddle.net

ws sandbox: app.gosandy.io

Release v0.6.x Changelog

Added Hello World bot, Portfolios bot, Scaling bot and Stable bot.

Added Binance, Kraken, KuCoin, Gate.io and BitMEX API.

Release v0.5.x Changelog

Updated exchange integrations as simple libcurl wrappers.

Release v0.4.x Changelog

Added main KryptoNinja class derived from all other classes and ready to be extended.

Added C++ OOP everywhere.

Added test units.

Added --interface=IP argument to bind outgoing traffic to a specific network interface.

Added Ethfinex and FCoin API.

Added build-in document root to stop reading files from disk.

Added build chain for win32.

Updated OKEx websocket to binary data.

Added build chain for OSX v10.13.

Release v0.3.x Changelog

Updated HitBTC API v2.

Added ZIP installation steps for non-git-lovers.

Added HamelinRat quoting mode and Trend safety thanks to b-seite and serzhiio contributions.

Added command-line arguments.

Updated quoting engine and gateways without nodejs.

Added Makefile to replace npm scripts.

Added PNG files as configuration files.

Added built-in C++ WWW Server to replace expressjs and socketio.

Added built-in SQLite C++ interface to replace external mongodb server.

Added Poloniex API.

Release v0.2.x Changelog

Updated application name to K because of Kira.

Added nodejs7, typescript2, angular4 and reactivexjs.

Added cleanup of bandwidth, source code, dependencies and installation steps.

Added many quoting parameters thanks to Camille92 genius suggestions.

Added support for multiple instances/config files with nested matryoshka UI.

Added npm scripts, david-dm, travis-ci, coveralls and codacy.

Added historical charts to replace grafana.

Added C++ math functions.

Updated OKCoin API (since https://www.okcoin.com/t-354.html).

Updated Bitfinex API v2.

Added Coinbase FIX API.

Added Korbit API.

Added new quoting styles PingPong, Boomerang, AK-47.

Added cleanup of database records, memory usage and log recording.

Added audio notices, realtime wallet display, and grafana integration.

Added https, dark theme and new UI elements.

Added a bit of love to Kira.

Release v0.1.0 Changelog

see the upstream project michaelgrosner/tribeca.

Unlock

The bot is unlocked for collaborators and contributors (feel free to make acceptable Pull Requests for already opened issues or for anything you consider useful, and let me know the BTC Payment Address for the bot that you wish to unlock in the description of the PR, and I will credit it for you).

While locked, the orderbook will be in realtime 121 seconds, and later it will be updated only once every 121 seconds.

Anonymous users can also unlock any API Key by paying 0.00121000 BTC to the address displayed on exit.

Once unlocked you may use different bots or currency pairs or reinstall on a different machine with the same unlocked API Key. However, if you want to use more than one exchange, you will need to pay again to unlock the API Key for each exchange.

Otherwise if you choose to not support further development by ctubio, just keep running some old commit and do not upgrade (any commit prior to v0.3.0 was completely unlocked).

Please don't open issues asking how much % less the bot generates with --free-version; it is relative to your trading strategy, the market conditions, and the bot's performance.

Donations

nope, this project doesn't have maintenance costs. but you can donate to your favorite developer today!
(or tomorrow!)

or see the upstream project michaelgrosner/tribeca.

or donate your time with programming or financial suggestions in the IRC channel #krypto.ninja at irc.libera.chat on port 6697 (SSL), or 6667 (plain); or feel free to make any question, but questions technically are not donations.

General Discussion

IRC is awesome!

but if you dislike it, consider to create a new discussion permanently readable by everybody.

Very Special Thanks to:

Help

If you need installation or usage support, please create a new discussion.

Issues

To request new features open a new issue and explain your improvement as you consider.

To report errors open a new issue only after collecting all possible relevant log messages.

Pull Requests are welcome, but adhere to the Contributor License Agreement:

  • Your biological and technological distinctiveness will be added to our own. Resistance is futile.

like yesterday, since 0day and ∞

bcn

every new day we sing:

If love is so nice, tell me why are you so sad?
If love is so nice, tell me, oh tell me why are you hurt so bad?
One Love! get ready!

Now feel this drumbeat as it beats within,
playin' a riddim, resisting against the system:



We have already enough policemen,
if you like adventures choose to be a brave firefighter.








Violence should not be the answer to those who
are asking for freedom.













+ 99999