rust-okx 0.6.3

Async Rust client for the OKX v5 REST API
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
use std::io::stdout;
use std::sync::Arc;

use anyhow::Result;
use crossterm::event::{Event, EventStream, KeyCode, KeyEventKind};
use crossterm::execute;
use crossterm::terminal::{
    EnterAlternateScreen, LeaveAlternateScreen, disable_raw_mode, enable_raw_mode,
};
use futures_util::StreamExt;
use ratatui::prelude::*;
use rust_okx::api::trade::{CancelOrderRequest, PlaceOrderRequest};
use rust_okx::{Credentials, OkxClient};
use tokio::sync::mpsc;
use tokio::task::JoinHandle;

mod app;
mod config;
mod credentials;
mod okx_config;
mod tasks;
mod ui;
mod views;

use app::{
    App, BAR_OPTIONS, DEFAULT_WATCHLIST, LogLevel, PendingAction, StreamKind, StreamState, Tab,
};
use clap::Parser;
use config::{CliArgs, RuntimeConfig, validate_bar};
use okx_config::OkxConfig;

#[tokio::main(flavor = "multi_thread")]
async fn main() -> Result<()> {
    dotenvy::dotenv().ok();

    let args = CliArgs::parse();
    let profile_name = args.profile.clone();
    let active_profile = profile_name
        .clone()
        .unwrap_or_else(|| credentials::DEFAULT_PROFILE.to_owned());
    let (creds, profile_demo, base_url) =
        tokio::task::block_in_place(|| credentials::load_or_prompt(profile_name.as_deref()))?;

    let mut config = RuntimeConfig::from_args(args)?;
    config.demo = config.demo || profile_demo;
    validate_bar(&config.bar)?;

    eprintln!(
        "Starting OKX TUI: {} {} {} trade_enabled={}",
        config.mode_label(),
        config.inst_id,
        config.bar,
        config.trade_enabled
    );

    let builder = OkxClient::builder()
        .credentials(creds.clone())
        .demo_trading(config.demo);
    let rest = Arc::new(
        if let Some(url) = base_url {
            builder.base_url(url)
        } else {
            builder.region(config.region)
        }
        .build(),
    );

    let watchlist = OkxConfig::load()?
        .map(|cfg| cfg.profile_watchlist_or_default(&active_profile, &DEFAULT_WATCHLIST))
        .unwrap_or_else(|| {
            DEFAULT_WATCHLIST
                .iter()
                .map(|id| (*id).to_owned())
                .collect()
        });
    let mut app = App::new(config.clone(), watchlist);
    app.apply_rest_snapshot(tasks::fetch_rest_snapshot(&rest, &config.inst_id, &config.bar).await);

    let (tx, mut rx) = mpsc::channel(256);

    let mut watchlist_handle = tasks::spawn_watchlist_ws(app.watchlist_instruments(), tx.clone());

    let mut handles = TaskHandles::spawn(rest.clone(), creds.clone(), &app, tx.clone());

    enable_raw_mode()?;
    execute!(stdout(), EnterAlternateScreen)?;
    let mut terminal = Terminal::new(CrosstermBackend::new(stdout()))?;

    let result = run_tui(
        &mut terminal,
        &mut app,
        &mut rx,
        tx.clone(),
        rest,
        &mut handles,
        &mut watchlist_handle,
        active_profile.to_string(),
    )
    .await;

    handles.abort();
    watchlist_handle.abort();
    disable_raw_mode()?;
    execute!(stdout(), LeaveAlternateScreen)?;

    result
}

struct TaskHandles {
    rest: JoinHandle<()>,
    market: JoinHandle<()>,
    candles: JoinHandle<()>,
    private: JoinHandle<()>,
}

impl TaskHandles {
    fn spawn(
        rest_client: Arc<OkxClient>,
        credentials: Credentials,
        app: &App,
        tx: mpsc::Sender<app::AppMsg>,
    ) -> Self {
        Self {
            rest: tasks::spawn_periodic_rest_refresh(
                rest_client,
                app.config.inst_id.clone(),
                app.config.bar.clone(),
                app.config.refresh_ms,
                app.rest_generation,
                tx.clone(),
            ),
            market: tasks::spawn_market_ws(app.config.inst_id.clone(), tx.clone()),
            candles: tasks::spawn_candle_ws(
                app.config.inst_id.clone(),
                app.config.bar.clone(),
                tx.clone(),
            ),
            private: tasks::spawn_private_ws(credentials, app.config.demo, tx),
        }
    }

    fn abort(&self) {
        self.rest.abort();
        self.market.abort();
        self.candles.abort();
        self.private.abort();
    }

