ic-query 0.25.2

Internet Computer query library for NNS, SNS, ICRC, system canisters, and public network metadata
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

mod model;
mod text;

#[cfg(feature = "host")]
mod cache;
#[cfg(feature = "host")]
mod error;
#[cfg(feature = "host")]
mod source;

pub use model::{
    NnsSubnetNodeProviderRow, NnsSubnetTopologyFreshness, NnsSubnetTopologyReport,
    NnsSubnetTopologyRow, NnsSubnetTopologyValidationError,
};
pub use text::nns_subnet_topology_report_text;

#[cfg(feature = "host")]
pub use cache::{
    load_cached_nns_subnet_topology, load_or_refresh_missing_nns_subnet_topology,
    load_or_refresh_missing_nns_subnet_topology_with_source,
    load_or_refresh_stale_nns_subnet_topology,
    load_or_refresh_stale_nns_subnet_topology_with_source, nns_subnet_topology_cache_path,
    nns_subnet_topology_freshness, nns_subnet_topology_refresh_lock_path,
    refresh_nns_subnet_topology, refresh_nns_subnet_topology_with_source,
};
#[cfg(feature = "host")]
pub use error::NnsSubnetTopologyHostError;
#[cfg(feature = "host")]
pub use model::{
    CachedNnsSubnetTopologyReport, NnsSubnetTopologyCacheRequest, NnsSubnetTopologyRefreshRequest,
};
#[cfg(feature = "host")]
pub use source::NnsSubnetTopologySource;

/// Current serialized schema version for exact-version Subnet topology reports.
pub const NNS_SUBNET_TOPOLOGY_REPORT_SCHEMA_VERSION: u32 = 1;
#[cfg(feature = "host")]
/// Default mainnet replica endpoint for live topology refreshes.
pub const DEFAULT_NNS_SUBNET_TOPOLOGY_SOURCE_ENDPOINT: &str = "https://icp-api.io";
#[cfg(feature = "host")]
/// Default age after which a cached topology report is stale.
pub const DEFAULT_NNS_SUBNET_TOPOLOGY_STALE_AFTER_SECONDS: u64 = 24 * 60 * 60;
#[cfg(feature = "host")]
/// Default age after which a topology refresh lock is stale.
pub const DEFAULT_NNS_SUBNET_TOPOLOGY_REFRESH_LOCK_STALE_SECONDS: u64 = 30 * 60;

#[cfg(all(test, feature = "host"))]
mod tests;