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

use super::NnsTopologyAssessmentStatus;
use serde::{Deserialize, Serialize};

///
/// NnsTopologyGapsReport
///
/// NNS topology report listing unresolved registry relations.
///

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct NnsTopologyGapsReport {
    pub schema_version: u32,
    pub network: String,
    pub source_endpoint: String,
    pub status: NnsTopologyAssessmentStatus,
    pub gaps: Vec<NnsTopologyGapRow>,
}

///
/// NnsTopologyGapRow
///
/// One unresolved subject found while joining topology inputs.
///

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct NnsTopologyGapRow {
    pub subject_kind: NnsTopologyGapSubjectKind,
    pub subject: String,
    pub missing_relation: NnsTopologyGapRelationKind,
    pub referenced_id: String,
}

///
/// NnsTopologyGapSubjectKind
///
/// Registry subject whose referenced topology relation is missing.
///

#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum NnsTopologyGapSubjectKind {
    /// A Registry node record or Subnet membership node.
    Node,
    /// A Registry node-operator record.
    NodeOperator,
}

impl NnsTopologyGapSubjectKind {
    /// Return the stable JSON and text label.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Node => "node",
            Self::NodeOperator => "node_operator",
        }
    }
}

///
/// NnsTopologyGapRelationKind
///
/// Required Registry relation missing from a component-topology join.
///

#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum NnsTopologyGapRelationKind {
    /// The referenced node provider is absent.
    NodeProvider,
    /// The referenced node operator is absent.
    NodeOperator,
    /// The referenced data center is absent.
    DataCenter,
}

impl NnsTopologyGapRelationKind {
    /// Return the stable JSON and text label.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::NodeProvider => "node_provider",
            Self::NodeOperator => "node_operator",
            Self::DataCenter => "data_center",
        }
    }
}

#[cfg(test)]
mod tests;