helius-rust-client 0.1.0

A rust client wrapping Helius APIs and the standard Solana RPC 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
116
117
118
119
120
121
122
123
124
125
126
127

use super::{
    init::{HeliusClient, API_URL_V0},
    parse_response,
};
use solana_client::client_error::Result as ClientResult;
use solana_sdk::commitment_config::CommitmentLevel;

use std::collections::HashMap;

use crate::{
    client::api_commitment_error,
    models::{
        enriched_transaction::{EnrichedTransaction, RequestConfig},
        raw_transaction::{GetRawTransactionsRequestConfig, RawTransaction},
    },
};

impl HeliusClient {
    /// Returns raw transaction history for a given address. GET request to `https://api.helius.xyz/v0/addresses/{address}/raw-transactions`.
    /// * `config` - The [`RequestConfig`](crate::models::transactions::RequestConfig).
    pub async fn get_transactions_for_address(
        &self,
        config: GetRawTransactionsRequestConfig,
    ) -> ClientResult<Vec<RawTransaction>> {
        let query = config.generate_query_parameters(self.api_key.clone())?;
        let request_url = format!(
            "{}/addresses/{}/raw-transactions?",
            API_URL_V0,
            config.address.to_string(),
        );

        let response = self.http_client.get(request_url).query(&query).send().await;

        parse_response(response).await
    }

    /// Returns raw transaction information for the given transaction hashes. POST request to `https://api.helius.xyz/v0/raw-transactions`.
    /// * `transaction_hashes` - The transaction hashes as Strings.
    /// * `commitment` - an Option containing the [`CommitmentLevel`]. Default is finalized.
    pub async fn get_transactions_by_hash(
        &self,
        transaction_hashes: Vec<String>,
        commitment: Option<CommitmentLevel>,
    ) -> ClientResult<Vec<RawTransaction>> {
        let request_url = format!("{}/raw-transactions?api-key={}", API_URL_V0, self.api_key,);

        let request_url = attach_commitment(request_url, commitment)?;
        let mut body = HashMap::new();
        body.insert("transactions", transaction_hashes);

        let response = self
            .http_client
            .post(request_url)
            .header("accept", "application/json")
            .header("Content-Type", "application/json")
            .json(&body)
            .send()
            .await;

        parse_response(response).await
    }

    /// Returns enriched transaction history for a given address. GET request to `https://api.helius.xyz/v0/addresses/{address}/transactions`.
    /// * `address` - The address that you want transactions for.
    pub async fn get_enriched_transactions(
        &self,
        config: RequestConfig,
    ) -> ClientResult<Vec<EnrichedTransaction>> {
        let query = config.generate_query_parameters(self.api_key.clone())?;
        let request_url = format!(
            "{}/addresses/{}/transactions?",
            API_URL_V0,
            config.address.to_string(),
        );
        let request_url = attach_commitment(request_url, config.commitment)?;

        let response = self.http_client.get(request_url).query(&query).send().await;

        parse_response(response).await
    }

    /// Returns enriched transaction information for the given transaction hashes. POST request to `https://api.helius.xyz/v0/transactions`.
    /// * `transaction_hashes` - The transaction hashes as Strings.
    /// * `commitment` - an Option containing the [`CommitmentLevel`]. Default is finalized.
    pub async fn get_enriched_transactions_by_hash(
        &self,
        transaction_hashes: Vec<String>,
        commitment: Option<CommitmentLevel>,
    ) -> ClientResult<Vec<EnrichedTransaction>> {
        let request_url = format!("{}/transactions/?api-key={}", API_URL_V0, self.api_key,);

        let request_url = attach_commitment(request_url, commitment)?;

        let mut body = HashMap::new();
        body.insert("transactions", transaction_hashes);

        let response = self
            .http_client
            .post(request_url)
            .header("accept", "application/json")
            .header("Content-Type", "application/json")
            .json(&body)
            .send()
            .await;

        parse_response(response).await
    }
}

fn attach_commitment(
    mut request_url: String,
    commitment: Option<CommitmentLevel>,
) -> ClientResult<String> {
    match commitment {
        Some(CommitmentLevel::Confirmed) => {
            request_url.push_str("&commitment=confirmed");
        }
        Some(CommitmentLevel::Finalized) => {
            request_url.push_str("&commitment=finalized");
        }
        None => {
            request_url.push_str("&commitment=finalized");
        }
        _ => return api_commitment_error(),
    }
    Ok(request_url)
}