Skip to content

Commit 812826e

Browse files
committed
feat: update README with new configuration initialization process and testnet instructions
1 parent 4dd6464 commit 812826e

File tree

1 file changed

+26
-9
lines changed

1 file changed

+26
-9
lines changed

README.md

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
- **OpenClaw Strategy Advisor**: Integrates OpenClaw as an advisory tool for automated backtests and improvement suggestions; users decide whether to adopt recommended changes.
3535
- **Local Hot-Reload of Profitable Strategies**: Strategy code and parameters can be iterated locally and take effect immediately, so performance improvements are under user control.
3636
- **Cloud Can Be Decentralized Relayer Network**: The lightweight relay architecture allows future migration to decentralized relay networks, reducing single points of failure and improving censorship resistance.
37-
- **Unified Incentive (Credit) System**: A transparent, verifiable Credit mechanism rewards all participants (signal providers, followers, relay nodes), aligning incentives across the ecosystem.
37+
- **Unified Incentive (Credit) System**: A transparent, verifiable Credit mechanism rewards all participants (signal providers, followers, relay nodes), aligning incentives across the ecosystem.
3838

3939
## **How It Works (Simplified Flow)**
4040

@@ -84,28 +84,45 @@
8484

8585
1. **Clone & Install**:
8686
```bash
87-
git clone https://your-repo-url/moltrade-bot.git
88-
cd moltrade-bot
87+
git clone https://github.com/hetu-project/moltrade.git
88+
cd moltrade/trader
8989
pip install -r requirements.txt # Installs nostr, hyperliquid-py, etc.
9090
```
91-
2. **Configure Your Secrets**:
92-
- Copy `config.example.json` to `config.json`.
93-
- **Fill in your Hyperliquid account details (API keys and wallet)**.
94-
- **Important**: Never commit this file or share your private keys.
95-
3. **Run the Bot**:
91+
2. **Initialize Configuration**:
92+
93+
```bash
94+
python main.py --init
95+
```
96+
97+
This generates `config.json` with prompts for your Hyperliquid API keys and wallet details.
98+
**Important**: Never commit this file or share your private keys.
99+
100+
3. **Test on Testnet**:
101+
96102
```bash
97-
python main.py
103+
python main.py --config config.json --test --strategy test --symbol HYPE
98104
```
105+
106+
Verify configuration and strategy behavior without real trades.
107+
108+
4. **Run Live Trading**:
109+
Once confident in your setup, switch to mainnet:
110+
```bash
111+
python main.py --config config.json --strategy momentum --symbol HYPE
112+
```
113+
⚠️ **Ensure API keys, risk settings, and strategy parameters are correct before live trading.**
99114
The bot will start, generate a Nostr key pair for communication, and await configuration via its local API or admin panel.
100115

101116
## **Docker Setup**
102117

103118
**For Relayer:**
119+
104120
```bash
105121
cd docker && docker compose -f docker-compose.relayer.yml up --build
106122
```
107123

108124
**For Trader:**
125+
109126
```bash
110127
cd docker && docker compose -f docker-compose.trader.yml up
111128
```

0 commit comments

Comments
 (0)