Jędrzej Stuczyński
f328f3fa9e
* Squashing all the changes initial router started expanding the API initial empty openapi/swagger populated build-info endpoint wip: populating rest of swagger missing swagger data + using closure capture for immutable state running the api as a proper task in gateway 'run' fixing some version/feature clashes refactored routes structures initial host information endpoint expanded on gateway-related endpoints signing host information moved all models to separate crate unified http api client routes unification + node api client new generic cache and refresher nym-api caching node self described information removed old cache type temporarily wired up NymContractCache to NodeDescriptionProvider caching self reported host info clients using self-described gateway information fixed request timeouts for wasm fixed wasm builds post rebase fixes cargo fmt brought in wg routes into nym-node router added ErrorResponse for wireguard routes basic swagger support for wg endpoints turns out swagger can be happy with strongly typed requests output type support for wg routes using concrete error type for nym node request error fixed the registration test landing page configurability increased configurability fixed build and lints of other crates added default user-agent to http-api-client reduced severity of gateway details lookup failure changed default http port from 80 to 8080 nym-api using new default port for queries added health endpoint nym-api trying multiple ports for the client using camelcase for node status corrected health endpoint description restored and revamped 'force_tls' flag to filter all gateways that support the wss protocol fixed 'pub_key' path param in open api schema derived Debug on 'NymNodeDescription' ensuring valid public ips added init and run flags to set hostname and public ips fixed listening address being pushed to public ip fixed the positional local flag logging remote ip address of the request updated helper function to query for described gateways enabled tls in gateway client removed hack-opts from mix fetch additional changes after rebasing against origin/develop * clippy * wasm-related target locking * more clippy, but this time in tests
419 lines
12 KiB
Rust
419 lines
12 KiB
Rust
// Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
use crate::nym_api::error::NymAPIError;
|
|
use crate::nym_api::routes::{CORE_STATUS_COUNT, SINCE_ARG};
|
|
use async_trait::async_trait;
|
|
use http_api_client::{ApiClient, NO_PARAMS};
|
|
use nym_api_requests::coconut::{
|
|
BlindSignRequestBody, BlindedSignatureResponse, VerifyCredentialBody, VerifyCredentialResponse,
|
|
};
|
|
use nym_api_requests::models::{
|
|
ComputeRewardEstParam, DescribedGateway, GatewayBondAnnotated, GatewayCoreStatusResponse,
|
|
GatewayStatusReportResponse, GatewayUptimeHistoryResponse, InclusionProbabilityResponse,
|
|
MixNodeBondAnnotated, MixnodeCoreStatusResponse, MixnodeStatusReportResponse,
|
|
MixnodeStatusResponse, MixnodeUptimeHistoryResponse, RewardEstimationResponse,
|
|
StakeSaturationResponse, UptimeResponse,
|
|
};
|
|
use nym_mixnet_contract_common::mixnode::MixNodeDetails;
|
|
use nym_mixnet_contract_common::{GatewayBond, IdentityKeyRef, MixId};
|
|
use nym_name_service_common::response::NamesListResponse;
|
|
use nym_service_provider_directory_common::response::ServicesListResponse;
|
|
|
|
pub mod error;
|
|
pub mod routes;
|
|
|
|
pub use http_api_client::Client;
|
|
|
|
#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
|
|
#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
|
|
pub trait NymApiClientExt: ApiClient {
|
|
async fn get_mixnodes(&self) -> Result<Vec<MixNodeDetails>, NymAPIError> {
|
|
self.get_json(&[routes::API_VERSION, routes::MIXNODES], NO_PARAMS)
|
|
.await
|
|
}
|
|
|
|
async fn get_mixnodes_detailed(&self) -> Result<Vec<MixNodeBondAnnotated>, NymAPIError> {
|
|
self.get_json(
|
|
&[
|
|
routes::API_VERSION,
|
|
routes::STATUS,
|
|
routes::MIXNODES,
|
|
routes::DETAILED,
|
|
],
|
|
NO_PARAMS,
|
|
)
|
|
.await
|
|
}
|
|
|
|
async fn get_gateways_detailed(&self) -> Result<Vec<GatewayBondAnnotated>, NymAPIError> {
|
|
self.get_json(
|
|
&[
|
|
routes::API_VERSION,
|
|
routes::STATUS,
|
|
routes::GATEWAYS,
|
|
routes::DETAILED,
|
|
],
|
|
NO_PARAMS,
|
|
)
|
|
.await
|
|
}
|
|
|
|
async fn get_mixnodes_detailed_unfiltered(
|
|
&self,
|
|
) -> Result<Vec<MixNodeBondAnnotated>, NymAPIError> {
|
|
self.get_json(
|
|
&[
|
|
routes::API_VERSION,
|
|
routes::STATUS,
|
|
routes::MIXNODES,
|
|
routes::DETAILED_UNFILTERED,
|
|
],
|
|
NO_PARAMS,
|
|
)
|
|
.await
|
|
}
|
|
|
|
async fn get_gateways(&self) -> Result<Vec<GatewayBond>, NymAPIError> {
|
|
self.get_json(&[routes::API_VERSION, routes::GATEWAYS], NO_PARAMS)
|
|
.await
|
|
}
|
|
|
|
async fn get_gateways_described(&self) -> Result<Vec<DescribedGateway>, NymAPIError> {
|
|
self.get_json(
|
|
&[routes::API_VERSION, routes::GATEWAYS, routes::DESCRIBED],
|
|
NO_PARAMS,
|
|
)
|
|
.await
|
|
}
|
|
|
|
async fn get_active_mixnodes(&self) -> Result<Vec<MixNodeDetails>, NymAPIError> {
|
|
self.get_json(
|
|
&[routes::API_VERSION, routes::MIXNODES, routes::ACTIVE],
|
|
NO_PARAMS,
|
|
)
|
|
.await
|
|
}
|
|
|
|
async fn get_active_mixnodes_detailed(&self) -> Result<Vec<MixNodeBondAnnotated>, NymAPIError> {
|
|
self.get_json(
|
|
&[
|
|
routes::API_VERSION,
|
|
routes::STATUS,
|
|
routes::MIXNODES,
|
|
routes::ACTIVE,
|
|
routes::DETAILED,
|
|
],
|
|
NO_PARAMS,
|
|
)
|
|
.await
|
|
}
|
|
|
|
async fn get_rewarded_mixnodes(&self) -> Result<Vec<MixNodeDetails>, NymAPIError> {
|
|
self.get_json(
|
|
&[routes::API_VERSION, routes::MIXNODES, routes::REWARDED],
|
|
NO_PARAMS,
|
|
)
|
|
.await
|
|
}
|
|
|
|
async fn get_mixnode_report(
|
|
&self,
|
|
mix_id: MixId,
|
|
) -> Result<MixnodeStatusReportResponse, NymAPIError> {
|
|
self.get_json(
|
|
&[
|
|
routes::API_VERSION,
|
|
routes::STATUS,
|
|
routes::MIXNODE,
|
|
&mix_id.to_string(),
|
|
routes::REPORT,
|
|
],
|
|
NO_PARAMS,
|
|
)
|
|
.await
|
|
}
|
|
|
|
async fn get_gateway_report(
|
|
&self,
|
|
identity: IdentityKeyRef<'_>,
|
|
) -> Result<GatewayStatusReportResponse, NymAPIError> {
|
|
self.get_json(
|
|
&[
|
|
routes::API_VERSION,
|
|
routes::STATUS,
|
|
routes::GATEWAY,
|
|
identity,
|
|
routes::REPORT,
|
|
],
|
|
NO_PARAMS,
|
|
)
|
|
.await
|
|
}
|
|
|
|
async fn get_mixnode_history(
|
|
&self,
|
|
mix_id: MixId,
|
|
) -> Result<MixnodeUptimeHistoryResponse, NymAPIError> {
|
|
self.get_json(
|
|
&[
|
|
routes::API_VERSION,
|
|
routes::STATUS,
|
|
routes::MIXNODE,
|
|
&mix_id.to_string(),
|
|
routes::HISTORY,
|
|
],
|
|
NO_PARAMS,
|
|
)
|
|
.await
|
|
}
|
|
|
|
async fn get_gateway_history(
|
|
&self,
|
|
identity: IdentityKeyRef<'_>,
|
|
) -> Result<GatewayUptimeHistoryResponse, NymAPIError> {
|
|
self.get_json(
|
|
&[
|
|
routes::API_VERSION,
|
|
routes::STATUS,
|
|
routes::GATEWAY,
|
|
identity,
|
|
routes::HISTORY,
|
|
],
|
|
NO_PARAMS,
|
|
)
|
|
.await
|
|
}
|
|
|
|
async fn get_rewarded_mixnodes_detailed(
|
|
&self,
|
|
) -> Result<Vec<MixNodeBondAnnotated>, NymAPIError> {
|
|
self.get_json(
|
|
&[
|
|
routes::API_VERSION,
|
|
routes::STATUS,
|
|
routes::MIXNODES,
|
|
routes::REWARDED,
|
|
routes::DETAILED,
|
|
],
|
|
NO_PARAMS,
|
|
)
|
|
.await
|
|
}
|
|
|
|
async fn get_gateway_core_status_count(
|
|
&self,
|
|
identity: IdentityKeyRef<'_>,
|
|
since: Option<i64>,
|
|
) -> Result<GatewayCoreStatusResponse, NymAPIError> {
|
|
if let Some(since) = since {
|
|
self.get_json(
|
|
&[
|
|
routes::API_VERSION,
|
|
routes::STATUS_ROUTES,
|
|
routes::GATEWAY,
|
|
identity,
|
|
CORE_STATUS_COUNT,
|
|
],
|
|
&[(SINCE_ARG, since.to_string())],
|
|
)
|
|
.await
|
|
} else {
|
|
self.get_json(
|
|
&[
|
|
routes::API_VERSION,
|
|
routes::STATUS_ROUTES,
|
|
routes::GATEWAY,
|
|
identity,
|
|
],
|
|
NO_PARAMS,
|
|
)
|
|
.await
|
|
}
|
|
}
|
|
|
|
async fn get_mixnode_core_status_count(
|
|
&self,
|
|
mix_id: MixId,
|
|
since: Option<i64>,
|
|
) -> Result<MixnodeCoreStatusResponse, NymAPIError> {
|
|
if let Some(since) = since {
|
|
self.get_json(
|
|
&[
|
|
routes::API_VERSION,
|
|
routes::STATUS_ROUTES,
|
|
routes::MIXNODE,
|
|
&mix_id.to_string(),
|
|
CORE_STATUS_COUNT,
|
|
],
|
|
&[(SINCE_ARG, since.to_string())],
|
|
)
|
|
.await
|
|
} else {
|
|
self.get_json(
|
|
&[
|
|
routes::API_VERSION,
|
|
routes::STATUS_ROUTES,
|
|
routes::MIXNODE,
|
|
&mix_id.to_string(),
|
|
CORE_STATUS_COUNT,
|
|
],
|
|
NO_PARAMS,
|
|
)
|
|
.await
|
|
}
|
|
}
|
|
|
|
async fn get_mixnode_status(
|
|
&self,
|
|
mix_id: MixId,
|
|
) -> Result<MixnodeStatusResponse, NymAPIError> {
|
|
self.get_json(
|
|
&[
|
|
routes::API_VERSION,
|
|
routes::STATUS_ROUTES,
|
|
routes::MIXNODE,
|
|
&mix_id.to_string(),
|
|
routes::STATUS,
|
|
],
|
|
NO_PARAMS,
|
|
)
|
|
.await
|
|
}
|
|
|
|
async fn get_mixnode_reward_estimation(
|
|
&self,
|
|
mix_id: MixId,
|
|
) -> Result<RewardEstimationResponse, NymAPIError> {
|
|
self.get_json(
|
|
&[
|
|
routes::API_VERSION,
|
|
routes::STATUS_ROUTES,
|
|
routes::MIXNODE,
|
|
&mix_id.to_string(),
|
|
routes::REWARD_ESTIMATION,
|
|
],
|
|
NO_PARAMS,
|
|
)
|
|
.await
|
|
}
|
|
|
|
async fn compute_mixnode_reward_estimation(
|
|
&self,
|
|
mix_id: MixId,
|
|
request_body: &ComputeRewardEstParam,
|
|
) -> Result<RewardEstimationResponse, NymAPIError> {
|
|
self.post_json(
|
|
&[
|
|
routes::API_VERSION,
|
|
routes::STATUS_ROUTES,
|
|
routes::MIXNODE,
|
|
&mix_id.to_string(),
|
|
routes::COMPUTE_REWARD_ESTIMATION,
|
|
],
|
|
NO_PARAMS,
|
|
request_body,
|
|
)
|
|
.await
|
|
}
|
|
|
|
async fn get_mixnode_stake_saturation(
|
|
&self,
|
|
mix_id: MixId,
|
|
) -> Result<StakeSaturationResponse, NymAPIError> {
|
|
self.get_json(
|
|
&[
|
|
routes::API_VERSION,
|
|
routes::STATUS_ROUTES,
|
|
routes::MIXNODE,
|
|
&mix_id.to_string(),
|
|
routes::STAKE_SATURATION,
|
|
],
|
|
NO_PARAMS,
|
|
)
|
|
.await
|
|
}
|
|
|
|
async fn get_mixnode_inclusion_probability(
|
|
&self,
|
|
mix_id: MixId,
|
|
) -> Result<InclusionProbabilityResponse, NymAPIError> {
|
|
self.get_json(
|
|
&[
|
|
routes::API_VERSION,
|
|
routes::STATUS_ROUTES,
|
|
routes::MIXNODE,
|
|
&mix_id.to_string(),
|
|
routes::INCLUSION_CHANCE,
|
|
],
|
|
NO_PARAMS,
|
|
)
|
|
.await
|
|
}
|
|
|
|
async fn get_mixnode_avg_uptime(&self, mix_id: MixId) -> Result<UptimeResponse, NymAPIError> {
|
|
self.get_json(
|
|
&[
|
|
routes::API_VERSION,
|
|
routes::STATUS_ROUTES,
|
|
routes::MIXNODE,
|
|
&mix_id.to_string(),
|
|
routes::AVG_UPTIME,
|
|
],
|
|
NO_PARAMS,
|
|
)
|
|
.await
|
|
}
|
|
|
|
async fn blind_sign(
|
|
&self,
|
|
request_body: &BlindSignRequestBody,
|
|
) -> Result<BlindedSignatureResponse, NymAPIError> {
|
|
self.post_json(
|
|
&[
|
|
routes::API_VERSION,
|
|
routes::COCONUT_ROUTES,
|
|
routes::BANDWIDTH,
|
|
routes::COCONUT_BLIND_SIGN,
|
|
],
|
|
NO_PARAMS,
|
|
request_body,
|
|
)
|
|
.await
|
|
}
|
|
|
|
async fn verify_bandwidth_credential(
|
|
&self,
|
|
request_body: &VerifyCredentialBody,
|
|
) -> Result<VerifyCredentialResponse, NymAPIError> {
|
|
self.post_json(
|
|
&[
|
|
routes::API_VERSION,
|
|
routes::COCONUT_ROUTES,
|
|
routes::BANDWIDTH,
|
|
routes::COCONUT_VERIFY_BANDWIDTH_CREDENTIAL,
|
|
],
|
|
NO_PARAMS,
|
|
request_body,
|
|
)
|
|
.await
|
|
}
|
|
|
|
async fn get_service_providers(&self) -> Result<ServicesListResponse, NymAPIError> {
|
|
log::trace!("Getting service providers");
|
|
self.get_json(&[routes::API_VERSION, routes::SERVICE_PROVIDERS], NO_PARAMS)
|
|
.await
|
|
}
|
|
|
|
//async fn get_registered_names(&self) -> Result<Vec<NameEntry>, NymAPIError> {
|
|
async fn get_registered_names(&self) -> Result<NamesListResponse, NymAPIError> {
|
|
log::trace!("Getting registered names");
|
|
self.get_json(&[routes::API_VERSION, routes::REGISTERED_NAMES], NO_PARAMS)
|
|
.await
|
|
}
|
|
}
|
|
|
|
#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
|
|
#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
|
|
impl NymApiClientExt for Client {}
|