ic-query 0.80.1

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

use serde::{Deserialize, Serialize};

///
/// NnsTopologyCoverageReport
///
/// NNS topology report describing registry relation join coverage.
///

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct NnsTopologyCoverageReport {
    pub schema_version: u32,
    pub network: String,
    pub source_endpoint: String,
    pub node_count: usize,
    pub node_provider_count: usize,
    pub node_operator_count: usize,
    pub data_center_count: usize,
    /// Registry relation coverage, serialized as flat report counts.
    #[serde(flatten)]
    pub join_coverage: NnsTopologyJoinCoverageCounts,
}

///
/// NnsTopologyJoinCoverageCounts
///
/// Relation-coverage counts shared by coverage and summary reports.
///

#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct NnsTopologyJoinCoverageCounts {
    /// Number of nodes with known node provider references.
    pub nodes_with_known_node_provider_count: usize,
    /// Number of nodes with unknown node provider references.
    pub nodes_with_unknown_node_provider_count: usize,
    /// Number of nodes with known node operator references.
    pub nodes_with_known_node_operator_count: usize,
    /// Number of nodes with unknown node operator references.
    pub nodes_with_unknown_node_operator_count: usize,
    /// Number of nodes with known data center references.
    pub nodes_with_known_data_center_count: usize,
    /// Number of nodes with unknown data center references.
    pub nodes_with_unknown_data_center_count: usize,
    /// Number of node operators with known node provider references.
    pub node_operators_with_known_node_provider_count: usize,
    /// Number of node operators with unknown node provider references.
    pub node_operators_with_unknown_node_provider_count: usize,
    /// Number of node operators with known data center references.
    pub node_operators_with_known_data_center_count: usize,
    /// Number of node operators with unknown data center references.
    pub node_operators_with_unknown_data_center_count: usize,
}

impl NnsTopologyJoinCoverageCounts {
    pub(in crate::nns::topology::report) const fn relationships(
        &self,
    ) -> [(&'static str, usize, usize); 5] {
        [
            (
                "nodes -> node providers",
                self.nodes_with_known_node_provider_count,
                self.nodes_with_unknown_node_provider_count,
            ),
            (
                "nodes -> node operators",
                self.nodes_with_known_node_operator_count,
                self.nodes_with_unknown_node_operator_count,
            ),
            (
                "nodes -> data centers",
                self.nodes_with_known_data_center_count,
                self.nodes_with_unknown_data_center_count,
            ),
            (
                "node operators -> node providers",
                self.node_operators_with_known_node_provider_count,
                self.node_operators_with_unknown_node_provider_count,
            ),
            (
                "node operators -> data centers",
                self.node_operators_with_known_data_center_count,
                self.node_operators_with_unknown_data_center_count,
            ),
        ]
    }
}