ic-query 0.84.0

Internet Computer query library for CloudEngine, 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
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

use crate::nns::inventory::{
    NnsInventoryInputKind, NnsInventoryResolveError, resolve_nns_inventory_row,
};

use super::{
    NNS_NODE_INFO_REPORT_SCHEMA_VERSION, NnsInventoryInfoRequest, NnsNodeHostError,
    NnsNodeInfoReport, NnsNodeListReport, NnsNodeListRequest,
    cache::{load_cached_nns_node_report, nns_node_cache_path},
    filters::filter_node_list_report,
    refresh::refresh_nns_node_report_with_source,
    source::NnsNodeSource,
};
use crate::nns::{LiveNnsSource, inventory::load_or_refresh_nns_inventory_report};
use crate::{QueryProgress, progress::IgnoreQueryProgress};

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

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

/// Build the report while reporting authorized cache refreshes.
pub async fn build_nns_node_list_report_with_progress(
    request: &NnsNodeListRequest,
    progress: &mut dyn QueryProgress,
) -> Result<NnsNodeListReport, NnsNodeHostError> {
    build_nns_node_list_report_with_source_and_progress(
        request,
        &LiveNnsSource::default(),
        progress,
    )
    .await
}

pub async fn build_nns_node_list_report_with_source(
    request: &NnsNodeListRequest,
    source: &dyn NnsNodeSource,
) -> Result<NnsNodeListReport, NnsNodeHostError> {
    build_nns_node_list_report_with_source_and_progress(request, source, &mut IgnoreQueryProgress)
        .await
}

/// Build the report with a caller-owned source and progress sink.
pub async fn build_nns_node_list_report_with_source_and_progress(
    request: &NnsNodeListRequest,
    source: &dyn NnsNodeSource,
    progress: &mut dyn QueryProgress,
) -> Result<NnsNodeListReport, NnsNodeHostError> {
    let report = load_or_refresh_nns_inventory_report(
        &request.inventory,
        nns_node_cache_path(
            &request.inventory.cache.cache_root,
            &request.inventory.cache.network,
        ),
        progress,
        |cache| load_cached_nns_node_report(cache).map(|cached| cached.report),
        async |refresh_request| {
            refresh_nns_node_report_with_source(refresh_request, source)
                .await
                .map(|_| ())
        },
    )
    .await?;
    Ok(filter_node_list_report(report, &request.filters))
}

/// Build the report while reporting authorized cache refreshes.
pub async fn build_nns_node_info_report_with_progress(
    request: &NnsInventoryInfoRequest,
    progress: &mut dyn QueryProgress,
) -> Result<NnsNodeInfoReport, NnsNodeHostError> {
    build_nns_node_info_report_with_source_and_progress(
        request,
        &LiveNnsSource::default(),
        progress,
    )
    .await
}

pub async fn build_nns_node_info_report_with_source(
    request: &NnsInventoryInfoRequest,
    source: &dyn NnsNodeSource,
) -> Result<NnsNodeInfoReport, NnsNodeHostError> {
    build_nns_node_info_report_with_source_and_progress(request, source, &mut IgnoreQueryProgress)
        .await
}

/// Build the report with a caller-owned source and progress sink.
pub async fn build_nns_node_info_report_with_source_and_progress(
    request: &NnsInventoryInfoRequest,
    source: &dyn NnsNodeSource,
    progress: &mut dyn QueryProgress,
) -> Result<NnsNodeInfoReport, NnsNodeHostError> {
    let list_request = NnsNodeListRequest::new(
        request.cache.clone(),
        request.source_endpoint.clone(),
        request.now_unix_secs,
    );
    let mut report =
        build_nns_node_list_report_with_source_and_progress(&list_request, source, progress)
            .await?;
    let (index, resolved_from) = resolve_node(&report, &request.input)?;
    let node = report.nodes.swap_remove(index);
    Ok(NnsNodeInfoReport {
        schema_version: NNS_NODE_INFO_REPORT_SCHEMA_VERSION,
        input: request.input.clone(),
        resolved_from,
        provenance: report.provenance,
        node,
    })
}

pub(super) fn resolve_node(
    report: &NnsNodeListReport,
    input: &str,
) -> Result<(usize, String), NnsNodeHostError> {
    resolve_nns_inventory_row(
        &report.nodes,
        |row| row.node_principal.as_str(),
        input,
        NnsInventoryInputKind::Principal,
        "node_principal",
    )
    .map_err(|error| match error {
        NnsInventoryResolveError::NotFound { input } => NnsNodeHostError::NodeNotFound { input },
        NnsInventoryResolveError::Ambiguous { prefix, matches } => {
            NnsNodeHostError::AmbiguousNodePrefix { prefix, matches }
        }
    })
}