Skip to content

Commit ed7553f

Browse files
committed
docs: 📝 README
1 parent b608848 commit ed7553f

File tree

1 file changed

+70
-1
lines changed

1 file changed

+70
-1
lines changed

README.md

Lines changed: 70 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Install `uv` via their official [docs](https://docs.astral.sh/uv/#installation).
1010
curl -LsSf https://astral.sh/uv/install.sh | sh
1111
```
1212

13-
> [!NOTE]
13+
> [!IMPORTANT]
1414
> `uv` is highly recommended to use, other package managers are untested on this repo.
1515
1616
### Installation
@@ -44,4 +44,73 @@ Commands:
4444

4545
#### `status`
4646

47+
> [!NOTE]
48+
> This command is the quick dashboard for the HL Account address (provided by `--address` option or `ACCOUNT_ADDRESS` environment variable).
49+
50+
```shell
51+
$ uv run hlexec status
52+
Session Info
53+
Environment testnet
54+
HL Account 0xb764428a29EAEbe8e2301F5924746F818b331F5A
55+
Signer 0x57FbAe717f5712C3Bd612f34482832c86D9b17f2
56+
57+
Positions
58+
╭──────┬─────────┬─────┬──────────┬───────────┬────────────┬────────┬─────────────────┬─────────────╮
59+
│ Coin │ Size │ Lev │ Entry Px │ Value │ Unreal PnL │ ROE │ Liq Px │ Margin Used │
60+
├──────┼─────────┼─────┼──────────┼───────────┼────────────┼────────┼─────────────────┼─────────────┤
61+
│ ETH │ 0.1 │ 10x │ 4312.0 │ 430.39 │ -0.81 │ -1.88% │ 4002.1844693878 │ 38.175922 │
62+
│ DOGE │ -5175.0 │ 10x │ 0.21572 │ 1099.4805 │ 16.8705 │ 15.11% │ 0.3626983345 │ 109.94805 │
63+
╰──────┴─────────┴─────┴──────────┴───────────┴────────────┴────────┴─────────────────┴─────────────╯
64+
65+
Open Orders
66+
╭──────┬──────┬──────────┬─────────┬─────────────┬────────────────────────────────────┬─────────────────────╮
67+
│ Coin │ Side │ Limit Px │ Size │ OID │ Client OID │ Time │
68+
├──────┼──────┼──────────┼─────────┼─────────────┼────────────────────────────────────┼─────────────────────┤
69+
│ DOGE │ Sell │ 0.3 │ 8360.0 │ 38709445951 │ - │ 2025-09-04 11:08:37 │
70+
│ BTC │ Sell │ 130000.0 │ 0.02196 │ 38707223032 │ - │ 2025-09-04 10:56:32 │
71+
│ ETH │ Buy │ 2000.0 │ 0.01 │ 38684898004 │ 0x019913a9b0637000bf85feb8fa139da6 │ 2025-09-04 08:55:00 │
72+
│ ETH │ Buy │ 2000.0 │ 0.01 │ 38684843740 │ 0x019913a9b0637000bf85feb8fa139da5 │ 2025-09-04 08:54:42 │
73+
╰──────┴──────┴──────────┴─────────┴─────────────┴────────────────────────────────────┴─────────────────────╯
74+
```
75+
4776
#### `deposit <amount>`
77+
78+
> [!NOTE]
79+
> This will transfer USDC from the signer's Arbitrum Accont to the provided HL Account Address (provided by `--address` option or `ACCOUNT_ADDRESS` environment variable).
80+
81+
```sh
82+
$ uv run hlexec deposit 5
83+
Session Info
84+
Environment testnet
85+
HL Account 0xb764428a29EAEbe8e2301F5924746F818b331F5A
86+
Signer 0x57FbAe717f5712C3Bd612f34482832c86D9b17f2
87+
Signer Wallet Balances
88+
Address 0x57FbAe717f5712C3Bd612f34482832c86D9b17f2
89+
ETH 0.299963
90+
USDC 87.000000
91+
92+
💰 Initial HL balance: $5.00
93+
📤 Depositing: 5.000000 USDC
94+
95+
✅ Transaction sent: d2e138d06d6082c534f67aa9622d969d218d1fc1fb9ea6fb992df2fe74ad756a
96+
✅ Transaction confirmed in block 190866656
97+
⠏ Waiting for confirmation...
98+
99+
⏳ Waiting for HyperLiquid credit...
100+
101+
✅ HyperLiquid account credited: $5.00
102+
⠏ Checking HyperLiquid balance...
103+
104+
🔄 Transferring from signer 0x57FbAe717f5712C3Bd612f34482832c86D9b17f2 to target 0xb764428a29EAEbe8e2301F5924746F818b331F5A...
105+
✅ Internal transfer initiated
106+
⚠️ Transfer amount mismatch. Expected: $5.00, Got: $4.90
107+
108+
109+
Deposit Summary
110+
╔═══════════════╦════════════╗
111+
║ Requested ║ $5.00 ║
112+
║ Credited ║ $909.37 ║
113+
║ Final Balance ║ $914.37 ║
114+
║ Status ║ ✅ SUCCESS ║
115+
╚═══════════════╩════════════╝
116+
```

0 commit comments

Comments
 (0)