Merge pull request hummingbot#7552 from hummingbot/staging

sync / staging -> master for Hummingbot version 2.5.0

Author: nikspz

.github/pull_request_template.md

@@ -1,6 +1,7 @@
 **Before submitting this PR, please make sure**:
 
 - [ ] Your code builds clean without any errors or warnings
+- [ ] Tests all pass
 - [ ] You are using approved title ("feat/", "fix/", "docs/", "refactor/")
 
 **A description of the changes proposed in the pull request**:
@@ -13,4 +14,3 @@
 
 **Tips for QA testing**:
 
-

.gitignore

@@ -92,3 +92,5 @@ coverage.xml
 # External SDK files
 /**/.chain_cookie
 /**/.injective_cookie
+
+.env

CONTRIBUTING.md

@@ -18,6 +18,14 @@
 
 **Note:** Tests are crucial. If your pull request contains new, testable behavior, please submit tests. Refer to the 'Unit Test Coverage' section for more information.
 
+## Development Environment Setup
+
+### IDE Configuration
+If you're using VS Code or Cursor IDE, please refer to our [VS Code/Cursor Setup Guide](./CURSOR_VSCODE_SETUP.md) for detailed instructions on setting up your development environment, including:
+- VS Code/Cursor settings configuration
+- Debugging setup
+- Test discovery configuration
+
 ## Detailed Workflow
 
 ### 1. Fork the Repository

CURSOR_VSCODE_SETUP.md

