\n\nThis app monitors the [Binance](https://www.binance.com) cryptocurrency exchange in search of triangle arbitrage opportunities.\n\n## The HUD\nThe HUD is the chart displayed above. It is repainted after each calculation cycle to show snapshots of currently detected\narbitrage opportunities. To disable the HUD, set `HUD.ENABLED` to false.\n\n\n### Reading the HUD\n* **Trade** - Three symbols related by exchange rates that are involved in the triangle arbitrage.\n* **Profit** - Percent profit or loss from executing the triangle arbitrage. This includes trading fees specified via `TRADING.TAKER_FEE` config.\n* **AB Age** - Time in seconds since the most recent update of the market ticker relating the first and second symbols in the arbitrage.\n* **BC Age** - Time in seconds since the most recent update of the market ticker relating the second and third symbols in the arbitrage.\n* **CA Age** - Time in seconds since the most recent update of the market ticker relating the third and first symbols in the arbitrage.\n* **Age** - Time in seconds since the least recently updated market ticker involved in the triangle arbitrage.\n\n\n## Getting Started\nThese instructions will get a copy of the project up and running on your local machine for development and testing purposes.\n\n\n### Install Prerequisites\nThe following dependencies are recommended to run an instance:\n\n1. **NodeJS** - 11.10.0\n2. **Npm** - 6.10.0\n\n\n### Obtain the Codebase\n* Clone from github\n ```\n git clone https://github.com/bmino/binance-triangle-arbitrage.git\n ```\n* Download a zip of the [latest release](https://github.com/bmino/binance-triangle-arbitrage/releases/latest)\n\n\n### Configuration\nAll configuration is done inside the `/config` directory.\nTo setup your configuration for the first time, duplicate the `config.json.example` file and remove the \".example\" extension.\nThis process must be done before deploying the app for the first time and redone after each major version update where the configuration has changed.\nExplanations of each value can be found [here](config/readme.md).\n\n### Assumptions\n1. All fees are [paid via BNB balance](https://binance.zendesk.com/hc/en-us/articles/115000583311)\n2. Sufficient quantity of BNB is maintained during the runtime of the bot\n\n### Deployment\n1. Install project dependencies\n ```\n cd binance-triangle-arbitrage\n npm install\n ```\n\n2. Start the application\n ```\n npm start\n ```\n\n\n## Execution strategies\nThere are two supported methods of executing an identified triangle arbitrage opportunity. More details [here](src/resources/docs/strategies.md)\n\n* **Linear** - Three trades are executed sequentially with each being initiated after the previous has completed\n* **Parallel** - Three trades are executed asynchronously with each being initiated at the same time\n\n\n## Logging\nAll logs are stored in the `/logs` directory. The log level is set via the `LOG.LEVEL` configuration property.\n\n* **performance.log** - Data about performance and speed\n* **execution.log** - Market interactions and profits\n\n\n## Authors\n* **[Brandon Mino](https://github.com/bmino)** - *Project Lead*\n\nSee also the list of [contributors](https://github.com/bmino/binance-triangle-arbitrage/contributors) who participated in this project.\n\n\n## Donations\nThe developers listed above created and currently maintain this project for free.\nI don't expect any compensation nor donations, but if you appreciate my work feel free to donate to the following addresses:\n\n* Bitcoin (BTC): 1KLBb9qzFN19RxaQwD35CQmnYZvW1819XZ\n* Binance Coin (BNB): 0xb046b6991eb1bdc838cae567cff838b542e9f19d\n\n\n## License\nThis project is licensed under mit\n\n","readmeFilename":"readme.md"}
![](\"https://github.com/bmino/binance-triangle-arbitrage/blob/master/src/resources/mainDisplay.png\")