暗号通貨高頻度取引bot用websocketベースフレームワーク

概要

Pythonによる暗号通貨の高頻度取引bot向けフレームワークです。
このフレームワークの役割は主に以下の３つです。

websocketを最大限利用することでAPI制限とデータ取得遅延の問題を緩和すること。
取引所毎のwebsocketの仕様の差異を吸収すること。
Bot開発において頻繁に出現する処理を再利用可能な形でモジュール化すること。

現状、bitflyerのwebsocketと注文周りの実装のみほぼ完了しています。
簡単な動作確認しかできていないので、まだバグが多く残っているものと思われます。
コードを参考にする程度に留めるか、実行する際はご自身で十分に検証を行ってください。
どうしても発注を行いたい場合、証拠金を十分に減らした上で'FX_BTC_JPY'をご利用ください。
その他の商品については全く確認ができていないので、デバッグ以外の目的で実行しないでください。
プログラムの実行はあくまで自己責任です。不具合等によって損失が生じた場合でもこちらでは責任を負えません。

主な機能

websocket経由の約定データ、板情報、注文イベントの取得
通常の注文・web注文
注文イベントの処理: 注文の状態管理、ポジションサイズの計算、(未確定)損益計算
ポジションの仮想的な分割（複数ロジックの実行）
ファイルの暗号化・復号化（アカウント情報等を平文で置いておきたくない人用）
UDP経由の操作（webインターフェース等との連携）
クラス（ロジックファイル）の動的なロード・アンロード [現在調整中]

動作環境

UNIX互換環境(Windowsは未検証)
python>=3.6

依存ライブラリ

ccxt
websocket-client>=0.48
sortedcontainers
pycrypto (オプション) – アカウント情報ファイル等の暗号化・復号化
requests (オプション) – bitflyer web注文
beautifulsoup4 (オプション) – bitflyer web注文

インストール

別のプロジェクトからモジュールを読み込みたい場合、方法２か方法３を利用してください。

方法1: そもそもインストールしない

プロジェクト内に直接コードを書いて、プロジェクトルートからモジュールとして実行する場合は
特にインストール作業は必要ありません。
例えば、samples/bitflyer/orderbook.pyなら以下のように実行できます。

$ python3 -m samples.bitflyer.orderbook

方法2: PYTHONPATHにプロジェクトディレクトリを追加

使用しているシェルの設定ファイル(.bashrc, .zshrc等)にPYTHONPATHを追加します。
正しい作法ですが、IDEによってはlinterのエラーがでたり、自動補完が効かなかったりします

export PYTHONPATH="/path/to/btc_bot_framework:$PYTHONPATH"

方法3: パスの通った場所にシンボリックリンクを貼る(おすすめ)

少し行儀の悪い方法ですが、一番トラブルの少ない方法です。たぶん。

パスの通っている場所を調べる。

$ python3 -c 'import sys; print(sys.path)'
['', '/usr/lib/python38.zip', '/usr/lib/python3.8', '/usr/lib/python3.8/lib-dynload',
 '/home/sk/.local/lib/python3.8/site-packages', '/usr/lib/python3.8/site-packages']

どこでも良いので（できれば管理者権限の必要ないディレクトリ）にbotfwのシンボリックリンクを作成。

$ cd /home/sk/.local/lib/python3.8/site-packages  # pip install --user で使われるディレクトリ
$ ln -s /path/to/btc_bot_framework/botfw botfw

使い方

TODO
samples内のファイルを参照してください。

samples/bitflyer/simple_example_bot.py 簡単なbotの実装例。あくまで使い方を確認する用。
samples/bitlyfer/trade.py 約定データを取得して表示します。
samples/bitflyer/orderbook.py 板情報を取得して表示します。

trade及びorderbookの利用方法はtest_trade()とtest_orderbook()を参照してください。それぞれ 'botfw/base/trade.py' と 'botfw/base/orderbook.py' 内にあります。

プロジェクト構成

TODO

bin – 実行ファイル
botfw – フレームワーク本体: 取引所共通部分のディレクトリ(base)、取引所毎のディレクトリ(bitflyer, bitmex, ...)、etc
samples – 実行可能なサンプルプログラム
test – TODO

コーディングのスタイルとポリシー

多少コードが冗長になる場合でも、基本的には設計上の正しさを優先します。
フレームワーク部分（botfw）については以下の規則を適用します。
- pep8（flake8）に準拠。ただし__init__.pyは例外
- コメントを含めて英語(askiiコードのみ)で記述。それ以外のsampleやgitログ等は自由。
メソッド名や引数の変数名とその順序、また定数変数（全部大文字の変数）の内部値は可能な限りccxtと揃えます。
- 注意: 例えば、bitflyerのsideは'BUY'または'SELL'ですが、この規則により'buy', 'sell'とします。
- 取引所固有の変数名についてはその取引所の公式リファレンスに準拠します。
メソッド名の英単語は省略しませんが、変数名、及び引数名は意味の分かる範囲内で自由に省略します。

今後の予定

ポジションずれの自動修正オプションの実装
取引所の追加: bitmex（優先）、binance、liquid
サンプルロジックの追加（SFDbotを検討中）
その他諸々。

お願い

一人で色々考えて作るのは結構大変なので、コミッターやデバッガー、改善案を出してくれる人を募集しています。
OSSなので成果に対して報酬を出すことはできませんが、それでも良いという方は是非よろしくお願いします。

aliyome / btc_bot_framework