ic-query 0.93.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

use super::fetch_topology_inventory_reports;
use crate::nns::NnsInventoryListRequest;
use crate::nns::{
    LiveNnsSource,
    topology::report::{
        NnsTopologyCapacityReport, NnsTopologyGapsReport, NnsTopologyHostError,
        NnsTopologyProvidersReport, NnsTopologyRegionsReport, NnsTopologySource,
        capacity::topology_capacity_report_from_report, enforce_mainnet_network,
        gaps::topology_gaps_report_from_reports, providers::topology_providers_report_from_reports,
        regions::topology_regions_report_from_report,
    },
};

pub async fn build_nns_topology_gaps_report(
    request: &NnsInventoryListRequest,
) -> Result<NnsTopologyGapsReport, NnsTopologyHostError> {
    build_nns_topology_gaps_report_with_source(request, &LiveNnsSource::default()).await
}

pub async fn build_nns_topology_gaps_report_with_source(
    request: &NnsInventoryListRequest,
    source: &dyn NnsTopologySource,
) -> Result<NnsTopologyGapsReport, NnsTopologyHostError> {
    enforce_mainnet_network(request.cache.network.as_str())?;

    let reports = fetch_topology_inventory_reports(request, source).await?;

    Ok(topology_gaps_report_from_reports(
        request.cache.network.clone(),
        request.source_endpoint.clone(),
        &reports,
    ))
}

pub async fn build_nns_topology_capacity_report(
    request: &NnsInventoryListRequest,
) -> Result<NnsTopologyCapacityReport, NnsTopologyHostError> {
    build_nns_topology_capacity_report_with_source(request, &LiveNnsSource::default()).await
}

pub async fn build_nns_topology_capacity_report_with_source(
    request: &NnsInventoryListRequest,
    source: &dyn NnsTopologySource,
) -> Result<NnsTopologyCapacityReport, NnsTopologyHostError> {
    enforce_mainnet_network(request.cache.network.as_str())?;

    let snapshot = crate::nns::inventory::load_or_refresh_nns_inventory_report(
        request,
        source,
        &mut crate::progress::IgnoreQueryProgress,
    )
    .await?;
    let node_operator_report = crate::nns::node_operator::NnsNodeOperatorListReport {
        schema_version: 1,
        provenance: snapshot.provenance,
        node_operators: snapshot.node_operators,
    };

    Ok(topology_capacity_report_from_report(
        request.cache.network.clone(),
        request.source_endpoint.clone(),
        node_operator_report,
    ))
}

pub async fn build_nns_topology_regions_report(
    request: &NnsInventoryListRequest,
) -> Result<NnsTopologyRegionsReport, NnsTopologyHostError> {
    build_nns_topology_regions_report_with_source(request, &LiveNnsSource::default()).await
}

pub async fn build_nns_topology_regions_report_with_source(
    request: &NnsInventoryListRequest,
    source: &dyn NnsTopologySource,
) -> Result<NnsTopologyRegionsReport, NnsTopologyHostError> {
    enforce_mainnet_network(request.cache.network.as_str())?;

    let snapshot = crate::nns::inventory::load_or_refresh_nns_inventory_report(
        request,
        source,
        &mut crate::progress::IgnoreQueryProgress,
    )
    .await?;
    let data_center_report = crate::nns::data_center::NnsDataCenterListReport {
        schema_version: 1,
        provenance: snapshot.provenance,
        data_centers: snapshot.data_centers,
    };

    Ok(topology_regions_report_from_report(
        request.cache.network.clone(),
        request.source_endpoint.clone(),
        data_center_report,
    ))
}

pub async fn build_nns_topology_providers_report(
    request: &NnsInventoryListRequest,
) -> Result<NnsTopologyProvidersReport, NnsTopologyHostError> {
    build_nns_topology_providers_report_with_source(request, &LiveNnsSource::default()).await
}

pub async fn build_nns_topology_providers_report_with_source(
    request: &NnsInventoryListRequest,
    source: &dyn NnsTopologySource,
) -> Result<NnsTopologyProvidersReport, NnsTopologyHostError> {
    enforce_mainnet_network(request.cache.network.as_str())?;

    let reports = fetch_topology_inventory_reports(request, source).await?;

    Ok(topology_providers_report_from_reports(
        request.cache.network.clone(),
        request.source_endpoint.clone(),
        &reports,
    ))
}