Skip to content

Commit 15db39f

Browse files
authored
Merge pull request #7 from hypurrquant/feat/onboarding
feat: onboarding UX overhaul + skill rewrite
2 parents 5222b9d + dbb4359 commit 15db39f

13 files changed

Lines changed: 1002 additions & 328 deletions

File tree

README.md

Lines changed: 56 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ perp status --json
1212
## Features
1313

1414
- **3 Exchanges** — Pacifica (Solana), Hyperliquid (HyperEVM), Lighter (Ethereum)
15+
- **Live Dashboard** — Real-time multi-exchange dashboard with WebSocket feeds
1516
- **CCTP V2 Bridge** — $0 fee USDC bridging across Solana, Arbitrum, Base (6 routes)
1617
- **Funding Rate Arb** — Cross-exchange funding rate arbitrage scanner + auto-executor
1718
- **Grid & DCA Bots** — Automated strategies with background job management
@@ -21,15 +22,24 @@ perp status --json
2122
## Quick Start
2223

2324
```bash
24-
# Configure exchange keys
25-
export PRIVATE_KEY=<solana-base58-key> # Pacifica
25+
# Interactive setup (recommended for first-time users)
26+
perp init
27+
28+
# Or configure exchange keys manually
2629
export HL_PRIVATE_KEY=<evm-hex-key> # Hyperliquid
30+
export PRIVATE_KEY=<solana-base58-key> # Pacifica
2731
export LIGHTER_PRIVATE_KEY=<evm-hex-key> # Lighter
2832

29-
# Check status across exchanges
33+
# Or use wallet management
34+
perp wallet import evm <key> # Import & auto-bind to HL + Lighter
35+
perp wallet import solana <key> # Import & auto-bind to Pacifica
36+
37+
# Set default exchange (skip -e flag)
38+
perp settings set default-exchange hyperliquid
39+
40+
# Check status
3041
perp status
31-
perp -e hyperliquid status
32-
perp -e lighter status
42+
perp -e pacifica status
3343
```
3444

3545
## Commands
@@ -71,8 +81,19 @@ perp trade sl BTC 58000 # Stop-loss
7181
```bash
7282
perp manage leverage BTC 10 # Set leverage
7383
perp manage margin-mode BTC cross # Cross/isolated margin
74-
perp manage deposit hyperliquid 100 # Deposit USDC
75-
perp manage withdraw pacifica 50 # Withdraw USDC
84+
```
85+
86+
### Deposit & Withdraw
87+
88+
```bash
89+
perp deposit pacifica 100 # Deposit USDC into Pacifica
90+
perp deposit hyperliquid 100 # Deposit USDC into Hyperliquid (Arbitrum)
91+
perp deposit lighter ethereum 100 # Deposit via Ethereum L1
92+
perp deposit lighter cctp arb 100 # Deposit via CCTP (Arbitrum/Base/Avalanche)
93+
perp deposit lighter info # Show all Lighter deposit routes
94+
perp withdraw pacifica 50 # Withdraw USDC
95+
perp withdraw hyperliquid 50
96+
perp deposit info # All deposit instructions
7697
```
7798

7899
### Cross-Chain Bridge (CCTP V2)
@@ -118,6 +139,16 @@ perp stream trades BTC # Live trades
118139
perp stream funding # Live funding rates
119140
```
120141

142+
### Live Dashboard
143+
144+
```bash
145+
perp dashboard # Real-time multi-exchange dashboard
146+
perp dashboard --port 3457 # Custom port
147+
perp dashboard --exchanges hl,pac # Specific exchanges only
148+
```
149+
150+
WebSocket-based real-time monitoring: positions, orders, balances, funding rates, arb opportunities across all exchanges. Includes HIP-3 dex position tracking.
151+
121152
### Cross-Exchange Tools
122153

123154
```bash
@@ -213,25 +244,37 @@ perp plan execute plan.json # Execute multi-step plan
213244

214245
## Configuration
215246

247+
### Wallet Management (Recommended)
248+
249+
```bash
250+
perp init # Interactive setup wizard
251+
perp wallet generate evm # Generate new EVM wallet
252+
perp wallet import solana <key> # Import existing key
253+
perp wallet use <name> # Auto-bind to exchanges by type
254+
perp wallet list # List all wallets
255+
perp wallet balance # On-chain balances
256+
```
257+
258+
Wallets are stored in `~/.perp/wallets.json` (file permission 0600).
259+
216260
### Environment Variables
217261

218262
```bash
219-
# Exchange keys
263+
# Exchange keys (alternative to wallet management)
220264
PRIVATE_KEY= # Default key (Solana base58 or EVM hex)
221265
PACIFICA_PRIVATE_KEY= # Pacifica (Solana)
222266
HL_PRIVATE_KEY= # Hyperliquid (EVM)
223267
LIGHTER_PRIVATE_KEY= # Lighter (EVM)
224268
LIGHTER_API_KEY= # Lighter API key (40-byte)
225-
226-
# Optional
227-
DEBRIDGE_REFERRAL_CODE= # deBridge referral
228-
HL_REFERRAL_CODE= # Hyperliquid referral
229269
```
230270

271+
Key resolution order: `--private-key` flag → exchange-specific env var → `PRIVATE_KEY` → wallet store → `~/.perp/<exchange>.key`
272+
231273
### Settings
232274

233275
```bash
234276
perp settings show # Current settings
277+
perp settings set default-exchange hyperliquid # Set default exchange
235278
perp settings referrals on # Enable referral codes
236279
perp settings set referralCodes.hyperliquid MYCODE
237280
```
@@ -243,7 +286,7 @@ perp settings set referralCodes.hyperliquid MYCODE
243286
- **EVM**: `ethers` v6
244287
- **Exchanges**: `hyperliquid` SDK, `lighter-sdk` (WASM), `@pacifica/sdk`
245288
- **Bridge**: Circle CCTP V2 (Solana ↔ EVM), deBridge DLN (fallback)
246-
- **Testing**: Vitest (780+ tests)
289+
- **Testing**: Vitest (860+ tests)
247290

248291
## License
249292

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
"perp-mcp": "./dist/mcp-server.js"
88
},
99
"files": [
10-
"dist"
10+
"dist",
11+
"skills"
1112
],
1213
"type": "module",
1314
"scripts": {

0 commit comments

Comments
 (0)