dydx 0.3.0

dYdX v4 asynchronous client.
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

use super::*;
use anyhow::Error;

/// Other data dispatcher.
///
/// Check [the example](https://github.com/dydxprotocol/v4-clients/blob/main/v4-client-rs/client/examples/utility_endpoint.rs).
pub struct Utility<'a> {
    rest: &'a RestClient,
}

impl<'a> Utility<'a> {
    /// Create a new utility dispatcher.
    pub(crate) fn new(rest: &'a RestClient) -> Self {
        Self { rest }
    }

    /// Current server time (UTC) of Indexer.
    ///
    /// [Reference](https://docs.dydx.xyz/indexer-client/http#get-time).
    pub async fn get_time(&self) -> Result<TimeResponse, Error> {
        let rest = &self.rest;
        const URI: &str = "/v4/time";
        let url = format!("{}{URI}", rest.config.endpoint);
        let resp = rest
            .client
            .get(url)
            .send()
            .await?
            .error_for_status()?
            .json()
            .await?;
        Ok(resp)
    }

    /// Current block height and block time (UTC) parsed by Indexer.
    ///
    /// [Reference](https://docs.dydx.xyz/indexer-client/http#get-height).
    pub async fn get_height(&self) -> Result<HeightResponse, Error> {
        let rest = &self.rest;
        const URI: &str = "/v4/height";
        let url = format!("{}{URI}", rest.config.endpoint);
        let resp = rest
            .client
            .get(url)
            .send()
            .await?
            .error_for_status()?
            .json()
            .await?;
        Ok(resp)
    }

    /// Query for screening results (compliance) of the address.
    ///
    /// [Reference](https://docs.dydx.xyz/indexer-client/http#get-screen).
    #[deprecated(since = "0.3.0", note = "Use `screen` instead")]
    pub async fn get_screen(&self, query: &Address) -> Result<ComplianceResponse, Error> {
        self.screen(query).await
    }

    /// Query for screening results (compliance) of the address.
    ///
    /// [Reference](https://docs.dydx.xyz/indexer-client/http#get-screen).
    pub async fn screen(&self, query: &Address) -> Result<ComplianceResponse, Error> {
        let rest = &self.rest;
        const URI: &str = "/v4/screen";
        let url = format!("{}{URI}", rest.config.endpoint);
        let resp = rest
            .client
            .get(url)
            .query(&[("address", query)])
            .send()
            .await?
            .error_for_status()?
            .json()
            .await?;
        Ok(resp)
    }

    /// Screens an address to determine if it is restricted.
    ///
    /// [Reference](https://docs.dydx.xyz/indexer-client/http#get-compliance-screen).
    pub async fn compliance_screen(
        &self,
        address: &Address,
    ) -> Result<ComplianceV2Response, Error> {
        let rest = &self.rest;
        const URI: &str = "/v4/compliance/screen";
        let url = format!("{}{URI}/{address}", rest.config.endpoint);
        let resp = rest
            .client
            .get(url)
            .send()
            .await?
            .error_for_status()?
            .json()
            .await?;
        Ok(resp)
    }
}