@@ -0,0 +1,115 @@
+## VS Code/Cursor Setup Guide for Hummingbot Testing
+
+This guide outlines how to configure VS Code or Cursor to efficiently run and debug Hummingbot tests
+
+**I. Prerequisites:**
+
+* **Hummingbot Repository:** You have cloned the Hummingbot repository to your local machine.
+* **Conda Environment:** You have created and activated the `hummingbot` Conda environment with all necessary dependencies installed.
+
+**II. Required Files and Configuration:**
+
+Ensure the following files exist in your Hummingbot project directory with the specified content.
+
+**1. `.env` (Project Root Directory):**
+
+```
+PYTHONPATH=${PYTHONPATH}:${PWD}
+CONDA_ENV=hummingbot
+```
+
+* **`PYTHONPATH`**: This ensures that Python can find the Hummingbot modules within your project directory.
+* **`CONDA_ENV`**: This variable can be used by other tools or scripts to identify the active Conda environment.
+
+**2. `.vscode/settings.json` (Create this directory and file if it doesn't exist):**
+
+```json
+{
+    "python.testing.pytestEnabled": true,
+    "python.testing.pytestArgs": [
+        "test",
+        // "-v",  // optional: verbose output
+
+        // From MakeFile (currently broken tests - KEEP UPDATED)
+        "--ignore=test/hummingbot/connector/derivative/dydx_v4_perpetual/",
+        "--ignore=test/hummingbot/connector/derivative/injective_v2_perpetual/",
+        "--ignore=test/hummingbot/connector/exchange/injective_v2/",
+        "--ignore=test/hummingbot/remote_iface/",
+        "--ignore=test/connector/utilities/oms_connector/",
+        "--ignore=test/hummingbot/strategy/amm_arb/",
+
+        // Skip prompt tests that modify conf_client.yml
+        "--ignore=test/hummingbot/client/command/test_create_command.py",
+    ],
+    "python.envFile": "${workspaceFolder}/.env",
+    "python.pythonPath": "${config:python.defaultInterpreterPath}" // Ensure correct Python interpreter
+}
+```
+
+
+**3. `.vscode/launch.json` (Create this directory and file if it doesn't exist):**
+
+```json
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python: Hummingbot",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceRoot}/bin/hummingbot.py",
+            "console": "integratedTerminal"
+        }
+    ]
+}
+```
+
+* This configuration allows you to run and debug the main Hummingbot application directly from VS Code/Cursor.
+
+**III. Setup Steps in VS Code/Cursor:**
+
+1.  **Open the Hummingbot Project:** Open the root directory of your cloned Hummingbot repository in VS Code or Cursor.
+
+2.  **Select the Python Interpreter:**
+    * Open the Command Palette: Press `Ctrl+Shift+P` (Windows/Linux) or `Cmd+Shift+P` (macOS).
+    * Type "Python: Select Interpreter" and press Enter.
+    * A list of available Python interpreters will appear. **Select the Python interpreter associated with your `hummingbot` Conda environment.** The path should typically include the name of your Conda environment.
+
+3.  **Ensure `.env` is Loaded:** VS Code/Cursor should automatically load the `.env` file specified in `settings.json`. You can verify this by checking the Python environment variables within the IDE's terminal or debug configurations.
+
+4.  **Fix Test Discovery (Conda Environment Issue):**
+    * Open your terminal.
+    * Run the following commands to create a symbolic link to work around a known Conda environment detection issue:
+        ```bash
+        mkdir -p ~/anaconda3/envs/hummingbot/envs
+        ln -s ~/anaconda3/envs/hummingbot/ ~/anaconda3/envs/hummingbot/envs/hummingbot
+        ```
+        **Note:** Adjust `~/anaconda3/envs/hummingbot` to the actual path of your `hummingbot` Conda environment if it's located elsewhere.
+
+**IV. Running Tests:**
+
+1.  **Open the Testing View:** In the VS Code/Cursor Activity Bar (usually on the left), click on the **Testing icon** (it often looks like a flask or a beaker).
+
+2.  **Discover Tests:** If the tests are not automatically discovered, you might see a prompt to configure testing. Ensure pytest is selected and the `test` directory is specified as the test source. VS Code/Cursor should then discover the tests based on your `settings.json`.
+
+3.  **Run Tests:**
+    * You will see a list of discovered tests in the Testing View, organized by file and test function.
+    * **Run All Tests:** Click the "Run All Tests" button (usually a play icon at the top).
+    * **Run Specific Tests:** You can run individual test files, test classes, or specific test functions by right-clicking on them in the Testing View and selecting "Run".
+
+4.  **View Test Results:** The Testing View will display the status of each test (passed, failed, skipped). You can click on a failed test to see the error output and navigate to the test code.
+
+**V. Debugging Tests:**
+
+1.  **Set Breakpoints:** In your test files or the Hummingbot code you want to debug, click in the gutter (the space to the left of the line numbers) to set breakpoints.
+
+2.  **Run Tests in Debug Mode:**
+    * In the Testing View, right-click on the test(s) you want to debug and select "Debug".
+    * VS Code/Cursor will start the debugger and stop at your breakpoints, allowing you to inspect variables, step through code, and understand the flow of execution.
+
+**VI. Notes on Ignored Tests:**
+
+* **Broken Tests (Makefile):** The `--ignore` flags in `settings.json` exclude tests that are currently known to be broken (as indicated in the project's `Makefile`). **It is crucial to regularly review and update this list if the status of these tests changes.**
+* **`test_create_command.py`:** Tests in `test_create_command.py` are ignored because they modify the `conf_client.yml` file. Running these tests locally can potentially interfere with your Hummingbot configuration. If you make changes that could affect these commands, ensure your Pull Request (PR) will pass the automated tests, as they might be run in the CI environment.
+
+By following these steps, you can effectively use VS Code or Cursor to run and debug Hummingbot tests, leveraging the IDE's features for a more integrated and potentially more efficient testing experience, especially when debugging is required. Remember to keep the ignored tests list up-to-date with the `Makefile` to maintain consistency.

Dockerfile

@@ -28,6 +28,11 @@ COPY README.md .
 SHELL [ "/bin/bash", "-lc" ]
 RUN echo "conda activate hummingbot" >> ~/.bashrc
 
+COPY setup/pip_packages.txt /tmp/pip_packages.txt
+RUN python3 -m pip install --no-deps -r /tmp/pip_packages.txt && \
+    rm /tmp/pip_packages.txt
+
+
 RUN python3 setup.py build_ext --inplace -j 8 && \
     rm -rf build/ && \
     find . -type f -name "*.cpp" -delete

Makefile

@@ -8,15 +8,16 @@
 .PHONY: uninstall
 .PHONY: clean
 .PHONY: build
+.PHONY: run-v2
 
 test:
 	coverage run -m pytest \
  	--ignore="test/mock" \
- 	--ignore="test/connector/utilities/*" \
- 	--ignore="test/hummingbot/connector/derivative/dydx_v4_perpetual" \
- 	--ignore="test/hummingbot/connector/derivative/kucoin_perpetual" \
- 	--ignore="test/hummingbot/connector/derivative/okx_perpetual" \
- 	--ignore="test/hummingbot/strategy/amm_arb/"
+ 	--ignore="test/hummingbot/connector/derivative/dydx_v4_perpetual/" \
+ 	--ignore="test/hummingbot/remote_iface/" \
+ 	--ignore="test/connector/utilities/oms_connector/" \
+ 	--ignore="test/hummingbot/strategy/amm_arb/" \
+ 	--ignore="test/hummingbot/strategy/cross_exchange_market_making/" \
 
 run_coverage: test
 	coverage report
@@ -44,3 +45,9 @@ uninstall:
 
 build:
 	./compile
+
+run-v2:
+	./bin/hummingbot_quickstart.py -p a -f v2_with_controllers.py -c $(filter-out $@,$(MAKECMDGOALS))
+
+%:
+	@:

README.md

@@ -61,6 +61,7 @@ Currently, the master branch of Hummingbot also includes the following exchange
 |----|------|-------|------|------|----------|
 | `ascend_ex` | AscendEx | CEX | CLOB Spot | [Docs](https://hummingbot.org/exchanges/ascendex/) | - |
 | `balancer` | Balancer | DEX | AMM | [Docs](https://hummingbot.org/exchanges/balancer/) | - |
+| `bing_x` | BingX | CEX     | CLOB Spot | [Docs](https://hummingbot.org/exchanges/bing_x/) | - |
 | `bitget_perpetual` | Bitget | CEX | CLOB Perp | [Docs](https://hummingbot.org/exchanges/bitget-perpetual/) | - |
 | `bitmart` | BitMart | CEX | CLOB Spot | [Docs](https://hummingbot.org/exchanges/bitmart/) | - |
 | `bitrue` | Bitrue | CEX | CLOB Spot | [Docs](https://hummingbot.org/exchanges/bitrue/) | - |

bin/hummingbot.py

@@ -86,8 +86,8 @@ def main():
     secrets_manager_cls = ETHKeyFileSecretManger
 
     try:
-        ev_loop: asyncio.AbstractEventLoop = asyncio.get_event_loop()
-    except Exception:
+        ev_loop: asyncio.AbstractEventLoop = asyncio.get_running_loop()
+    except RuntimeError:
         ev_loop: asyncio.AbstractEventLoop = asyncio.new_event_loop()
         asyncio.set_event_loop(ev_loop)
 

bin/hummingbot_quickstart.py

@@ -160,8 +160,8 @@ def main():
         secrets_manager = secrets_manager_cls(args.config_password)
 
     try:
-        ev_loop: asyncio.AbstractEventLoop = asyncio.get_event_loop()
-    except Exception:
+        ev_loop: asyncio.AbstractEventLoop = asyncio.get_running_loop()
+    except RuntimeError:
         ev_loop: asyncio.AbstractEventLoop = asyncio.new_event_loop()
         asyncio.set_event_loop(ev_loop)
 

conf/__init__.py

@@ -90,6 +90,10 @@
 gate_io_api_key = os.getenv("GATE_IO_API_KEY")
 gate_io_secret_key = os.getenv("GATE_IO_SECRET_KEY")
 
+# Mexc Tests
+mexc_api_key = os.getenv("MEXC_API_KEY")
+mexc_api_secret = os.getenv("MEXC_API_SECRET")
+
 # Wallet Tests
 test_erc20_token_address = os.getenv("TEST_ERC20_TOKEN_ADDRESS")
 web3_test_private_key_a = os.getenv("TEST_WALLET_PRIVATE_KEY_A")