lnm-sdk 0.4.2

Rust SDK for interacting with LN Markets.
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
use std::{env, time::Instant};

use dotenv::dotenv;

use crate::shared::models::{
    margin::Margin,
    price::{Percentage, PercentageCapped},
    quantity::Quantity,
};

use super::super::{
    super::{
        config::RestClientConfig,
        models::{client_id::ClientId, ticker::Ticker},
        repositories::FuturesDataRepository,
    },
    futures_data::LnmFuturesDataRepository,
};

use super::*;

fn init_repositories_from_env() -> (LnmFuturesIsolatedRepository, LnmFuturesDataRepository) {
    dotenv().ok();

    let domain =
        env::var("LNM_API_DOMAIN").expect("LNM_API_DOMAIN environment variable must be set");
    let key = env::var("LNM_API_V3_KEY").expect("LNM_API_V3_KEY environment variable must be set");
    let secret =
        env::var("LNM_API_V3_SECRET").expect("LNM_API_V3_SECRET environment variable must be set");
    let passphrase = env::var("LNM_API_V3_PASSPHRASE")
        .expect("LNM_API_V3_PASSPHRASE environment variable must be set");

    let base = LnmRestBase::with_credentials(
        RestClientConfig::default().timeout(),
        domain,
        key,
        passphrase,
        SignatureGeneratorV3::new(secret),
        None,
    )
    .expect("Can create `LnmApiBase`");

    (
        LnmFuturesIsolatedRepository::new(base.clone()),
        LnmFuturesDataRepository::new(base),
    )
}

async fn test_create_short_trade_quantity_limit(
    repo: &LnmFuturesIsolatedRepository,
    ticker: &Ticker,
) -> Trade {
    let side = TradeSide::Sell;
    let quantity = Quantity::try_from(1).unwrap();
    let leverage = Leverage::try_from(1).unwrap();
    let discount_percentage = PercentageCapped::try_from(30).unwrap();
    let out_of_mkt_price = ticker
        .last_price()
        .apply_discount(discount_percentage)
        .unwrap();
    let execution = out_of_mkt_price.into();
    let stoploss = None;
    let takeprofit = None;
    let client_id = ClientId::try_from("test-id").ok();

    let created_trade = repo
        .new_trade(
            side,
            quantity.into(),
            leverage,
            execution,
            stoploss,
            takeprofit,
            client_id.clone(),
        )
        .await
        .expect("must create trade");

    assert_eq!(created_trade.trade_type(), execution.to_type());
    assert_eq!(created_trade.side(), side);
    assert_eq!(created_trade.quantity(), quantity);
    assert_eq!(created_trade.leverage(), leverage);
    assert_eq!(created_trade.price(), out_of_mkt_price);
    assert_eq!(created_trade.stoploss(), stoploss);
    assert_eq!(created_trade.takeprofit(), takeprofit);

    assert!(created_trade.open());
    assert!(!created_trade.running());
    assert!(!created_trade.closed());
    assert!(!created_trade.canceled());

    assert_eq!(created_trade.opening_fee(), 0);
    assert_eq!(created_trade.closing_fee(), 0);

    assert!(created_trade.filled_at().is_none());
    assert!(created_trade.closed_at().is_none());
    assert!(created_trade.exit_price().is_none());
    assert_eq!(created_trade.client_id(), client_id.as_ref());

    created_trade
}

async fn test_create_long_trade_margin_limit(
    repo: &LnmFuturesIsolatedRepository,
    ticker: &Ticker,
) -> Trade {
    let side = TradeSide::Buy;

    let leverage = Leverage::try_from(1).unwrap();
    let discount_percentage = PercentageCapped::try_from(30).unwrap();
    let out_of_mkt_price = ticker
        .last_price()
        .apply_discount(discount_percentage)
        .unwrap();
    let implied_qtd = Quantity::try_from(1).unwrap();
    let margin = Margin::calculate(implied_qtd, out_of_mkt_price, leverage);
    let discount = PercentageCapped::try_from(5).unwrap();
    let stoploss = Some(out_of_mkt_price.apply_discount(discount).unwrap());
    let takeprofit = None;
    let execution = out_of_mkt_price.into();
    let client_id = None;

    let created_trade = repo
        .new_trade(
            side,
            margin.into(),
            leverage,
            execution,
            stoploss,
            takeprofit,
            client_id,
        )
        .await
        .expect("must create trade");

    assert_eq!(created_trade.trade_type(), execution.to_type());
    assert_eq!(created_trade.side(), side);
    assert_eq!(created_trade.margin(), margin);
    assert_eq!(created_trade.leverage(), leverage);
    assert_eq!(created_trade.price(), out_of_mkt_price);
    assert_eq!(created_trade.stoploss(), stoploss);
    assert_eq!(created_trade.takeprofit(), takeprofit);

    assert!(created_trade.open());
    assert!(!created_trade.running());
    assert!(!created_trade.closed());
    assert!(!created_trade.canceled());

    assert_eq!(created_trade.opening_fee(), 0);
    assert_eq!(created_trade.closing_fee(), 0);

    assert!(created_trade.filled_at().is_none());
    assert!(created_trade.closed_at().is_none());
    assert!(created_trade.exit_price().is_none());

    created_trade
}

