koios_sdk/api/
address.rs

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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
use crate::{
    error::Result,
    models::{
        address::{AddressAsset, AddressInfo, AddressTransaction},
        requests::{
            AddressTransactionsRequest, CredentialTransactionsRequest, CredentialUtxosRequest,
            PaymentAddressesRequest, PaymentAddressesWithExtendedRequest,
        },
        UtxoInfo,
    },
    Client,
};
use urlencoding::encode;

impl Client {
    /// Get address info - balance, associated stake address (if any) and UTxO set for given addresses
    ///
    /// # Arguments
    ///
    /// * `addresses` - List of addresses to query
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use koios_sdk::Client;
    ///
    /// #[tokio::main]
    /// async fn main() -> Result<(), Box<dyn std::error::Error>> {
    ///     let client = Client::new()?;
    ///     let addresses = vec![
    ///         "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz".to_string()
    ///     ];
    ///     let address_info = client.get_address_info(&addresses).await?;
    ///     println!("Address info: {:?}", address_info);
    ///     Ok(())
    /// }
    /// ```
    pub async fn get_address_info(&self, addresses: &[String]) -> Result<Vec<AddressInfo>> {
        let encoded_addresses: Vec<String> = addresses
            .iter()
            .map(|addr| encode(addr).into_owned())
            .collect();
        let request = PaymentAddressesRequest::new(encoded_addresses);
        self.post("/address_info", &request).await
    }

    /// Get UTxO set for given addresses
    ///
    /// # Arguments
    ///
    /// * `addresses` - List of addresses to query
    /// * `extended` - Optional flag to include extended information
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use koios_sdk::Client;
    ///
    /// #[tokio::main]
    /// async fn main() -> Result<(), Box<dyn std::error::Error>> {
    ///     let client = Client::new()?;
    ///     let addresses = vec![
    ///         "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz".to_string()
    ///     ];
    ///     let utxos = client.get_address_utxos(&addresses, Some(true)).await?;
    ///     println!("Address UTXOs: {:?}", utxos);
    ///     Ok(())
    /// }
    /// ```
    pub async fn get_address_utxos(
        &self,
        addresses: &[String],
        extended: Option<bool>,
    ) -> Result<Vec<UtxoInfo>> {
        let encoded_addresses: Vec<String> = addresses
            .iter()
            .map(|addr| encode(addr).into_owned())
            .collect();
        let request = PaymentAddressesWithExtendedRequest::new(encoded_addresses, extended);
        self.post("/address_utxos", &request).await
    }

    /// Get UTxO details for requested payment credentials
    ///
    /// # Arguments
    ///
    /// * `payment_credentials` - List of payment credentials to query
    /// * `extended` - Optional flag to include extended information
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use koios_sdk::Client;
    ///
    /// #[tokio::main]
    /// async fn main() -> Result<(), Box<dyn std::error::Error>> {
    ///     let client = Client::new()?;
    ///     let credentials = vec![
    ///         "025b0a8f85cb8a46e1dda3fae5d22f07e2d56abb4019a2129c5d6c52".to_string()
    ///     ];
    ///     let utxos = client.get_credential_utxos(&credentials, Some(true)).await?;
    ///     println!("Credential UTXOs: {:?}", utxos);
    ///     Ok(())
    /// }
    /// ```
    pub async fn get_credential_utxos(
        &self,
        payment_credentials: &[String],
        extended: Option<bool>,
    ) -> Result<Vec<UtxoInfo>> {
        let encoded_credentials: Vec<String> = payment_credentials
            .iter()
            .map(|cred| encode(cred).into_owned())
            .collect();
        let request = CredentialUtxosRequest::new(encoded_credentials, extended);
        self.post("/credential_utxos", &request).await
    }

