nym-node-requests 1.21.5-rc.2

Nym Node API endpoint definitions and functions
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

// Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
// SPDX-License-Identifier: Apache-2.0

use super::v1::gateway::models::Wireguard;
use super::v1::metrics::models::SessionStats;
use crate::api::SignedLewesProtocol;
use crate::api::v1::authenticator::models::Authenticator;
use crate::api::v1::gateway::models::WebSockets;
use crate::api::v1::health::models::NodeHealth;
use crate::api::v1::ip_packet_router::models::IpPacketRouter;
use crate::api::v1::network_requester::exit_policy::models::UsedExitPolicy;
use crate::api::v1::network_requester::models::NetworkRequester;
use crate::api::v1::node::models::{
    AuxiliaryDetailsV1, NodeDescription, NodeRoles, SignedHostInformation,
};
use crate::api::v1::node_load::models::NodeLoad;
use crate::api::v2::node::models::AuxiliaryDetailsV2;
use crate::routes;
use async_trait::async_trait;
use nym_bin_common::build_information::BinaryBuildInformationOwned;
use nym_http_api_client::{ApiClient, HttpClientError};

pub use nym_http_api_client::Client;

pub type NymNodeApiClientError = HttpClientError;

#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
pub trait NymNodeApiClientExt: ApiClient {
    async fn get_health(&self) -> Result<NodeHealth, NymNodeApiClientError> {
        self.get_json_from(routes::api::v1::health_absolute()).await
    }

    async fn get_node_load(&self) -> Result<NodeLoad, NymNodeApiClientError> {
        self.get_json_from(routes::api::v1::load_absolute()).await
    }

    async fn get_host_information(&self) -> Result<SignedHostInformation, NymNodeApiClientError> {
        self.get_json_from(routes::api::v1::host_info_absolute())
            .await
    }

    async fn get_description(&self) -> Result<NodeDescription, NymNodeApiClientError> {
        self.get_json_from(routes::api::v1::description_absolute())
            .await
    }

    async fn get_build_information(
        &self,
    ) -> Result<BinaryBuildInformationOwned, NymNodeApiClientError> {
        self.get_json_from(routes::api::v1::build_info_absolute())
            .await
    }

    async fn get_roles(&self) -> Result<NodeRoles, NymNodeApiClientError> {
        self.get_json_from(routes::api::v1::roles_absolute()).await
    }

    async fn get_auxiliary_details(&self) -> Result<AuxiliaryDetailsV1, NymNodeApiClientError> {
        self.get_json_from(routes::api::v1::auxiliary_absolute())
            .await
    }

    async fn get_auxiliary_details_v2(&self) -> Result<AuxiliaryDetailsV2, NymNodeApiClientError> {
        self.get_json_from(routes::api::v2::auxiliary_absolute())
            .await
    }

    // TODO: implement calls for other endpoints; for now I only care about the wss
    async fn get_mixnet_websockets(&self) -> Result<WebSockets, NymNodeApiClientError> {
        self.get_json_from(
            routes::api::v1::gateway::client_interfaces::mixnet_websockets_absolute(),
        )
        .await
    }

    async fn get_network_requester(&self) -> Result<NetworkRequester, NymNodeApiClientError> {
        self.get_json_from(routes::api::v1::network_requester_absolute())
            .await
    }

    async fn get_exit_policy(&self) -> Result<UsedExitPolicy, NymNodeApiClientError> {
        self.get_json_from(routes::api::v1::network_requester::exit_policy_absolute())
            .await
    }

    async fn get_ip_packet_router(&self) -> Result<IpPacketRouter, NymNodeApiClientError> {
        self.get_json_from(routes::api::v1::ip_packet_router_absolute())
            .await
    }

    async fn get_authenticator(&self) -> Result<Authenticator, NymNodeApiClientError> {
        self.get_json_from(routes::api::v1::authenticator_absolute())
            .await
    }

    async fn get_wireguard(&self) -> Result<Wireguard, NymNodeApiClientError> {
        self.get_json_from(routes::api::v1::gateway::client_interfaces::wireguard_absolute())
            .await
    }

    async fn get_sessions_metrics(&self) -> Result<SessionStats, NymNodeApiClientError> {
        self.get_json_from(routes::api::v1::metrics::sessions_absolute())
            .await
    }

    async fn get_lewes_protocol(&self) -> Result<SignedLewesProtocol, NymNodeApiClientError> {
        self.get_json_from(routes::api::v1::lp_absolute()).await
    }
}

#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
impl NymNodeApiClientExt for Client {}