nym_node_requests/
lib.rs

1// Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
2// SPDX-License-Identifier: Apache-2.0
3
4pub mod api;
5pub mod error;
6
7#[cfg(feature = "client")]
8pub use crate::api::helpers::try_get_valid_nym_node_api_client;
9
10macro_rules! absolute_route {
11    ( $name:ident, $parent:expr, $suffix:expr ) => {
12        pub fn $name() -> String {
13            format!("{}{}", $parent, $suffix)
14        }
15    };
16}
17
18// still thinking how to nicely organise it
19pub mod routes {
20    pub const LANDING_PAGE: &str = "/";
21    pub const ROOT: &str = "/";
22    pub const API: &str = "/api";
23
24    pub mod api {
25        pub const V1: &str = "/v1";
26
27        absolute_route!(v1_absolute, super::API, V1);
28
29        pub mod v1 {
30            use super::*;
31
32            pub const ROLES: &str = "/roles";
33            pub const BUILD_INFO: &str = "/build-information";
34            pub const HOST_INFO: &str = "/host-information";
35            pub const SYSTEM_INFO: &str = "/system-info";
36            pub const NODE_DESCRIPTION: &str = "/description";
37            pub const AUXILIARY: &str = "/auxiliary-details";
38            pub const HEALTH: &str = "/health";
39            pub const LOAD: &str = "/load";
40            pub const NETWORK: &str = "/network";
41            pub const SWAGGER: &str = "/swagger";
42
43            pub const GATEWAY: &str = "/gateway";
44            pub const MIXNODE: &str = "/mixnode";
45            pub const METRICS: &str = "/metrics";
46            pub const BRIDGES: &str = "/bridges";
47            pub const NETWORK_REQUESTER: &str = "/network-requester";
48            pub const IP_PACKET_ROUTER: &str = "/ip-packet-router";
49            pub const AUTHENTICATOR: &str = "/authenticator";
50            pub const LEWES_PROTOCOL: &str = "/lewes-protocol";
51
52            // define helper functions to get absolute routes
53            absolute_route!(health_absolute, v1_absolute(), HEALTH);
54            absolute_route!(load_absolute, v1_absolute(), LOAD);
55            absolute_route!(network_absolute, v1_absolute(), NETWORK);
56            absolute_route!(roles_absolute, v1_absolute(), ROLES);
57            absolute_route!(build_info_absolute, v1_absolute(), BUILD_INFO);
58            absolute_route!(host_info_absolute, v1_absolute(), HOST_INFO);
59            absolute_route!(system_info_absolute, v1_absolute(), SYSTEM_INFO);
60            absolute_route!(description_absolute, v1_absolute(), NODE_DESCRIPTION);
61            absolute_route!(auxiliary_absolute, v1_absolute(), AUXILIARY);
62
63            absolute_route!(gateway_absolute, v1_absolute(), GATEWAY);
64            absolute_route!(mixnode_absolute, v1_absolute(), MIXNODE);
65            absolute_route!(metrics_absolute, v1_absolute(), METRICS);
66            absolute_route!(network_requester_absolute, v1_absolute(), NETWORK_REQUESTER);
67            absolute_route!(ip_packet_router_absolute, v1_absolute(), IP_PACKET_ROUTER);
68            absolute_route!(authenticator_absolute, v1_absolute(), AUTHENTICATOR);
69            absolute_route!(lp_absolute, v1_absolute(), LEWES_PROTOCOL);
70            absolute_route!(swagger_absolute, v1_absolute(), SWAGGER);
71
72            pub mod metrics {
73                use super::*;
74
75                pub const LEGACY_MIXING: &str = "/mixing";
76                pub const PACKETS_STATS: &str = "/packets-stats";
77                pub const WIREGUARD_STATS: &str = "/wireguard-stats";
78                pub const SESSIONS: &str = "/sessions";
79                pub const VERLOC: &str = "/verloc";
80                pub const PROMETHEUS: &str = "/prometheus";
81
82                absolute_route!(legacy_mixing_absolute, metrics_absolute(), LEGACY_MIXING);
83                absolute_route!(packets_stats_absolute, metrics_absolute(), PACKETS_STATS);
84                absolute_route!(
85                    wireguard_stats_absolute,
86                    metrics_absolute(),
87                    WIREGUARD_STATS
88                );
89                absolute_route!(sessions_absolute, metrics_absolute(), SESSIONS);
90                absolute_route!(verloc_absolute, metrics_absolute(), VERLOC);
91                absolute_route!(prometheus_absolute, metrics_absolute(), PROMETHEUS);
92            }
93
94            pub mod gateway {
95                use super::*;
96
97                pub const CLIENT_INTERFACES: &str = "/client-interfaces";
98
99                absolute_route!(
100                    client_interfaces_absolute,
101                    gateway_absolute(),
102                    CLIENT_INTERFACES
103                );
104
105                pub mod client_interfaces {
106                    use super::*;
107
108                    pub const WIREGUARD: &str = "/wireguard";
109                    pub const WEBSOCKETS: &str = "/mixnet-websockets";
110
111                    absolute_route!(wireguard_absolute, client_interfaces_absolute(), WIREGUARD);
112                    absolute_route!(
113                        mixnet_websockets_absolute,
114                        client_interfaces_absolute(),
115                        WEBSOCKETS
116                    );
117                }
118            }
119
120            pub mod mixnode {
121                // use super::*;
122            }
123
124            pub mod network_requester {
125                use super::*;
126
127                pub const EXIT_POLICY: &str = "/exit-policy";
128
129                absolute_route!(
130                    exit_policy_absolute,
131                    network_requester_absolute(),
132                    EXIT_POLICY
133                );
134            }
135
136            pub mod ip_packet_router {
137                // use super::*;
138            }
139
140            pub mod network {
141                use super::*;
142                pub const UPGRADE_MODE_STATUS: &str = "/upgrade-mode-status";
143
144                absolute_route!(
145                    upgrade_mode_status_absolute,
146                    network_absolute(),
147                    UPGRADE_MODE_STATUS
148                );
149            }
150
151            pub mod lewes_protocol {
152                // use super::*;
153            }
154        }
155    }
156}
157
158#[cfg(test)]
159mod tests {
160    use super::*;
161
162    #[test]
163    fn route_expansion_works() {
164        assert_eq!("/api/v1", routes::api::v1_absolute());
165
166        assert_eq!(
167            "/api/v1/build-information",
168            routes::api::v1::build_info_absolute()
169        );
170        assert_eq!(
171            "/api/v1/host-information",
172            routes::api::v1::host_info_absolute()
173        );
174        assert_eq!("/api/v1/roles", routes::api::v1::roles_absolute());
175
176        assert_eq!("/api/v1/gateway", routes::api::v1::gateway_absolute());
177        assert_eq!(
178            "/api/v1/gateway/client-interfaces",
179            routes::api::v1::gateway::client_interfaces_absolute()
180        );
181        assert_eq!(
182            "/api/v1/gateway/client-interfaces/wireguard",
183            routes::api::v1::gateway::client_interfaces::wireguard_absolute()
184        );
185        assert_eq!(
186            "/api/v1/gateway/client-interfaces/mixnet-websockets",
187            routes::api::v1::gateway::client_interfaces::mixnet_websockets_absolute()
188        );
189
190        assert_eq!("/api/v1/mixnode", routes::api::v1::mixnode_absolute());
191        assert_eq!(
192            "/api/v1/network-requester",
193            routes::api::v1::network_requester_absolute()
194        );
195        assert_eq!(
196            "/api/v1/ip-packet-router",
197            routes::api::v1::ip_packet_router_absolute()
198        );
199    }
200}
nym_node_requests/lib.rs

nym_node_requests/
lib.rs