    fn restart_instrument(
        &mut self,
        rest_client: Arc<OkxClient>,
        app: &App,
        tx: mpsc::Sender<app::AppMsg>,
    ) {
        self.rest.abort();
        self.market.abort();
        self.candles.abort();
        self.rest = tasks::spawn_periodic_rest_refresh(
            rest_client,
            app.config.inst_id.clone(),
            app.config.bar.clone(),
            app.config.refresh_ms,
            app.rest_generation,
            tx.clone(),
        );
        self.market = tasks::spawn_market_ws(app.config.inst_id.clone(), tx.clone());
        self.candles =
            tasks::spawn_candle_ws(app.config.inst_id.clone(), app.config.bar.clone(), tx);
    }

    fn restart_bar(
        &mut self,
        rest_client: Arc<OkxClient>,
        app: &App,
        tx: mpsc::Sender<app::AppMsg>,
    ) {
        self.rest.abort();
        self.candles.abort();
        self.rest = tasks::spawn_periodic_rest_refresh(
            rest_client,
            app.config.inst_id.clone(),
            app.config.bar.clone(),
            app.config.refresh_ms,
            app.rest_generation,
            tx.clone(),
        );
        self.candles =
            tasks::spawn_candle_ws(app.config.inst_id.clone(), app.config.bar.clone(), tx);
    }
}

async fn run_tui(
    terminal: &mut Terminal<CrosstermBackend<std::io::Stdout>>,
    app: &mut App,
    rx: &mut mpsc::Receiver<app::AppMsg>,
    tx: mpsc::Sender<app::AppMsg>,
    rest: Arc<OkxClient>,
    handles: &mut TaskHandles,
    watchlist_handle: &mut JoinHandle<()>,
    active_profile: String,
) -> Result<()> {
    let mut event_stream = EventStream::new();
    let mut tick = tokio::time::interval(std::time::Duration::from_millis(150));

    loop {
        tokio::select! {
            _ = tick.tick() => {
                terminal.draw(|f| ui::render(f, app))?;
            }
            Some(Ok(Event::Key(key))) = event_stream.next() => {
                if key.kind == KeyEventKind::Press
                    && handle_key(
                        key.code,
                        app,
                        &rest,
                        &tx,
                        handles,
                        watchlist_handle,
                        &active_profile,
                    ).await?
                {
                    return Ok(());
                }
            }
            Some(msg) = rx.recv() => {
                app.apply_msg(msg);
            }
        }
    }
}

async fn handle_key(
    key: KeyCode,
    app: &mut App,
    rest: &Arc<OkxClient>,
    tx: &mpsc::Sender<app::AppMsg>,
    handles: &mut TaskHandles,
    watchlist_handle: &mut JoinHandle<()>,
    active_profile: &str,
) -> Result<bool> {
    if handle_confirmation(key, app, rest, tx).await? {
        return Ok(false);
    }
    if handle_bar_picker(key, app, rest, tx, handles).await? {
        return Ok(false);
    }
    if handle_watchlist_input(key, app, tx, watchlist_handle, active_profile)? {
        return Ok(false);
    }
    if handle_symbol_input(key, app, rest, tx, handles).await? {
        return Ok(false);
    }

    match key {
        KeyCode::Char('q') | KeyCode::Esc => return Ok(true),
        KeyCode::Tab | KeyCode::Right => app.next_tab(),
        KeyCode::Left | KeyCode::BackTab => app.prev_tab(),
        KeyCode::Char(c @ '1'..='7') if app.tab != Tab::Trade => {
            app.set_tab_by_number((c as u8 - b'0') as usize);
        }
        KeyCode::Char('r') => refresh_now(app, rest, tx),
        KeyCode::Char('p') => {
            app.paused = !app.paused;
            app.log(
                LogLevel::Info,
                format!(
                    "stream display {}",
                    if app.paused { "paused" } else { "resumed" }
                ),
            );
        }
        KeyCode::Char('/') => {
            app.symbol_editing = true;
            app.symbol_input = app.config.inst_id.clone();
        }
        KeyCode::Char('b') => app.bar_picking = true,
        KeyCode::Down if app.tab == Tab::Orders => app.select_next_order(),
        KeyCode::Up if app.tab == Tab::Orders => app.select_prev_order(),
        KeyCode::Char('c') if app.tab == Tab::Orders => {
            app.build_cancel_confirmation();
        }
        KeyCode::Down if app.tab == Tab::Watchlist => app.select_next_watchlist(),
        KeyCode::Up if app.tab == Tab::Watchlist => app.select_prev_watchlist(),
        KeyCode::Char('a') if app.tab == Tab::Watchlist => {
            app.watchlist_editing = true;
            app.watchlist_input.clear();
        }
        KeyCode::Enter if app.tab == Tab::Watchlist => {
            if let Some(inst) = app.active_watchlist_inst() {
                if inst != app.config.inst_id {
                    change_instrument(app, rest, tx, handles, inst).await?;
                }
            }
        }
        _ if app.tab == Tab::Trade => handle_trade_key(key, app),
        _ => {}
    }

    Ok(false)
}

