asterdex-sdk 0.1.5

AsterDex Futures SDK v3 — Rust async client for REST and WebSocket APIs
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
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
// Integration tests for authenticated (signed) endpoints.
//
// Run: cargo test --test aster_account -- --include-ignored --test-threads=1
//
// Covers: account info, trading queries, advanced trading, settings,
//         listen key, batch orders, MMP, and misc signed endpoints.
//
// All tests are #[ignore]. Credentials are loaded from .env via dotenvy.
// MUST run with --test-threads=1 to avoid EIP-712 nonce collisions.

use asterdex_sdk::{
    AsterDexError, CancelOrderParams, PlaceOrderParams, FuturesClient,
};
use asterdex_sdk::futures::models::trading::{
    AllOrdersParams, CountdownParams, GetOrderParams, IncomeParams, UserTradesParams,
};
use asterdex_sdk::futures::models::account::MmpUpdateParams;

fn build_client() -> FuturesClient {
    let _ = dotenvy::dotenv();
    FuturesClient::from_env().expect("FuturesClient::from_env() failed — check .env credentials")
}

/// Place a BTCUSDT LIMIT BUY at $10,000 (far below market) and return the order_id.
async fn place_test_order(client: &FuturesClient) -> i64 {
    client
        .place_order(PlaceOrderParams {
            symbol: "BTCUSDT".to_string(),
            side: "BUY".to_string(),
            order_type: "LIMIT".to_string(),
            quantity: "0.001".to_string(),
            price: Some("70000.0".to_string()),
            time_in_force: Some("GTC".to_string()),
            ..Default::default()
        })
        .await
        .expect("place test order failed")
        .data
        .order_id
}

/// Cancel an order by id; ignore -2011 (already gone).
async fn cleanup_order(client: &FuturesClient, order_id: i64) {
    let _ = client
        .cancel_order(CancelOrderParams {
            symbol: "BTCUSDT".to_string(),
            order_id: Some(order_id),
            ..Default::default()
        })
        .await;
}

// ===========================================================================
// SECTION 1 — Account Info (read-only, no state change)
// ===========================================================================

/// Balance: at least one asset returned.
#[tokio::test]
#[ignore]
async fn test_get_balance() {
    let client = build_client();
    let resp = client.get_balance().await.expect("get_balance failed");
    assert!(!resp.data.is_empty(), "balance list is empty");
    // At least one asset should have a wallet balance field
    let _ = &resp.data[0].asset; // must deserialize
}

/// Full account with join margin: returns a JSON object.
#[tokio::test]
#[ignore]
async fn test_get_account_with_join_margin() {
    let client = build_client();
    let resp = client
        .get_account_with_join_margin()
        .await
        .expect("get_account_with_join_margin failed");
    // Verify basic structure of the account info response.
    let _ = resp.data.total_wallet_balance;
}

/// Position side dual: returns a valid boolean.
#[tokio::test]
#[ignore]
async fn test_get_position_side_dual() {
    let client = build_client();
    let resp = client
        .get_position_side_dual()
        .await
        .expect("get_position_side_dual failed");
    // Just verify it deserializes — dual_side_position is a bool
    let _ = resp.data.dual_side_position;
}

/// Setting position side to the current value returns -4059 (no change needed).
#[tokio::test]
#[ignore]
async fn test_set_position_side_dual_noop() {
    let client = build_client();
    let current = client
        .get_position_side_dual()
        .await
        .expect("get_position_side_dual failed")
        .data
        .dual_side_position;

    let result = client.set_position_side_dual(current).await;
    match result {
        // Already in desired mode
        Err(AsterDexError::ApiError { code: -4059, .. }) => {}
        // Mode actually changed (edge case: other session flipped it between the two calls)
        Ok(r) => assert_eq!(r.data.code, 200),
        Err(e) => panic!("unexpected error from set_position_side_dual: {e:?}"),
    }
}