async fn test_get_trades_open(repo: &LnmFuturesIsolatedRepository, exp_open_trades: Vec<&Trade>) {
    let open_trades = repo.get_open_trades().await.expect("must get trades");

    assert_eq!(open_trades.len(), exp_open_trades.len());

    for open_trade in &open_trades {
        let ok = exp_open_trades
            .iter()
            .any(|exp| exp.id() == open_trade.id());
        assert!(ok, "open trade {} was not returned", open_trade.id());
    }
}

async fn test_update_trade_stoploss(repo: &LnmFuturesIsolatedRepository, id: Uuid, price: Price) {
    let gain = Percentage::try_from(5).unwrap();
    let stoploss = Some(price.apply_gain(gain).unwrap());
    let updated_trade = repo
        .update_stoploss(id, stoploss)
        .await
        .expect("must update trade");

    assert_eq!(updated_trade.id(), id);
    assert_eq!(updated_trade.stoploss(), stoploss);
}

async fn test_update_trade_takeprofit(repo: &LnmFuturesIsolatedRepository, id: Uuid, price: Price) {
    let gain = Percentage::try_from(5).unwrap();
    let takeprofit = Some(price.apply_gain(gain).unwrap());
    let updated_trade = repo
        .update_takeprofit(id, takeprofit)
        .await
        .expect("must update trade");

    assert_eq!(updated_trade.id(), id);
    assert_eq!(updated_trade.takeprofit(), takeprofit);
}

async fn test_cancel_trade(repo: &LnmFuturesIsolatedRepository, id: Uuid) {
    let canceled_trade = repo.cancel_trade(id).await.expect("must cancel trade");

    assert_eq!(canceled_trade.id(), id);
    assert!(!canceled_trade.open());
    assert!(!canceled_trade.running());
    assert!(!canceled_trade.closed());
    assert!(canceled_trade.canceled());
}

async fn test_cancel_all_trades(repo: &LnmFuturesIsolatedRepository, exp_open_trades: Vec<&Trade>) {
    let cancelled_trades = repo.cancel_all_trades().await.expect("must cancel trades");

    assert_eq!(cancelled_trades.len(), exp_open_trades.len());

    for open_trade in &exp_open_trades {
        let cancelled = cancelled_trades
            .iter()
            .any(|cancelled| cancelled.id() == open_trade.id());
        assert!(cancelled, "trade {} was not cancelled", open_trade.id());
    }
}

async fn test_get_trades_canceled(
    repo: &LnmFuturesIsolatedRepository,
    exp_canceled_trades: Vec<&Trade>,
) {
    let limit = Some(NonZeroU64::try_from(exp_canceled_trades.len() as u64).unwrap());
    let canceled_trades = repo
        .get_canceled_trades(None, None, limit, None)
        .await
        .expect("must get trades");

    assert_eq!(canceled_trades.data().len(), exp_canceled_trades.len());

    for trade in canceled_trades.data() {
        let ok = exp_canceled_trades.iter().any(|exp| exp.id() == trade.id());
        assert!(ok, "canceled trade {} was not returned", trade.id());
    }
}

