# bTrader
This is an arbitrage trading bot based on this [JS implementation](https://github.com/bmino/binance-triangle-arbitrage). For that reason, the configuration files for both of them are compatible.
For further information on the status of this bot, refer to [Development status](#development-status)
## Steps to run the bot
Two-step process:
1. Read the configuration guide from [here](https://github.com/bmino/binance-triangle-arbitrage/blob/master/config/readme.md). I was lazy to write one of my own, so you can read it from the JS implementation repository. After that, generate your own configuration file or just edit the one on the `config/` directory on this repository.
**Note #1:** Telegram bot is not available on the JS implementation. For that reason, nothing on their original configuration file refers to that. If you plan on using Telegram, please read the [Telegram configuration](#telegram-configuration) section.
**Note #2:** Not all of the variables on their original configuration file are being used. For further information, read the [Config file compatibility](#config-file-compatibility) section.
2. (Recommended) Use the Docker image (`$(pwd)/config.json` is the path to your configuration file):
```
docker run -it --name btrader -v $(pwd)/config.json:/config.json gabrielmilan/btrader
```
2. (Few more steps) Use the Python package:
```
python3 -m pip install btrader
python3
>>>> from btrader import bTrader
>>>> bot = bTrader("config.json")
>>>> bot.run()
```
## Development status
- [x] C++ implementation of calculations
- [x] Monitoring websockets
- [x] Computing profits over all possible triangles
- [x] Filtering and showing viable operations
- [x] Implement asset step size
- [x] Structure for holding trading actions and quantities
- [x] Perform trading actions
- [ ] Checking configuration file
- [ ] Compatibility for LOG.LEVEL
- [ ] Compatibility for TRADING.EXECUTION_STRATEGY and TRADING.EXECUTION_TEMPLATE
- [ ] Best deals printing
- [x] Telegram bot
- [ ] Generate binary distributions
## Config file compatibility
- [x] KEYS
- [x] INVESTMENT
- [x] TRADING [ENABLED, EXECUTION_CAP, TAKER_FEE, PROFIT_THRESHOLD, AGE_THRESHOLD]
- [ ] TRADING [EXECUTION_STRATEGY, EXECUTION_TEMPLATE]
- [ ] HUD
- [ ] LOG
- [x] DEPTH [SIZE]
- [ ] DEPTH [PRUNE, INITIALIZATION_INTERVAL]
- [ ] TIMING
## Telegram configuration
- Generate a bot token with BotFather (official tutorial [here](https://core.telegram.org/bots#6-botfather))
- (Optional) Get your Telegram user ID with the @userinfobot
- Fill the configuration file with your data
- Send `/start` to your bot on Telegram so it can identify you as the main user (by doing this or configuring user ID on the config file, the bot will only respond to you)
- Bot will notify you about executed trades or discovered deals, according to your config file
- You can check the average/std/best age of deals by sending `/age`
