kraapi 0.2.1

Asynchronous HTTP client for the Kraken Cryptocurrency Exchange
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

use indexmap::map::IndexMap;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

use crate::auth::KrakenAuth;
// Structs/Enums
use super::{EndpointInfo, KrakenInput, MethodType};

// Traits
use super::{Input, InputList, InputListItem, IntoInputList, MutateInput, Output, UpdateInput};

pub use super::KOOrderDescription;
pub use super::KOOrderInfo;
pub use super::KOOrderStatus;

/// Request builder for the Query Orders Info endpoint
pub struct KIQueryOrders {
    params: IndexMap<String, String>,
}

impl KIQueryOrders {
    /// Constructor returning a [KrakenInput] builder for the query orders info endpoint.
    /// * `txid` is the transaction ID to query order info for
    pub fn build(txid: String) -> Self {
        let order_info = KIQueryOrders {
            params: IndexMap::new(),
        };
        order_info.with_item(txid)
    }

    /// Constructor returning a [KrakenInput] builder for the query orders info endpoint.
    /// * `txids` is any iterable collection of transaction IDs to query order info for
    pub fn build_with_list<T>(txids: T) -> Self
    where
        T: IntoIterator<Item = String>,
    {
        let order_info = KIQueryOrders {
            params: IndexMap::new(),
        };
        order_info.with_item_list(txids)
    }

    /// Update the list of transaction IDs to query order info for.
    /// Useful for templating
    pub fn update_transaction_list<T>(self, txids: T) -> Self
    where
        T: IntoIterator<Item = String>,
    {
        self.update_input("txid", String::from(""))
            .with_item_list(txids)
    }

    /// Should trades be included in returned output?
    pub fn with_trade_info(self, include_trades: bool) -> Self {
        if include_trades {
            self.update_input("trades", include_trades.to_string())
        } else {
            self.update_input("trades", String::from(""))
        }
    }

    /// Filter results to the given user ref id. 
    /// A custom userref can be passed into the add order endpoint
    pub fn with_userref(self, userref: u32) -> Self {
        self.update_input("userref", userref.to_string())
    }

    fn with_nonce(self) -> Self {
        self.update_input("nonce", KrakenAuth::nonce())
    }
}

impl Input for KIQueryOrders {
    fn finish(self) -> KrakenInput {
        KrakenInput {
            info: EndpointInfo {
                methodtype: MethodType::Private,
                endpoint: String::from("QueryOrders"),
            },
            params: Some(self.with_nonce().params),
        }
    }

    fn finish_clone(self) -> (KrakenInput, Self) {
        let newself = self.with_nonce();
        (
            KrakenInput {
                info: EndpointInfo {
                    methodtype: MethodType::Private,
                    endpoint: String::from("QueryOrders"),
                },
                params: Some(newself.params.clone()),
            },
            newself,
        )
    }
}

impl MutateInput for KIQueryOrders {
    fn list_mut(&mut self) -> &mut IndexMap<String, String> {
        &mut self.params
    }
}

impl UpdateInput for KIQueryOrders {}

impl IntoInputList for KIQueryOrders {
    fn list_name(&self) -> String {
        String::from("txid")
    }
}

impl InputListItem for KIQueryOrders {
    type ListItem = String;
}

impl InputList for KIQueryOrders {}

/// Response from the Query Orders Info endpoint
#[derive(Deserialize, Serialize, Debug)]
pub struct KOQueryOrders {
    /// Map with the order's transaction ID as the key and the order info as the value
    #[serde(flatten)]
    pub orders: HashMap<String, KOOrderInfo>,
}

impl Output for KOQueryOrders {}