ic-query 0.6.0

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

#[cfg(feature = "host")]
mod build;
#[cfg(feature = "host")]
mod cache;
mod model;
#[cfg(feature = "host")]
mod refresh;
#[cfg(feature = "host")]
mod resolve;
#[cfg(feature = "host")]
mod source;
mod text;

#[cfg(feature = "host")]
pub use build::{build_nns_node_provider_info_report, build_nns_node_provider_list_report};
#[cfg(all(test, feature = "host"))]
use build::{
    build_nns_node_provider_info_report_with_source,
    build_nns_node_provider_list_report_with_source,
};
#[cfg(feature = "host")]
pub use cache::{nns_node_provider_cache_path, nns_node_provider_refresh_lock_path};
#[cfg(feature = "host")]
pub use refresh::refresh_nns_node_provider_report;
#[cfg(all(test, feature = "host"))]
use refresh::refresh_nns_node_provider_report_with_source;
#[cfg(all(test, feature = "host"))]
use resolve::resolve_node_provider;
#[cfg(all(test, feature = "host"))]
use source::NnsNodeProviderSource;

#[cfg(all(test, feature = "host"))]
use crate::ic_registry::{MainnetNodeProviderList, MainnetRegistryFetchRequest};

pub use model::{
    NnsNodeProviderCacheRequest, NnsNodeProviderInfoReport, NnsNodeProviderInfoRequest,
    NnsNodeProviderListReport, NnsNodeProviderListRequest, NnsNodeProviderRow,
};
#[cfg(feature = "host")]
pub use model::{
    NnsNodeProviderHostError, NnsNodeProviderRefreshReport, NnsNodeProviderRefreshRequest,
};
#[cfg(feature = "host")]
pub use text::nns_node_provider_refresh_report_text;
pub use text::{
    nns_node_provider_info_report_text, nns_node_provider_list_report_text,
    nns_node_provider_list_report_verbose_text,
};

pub const DEFAULT_NNS_SOURCE_ENDPOINT: &str = "https://icp-api.io";
#[cfg(feature = "host")]
pub const DEFAULT_NODE_PROVIDER_REFRESH_LOCK_STALE_SECONDS: u64 = 30 * 60;
#[cfg(feature = "host")]
pub const NNS_NODE_PROVIDER_LIST_REPORT_SCHEMA_VERSION: u32 = 1;
#[cfg(feature = "host")]
pub const NNS_NODE_PROVIDER_INFO_REPORT_SCHEMA_VERSION: u32 = 1;
#[cfg(feature = "host")]
pub const NNS_NODE_PROVIDER_REFRESH_REPORT_SCHEMA_VERSION: u32 = 1;
#[cfg(feature = "host")]
const NNS_NODE_PROVIDER_CACHE_DIR: &str = "node-provider";
#[cfg(feature = "host")]
const NNS_NODE_PROVIDER_CACHE_FILE: &str = "providers.json";

#[cfg(feature = "host")]
impl_nns_mainnet_network_enforcer!(NnsNodeProviderHostError);

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