/// Leverage bracket for BTCUSDT: has at least one bracket.
#[tokio::test]
#[ignore]
async fn test_get_leverage_bracket_btcusdt() {
    let client = build_client();
    let resp = client
        .get_leverage_bracket(Some("BTCUSDT"))
        .await
        .expect("get_leverage_bracket failed");
    assert!(!resp.data.is_empty(), "leverage brackets is empty");
    let btc = resp
        .data
        .iter()
        .find(|b| b.symbol == "BTCUSDT")
        .expect("BTCUSDT not in leverage brackets");
    assert!(!btc.brackets.is_empty(), "BTCUSDT has no brackets");
    assert!(btc.brackets[0].initial_leverage > 0);
}

/// Commission rate for BTCUSDT: rates are non-empty strings.
#[tokio::test]
#[ignore]
async fn test_get_commission_rate_btcusdt() {
    let client = build_client();
    let resp = client
        .get_commission_rate("BTCUSDT")
        .await
        .expect("get_commission_rate failed");
    assert_eq!(resp.data.symbol, "BTCUSDT");
    assert!(!resp.data.maker_commission_rate.is_empty());
    assert!(!resp.data.taker_commission_rate.is_empty());
}

/// Multi-assets margin: returns a bool.
#[tokio::test]
#[ignore]
async fn test_get_multi_assets_margin() {
    let client = build_client();
    let resp = client
        .get_multi_assets_margin()
        .await
        .expect("get_multi_assets_margin failed");
    // Just verify deserialization
    let _ = resp.data.multi_assets_margin;
}

/// ADL quantile for BTCUSDT: returns list or empty object when no positions.
#[tokio::test]
#[ignore]
async fn test_get_adl_quantile_btcusdt() {
    let client = build_client();
    // Some testnet deployments return {} (empty map) instead of [] when there are no positions,
    // which fails Vec<AdlQuantileResponse> deserialization. Treat SerdeError as "no positions".
    match client.get_adl_quantile(Some("BTCUSDT")).await {
        Ok(resp) => { let _ = resp.data; }
        Err(AsterDexError::SerdeError { .. }) => {
            eprintln!("get_adl_quantile: empty-object response (no open positions)");
        }
        Err(e) => panic!("unexpected error from get_adl_quantile: {e:?}"),
    }
}

// ===========================================================================
// SECTION 2 — Trading Queries (mostly read-only)
// ===========================================================================

/// Position risk for BTCUSDT: returns a list or 404 if endpoint not available on testnet.
#[tokio::test]
#[ignore]
async fn test_get_positions_btcusdt() {
    let client = build_client();
    match client.get_position_risk(Some("BTCUSDT")).await {
        Ok(resp) => { let _ = resp.data; }
        // Some testnet deployments don't expose /fapi/v3/positionRisk
        Err(AsterDexError::HttpError { status: 404, .. }) => {
            eprintln!("get_position_risk: 404 — endpoint not available on this testnet");
        }
        Err(e) => panic!("unexpected error from get_position_risk: {e:?}"),
    }
}

/// All orders (history) for BTCUSDT: returns a list.
#[tokio::test]
#[ignore]
async fn test_get_all_orders_btcusdt() {
    let client = build_client();
    let resp = client
        .get_all_orders(AllOrdersParams {
            symbol: "BTCUSDT".to_string(),
            limit: Some(5),
            ..Default::default()
        })
        .await
        .expect("get_all_orders failed");
    // May be empty on a fresh account
    let _ = resp.data;
}

/// Query a specific order by ID: place → get_order → cancel.
#[tokio::test]
#[ignore]
async fn test_get_order_by_id() {
    let client = build_client();
    let order_id = place_test_order(&client).await;

    let resp = client
        .get_order(GetOrderParams {
            symbol: "BTCUSDT".to_string(),
            order_id: Some(order_id),
            orig_client_order_id: None,
        })
        .await
        .expect("get_order failed");

    assert_eq!(resp.data.order_id, order_id);
    assert_eq!(resp.data.symbol, "BTCUSDT");

    cleanup_order(&client, order_id).await;
}

