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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

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

const URI: &str = "/v4/affiliates";

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

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

    /// Get affiliate metadata.
    pub async fn get_metadata(
        &self,
        address: &Address,
    ) -> Result<AffiliateMetadataResponse, Error> {
        let rest = &self.rest;
        let url = format!("{}{URI}/metadata", rest.config.endpoint);
        let resp = rest
            .client
            .get(url)
            .query(&[("address", address.to_string())])
            .send()
            .await?
            .error_for_status()?
            .json()
            .await?;
        Ok(resp)
    }

    /// Get affiliate address.
    pub async fn get_address(
        &self,
        referral_code: &str,
    ) -> Result<AffiliateAddressResponse, Error> {
        let rest = &self.rest;
        let url = format!("{}{URI}/address", rest.config.endpoint);
        let resp = rest
            .client
            .get(url)
            .query(&[("referralCode", referral_code.to_string())])
            .send()
            .await?
            .error_for_status()?
            .json()
            .await?;
        Ok(resp)
    }

    /// Get affiliate snapshot.
    pub async fn get_snapshot(
        &self,
        address_filter: Option<&[&Address]>,
        sort_by_affiliate_earnings: Option<bool>,
        pagination: Option<PaginationRequest>,
    ) -> Result<AffiliateSnapshotResponse, Error> {
        let rest = &self.rest;
        let url = format!("{}{URI}/snapshot", rest.config.endpoint);
        let pagination = pagination.unwrap_or_default();
        let sort_by_affiliate_earnings = sort_by_affiliate_earnings.unwrap_or(false);

        let mut query = vec![];

        if sort_by_affiliate_earnings {
            query.push(("sortByAffiliateEarnings", "true".to_string()));
        }

        if let Some(address_filter) = address_filter {
            let address_filter = address_filter
                .iter()
                .map(|a| a.to_string())
                .collect::<Vec<String>>()
                .join(",");
            query.push(("addressFilter", address_filter));
        }

        let resp = rest
            .client
            .get(url)
            .query(&query)
            .query(&pagination)
            .send()
            .await?
            .error_for_status()?
            .json()
            .await?;
        Ok(resp)
    }

    /// Get affiliate total volume.
    pub async fn get_total_volume(
        &self,
        address: &Address,
    ) -> Result<AffiliateTotalVolumeResponse, Error> {
        let rest = &self.rest;
        let url = format!("{}{URI}/total_volume", rest.config.endpoint);
        let resp = rest
            .client
            .get(url)
            .query(&[("address", address.to_string())])
            .send()
            .await?
            .error_for_status()?
            .json()
            .await?;
        Ok(resp)
    }
}