diff --git a/README.md b/README.md index b373377..3cb529d 100644 --- a/README.md +++ b/README.md @@ -34,24 +34,46 @@ The project is composed of several key scripts that work together: 1. **Clone the Repository** ```bash - git clone [https://github.com/your-username/your-repo-name.git](https://github.com/your-username/your-repo-name.git) - cd your-repo-name - - + git clone [https://github.com/your-username/your-repo-name.git](https://github.com/your-username/your-repo-name.git) + cd your-repo-name + ``` 2. **Create and Activate a Virtual Environment** ```bash - # For Windows - python -m venv .venv - .\.venv\Scripts\activate - # For macOS/Linux - python3 -m venv .venv - source .venv/bin/activate + # For Windows + python -m venv .venv + .\.venv\Scripts\activate + # For macOS/Linux + python3 -m venv .venv + source .venv/bin/activate + ``` 3. **Install Dependencies** ```bash - pip install -r requirements.txt - -##Getting Started: Configuration + pip install -r requirements.txt + ``` +## Getting Started: Configuration Before running the application, you must configure your wallets, agents, and API keys. -1. **Create the .env File In the root of the project, create a file named .env. Copy the following content into it and replace the placeholder values with your actual keys. ** +1. Create the .env File In the root of the project, create a file named .env. Copy the following content into it and replace the placeholder values with your actual keys. + +2. **Activate Your Main Wallet on Hyperliquid** + The `trade_executor.py` script will fail if your main wallet is not registered. + * Go to the Hyperliquid website, connect your main wallet, and make a small deposit. This is a one-time setup step. +3. **Create and Authorize Trading Agents** + The `trade_executor.py` uses secure "agent" keys that can trade but cannot withdraw. You need to generate these and authorize them with your main wallet. + * Run the `create_agent.py` script + ```bash + python create_agent.py + ``` + The script will output a new Agent Private Key. Copy this key and add it to your .env file (e.g., as SCALPER_AGENT_PK). Repeat this for each agent you want to create. +4. **Configure** + Your Strategies Open the `_data/strategies.json` file to define which strategies you want to run. + * Set "enabled": true to activate a strategy. + * Assign an "agent" (e.g., "scalper", "swing") to each strategy. The agent name must correspond to a key in your .env file (e.g., SCALPER_AGENT_PK -> "scalper"). + * Configure the parameters for each strategy, such as the coin, timeframe, and any indicator settings. + +##Usage## + Once everything is configured, you can run the main application from your terminal: + ```bash + python main_app.py + ```