rust-okx 0.6.4

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

use http::Method;

use crate::OkxClient;
use crate::test_util::MockTransport;

use super::super::{
    CurrencyRequest, FinanceHistoryRequest, SavingsPurchaseRedemptionRequest, SetLendingRateRequest,
};
use super::signed_client;

#[tokio::test]
async fn savings_balance_sends_signed_query() {
    let body = r#"{"code":"0","msg":"","data":[{"ccy":"USDT","amt":"1","loanAmt":"0","pendingAmt":"0","earnings":"0.001","rate":"0.01"}]}"#;
    let mock = MockTransport::new(body);
    let client = signed_client(mock.clone());

    let request = CurrencyRequest::new().currency("USDT");
    let rows = client
        .finance()
        .savings()
        .get_saving_balance(&request)
        .await
        .unwrap();
    assert_eq!(rows[0].ccy, "USDT");
    assert_eq!(rows[0].amt.as_str(), "1");

    let req = mock.captured();
    assert_eq!(req.method, Method::GET);
    assert!(
        req.uri
            .ends_with("/api/v5/finance/savings/balance?ccy=USDT")
    );
    assert!(req.is_signed());
}

#[tokio::test]
async fn purchase_redemption_posts_signed_body() {
    let body = r#"{"code":"0","msg":"","data":[{"ccy":"USDT","amt":"1","side":"purchase","rate":"0.01"}]}"#;
    let mock = MockTransport::new(body);
    let client = signed_client(mock.clone());
    let request = SavingsPurchaseRedemptionRequest::new("USDT", "1", "purchase").rate("0.01");

    let rows = client
        .finance()
        .savings()
        .purchase_redemption(&request)
        .await
        .unwrap();
    assert_eq!(rows[0].ccy, "USDT");
    assert_eq!(rows[0].side, "purchase");

    let req = mock.captured();
    assert_eq!(req.method, Method::POST);
    assert!(
        req.uri
            .ends_with("/api/v5/finance/savings/purchase-redempt")
    );
    let sent: serde_json::Value = serde_json::from_str(req.body_str()).unwrap();
    assert_eq!(sent["ccy"], "USDT");
    assert_eq!(sent["amt"], "1");
    assert_eq!(sent["side"], "purchase");
    assert_eq!(sent["rate"], "0.01");
    assert!(req.is_signed());
}

#[tokio::test]
async fn set_lending_rate_posts_signed_body() {
    let body = r#"{"code":"0","msg":"","data":[{"ccy":"USDT","rate":"0.02"}]}"#;
    let mock = MockTransport::new(body);
    let client = signed_client(mock.clone());

    let request = SetLendingRateRequest::new("USDT", "0.02");
    let rows = client
        .finance()
        .savings()
        .set_lending_rate(&request)
        .await
        .unwrap();
    assert_eq!(rows[0].ccy, "USDT");
    assert_eq!(rows[0].rate.as_str(), "0.02");

    let req = mock.captured();
    assert_eq!(req.method, Method::POST);
    assert!(
        req.uri
            .ends_with("/api/v5/finance/savings/set-lending-rate")
    );
    let sent: serde_json::Value = serde_json::from_str(req.body_str()).unwrap();
    assert_eq!(sent["ccy"], "USDT");
    assert_eq!(sent["rate"], "0.02");
    assert!(req.is_signed());
}

#[tokio::test]
async fn get_lending_history_uses_builder_query() {
    let body = r#"{"code":"0","msg":"","data":[{"ccy":"USDT","amt":"1","earnings":"0.001","rate":"0.01","ts":"1597026383085"}]}"#;
    let mock = MockTransport::new(body);
    let client = signed_client(mock.clone());
    let request = FinanceHistoryRequest::new().currency("USDT").limit(5);

    let rows = client
        .finance()
        .savings()
        .get_lending_history(&request)
        .await
        .unwrap();
    assert_eq!(rows[0].ccy, "USDT");
    assert_eq!(rows[0].ts.as_str(), "1597026383085");

    let req = mock.captured();
    assert_eq!(req.method, Method::GET);
    assert_eq!(req.query(), Some("ccy=USDT&limit=5"));
    assert!(req.is_signed());
}

#[tokio::test]
async fn get_public_borrow_history_is_not_signed() {
    let body = r#"{"code":"0","msg":"","data":[{"ccy":"USDT","amt":"1000","rate":"0.0001","ts":"1597026383085"}]}"#;
    let mock = MockTransport::new(body);
    let client = OkxClient::with_transport(mock.clone()).build();
    let request = FinanceHistoryRequest::new().currency("USDT").limit(1);

    let rows = client
        .finance()
        .savings()
        .get_public_borrow_history(&request)
        .await
        .unwrap();
    assert_eq!(rows[0].ccy, "USDT");
    assert_eq!(rows[0].rate.as_str(), "0.0001");

    let req = mock.captured();
    assert_eq!(req.method, Method::GET);
    assert_eq!(req.query(), Some("ccy=USDT&limit=1"));
    assert!(!req.is_signed(), "public endpoint must not be signed");
}

#[tokio::test]
async fn get_public_borrow_info_omits_currency_when_absent() {
    let body = r#"{"code":"0","msg":"","data":[{"ccy":"USDT","avgAmt":"5000","avgRate":"0.0002","preRate":"0.0001"}]}"#;
    let mock = MockTransport::new(body);
    let client = OkxClient::with_transport(mock.clone()).build();

    let rows = client
        .finance()
        .savings()
        .get_public_borrow_info(&CurrencyRequest::default())
        .await
        .unwrap();
    assert_eq!(rows[0].ccy, "USDT");
    assert_eq!(rows[0].avg_amt.as_str(), "5000");

    let req = mock.captured();
    assert_eq!(req.method, Method::GET);
    assert!(
        req.uri
            .ends_with("/api/v5/finance/savings/lending-rate-summary")
    );
    assert_eq!(req.query(), None);
    assert!(!req.is_signed(), "public endpoint must not be signed");
}