kudu 0.2.0

Library for interacting with Antelope blockchains
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

// SPDX-FileCopyrightText: 2024-2026 DigiGaia SCCL
// SPDX-License-Identifier: AGPL-3.0-or-later

use std::hash::{Hash, Hasher};
use std::sync::Arc;

use serde_json::Value as JsonValue;
use snafu::{Snafu, ResultExt, ensure};
use ureq;

use kudu_macros::with_location;

// see API endpoints from greymass here: https://www.greymass.com/endpoints

#[derive(Clone, Debug)]
pub struct APIClient {
    pub endpoint: String,
    pub agent: ureq::Agent,
}

#[with_location]
#[derive(Debug, Snafu)]
pub enum HttpError {
    #[snafu(display("http status: {code} - error: {message}"))]
    HttpError { code: u16, message: String },

    #[snafu(display("{source}"))]
    ConnectionError { source: ureq::Error },

    #[snafu(display("{source}"))]
    JsonError { source: ureq::Error },
}

pub fn return_checked_json_response(mut response: ureq::http::Response<ureq::Body>) -> Result<JsonValue, HttpError> {
    let code = response.status().as_u16();
    let result: JsonValue = response
        .body_mut()
        .read_json().context(JsonSnafu)?;

    // HTTP status code 4xx and 5xx need to raise an error
    // we do it manually to add more information to the error than just the status code
    ensure!(!(400..600).contains(&code), HttpSnafu { code, message: result["error"].to_string() });

    Ok(result)
}


impl APIClient {
    pub fn new(endpoint: &str) -> Self {
        APIClient {
            endpoint: endpoint.trim_end_matches('/').to_owned(),
            agent: ureq::Agent::config_builder()
                .http_status_as_error(false)
                // FIXME: user_agent seems to not work? InvalidHeaderValue???
                // .user_agent(&format!("kudu/{}", crate::config::VERSION))
                // no way to specify content-type?
            // .accept("application/json")  // is it necessary?
                .build()
                .into()
        }
    }

    fn fullpath(&self, path: &str) -> String {
        format!("{}{}", &self.endpoint, path)
    }

    pub fn get(&self, path: &str) -> Result<JsonValue, HttpError> {
        let response = self.agent.get(self.fullpath(path))
            .call().context(ConnectionSnafu)?;
        return_checked_json_response(response)
    }

    pub fn call(&self, path: &str, params: &JsonValue) -> Result<JsonValue, HttpError> {
        let response = self.agent.post(self.fullpath(path))
            .send_json(params).context(ConnectionSnafu)?;
        return_checked_json_response(response)
    }

    pub fn call_unchecked(&self, path: &str, params: &JsonValue) -> Result<JsonValue, HttpError> {
        self.agent.post(self.fullpath(path))
            .send_json(params).context(ConnectionSnafu)?
            .body_mut()
            .read_json().context(JsonSnafu)
    }


    // -----------------------------------------------------------------------------
    //     helper functions for known endpoints
    //     TODO: maybe this is not the best place to define them?
    // -----------------------------------------------------------------------------

    pub fn local() -> Arc<Self> {
        Arc::new(APIClient::new("http://127.0.0.1:8888"))
    }

    pub fn jungle() -> Arc<Self> {
        Arc::new(APIClient::new("https://jungle4.greymass.com"))
    }

    pub fn vaulta() -> Arc<Self> {
        Arc::new(APIClient::new("https://vaulta.greymass.com"))
    }
}

impl PartialEq for APIClient {
    fn eq(&self, other: &Self) -> bool {
        self.endpoint == other.endpoint
    }
}

impl Eq for APIClient {}

impl Hash for APIClient {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.endpoint.hash(state);
    }
}