async fn handle_bar_picker(
    key: KeyCode,
    app: &mut App,
    rest: &Arc<OkxClient>,
    tx: &mpsc::Sender<app::AppMsg>,
    handles: &mut TaskHandles,
) -> Result<bool> {
    if !app.bar_picking {
        return Ok(false);
    }
    match key {
        KeyCode::Char(c @ '1'..='9') => {
            let idx = (c as u8 - b'1') as usize;
            if let Some(&bar) = BAR_OPTIONS.get(idx) {
                app.bar_picking = false;
                change_bar(app, rest, tx, handles, bar.to_owned()).await?;
            }
        }
        KeyCode::Esc => app.bar_picking = false,
        _ => {}
    }
    Ok(true)
}

async fn handle_confirmation(
    key: KeyCode,
    app: &mut App,
    rest: &Arc<OkxClient>,
    tx: &mpsc::Sender<app::AppMsg>,
) -> Result<bool> {
    let Some(confirmation) = app.confirmation.clone() else {
        return Ok(false);
    };

    match key {
        KeyCode::Char('y') | KeyCode::Char('Y') => {
            app.confirmation = None;
            match confirmation.action {
                PendingAction::PlaceOrder => submit_order(app, rest, tx).await,
                PendingAction::CancelOrder { ord_id } => cancel_order(app, rest, tx, ord_id).await,
            }
            Ok(true)
        }
        KeyCode::Char('n') | KeyCode::Char('N') | KeyCode::Esc => {
            app.confirmation = None;
            app.trade.message = "操作已取消".to_owned();
            Ok(true)
        }
        _ => Ok(true),
    }
}

async fn handle_symbol_input(
    key: KeyCode,
    app: &mut App,
    rest: &Arc<OkxClient>,
    tx: &mpsc::Sender<app::AppMsg>,
    handles: &mut TaskHandles,
) -> Result<bool> {
    if !app.symbol_editing {
        return Ok(false);
    }

    match key {
        KeyCode::Enter => {
            let next = app.symbol_input.trim().to_ascii_uppercase();
            app.symbol_editing = false;
            if !next.is_empty() && next != app.config.inst_id {
                change_instrument(app, rest, tx, handles, next).await?;
            }
        }
        KeyCode::Esc => {
            app.symbol_editing = false;
            app.symbol_input = app.config.inst_id.clone();
        }
        KeyCode::Backspace => {
            app.symbol_input.pop();
        }
        KeyCode::Char(c) if c.is_ascii_alphanumeric() || c == '-' => {
            app.symbol_input.push(c.to_ascii_uppercase());
        }
        _ => {}
    }
    Ok(true)
}

fn handle_watchlist_input(
    key: KeyCode,
    app: &mut App,
    tx: &mpsc::Sender<app::AppMsg>,
    watchlist_handle: &mut JoinHandle<()>,
    active_profile: &str,
) -> Result<bool> {
    if !app.watchlist_editing {
        return Ok(false);
    }

    match key {
        KeyCode::Enter => {
            let next = app.watchlist_input.trim().to_ascii_uppercase();
            app.watchlist_editing = false;
            app.watchlist_input.clear();
            if app.add_watchlist_inst(next) {
                let watchlist = app.watchlist_instruments();
                if let Err(error) = OkxConfig::save_profile_watchlist(active_profile, &watchlist) {
                    app.log(LogLevel::Error, format!("保存自选失败: {error}"));
                }
                watchlist_handle.abort();
                *watchlist_handle = tasks::spawn_watchlist_ws(watchlist, tx.clone());
            }
        }
        KeyCode::Esc => {
            app.watchlist_editing = false;
            app.watchlist_input.clear();
        }
        KeyCode::Backspace => {
            app.watchlist_input.pop();
        }
        KeyCode::Char(c) if c.is_ascii_alphanumeric() || c == '-' => {
            app.watchlist_input.push(c.to_ascii_uppercase());
        }
        _ => {}
    }
    Ok(true)
}