    /// Get the transaction hash list of input address array, optionally filtering after specified block height
    ///
    /// # Arguments
    ///
    /// * `addresses` - List of addresses to query
    /// * `after_block_height` - Optional block height to filter from
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use koios_sdk::Client;
    ///
    /// #[tokio::main]
    /// async fn main() -> Result<(), Box<dyn std::error::Error>> {
    ///     let client = Client::new()?;
    ///     let addresses = vec![
    ///         "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz".to_string()
    ///     ];
    ///     let txs = client.get_address_transactions(&addresses, Some(42000000)).await?;
    ///     println!("Address transactions: {:?}", txs);
    ///     Ok(())
    /// }
    /// ```
    pub async fn get_address_transactions(
        &self,
        addresses: &[String],
        after_block_height: Option<u64>,
    ) -> Result<Vec<AddressTransaction>> {
        let encoded_addresses: Vec<String> = addresses
            .iter()
            .map(|addr| encode(addr).into_owned())
            .collect();
        let request = AddressTransactionsRequest::new(encoded_addresses, after_block_height);
        self.post("/address_txs", &request).await
    }

    /// Get the transaction hash list of input payment credential array, optionally filtering after specified block height
    ///
    /// # Arguments
    ///
    /// * `payment_credentials` - List of payment credentials to query
    /// * `after_block_height` - Optional block height to filter from
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use koios_sdk::Client;
    ///
    /// #[tokio::main]
    /// async fn main() -> Result<(), Box<dyn std::error::Error>> {
    ///     let client = Client::new()?;
    ///     let credentials = vec![
    ///         "025b0a8f85cb8a46e1dda3fae5d22f07e2d56abb4019a2129c5d6c52".to_string()
    ///     ];
    ///     let txs = client.get_credential_transactions(&credentials, Some(42000000)).await?;
    ///     println!("Credential transactions: {:?}", txs);
    ///     Ok(())
    /// }
    /// ```
    pub async fn get_credential_transactions(
        &self,
        payment_credentials: &[String],
        after_block_height: Option<u64>,
    ) -> Result<Vec<AddressTransaction>> {
        let encoded_credentials: Vec<String> = payment_credentials
            .iter()
            .map(|cred| encode(cred).into_owned())
            .collect();
        let request = CredentialTransactionsRequest::new(encoded_credentials, after_block_height);
        self.post("/credential_txs", &request).await
    }

    /// Get the list of all the assets (policy, name and quantity) for given addresses
    ///
    /// # Arguments
    ///
    /// * `addresses` - List of addresses to query
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use koios_sdk::Client;
    ///
    /// #[tokio::main]
    /// async fn main() -> Result<(), Box<dyn std::error::Error>> {
    ///     let client = Client::new()?;
    ///     let addresses = vec![
    ///         "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz".to_string()
    ///     ];
    ///     let assets = client.get_address_assets(&addresses).await?;
    ///     println!("Address assets: {:?}", assets);
    ///     Ok(())
    /// }
    /// ```
    pub async fn get_address_assets(&self, addresses: &[String]) -> Result<Vec<AddressAsset>> {
        let encoded_addresses: Vec<String> = addresses
            .iter()
            .map(|addr| encode(addr).into_owned())
            .collect();
        let request = PaymentAddressesRequest::new(encoded_addresses);
        self.post("/address_assets", &request).await
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;
    use wiremock::matchers::{method, path};
    use wiremock::{Mock, MockServer, ResponseTemplate};

    #[tokio::test]
    async fn test_get_address_info() {
        let mock_server = MockServer::start().await;
        let client = Client::builder()
            .base_url(mock_server.uri())
            .build()
            .unwrap();

        let address = "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz";
        let mock_response = json!([{
            "address": address,
            "balance": "42000000",
            "stake_address": "stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc",
            "script_address": false,
            "utxo_set": []
        }]);

        Mock::given(method("POST"))
            .and(path("/address_info"))
            .respond_with(ResponseTemplate::new(200).set_body_json(&mock_response))
            .mount(&mock_server)
            .await;

        let response = client
            .get_address_info(&[address.to_string()])
            .await
            .unwrap();
        assert_eq!(response.len(), 1);
        assert_eq!(response[0].address, address);
    }

    // Add more tests for other endpoints...
}