/// Query a specific open order by ID: place → get_open_order → cancel.
#[tokio::test]
#[ignore]
async fn test_get_open_order_by_id() {
    let client = build_client();
    let order_id = place_test_order(&client).await;

    let resp = client
        .get_open_order(GetOrderParams {
            symbol: "BTCUSDT".to_string(),
            order_id: Some(order_id),
            orig_client_order_id: None,
        })
        .await
        .expect("get_open_order failed");

    assert_eq!(resp.data.order_id, order_id);
    assert_eq!(resp.data.status, "NEW");

    cleanup_order(&client, order_id).await;
}

/// User trade history for BTCUSDT: returns a list or SerdeError if the endpoint
/// overlaps with the public trades endpoint on this testnet deployment.
#[tokio::test]
#[ignore]
async fn test_get_user_trades_btcusdt() {
    let client = build_client();
    // On some testnet builds /fapi/v3/trades returns public trade records regardless
    // of auth, causing a UserTrade deserialization failure (missing `symbol`, `side`, etc.).
    match client
        .get_user_trades(UserTradesParams {
            symbol: "BTCUSDT".to_string(),
            limit: Some(5),
            ..Default::default()
        })
        .await
    {
        Ok(resp) => { let _ = resp.data; }
        Err(AsterDexError::SerdeError { .. }) => {
            eprintln!("get_user_trades: serde error — testnet may return public trades at this endpoint");
        }
        Err(e) => panic!("unexpected error from get_user_trades: {e:?}"),
    }
}

/// Income history: returns a list (may be empty).
#[tokio::test]
#[ignore]
async fn test_get_income() {
    let client = build_client();
    let resp = client
        .get_income(IncomeParams {
            limit: Some(5),
            ..Default::default()
        })
        .await
        .expect("get_income failed");
    let _ = resp.data;
}

/// Force orders (liquidation history): returns raw JSON list.
#[tokio::test]
#[ignore]
async fn test_get_force_orders() {
    let client = build_client();
    let resp = client
        .get_force_orders(Some("BTCUSDT"), None, None, None, Some(5))
        .await
        .expect("get_force_orders failed");
    // Vec<serde_json::Value> — just verify it deserializes
    let _ = resp.data;
}

/// Position margin change history for BTCUSDT: returns raw JSON list.
#[tokio::test]
#[ignore]
async fn test_get_position_margin_history_btcusdt() {
    let client = build_client();
    let resp = client
        .get_position_margin_history("BTCUSDT", None, None, None, Some(5))
        .await
        .expect("get_position_margin_history failed");
    // Vec<serde_json::Value> — just verify it deserializes
    let _ = resp.data;
}

// ===========================================================================
// SECTION 3 — Settings
// ===========================================================================

/// Set leverage for BTCUSDT to 10×: verifies the response.
#[tokio::test]
#[ignore]
async fn test_set_leverage_btcusdt_10x() {
    let client = build_client();
    let resp = client
        .set_leverage("BTCUSDT", 10)
        .await
        .expect("set_leverage failed");
    assert_eq!(resp.data.symbol, "BTCUSDT");
    assert_eq!(resp.data.leverage, 10);
    assert!(!resp.data.max_notional_value.is_empty());

    // Restore to 20× so other tests are unaffected
    let _ = client.set_leverage("BTCUSDT", 20).await;
}

/// Set margin type to CROSSED: accepts success or -4046 (already in that mode).
#[tokio::test]
#[ignore]
async fn test_set_margin_type_crossed_btcusdt() {
    let client = build_client();
    match client.set_margin_type("BTCUSDT", "CROSSED").await {
        Ok(r) => assert_eq!(r.data.code, 200),
        // -4046: "No need to change margin type" — already CROSSED
        Err(AsterDexError::ApiError { code: -4046, .. }) => {}
        Err(e) => panic!("unexpected error: {e:?}"),
    }
}

/// noop endpoint: returns an empty response with no error.
#[tokio::test]
#[ignore]
async fn test_noop() {
    let client = build_client();
    client.noop().await.expect("noop failed");
}

