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

use super::{
    NnsTopologyGapRelationKind,
    NnsTopologyGapRelationKind::{DataCenter, NodeOperator, NodeProvider},
    TopologyInventoryReports,
};
use crate::nns::{node::NnsNodeRow, node_operator::NnsNodeOperatorRow};
use std::collections::BTreeSet;

///
/// TopologyRelation
///
/// Membership decision for one borrowed topology reference.
///

pub(super) struct TopologyRelation<'a> {
    pub(super) kind: NnsTopologyGapRelationKind,
    pub(super) referenced_id: &'a str,
    pub(super) known: bool,
}

///
/// TopologyRelationIndex
///
/// Borrowed registry identifiers used to validate topology relation joins.
///

pub(in crate::nns::topology::report) struct TopologyRelationIndex<'a> {
    node_provider_principals: BTreeSet<&'a str>,
    node_operator_principals: BTreeSet<&'a str>,
    data_center_ids: BTreeSet<&'a str>,
}

impl<'a> TopologyRelationIndex<'a> {
    pub(in crate::nns::topology::report) fn from_reports(
        reports: &'a TopologyInventoryReports,
    ) -> Self {
        let node_provider_principals = reports
            .node_provider
            .node_providers
            .iter()
            .map(|provider| provider.node_provider_principal.as_str())
            .collect::<BTreeSet<_>>();
        let node_operator_principals = reports
            .registry
            .node_operators
            .iter()
            .map(|operator| operator.node_operator_principal.as_str())
            .collect::<BTreeSet<_>>();
        let data_center_ids = reports
            .registry
            .data_centers
            .iter()
            .map(|data_center| data_center.data_center_id.as_str())
            .collect::<BTreeSet<_>>();

        Self {
            node_provider_principals,
            node_operator_principals,
            data_center_ids,
        }
    }

    /// Return provider, operator and data-center relations in that order.
    pub(super) fn node_relations<'node>(
        &self,
        node: &'node NnsNodeRow,
    ) -> [TopologyRelation<'node>; 3] {
        [
            (NodeProvider, node.node_provider_principal.as_str()),
            (NodeOperator, node.node_operator_principal.as_str()),
            (DataCenter, node.data_center_id.as_str()),
        ]
        .map(|(kind, referenced_id)| self.relation(kind, referenced_id))
    }

    /// Return provider and data-center relations in that order.
    pub(super) fn operator_relations<'node>(
        &self,
        operator: &'node NnsNodeOperatorRow,
    ) -> [TopologyRelation<'node>; 2] {
        [
            (NodeProvider, operator.node_provider_principal.as_str()),
            (DataCenter, operator.data_center_id.as_str()),
        ]
        .map(|(kind, referenced_id)| self.relation(kind, referenced_id))
    }

    fn relation<'id>(
        &self,
        kind: NnsTopologyGapRelationKind,
        referenced_id: &'id str,
    ) -> TopologyRelation<'id> {
        let known = match kind {
            NodeProvider => self.node_provider_principals.contains(referenced_id),
            NodeOperator => self.node_operator_principals.contains(referenced_id),
            DataCenter => self.data_center_ids.contains(referenced_id),
        };
        TopologyRelation {
            kind,
            referenced_id,
            known,
        }
    }
}