async fn test_create_long_trade_quantity_market(
    repo: &LnmFuturesIsolatedRepository,
    ticker: &Ticker,
) -> Trade {
    let side = TradeSide::Buy;
    let quantity = Quantity::try_from(1).unwrap();
    let leverage = Leverage::try_from(2).unwrap();
    let est_price = ticker.last_price();
    let range_percentage = PercentageCapped::try_from(10).unwrap();
    let stoploss = Some(est_price.apply_discount(range_percentage).unwrap());
    let takeprofit = Some(est_price.apply_gain(range_percentage.into()).unwrap());
    let execution = TradeExecution::Market;
    let client_id = None;

    let created_trade = repo
        .new_trade(
            side,
            quantity.into(),
            leverage,
            execution,
            stoploss,
            takeprofit,
            client_id,
        )
        .await
        .expect("must create trade");

    assert_eq!(created_trade.trade_type(), execution.to_type());
    assert_eq!(created_trade.side(), side);
    assert_eq!(created_trade.quantity(), quantity);
    assert_eq!(created_trade.leverage(), leverage);
    assert_eq!(created_trade.stoploss(), stoploss);
    assert_eq!(created_trade.takeprofit(), takeprofit);

    assert!(!created_trade.open());
    assert!(created_trade.running());
    assert!(!created_trade.closed());
    assert!(!created_trade.canceled());

    assert!(created_trade.opening_fee() > 0);
    assert_eq!(created_trade.closing_fee(), 0);

    assert!(created_trade.filled_at().is_some());
    assert!(created_trade.closed_at().is_none());
    assert!(created_trade.exit_price().is_none());

    created_trade
}

async fn test_add_margin(repo: &LnmFuturesIsolatedRepository, trade: Trade) -> Trade {
    assert!(trade.leverage().as_f64() > 1.6);

    let target_leverage = Leverage::try_from(1.5).unwrap();
    let target_margin = Margin::calculate(trade.quantity(), trade.price(), target_leverage);
    let amount = target_margin.as_u64() - trade.margin().as_u64();
    let amount = amount.try_into().unwrap();

    let updated_trade = repo
        .add_margin_to_trade(trade.id(), amount)
        .await
        .expect("must add margin");

    assert_eq!(updated_trade.id(), trade.id());
    assert_eq!(updated_trade.margin(), target_margin);
    assert!(updated_trade.leverage() < trade.leverage());

    updated_trade
}

async fn test_cash_in(repo: &LnmFuturesIsolatedRepository, trade: Trade) -> Trade {
    assert!(trade.leverage().as_f64() < 1.9);

    let target_leverage = Leverage::try_from(2).unwrap();
    let target_margin = Margin::calculate(trade.quantity(), trade.price(), target_leverage);
    let amount = trade.margin().as_u64() - target_margin.as_u64() + trade.pl().max(0) as u64;
    let amount = amount.try_into().unwrap();

    let updated_trade = repo
        .cash_in_trade(trade.id(), amount)
        .await
        .expect("must cash-in");

    assert_eq!(updated_trade.id(), trade.id());
    assert!(updated_trade.leverage() > trade.leverage());

    updated_trade
}

async fn test_create_short_trade_margin_market(
    repo: &LnmFuturesIsolatedRepository,
    ticker: &Ticker,
) -> Trade {
    let discount = PercentageCapped::try_from(5).unwrap();
    let est_min_price = ticker.last_price().apply_discount(discount).unwrap();

    let side = TradeSide::Sell;
    let leverage = Leverage::try_from(1).unwrap();
    let implied_qtd = Quantity::try_from(1).unwrap();
    let margin = Margin::calculate(implied_qtd, est_min_price, leverage);
    let est_price = ticker.last_price();
    let range = PercentageCapped::try_from(10).unwrap();
    let stoploss = Some(est_price.apply_gain(range.into()).unwrap());
    let takeprofit = Some(est_price.apply_discount(range).unwrap());
    let execution = TradeExecution::Market;
    let client_id = None;

    let created_trade = repo
        .new_trade(
            side,
            margin.into(),
            leverage,
            execution,
            stoploss,
            takeprofit,
            client_id,
        )
        .await
        .expect("must create trade");

    assert_eq!(created_trade.trade_type(), execution.to_type());
    assert_eq!(created_trade.side(), side);
    assert_eq!(created_trade.margin(), margin);
    assert_eq!(created_trade.leverage(), leverage);
    assert_eq!(created_trade.stoploss(), stoploss);
    assert_eq!(created_trade.takeprofit(), takeprofit);

    assert!(!created_trade.open());
    assert!(created_trade.running());
    assert!(!created_trade.closed());
    assert!(!created_trade.canceled());

    assert!(created_trade.opening_fee() > 0);
    assert_eq!(created_trade.closing_fee(), 0);

    assert!(created_trade.filled_at().is_some());
    assert!(created_trade.closed_at().is_none());
    assert!(created_trade.exit_price().is_none());

    created_trade
}

async fn test_get_trades_running(
    repo: &LnmFuturesIsolatedRepository,
    exp_running_trades: Vec<&Trade>,
) {
    let running_trades = repo.get_running_trades().await.expect("must get trades");

    assert_eq!(running_trades.len(), exp_running_trades.len());

    for trade in &running_trades {
        let ok = exp_running_trades.iter().any(|exp| exp.id() == trade.id());
        assert!(ok, "running trade {} was not returned", trade.id());
    }
}