/// Countdown cancel all (set to 0 = disable): safe idempotent operation.
#[tokio::test]
#[ignore]
async fn test_countdown_cancel_all_disable() {
    let client = build_client();
    let resp = client
        .countdown_cancel_all(CountdownParams {
            symbol: "BTCUSDT".to_string(),
            countdown_time: 0, // 0 = disable any active countdown
        })
        .await
        .expect("countdown_cancel_all failed");
    assert_eq!(resp.data.symbol, "BTCUSDT");
    assert_eq!(resp.data.countdown_time, 0);
}

// ===========================================================================
// SECTION 4 — Listen Key Lifecycle
// ===========================================================================

/// create → renew → delete: full listen key lifecycle.
#[tokio::test]
#[ignore]
async fn test_listen_key_lifecycle() {
    let client = build_client();

    // Create
    let create_resp = client
        .create_listen_key()
        .await
        .expect("create_listen_key failed");
    let listen_key = create_resp.data.listen_key.clone();
    assert!(!listen_key.is_empty(), "listen_key is empty");

    // Renew
    client
        .renew_listen_key(&listen_key)
        .await
        .expect("renew_listen_key failed");

    // Delete
    client
        .delete_listen_key(&listen_key)
        .await
        .expect("delete_listen_key failed");
}

/// Renew a non-existent listen key returns ApiError -1125.
#[tokio::test]
#[ignore]
async fn test_renew_invalid_listen_key_returns_error() {
    let client = build_client();
    let result = client.renew_listen_key("invalid_key_that_does_not_exist").await;
    assert!(
        matches!(result, Err(AsterDexError::ApiError { code: -1125, .. }))
            || result.is_err(),
        "expected error for invalid listen key, got Ok"
    );
}

// ===========================================================================
// SECTION 5 — Batch Orders
// ===========================================================================

/// Place 2 BTCUSDT LIMIT orders in a batch, verify both succeed, then cancel.
#[tokio::test]
async fn test_place_batch_orders_btcusdt() {
    let client = build_client();

    let orders = vec![
        PlaceOrderParams {
            symbol: "BTCUSDT".to_string(),
            side: "BUY".to_string(),
            order_type: "LIMIT".to_string(),
            quantity: "0.001".to_string(),
            price: Some("70000.0".to_string()),
            time_in_force: Some("GTC".to_string()),
            ..Default::default()
        },
        PlaceOrderParams {
            symbol: "BTCUSDT".to_string(),
            side: "BUY".to_string(),
            order_type: "LIMIT".to_string(),
            quantity: "0.001".to_string(),
            price: Some("9900.0".to_string()),
            time_in_force: Some("GTC".to_string()),
            ..Default::default()
        },
    ];

    let batch_resp = client.place_batch_orders(orders).await
        .expect("place_batch_orders failed");

    assert_eq!(batch_resp.data.len(), 2, "expected 2 batch results");
    let order_ids: Vec<i64> = batch_resp
        .data
        .iter()
        .filter_map(|r| r.order_id)
        .collect();
    assert_eq!(order_ids.len(), 2, "expected 2 successful order placements");

    let cancel_resp = client
        .cancel_batch_orders("BTCUSDT", order_ids)
        .await
        .expect("cancel_batch_orders failed");
    assert_eq!(cancel_resp.data.len(), 2, "expected 2 cancel results");
}

/// Attempting to place > 5 orders is rejected client-side before any network call.
#[tokio::test]
async fn test_place_batch_orders_exceeds_limit() {
    let client = build_client();
    let orders: Vec<PlaceOrderParams> = (0..6)
        .map(|_| PlaceOrderParams::default())
        .collect();
    let result = client.place_batch_orders(orders).await;
    assert!(
        matches!(result, Err(AsterDexError::InvalidParams { .. })),
        "expected InvalidParams for >5 orders, got: {result:?}"
    );
}

/// Cancel all open orders for BTCUSDT: returns code 200 even if none exist.
#[tokio::test]
#[ignore]
async fn test_cancel_all_open_orders_btcusdt() {
    let client = build_client();
    let resp = client
        .cancel_all_open_orders("BTCUSDT")
        .await
        .expect("cancel_all_open_orders failed");
    assert_eq!(resp.data.code, 200, "expected code 200, got: {}", resp.data.code);
}

