Merge branch 'main' into 47-cleanup-of-unused-top-level-files

CHANGELOG.md

@@ -2,9 +2,22 @@
 
 ## [Unreleased](https://github.com/bancorprotocol/fastlane-bot/tree/HEAD)
 
-[Full Changelog](https://github.com/bancorprotocol/fastlane-bot/compare/v2.7.0...HEAD)
+[Full Changelog](https://github.com/bancorprotocol/fastlane-bot/compare/v2.7.1...HEAD)
 
 - Change automation to increment patch version instead of minor version. [\#53](https://github.com/bancorprotocol/fastlane-bot/issues/53)
+
+Closed issues
+
+- Update README with Brownie and pyyaml Install Troubleshoot [\#31](https://github.com/bancorprotocol/fastlane-bot/issues/31)
+
+Merged pull requests
+
+- Adds additional installation instructions for apple-silicon users. [\#52](https://github.com/bancorprotocol/fastlane-bot/pull/52) ([mikewcasale](https://github.com/mikewcasale))
+
+## [v2.7.1](https://github.com/bancorprotocol/fastlane-bot/tree/v2.7.1) (2023-08-06)
+
+[Full Changelog](https://github.com/bancorprotocol/fastlane-bot/compare/v2.7.0...v2.7.1)
+
 - Change automation to increment patch version instead of minor. [\#54](https://github.com/bancorprotocol/fastlane-bot/pull/54) ([mikewcasale](https://github.com/mikewcasale))
 
 ## [v2.7.0](https://github.com/bancorprotocol/fastlane-bot/tree/v2.7.0) (2023-08-02)

README.md

@@ -18,19 +18,53 @@ Permanent URL for this repository: [github.com/bancorprotocol/fastlane-bot][repo
 
 Install Fastlane Arbitrage Bot from PyPi using the following command:
 
+Clone the repo from Bancor's GitHub and install:
+
+```bash
+git clone https://github.com/bancorprotocol/fastlane-bot
+cd fastlane-bot
+pip install -r requirements.txt
+python setup.py install
+```
+
+Here are the added instructions for Mac users with an Apple Silicon chip:
+
+### Installation for Mac users with Apple Silicon chip
+
+Due to the architectural differences of the Apple Silicon chip, some Python packages may not install correctly using the standard method. Follow the instructions below to create a compatible conda environment, and then install Fastlane Arbitrage Bot:
+
+1. Install Miniforge tailored for Apple Silicon from [here](https://github.com/conda-forge/miniforge#miniforge3).
+
 ```bash
-pip install fastlane_bot
+# to install miniforge
+wget https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-MacOSX-arm64.sh
+bash Miniforge3-MacOSX-arm64.sh
 ```
 
-Or clone the repo from Bancor's GitHub:
+Follow the terminal prompts to ensure conda is installed and initialized.
+
+2. Create a new conda environment using the correct architecture:
+
+```bash
+conda create -n fastlane_bot_env python=3.9
+conda activate fastlane_bot_env
+```
+
+3. Clone the repo from GitHub:
 
 ```bash
 git clone https://github.com/bancorprotocol/fastlane-bot
 cd fastlane-bot
-pip install -r requirements.txt
-python setup.py install
 ```
 
+3. Now, install Fastlane Arbitrage Bot by using the provided bash scrip `apple-silicon-install.sh`:
+
+```bash
+./apple-silicon-install.sh
+```
+
+Please note that due to potential compatibility issues with the new Apple Silicon chip, some packages may still fail to install correctly. If you encounter any issues, please report them to the package maintainers.
+
 [sim]:https://github.com/bancorprotocol/carbon-simulator
 
 ### Legacy Installation (v1.0)

fastlane_bot/__init__.py

@@ -1,7 +1,7 @@
 from .bot import CarbonBot as Bot, __VERSION__, __DATE__
 from .config import Config, ConfigNetwork, ConfigDB, ConfigLogger, ConfigProvider
 
-__version__ = '2.7.1'
+__version__ = '2.7.2'