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

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

use super::AnnouncementsRequest;

const ANNOUNCEMENTS_RESPONSE: &str = r#"{
    "code": "0",
    "msg": "",
    "data": [{
        "details": [
            {
                "annType": "announcements-new-listings",
                "title": "OKX to list Virtuals Protocol (VIRTUAL) for spot trading",
                "url": "https://www.okx.com/help/okx-to-list-virtuals-protocol-virtual-for-spot-trading",
                "pTime": "1761620404821",
                "businessPTime": "1761620400000"
            },
            {
                "annType": "announcements-web3",
                "title": "Completion of X Layer Mainnet Upgrade",
                "url": "https://www.okx.com/help/completion-of-x-layer-mainnet-upgrade",
                "pTime": "1761582756071",
                "businessPTime": "1761580800000"
            }
        ],
        "totalPage": "123"
    }]
}"#;

const TYPES_RESPONSE: &str = r#"{
    "code": "0",
    "msg": "",
    "data": [
        {"annType": "announcements-new-listings", "annTypeDesc": "New listings"},
        {"annType": "announcements-delistings",   "annTypeDesc": "Delistings"}
    ]
}"#;

#[tokio::test]
async fn get_announcements_no_filter_parses_response() {
    let mock = MockTransport::new(ANNOUNCEMENTS_RESPONSE);
    let client = OkxClient::with_transport(mock.clone()).build();

    let pages = client
        .support()
        .get_announcements(&AnnouncementsRequest::default())
        .await
        .unwrap();

    assert_eq!(pages.len(), 1);
    assert_eq!(pages[0].total_page, "123");
    assert_eq!(pages[0].details.len(), 2);
    assert_eq!(pages[0].details[0].ann_type, "announcements-new-listings");
    assert_eq!(
        pages[0].details[0].title,
        "OKX to list Virtuals Protocol (VIRTUAL) for spot trading"
    );
    assert_eq!(pages[0].details[0].p_time.as_str(), "1761620404821");
    assert_eq!(
        pages[0].details[0].business_p_time.as_str(),
        "1761620400000"
    );

    let req = mock.captured();
    assert_eq!(req.method, http::Method::GET);
    assert_eq!(req.query(), None);
    assert!(!req.is_signed());
}

#[tokio::test]
async fn get_announcements_with_filters_builds_query() {
    let mock = MockTransport::new(ANNOUNCEMENTS_RESPONSE);
    let client = OkxClient::with_transport(mock.clone()).build();

    client
        .support()
        .get_announcements(
            &AnnouncementsRequest::new()
                .announcement_type("announcements-new-listings")
                .page(2),
        )
        .await
        .unwrap();

    let req = mock.captured();
    assert_eq!(
        req.query(),
        Some("annType=announcements-new-listings&page=2")
    );
    assert!(!req.is_signed());
}

#[tokio::test]
async fn get_announcement_types_parses_response() {
    let mock = MockTransport::new(TYPES_RESPONSE);
    let client = OkxClient::with_transport(mock.clone()).build();

    let types = client.support().get_announcement_types().await.unwrap();

    assert_eq!(types.len(), 2);
    assert_eq!(types[0].ann_type, "announcements-new-listings");
    assert_eq!(types[0].ann_type_desc, "New listings");
    assert_eq!(types[1].ann_type, "announcements-delistings");

    let req = mock.captured();
    assert_eq!(req.method, http::Method::GET);
    assert_eq!(req.query(), None);
    assert!(!req.is_signed());
}