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

use crate::nns::{
    LiveNnsSource, NnsInventoryError, NnsInventoryRefreshReport,
    topology::report::{
        NNS_TOPOLOGY_REFRESH_REPORT_SCHEMA_VERSION, NnsTopologyHostError, NnsTopologyRefreshReport,
        NnsTopologyRefreshRequest, NnsTopologyRefreshRow, NnsTopologyRefreshSource,
        enforce_mainnet_network,
    },
};
use crate::subnet_catalog::SubnetCatalogRefreshReport;

pub async fn refresh_nns_topology_report(
    request: &NnsTopologyRefreshRequest,
) -> Result<NnsTopologyRefreshReport, NnsTopologyHostError> {
    refresh_nns_topology_report_with_source(request, &LiveNnsSource::default()).await
}

pub async fn refresh_nns_topology_report_with_source(
    request: &NnsTopologyRefreshRequest,
    source: &dyn NnsTopologyRefreshSource,
) -> Result<NnsTopologyRefreshReport, NnsTopologyHostError> {
    enforce_mainnet_network(request.read.cache.network.as_str())?;

    let subnet_report = source.refresh_subnet_catalog_report(request).await?;
    let node_report = source.refresh_node_report(request).await?;
    validate_inventory_refresh_collection(&node_report, "nodes").map_err(|reason| {
        NnsInventoryError::InvalidSourceData {
            collection: crate::nns::NnsInventoryCollection::Node,
            reason,
        }
    })?;
    let node_provider_report = source.refresh_node_provider_report(request).await?;
    validate_inventory_refresh_collection(&node_provider_report, "node_providers").map_err(
        |reason| NnsInventoryError::InvalidSourceData {
            collection: crate::nns::NnsInventoryCollection::NodeProvider,
            reason,
        },
    )?;
    let node_operator_report = source.refresh_node_operator_report(request).await?;
    validate_inventory_refresh_collection(&node_operator_report, "node_operators").map_err(
        |reason| NnsInventoryError::InvalidSourceData {
            collection: crate::nns::NnsInventoryCollection::NodeOperator,
            reason,
        },
    )?;
    let data_center_report = source.refresh_data_center_report(request).await?;
    validate_inventory_refresh_collection(&data_center_report, "data_centers").map_err(
        |reason| NnsInventoryError::InvalidSourceData {
            collection: crate::nns::NnsInventoryCollection::DataCenter,
            reason,
        },
    )?;

    let components = vec![
        refresh_row_from_subnet_report(subnet_report),
        refresh_row_from_inventory_report(node_report),
        refresh_row_from_inventory_report(node_provider_report),
        refresh_row_from_inventory_report(node_operator_report),
        refresh_row_from_inventory_report(data_center_report),
    ];
    Ok(NnsTopologyRefreshReport {
        schema_version: NNS_TOPOLOGY_REFRESH_REPORT_SCHEMA_VERSION,
        network: request.read.cache.network.clone(),
        source_endpoint: request.read.source_endpoint.clone(),
        dry_run: request.dry_run,
        component_count: components.len(),
        wrote_cache_count: components
            .iter()
            .filter(|component| component.wrote_cache)
            .count(),
        replaced_existing_cache_count: components
            .iter()
            .filter(|component| component.replaced_existing_cache)
            .count(),
        components,
    })
}

fn refresh_row_from_inventory_report(report: NnsInventoryRefreshReport) -> NnsTopologyRefreshRow {
    NnsTopologyRefreshRow {
        source: report.collection,
        cache_path: report.cache_path,
        refresh_lock_path: report.refresh_lock_path,
        registry_version: report.provenance.registry_version,
        fetched_at: report.provenance.fetched_at,
        source_endpoint: report.provenance.source_endpoint,
        fetched_by: report.provenance.fetched_by,
        dry_run: report.dry_run,
        wrote_cache: report.wrote_cache,
        replaced_existing_cache: report.replaced_existing_cache,
        item_count: report.row_count,
    }
}

fn refresh_row_from_subnet_report(report: SubnetCatalogRefreshReport) -> NnsTopologyRefreshRow {
    NnsTopologyRefreshRow {
        source: "subnet_catalog".to_string(),
        cache_path: report.catalog_path,
        refresh_lock_path: report.refresh_lock_path,
        registry_version: report.metadata.registry_version,
        fetched_at: report.metadata.fetched_at,
        source_endpoint: report.metadata.source_endpoints.join(","),
        fetched_by: report.fetched_by,
        dry_run: report.dry_run,
        wrote_cache: report.wrote_catalog,
        replaced_existing_cache: report.replaced_existing_catalog,
        item_count: report.subnet_count,
    }
}

fn validate_inventory_refresh_collection(
    report: &NnsInventoryRefreshReport,
    expected: &str,
) -> Result<(), String> {
    if report.collection != expected {
        return Err(format!(
            "refresh collection is {:?}, expected {expected}",
            report.collection
        ));
    }
    Ok(())
}