Skip to content

Commit 98a8dc2

Browse files
committed
Add README and MIT license for open-source release
1 parent d781982 commit 98a8dc2

File tree

2 files changed

+65
-0
lines changed

2 files changed

+65
-0
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Damon
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# openclaw-hyperliquid-copytrade-skill
2+
3+
OpenClaw skill for Hyperliquid copy-trading with explainable decisions, Telegram notifications, risk controls, and one-click onboarding.
4+
5+
## Features
6+
7+
- Wallet monitoring and score-based follow/skip decisions
8+
- Order-level event handling (avoid duplicate fill-level spam)
9+
- Risk controls:
10+
- per-trade cap (default 10%)
11+
- total exposure cap (default 60%)
12+
- TP/SL + trailing TP logic
13+
- Telegram startup snapshot + decision messages
14+
- One-click start/stop/restart service management
15+
- Security preflight scanner before open-source publishing
16+
17+
## Quick Start
18+
19+
```bash
20+
python3 skills/openclaw-hyperliquid-copytrade/scripts/first_run_onboarding.py --start
21+
```
22+
23+
## Required env
24+
25+
- `TARGET_WALLETS`
26+
- `TELEGRAM_BOT_TOKEN`
27+
- `TELEGRAM_CHAT_ID`
28+
- `HL_WALLET_PRIVATE_KEY`
29+
30+
Reference: `references/env.example`
31+
32+
## Security
33+
34+
Read `SECURITY.md`.
35+
36+
Before publishing:
37+
38+
```bash
39+
python3 scripts/security_preflight.py
40+
```
41+
42+
## License
43+
44+
MIT

0 commit comments

Comments
 (0)