async fn test_close_trade(repo: &LnmFuturesIsolatedRepository, id: Uuid) {
    let closed_trade = repo.close_trade(id).await.expect("must close trade");

    assert_eq!(closed_trade.id(), id);
    assert!(!closed_trade.open());
    assert!(!closed_trade.running());
    assert!(closed_trade.closed());
    assert!(!closed_trade.canceled());
}

async fn test_get_trades_closed(
    repo: &LnmFuturesIsolatedRepository,
    exp_closed_trades: Vec<&Trade>,
) {
    let limit = Some(NonZeroU64::try_from(exp_closed_trades.len() as u64).unwrap());
    let closed_trades = repo
        .get_closed_trades(None, None, limit, None)
        .await
        .expect("must get trades");

    assert_eq!(closed_trades.data().len(), exp_closed_trades.len());

    for trade in closed_trades.data() {
        let ok = exp_closed_trades.iter().any(|exp| exp.id() == trade.id());
        assert!(ok, "closed trade {} was not returned", trade.id());
    }
}

async fn test_get_funding_fees(repo: &LnmFuturesIsolatedRepository) {
    let _ = repo
        .get_funding_fees(None, None, None, None)
        .await
        .expect("must get funding fees");
}

#[tokio::test]
#[ignore]
async fn test_api() {
    let (repo, repo_data) = init_repositories_from_env();

    macro_rules! time_test {
        ($test_name: expr, $test_block: expr) => {{
            println!("\nStarting test: {}", $test_name);
            let start = Instant::now();
            let result = $test_block;
            let elapsed = start.elapsed();
            println!("Test '{}' took: {:?}", $test_name, elapsed);
            result
        }};
    }

    // Initial clean-up

    time_test!(
        "cancel_all_trades (cleanup)",
        repo.cancel_all_trades().await.expect("must cancel trades")
    );

    // Start tests

    let ticker: Ticker = repo_data.get_ticker().await.expect("must get ticker");

    let short_limit_trade_a = time_test!(
        "test_create_short_trade_quantity_limit",
        test_create_short_trade_quantity_limit(&repo, &ticker).await
    );

    let long_limit_trade_b = time_test!(
        "test_create_long_trade_margin_limit",
        test_create_long_trade_margin_limit(&repo, &ticker).await
    );

    time_test!(
        "test_get_trades_open",
        test_get_trades_open(&repo, vec![&short_limit_trade_a, &long_limit_trade_b]).await
    );

    time_test!(
        "test_update_trade_stoploss",
        test_update_trade_stoploss(&repo, short_limit_trade_a.id(), short_limit_trade_a.price())
            .await
    );

    time_test!(
        "test_update_trade_takeprofit",
        test_update_trade_takeprofit(&repo, long_limit_trade_b.id(), long_limit_trade_b.price())
            .await
    );

    time_test!(
        "test_cancel_trade",
        test_cancel_trade(&repo, short_limit_trade_a.id()).await
    );

    time_test!(
        "test_cancel_all_trades",
        test_cancel_all_trades(&repo, vec![&long_limit_trade_b]).await
    );

    time_test!(
        "test_get_trades_canceled",
        test_get_trades_canceled(&repo, vec![&short_limit_trade_a, &long_limit_trade_b]).await
    );

    let long_market_trade_a = time_test!(
        "test_create_long_trade_quantity_market",
        test_create_long_trade_quantity_market(&repo, &ticker).await
    );

    let long_market_trade_a = time_test!(
        "test_add_margin",
        test_add_margin(&repo, long_market_trade_a).await
    );

    let long_market_trade_a = time_test!(
        "test_cash_in",
        test_cash_in(&repo, long_market_trade_a).await
    );

    let short_market_trade_b = time_test!(
        "test_create_short_trade_margin_market",
        test_create_short_trade_margin_market(&repo, &ticker).await
    );

    time_test!(
        "test_get_trades_running",
        test_get_trades_running(&repo, vec![&long_market_trade_a, &short_market_trade_b]).await
    );

    time_test!(
        "test_close_trade",
        test_close_trade(&repo, long_market_trade_a.id()).await
    );

    time_test!(
        "test_close_trade",
        test_close_trade(&repo, short_market_trade_b.id()).await
    );

    time_test!(
        "test_get_trades_closed",
        test_get_trades_closed(&repo, vec![&long_market_trade_a, &short_market_trade_b]).await
    );

    time_test!("test_get_funding_fees", test_get_funding_fees(&repo).await);
}