stellar-client 0.1.2

A client interface to the stellar Horizon 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

//! Contains the endpoint for fetching the orderbook for a given asset pair
use super::{Body, IntoRequest, Limit};
use error::Result;
use http::{Request, Uri};
use resources::{AssetIdentifier, Orderbook};
use std::str::FromStr;

/// Given an asset pair, the endpoint will return all bids and asks with an optional
/// limit parameter to cap the number of records returned.
///
/// <https://www.stellar.org/developers/horizon/reference/endpoints/orderbook-details.html>
///
/// ## Example
/// ```
/// use stellar_client::sync::Client;
/// use stellar_client::endpoint::{orderbook, trade, Limit};
///
/// let client = Client::horizon_test().unwrap();
///
/// // Grab a trade so we can get two valid assets.
/// let endpoint = trade::All::default().with_limit(1);
/// let records = client.request(endpoint).unwrap();
/// let trade = &records.records()[0];
/// let asset1 = trade.base_asset().clone();
/// let asset2 = trade.counter_asset().clone();
/// let orderbook_ep = orderbook::Details::for_asset_pair(asset1, asset2);
/// let orderbook   = client.request(orderbook_ep).unwrap();
///
/// assert_eq!(orderbook.base(), trade.base_asset());
/// ```
#[derive(Debug)]
pub struct Details {
    base_asset: AssetIdentifier,
    counter_asset: AssetIdentifier,
    limit: Option<u32>,
}

impl_limit!(Details);

impl Details {
    /// Creates a new orderbook::Details endpoint struct. Hand this to the client in order to request
    /// information about all bids and asks for an asset pair.
    ///
    /// ```
    /// use stellar_client::endpoint::orderbook;
    /// use stellar_client::resources::AssetIdentifier;
    ///
    /// let base = AssetIdentifier::native();
    /// let counter = AssetIdentifier::native();
    ///
    /// let details = orderbook::Details::for_asset_pair(base, counter);
    /// ```
    pub fn for_asset_pair(base: AssetIdentifier, counter: AssetIdentifier) -> Self {
        Self {
            base_asset: base,
            counter_asset: counter,
            limit: None,
        }
    }
}

impl IntoRequest for Details {
    type Response = Orderbook;

    fn into_request(self, host: &str) -> Result<Request<Body>> {
        let mut uri_str = format!("{}/order_book?", host);

        uri_str.push_str(&format!(
            "selling_asset_type={}",
            self.base_asset.asset_type()
        ));
        if !self.base_asset.is_native() {
            uri_str.push_str(&format!(
                "&selling_asset_code={}",
                self.base_asset.asset_code().unwrap()
            ));
            uri_str.push_str(&format!(
                "&selling_asset_issuer={}",
                self.base_asset.asset_issuer().unwrap()
            ));
        }

        uri_str.push_str(&format!(
            "&buying_asset_type={}",
            self.counter_asset.asset_type()
        ));
        if !self.counter_asset.is_native() {
            uri_str.push_str(&format!(
                "&buying_asset_code={}",
                self.counter_asset.asset_code().unwrap()
            ));
            uri_str.push_str(&format!(
                "&buying_asset_issuer={}",
                self.counter_asset.asset_issuer().unwrap()
            ));
        }

        if let Some(limit) = self.limit {
            uri_str.push_str(&format!("&limit={}", limit));
        }

        let uri = Uri::from_str(&uri_str)?;
        let request = Request::get(uri).body(Body::None)?;
        Ok(request)
    }
}

#[cfg(test)]
mod details_tests {
    use super::*;

    #[test]
    fn it_can_make_an_account_uri() {
        let xlm = AssetIdentifier::native();
        let foxcoin = AssetIdentifier::alphanum4("USD", "FantasticMrFox");
        let details = Details::for_asset_pair(xlm, foxcoin);
        let request = details
            .into_request("https://horizon-testnet.stellar.org")
            .unwrap();
        assert_eq!(request.uri().host().unwrap(), "horizon-testnet.stellar.org");
        assert_eq!(request.uri().path(), "/order_book");
        assert_eq!(request.uri().query().unwrap(), "selling_asset_type=native&buying_asset_type=credit_alphanum4&buying_asset_code=USD&buying_asset_issuer=FantasticMrFox");
    }
}