// ===========================================================================
// SECTION 6 — MMP (Market Maker Protection)
// ===========================================================================

/// Get MMP for BTCUSDT: succeed or return an acceptable error if not available.
/// MMP endpoints may not be deployed on all testnet instances.
#[tokio::test]
#[ignore]
async fn test_get_mmp_btcusdt() {
    let client = build_client();
    match client.get_mmp(Some("BTCUSDT")).await {
        Ok(resp) => assert!(resp.data.iter().any(|m| m.symbol == "BTCUSDT")),
        Err(AsterDexError::ApiError { code, msg }) => {
            eprintln!("get_mmp ApiError {code}: {msg}");
        }
        // 404 = MMP endpoint not deployed on this testnet build
        Err(AsterDexError::HttpError { status: 404, .. }) => {
            eprintln!("get_mmp: 404 — MMP endpoint not available on this testnet");
        }
        Err(e) => panic!("unexpected error from get_mmp: {e:?}"),
    }
}

/// MMP lifecycle: update → get → delete → reset (gracefully handles unsupported accounts).
#[tokio::test]
#[ignore]
async fn test_mmp_lifecycle_btcusdt() {
    let client = build_client();

    let params = MmpUpdateParams {
        symbol: "BTCUSDT".to_string(),
        window_time_ms: 5_000,
        frozen_time_ms: 3_000,
        qty_limit: Some(100),
        value_limit: None,
        delta_limit: Some(50),
    };

    match client.update_mmp(params).await {
        Ok(_resp) => {
            // update_mmp returns bool (true on success)

            // Verify get_mmp reflects the update
            let get_resp = client
                .get_mmp(Some("BTCUSDT"))
                .await
                .expect("get_mmp after update failed");
            assert_eq!(get_resp.data[0].symbol, "BTCUSDT");

            // Cleanup: delete MMP config
            let _ = client.delete_mmp("BTCUSDT").await;
        }
        Err(AsterDexError::ApiError { code, msg }) => {
            eprintln!("update_mmp ApiError {code}: {msg} — MMP may not be available");
        }
        // 404 = MMP endpoint not deployed on this testnet build
        Err(AsterDexError::HttpError { status: 404, .. }) => {
            eprintln!("update_mmp: 404 — MMP endpoint not available on this testnet");
        }
        Err(e) => panic!("unexpected error from update_mmp: {e:?}"),
    }
}

// ===========================================================================
// SECTION 7 — Raw Passthrough Methods
// ===========================================================================

/// raw_signed_post on /fapi/v3/noop returns a JSON object (empty).
#[tokio::test]
#[ignore]
async fn test_raw_signed_post_noop() {
    let client = build_client();
    let resp = client
        .raw_signed_post("/fapi/v3/noop", &[])
        .await
        .expect("raw_signed_post noop failed");
    assert!(
        resp.data.is_object() || resp.data.is_null(),
        "expected object or null, got: {:?}",
        resp.data
    );
}

/// raw_signed_get on /fapi/v3/balance returns an array.
#[tokio::test]
#[ignore]
async fn test_raw_signed_get_balance() {
    let client = build_client();
    let resp = client
        .raw_signed_get("/fapi/v3/balance", &[])
        .await
        .expect("raw_signed_get balance failed");
    assert!(resp.data.is_array(), "expected array from /balance, got: {:?}", resp.data);
}

/// raw_signed_delete on a non-existent listen key returns ApiError (not a network error).
#[tokio::test]
#[ignore]
async fn test_raw_signed_delete_invalid_listen_key() {
    let client = build_client();
    let result = client
        .raw_signed_delete("/fapi/v3/listenKey", &[("listenKey", "nonexistent")])
        .await;
    // Should return an API error, not a network error
    assert!(
        matches!(result, Err(AsterDexError::ApiError { .. })) || result.is_ok(),
        "expected ApiError or Ok, got: {result:?}"
    );
}