ic-query 0.19.1

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

use super::{
    DEFAULT_NODE_REFRESH_LOCK_STALE_SECONDS, NNS_NODE_INFO_REPORT_SCHEMA_VERSION,
    NnsInventoryInfoRequest, NnsInventoryRefreshRequest, NnsNodeHostError, NnsNodeInfoReport,
    NnsNodeListFilters, NnsNodeListReport, NnsNodeListRequest, cache::load_cached_nns_node_report,
    filters::filter_node_list_report, refresh::refresh_nns_node_cache_with_source,
    resolve::resolve_node, source::NnsNodeSource,
};
use crate::{HostCacheError, cache_file::load_or_refresh_missing_cache, nns::LiveNnsSource};

pub fn build_nns_node_list_report(
    request: &NnsNodeListRequest,
) -> Result<NnsNodeListReport, NnsNodeHostError> {
    build_nns_node_list_report_with_source(request, &LiveNnsSource)
}

pub fn build_nns_node_info_report(
    request: &NnsInventoryInfoRequest,
) -> Result<NnsNodeInfoReport, NnsNodeHostError> {
    build_nns_node_info_report_with_source(request, &LiveNnsSource)
}

pub fn build_nns_node_list_report_with_source(
    request: &NnsNodeListRequest,
    source: &dyn NnsNodeSource,
) -> Result<NnsNodeListReport, NnsNodeHostError> {
    let report = load_or_refresh_missing_cache(
        || load_cached_nns_node_report(&request.cache).map(|cached| cached.report),
        |err| match err {
            NnsNodeHostError::Cache(HostCacheError::MissingCache { path, .. }) => Ok(path),
            err => Err(err),
        },
        |_| {
            let refresh_request = NnsInventoryRefreshRequest::new(
                request.cache.clone(),
                request.source_endpoint.clone(),
                request.now_unix_secs,
                DEFAULT_NODE_REFRESH_LOCK_STALE_SECONDS,
            );
            refresh_nns_node_cache_with_source(&refresh_request, source).map(|_| ())
        },
    )?;
    Ok(filter_node_list_report(report, &request.filters))
}

pub fn build_nns_node_info_report_with_source(
    request: &NnsInventoryInfoRequest,
    source: &dyn NnsNodeSource,
) -> Result<NnsNodeInfoReport, NnsNodeHostError> {
    let list_request = NnsNodeListRequest {
        cache: request.cache.clone(),
        source_endpoint: request.source_endpoint.clone(),
        now_unix_secs: request.now_unix_secs,
        filters: NnsNodeListFilters::default(),
    };
    let report = build_nns_node_list_report_with_source(&list_request, source)?;
    let (node, resolved_from) = resolve_node(&report, &request.input)?;
    Ok(NnsNodeInfoReport {
        schema_version: NNS_NODE_INFO_REPORT_SCHEMA_VERSION,
        input: request.input.clone(),
        resolved_from,
        network: report.network,
        registry_canister_id: report.registry_canister_id,
        registry_version: report.registry_version,
        fetched_at: report.fetched_at,
        source_endpoint: report.source_endpoint,
        fetched_by: report.fetched_by,
        node_principal: node.node_principal,
        node_operator_principal: node.node_operator_principal,
        node_provider_principal: node.node_provider_principal,
        subnet_principal: node.subnet_principal,
        subnet_kind: node.subnet_kind,
        data_center_id: node.data_center_id,
    })
}