ic-query 0.5.11

Internet Computer query library for NNS, SNS, ICRC, and related 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
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

mod error;
#[cfg(feature = "host")]
mod host;
mod json;
mod model;
mod principal;
#[cfg(feature = "host")]
mod report;
mod resolver;
#[cfg(feature = "host")]
mod text;
#[cfg(feature = "host")]
mod time;

pub use error::CatalogError;
#[cfg(all(test, feature = "host"))]
pub(crate) use host::refresh_subnet_catalog_with_source;
#[cfg(feature = "host")]
pub use host::{
    CachedSubnetCatalog, SubnetCatalogCacheRequest, SubnetCatalogHostError,
    load_cached_subnet_catalog, load_or_refresh_subnet_catalog, subnet_catalog_path,
    subnet_catalog_refresh_lock_path,
};
#[cfg(feature = "host")]
pub(crate) use host::{
    LiveNnsRegistryRefreshSource, SubnetCatalogRefreshRequest, SubnetCatalogRefreshSource,
    load_or_refresh_subnet_catalog_with_source, refresh_subnet_catalog,
};
pub use json::{catalog_to_pretty_json, parse_catalog_json};
pub use model::{
    ClassificationSource, GeographicScope, RoutingRange, SubnetCatalog, SubnetInfo, SubnetKind,
    SubnetSpecialization,
};
pub use principal::canonical_principal_text;
pub(crate) use principal::{parse_principal, principal_bytes};
#[cfg(feature = "host")]
pub(crate) use report::{
    CatalogStaleStatus, SubnetCatalogFilters, SubnetCatalogInfoReport, SubnetCatalogInfoRequest,
    SubnetCatalogListReport, SubnetCatalogListRequest, SubnetCatalogRefreshReport,
    build_subnet_catalog_info_report, build_subnet_catalog_list_report,
};
#[cfg(all(test, feature = "host"))]
pub(crate) use report::{SubnetCatalogSubnetRow, build_subnet_catalog_list_report_with_source};
pub use resolver::{ResolveAs, ResolvedSubnet, ResolvedSubnetSubject};
#[cfg(all(test, feature = "host"))]
pub(crate) use text::compact_principal;
#[cfg(feature = "host")]
pub(crate) use text::{
    subnet_catalog_info_report_text, subnet_catalog_list_report_text,
    subnet_catalog_list_report_verbose_text, subnet_catalog_refresh_report_text,
};
#[cfg(all(test, feature = "host"))]
pub(crate) use time::parse_stale_after_duration;
#[cfg(feature = "host")]
pub(crate) use time::{catalog_stale_status, format_utc_timestamp_secs};

pub const CATALOG_SCHEMA_VERSION: u32 = 1;
pub const MAINNET_NETWORK: &str = "ic";
pub const MAINNET_REGISTRY_CANISTER_ID: &str = "rwlgt-iiaaa-aaaaa-aaaaa-cai";
#[cfg(feature = "host")]
pub(crate) const DEFAULT_STALE_AFTER_SECONDS: u64 = 7 * 24 * 60 * 60;
#[cfg(feature = "host")]
pub(crate) const DEFAULT_REFRESH_LOCK_STALE_SECONDS: u64 = 30 * 60;
#[cfg(feature = "host")]
pub const DEFAULT_SUBNET_CATALOG_SOURCE_ENDPOINT: &str = "https://icp-api.io";
#[cfg(feature = "host")]
pub(crate) const SUBNET_CATALOG_LIST_REPORT_SCHEMA_VERSION: u32 = 1;
#[cfg(feature = "host")]
pub(crate) const SUBNET_CATALOG_INFO_REPORT_SCHEMA_VERSION: u32 = 1;
#[cfg(feature = "host")]
pub(crate) const SUBNET_CATALOG_REFRESH_REPORT_SCHEMA_VERSION: u32 = 1;

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