whale-market-cli 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +39 -39
  2. package/package.json +1 -2
package/README.md CHANGED
@@ -11,7 +11,7 @@ A command-line interface for the Whales Market trading platform, built with Node
11
11
  - 📊 **Token Operations**: Browse, search, and view token details
12
12
  - 💰 **Trading**: View and manage offers and orders
13
13
  - 📈 **Portfolio Tracking**: Monitor your positions and portfolio
14
- - 📚 **Order Book**: Access order book v2 operations
14
+ - 📚 **Order Book**: View order book per token (`whales book <symbol>`) + orderbook v2 operations
15
15
  - 🎁 **Referral System**: Track campaigns and earnings
16
16
  - 🎨 **Beautiful Output**: Table and JSON output formats
17
17
  - ⚡ **Fast & Reliable**: Built with TypeScript for type safety
@@ -53,9 +53,12 @@ This will guide you through:
53
53
  ### 2. First Commands
54
54
 
55
55
  ```bash
56
- # List tokens
56
+ # List tokens (pre-market with Implied FDV, 24h Vol)
57
57
  whales tokens list
58
58
 
59
+ # View order book for a token
60
+ whales book MEGA
61
+
59
62
  # View your offers
60
63
  whales offers my
61
64
 
@@ -84,12 +87,16 @@ whales --help
84
87
 
85
88
  ### Token Operations
86
89
 
87
- - `whales tokens list [--status active|ended] [--chain <id>]` - List tokens
90
+ - `whales tokens list [--status active|settling|ended] [--chain <id>] [--limit <n>] [--sort vol|price|created] [--no-fdv] [--no-volume]` - List pre-market tokens (Implied FDV, 24h Vol by default)
88
91
  - `whales tokens get <token-id>` - Get token details
89
92
  - `whales tokens search <query> [--limit <n>]` - Search tokens
90
93
  - `whales tokens highlight` - Get highlighted/trending tokens
91
94
  - `whales tokens stats` - Get prediction stats
92
95
 
96
+ ### Order Book (per token)
97
+
98
+ - `whales book <symbol> [--depth <n>] [--chain-id <id>] [--format json|plain]` - View order book (SELL/BUY orders, spread, fill status, match type)
99
+
93
100
  ### Offer Management
94
101
 
95
102
  - `whales offers list [--type buy|sell] [--token <symbol>]` - List all offers
@@ -110,7 +117,7 @@ whales --help
110
117
  - `whales portfolio positions [--type open|filled]` - List positions
111
118
  - `whales portfolio balance [--token <symbol>]` - Show token balances
112
119
 
113
- ### Order Book V2
120
+ ### Order Book V2 (aggregated)
114
121
 
115
122
  - `whales orderbook snapshot` - Order book snapshot statistics
116
123
  - `whales orderbook positions --telegram-id <id>` - Get positions
@@ -138,32 +145,30 @@ whales tokens list
138
145
  ```
139
146
 
140
147
  ```
141
- ┌────────┬─────────────────────────────┬──────────┬────────┬───────────┬─────────────┐
142
- │ ID │ Name │ Symbol │ StatusPrice Chain
143
- ├────────┼─────────────────────────────┼──────────┼────────┼───────────┼─────────────┤
144
- 123 │ Example Token │ EXMP │ active │ $0.45Solana
145
- └────────┴─────────────────────────────┴──────────┴────────┴───────────┴─────────────┘
148
+ ┌────────┬─────────────────────────────┬──────────┬────────┬──────────────┬──────────┬─────────────┐
149
+ │ ID │ Name │ Symbol │ Price │ Implied FDV 24h Vol Status
150
+ ├────────┼─────────────────────────────┼──────────┼────────┼──────────────┼──────────┼─────────────┤
151
+ uuid │ Example Token │ EXMP │ $0.45 │ $45M │ $1.2Mactive
152
+ └────────┴─────────────────────────────┴──────────┴────────┴──────────────┴──────────┴─────────────┘
146
153
  ```
