f590aad42c
* nym-api: cache updates as node performance * nym-api: update get mixnode avg_uptime endpoint * nym-api: mixnode report to use cached data * nym-api: annotate gateway bond with node performance * nym-api: gateway report to use cached data * wip * Add get_gateway_avg_uptime * Add comment * update NR gateways to include node_performance on frontend * use node_performance values on frontend * fixup select gateway from list * fix up lint errors --------- Co-authored-by: fmtabbara <fmtabbara@hotmail.co.uk>
92 lines
3.3 KiB
Rust
92 lines
3.3 KiB
Rust
// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
pub(crate) use cache::NodeStatusCache;
|
|
use nym_task::TaskManager;
|
|
use okapi::openapi3::OpenApi;
|
|
use rocket::Route;
|
|
use rocket_okapi::{openapi_get_routes_spec, settings::OpenApiSettings};
|
|
use std::time::Duration;
|
|
|
|
use crate::{
|
|
nym_contract_cache::cache::NymContractCache,
|
|
support::{self, config::Config, storage},
|
|
};
|
|
|
|
use self::cache::refresher::NodeStatusCacheRefresher;
|
|
pub(crate) mod cache;
|
|
pub(crate) mod helpers;
|
|
pub(crate) mod local_guard;
|
|
pub(crate) mod models;
|
|
pub(crate) mod reward_estimate;
|
|
pub(crate) mod routes;
|
|
pub(crate) mod uptime_updater;
|
|
pub(crate) mod utils;
|
|
|
|
pub(crate) const FIFTEEN_MINUTES: Duration = Duration::from_secs(900);
|
|
pub(crate) const ONE_HOUR: Duration = Duration::from_secs(3600);
|
|
pub(crate) const ONE_DAY: Duration = Duration::from_secs(86400);
|
|
|
|
pub(crate) fn node_status_routes(
|
|
settings: &OpenApiSettings,
|
|
enabled: bool,
|
|
) -> (Vec<Route>, OpenApi) {
|
|
if enabled {
|
|
openapi_get_routes_spec![
|
|
settings: routes::gateway_report,
|
|
routes::gateway_uptime_history,
|
|
routes::gateway_core_status_count,
|
|
routes::mixnode_report,
|
|
routes::mixnode_uptime_history,
|
|
routes::mixnode_core_status_count,
|
|
routes::get_mixnode_status,
|
|
routes::get_mixnode_reward_estimation,
|
|
routes::compute_mixnode_reward_estimation,
|
|
routes::get_mixnode_stake_saturation,
|
|
routes::get_mixnode_inclusion_probability,
|
|
routes::get_mixnode_avg_uptime,
|
|
routes::get_gateway_avg_uptime,
|
|
routes::get_mixnode_inclusion_probabilities,
|
|
routes::get_mixnodes_detailed,
|
|
routes::get_rewarded_set_detailed,
|
|
routes::get_active_set_detailed,
|
|
routes::get_gateways_detailed,
|
|
]
|
|
} else {
|
|
// in the minimal variant we would not have access to endpoints relying on existence
|
|
// of the network monitor and the associated storage
|
|
openapi_get_routes_spec![
|
|
settings: routes::get_mixnode_status,
|
|
routes::get_mixnode_stake_saturation,
|
|
routes::get_mixnode_inclusion_probability,
|
|
routes::get_mixnode_inclusion_probabilities,
|
|
routes::get_mixnodes_detailed,
|
|
routes::get_rewarded_set_detailed,
|
|
routes::get_active_set_detailed,
|
|
]
|
|
}
|
|
}
|
|
|
|
/// Spawn the node status cache refresher.
|
|
///
|
|
/// It is primarily refreshed in-sync with the nym contract cache, however provide a fallback
|
|
/// caching interval that is twice the nym contract cache
|
|
pub(crate) fn start_cache_refresh(
|
|
config: &Config,
|
|
nym_contract_cache_state: &NymContractCache,
|
|
node_status_cache_state: &NodeStatusCache,
|
|
storage: Option<&storage::NymApiStorage>,
|
|
nym_contract_cache_listener: tokio::sync::watch::Receiver<support::caching::CacheNotification>,
|
|
shutdown: &TaskManager,
|
|
) {
|
|
let mut nym_api_cache_refresher = NodeStatusCacheRefresher::new(
|
|
node_status_cache_state.to_owned(),
|
|
config.get_node_status_caching_interval(),
|
|
nym_contract_cache_state.to_owned(),
|
|
nym_contract_cache_listener,
|
|
storage.cloned(),
|
|
);
|
|
let shutdown_listener = shutdown.subscribe();
|
|
tokio::spawn(async move { nym_api_cache_refresher.run(shutdown_listener).await });
|
|
}
|