fn handle_trade_key(key: KeyCode, app: &mut App) {
    match key {
        KeyCode::Enter => {
            app.build_place_confirmation();
        }
        KeyCode::Char('c') => {
            app.build_cancel_confirmation();
        }
        KeyCode::Char('s') => app.trade.side.toggle(),
        KeyCode::Char('o') => app.trade.order_type.toggle(),
        KeyCode::Char('m') => app.trade.trade_mode.cycle(),
        KeyCode::Down | KeyCode::Up => app.trade.next_field(),
        KeyCode::Backspace => app.trade.backspace(),
        KeyCode::Char(c) => app.trade.push_char(c),
        _ => {}
    }
}

fn refresh_now(app: &mut App, rest: &Arc<OkxClient>, tx: &mpsc::Sender<app::AppMsg>) {
    app.set_status(
        StreamKind::Rest,
        StreamState::Connecting,
        "manual refresh".to_owned(),
    );
    tasks::spawn_rest_snapshot(
        rest.clone(),
        app.config.inst_id.clone(),
        app.config.bar.clone(),
        app.rest_generation,
        tx.clone(),
    );
    app.log(LogLevel::Info, "REST refreshed".to_owned());
}

async fn change_instrument(
    app: &mut App,
    rest: &Arc<OkxClient>,
    tx: &mpsc::Sender<app::AppMsg>,
    handles: &mut TaskHandles,
    inst_id: String,
) -> Result<()> {
    app.log(LogLevel::Info, format!("switch instrument -> {inst_id}"));
    let generation = app.begin_rest_generation(format!("switching {inst_id}"));
    app.set_market(inst_id, Vec::new());
    handles.restart_instrument(rest.clone(), app, tx.clone());
    tasks::spawn_rest_snapshot(
        rest.clone(),
        app.config.inst_id.clone(),
        app.config.bar.clone(),
        generation,
        tx.clone(),
    );
    Ok(())
}

async fn change_bar(
    app: &mut App,
    rest: &Arc<OkxClient>,
    tx: &mpsc::Sender<app::AppMsg>,
    handles: &mut TaskHandles,
    bar: String,
) -> Result<()> {
    app.log(LogLevel::Info, format!("switch bar -> {bar}"));
    let generation = app.begin_rest_generation(format!("switching bar {bar}"));
    app.set_bar(bar, Vec::new());
    handles.restart_bar(rest.clone(), app, tx.clone());
    tasks::spawn_rest_snapshot(
        rest.clone(),
        app.config.inst_id.clone(),
        app.config.bar.clone(),
        generation,
        tx.clone(),
    );
    Ok(())
}

async fn submit_order(app: &mut App, rest: &Arc<OkxClient>, tx: &mpsc::Sender<app::AppMsg>) {
    let mut request = PlaceOrderRequest::new(
        app.config.inst_id.clone(),
        app.trade.trade_mode.as_trade_mode(),
        app.trade.side.as_order_side(),
        app.trade.order_type.as_order_type(),
        app.trade.size.clone(),
    );
    if app.trade.order_type == app::TradeTypeInput::Limit {
        request = request.price(app.trade.price.clone());
    }

    match rest.trade().place_order(&request).await {
        Ok(rows) => {
            let result = rows
                .first()
                .map(|row| format!("sCode={} ordId={} {}", row.s_code, row.ord_id, row.s_msg))
                .unwrap_or_else(|| "empty place-order response".to_owned());
            app.trade.message = result.clone();
            app.log(LogLevel::Info, format!("place order: {result}"));
            refresh_now(app, rest, tx);
        }
        Err(error) => {
            app.trade.message = error.to_string();
            app.log(LogLevel::Error, format!("place order failed: {error}"));
        }
    }
}

async fn cancel_order(
    app: &mut App,
    rest: &Arc<OkxClient>,
    tx: &mpsc::Sender<app::AppMsg>,
    ord_id: String,
) {
    match rest
        .trade()
        .cancel_order(&CancelOrderRequest::by_order_id(
            &app.config.inst_id,
            &ord_id,
        ))
        .await
    {
        Ok(rows) => {
            let result = rows
                .first()
                .map(|row| format!("sCode={} ordId={} {}", row.s_code, row.ord_id, row.s_msg))
                .unwrap_or_else(|| "empty cancel-order response".to_owned());
            app.trade.message = result.clone();
            app.log(LogLevel::Info, format!("cancel order {ord_id}: {result}"));
            refresh_now(app, rest, tx);
        }
        Err(error) => {
            app.trade.message = error.to_string();
            app.log(LogLevel::Error, format!("cancel order failed: {error}"));
        }
    }
}