147
154
 
148
155
  ### JSON Format
149
156
 
150
157
  ```bash
151
- whales tokens list --output json
158
+ whales tokens list --format json
152
159
  ```
153
160
 
154
161
  ```json
155
- {
156
- "data": [
157
- {
158
- "id": 123,
159
- "name": "Example Token",
160
- "symbol": "EXMP",
161
- "status": "active",
162
- "price": "0.45",
163
- "chain_id": 666666
164
- }
165
- ]
166
- }
162
+ [
163
+ {
164
+ "id": "uuid",
165
+ "name": "Example Token",
166
+ "symbol": "EXMP",
167
+ "status": "active",
168
+ "last_price": "0.45",
169
+ "chain_id": 56
170
+ }
171
+ ]
167
172
  ```
168
173
 
169
174
  ## Configuration
@@ -174,22 +179,11 @@ Configuration is stored in platform-specific locations:
174
179
  - **Linux**: `~/.config/whales-market-cli/config.json`
175
180
  - **Windows**: `%APPDATA%\whales-market-cli\config.json`
176
181
 
177
- ### Environment Variables
178
-
179
- You can override config values with environment variables:
180
-
181
- ```bash
182
- export WHALES_API_URL="https://api.whales.market"
183
- export WHALES_PRIVATE_KEY="your-private-key"
184
- export WHALES_WALLET_TYPE="solana"
185
- export WHALES_CHAIN_ID="666666"
186
- ```
187
-
188
182
  ### Global Options
189
183
 
190
184
  All commands support these global options:
191
185
 
192
- - `-o, --output <format>` - Output format (table|json), default: table
186
+ - `-f, --format <format>` - Output format (table|json|plain), default: table
193
187
  - `-k, --private-key <key>` - Private key (overrides config)
194
188
  - `--api-url <url>` - API endpoint URL
195
189
  - `--chain-id <id>` - Chain ID
@@ -199,14 +193,17 @@ All commands support these global options:
199
193
  ### Browse Tokens
200
194
 
201
195
  ```bash
202
- # List active tokens
196
+ # List active tokens (with Implied FDV, 24h Vol)
203
197
  whales tokens list --status active --limit 10
204
198
 
205
199
  # Search for a token
206
- whales tokens search "example"
200
+ whales tokens search "MEGA"
207
201
 
208
202
  # Get token details
209
- whales tokens get 123
203
+ whales tokens get <token-id>
204
+
205
+ # View order book for a token
206
+ whales book MEGA --depth 5
210
207
  ```
211
208
 
212
209
  ### Manage Offers
@@ -236,10 +233,13 @@ whales portfolio positions --type open
236
233
 
237
234
  ```bash
238
235
  # Get tokens as JSON
239
- whales tokens list --output json | jq '.data[0].name'
236
+ whales tokens list --format json | jq '.[0].name'
237
+
238
+ # View order book as JSON
239
+ whales book MEGA --format json | jq '.sell_orders'
240
240
 
241
241
  # Check if wallet is configured
242
- whales wallet address --output json | jq -r '.address'
242
+ whales wallet address --format json | jq -r '.address'
243
243
  ```
244
244
 
245
245
  ## Development
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "whale-market-cli",
3
- "version": "0.2.0",
3
+ "version": "0.3.0",
4
4
  "description": "CLI for Whales Market trading platform",
5
5
  "bin": {
6
6
  "whales": "bin/whales"
@@ -46,7 +46,6 @@
46
46
  "cli-table3": "0.6.5",
47
47
  "inquirer": "8.2.6",
48
48
  "ora": "5.4.1",
49
- "dotenv": "16.4.0",
50
49
  "@solana/web3.js": "1.95.0",
51
50
  "@solana/spl-token": "0.3.9",
52
51
  "ethers": "6.13.0",