ic-query 0.94.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
122
123
124
125

//! Module: subnet_catalog::model::policy
//!
//! Responsibility: own reproducible Subnet classification and resolver policy identity.
//! Does not own: Registry transport, cache loading, or report rendering.
//! Boundary: applies and validates the annotations committed by the policy digest.

#[cfg(feature = "subnet-catalog-host")]
use super::classification::REGISTRY_SUBNET_KINDS;
#[cfg(feature = "subnet-catalog-host")]
use super::{
    ClassificationSource, GeographicScope, SubnetClassification, SubnetInfo, SubnetSpecialization,
};
#[cfg(feature = "subnet-catalog-host")]
use ic_host_artifacts::artifact::Sha256Digest;
#[cfg(feature = "subnet-catalog-host")]
use std::fmt::Write;

/// Current classification policy schema.
pub const CLASSIFICATION_SCHEMA_VERSION: u32 = 1;
/// Current inclusive principal-byte resolver schema.
pub const RESOLVER_SCHEMA_VERSION: u32 = 1;

#[cfg(feature = "subnet-catalog-host")]
pub(super) const RESOLVER_BACKEND: &str = "local-nns-subnet-catalog";

#[cfg(feature = "subnet-catalog-host")]
struct CuratedClassification {
    principal: &'static str,
    specialization: SubnetSpecialization,
    geographic_scope: GeographicScope,
}

#[cfg(feature = "subnet-catalog-host")]
const CURATED_CLASSIFICATIONS: &[CuratedClassification] = &[
    CuratedClassification {
        principal: "pzp6e-ekpqk-3c5x7-2h6so-njoeq-mt45d-h3h6c-q3mxf-vpeq5-fk5o7-yae",
        specialization: SubnetSpecialization::Fiduciary,
        geographic_scope: GeographicScope::Global,
    },
    CuratedClassification {
        principal: "bkfrj-6k62g-dycql-7h53p-atvkj-zg4to-gaogh-netha-ptybj-ntsgw-rqe",
        specialization: SubnetSpecialization::European,
        geographic_scope: GeographicScope::Europe,
    },
];

#[cfg(feature = "subnet-catalog-host")]
#[must_use]
pub(super) fn classification_policy_digest() -> String {
    let kinds = REGISTRY_SUBNET_KINDS
        .iter()
        .map(|(raw, kind)| format!("{raw}={}", kind.as_str()))
        .collect::<Vec<_>>()
        .join(",");
    let charges = super::SubnetKind::ALL
        .into_iter()
        .filter(|kind| kind.charges_apply_by_default())
        .map(super::SubnetKind::as_str)
        .collect::<Vec<_>>()
        .join("|");
    let mut policy = format!(
        "ic-query/subnet-catalog/classification/v1;subnet_type:{kinds},other={};charges:{charges};defaults:specialization={},geographic_scope={},label=subnet_kind,sources={}|{};",
        super::SubnetKind::Unknown.as_str(),
        SubnetSpecialization::None.as_str(),
        GeographicScope::Global.as_str(),
        ClassificationSource::Registry.as_str(),
        ClassificationSource::Computed.as_str()
    );
    for rule in CURATED_CLASSIFICATIONS {
        let label = rule.specialization.as_str();
        write!(
            policy,
            "{label}:{}={label}|{}|{label};",
            rule.principal,
            rule.geographic_scope.as_str()
        )
        .expect("writing to String cannot fail");
    }
    policy.push_str("subnet_order=canonical_principal_text;routing_order=principal_bytes(start,end),subnet_principal");
    Sha256Digest::compute(policy.as_bytes()).to_string()
}

#[cfg(feature = "subnet-catalog-host")]
pub(super) fn apply_mainnet_classification_policy(subnets: &mut [SubnetInfo]) {
    for subnet in subnets {
        subnet.classification = mainnet_classification(subnet);
    }
}

#[cfg(feature = "subnet-catalog-host")]
pub(super) fn mainnet_classification(subnet: &SubnetInfo) -> SubnetClassification {
    let (specialization, geographic_scope, label, source) = CURATED_CLASSIFICATIONS
        .iter()
        .find(|rule| rule.principal == subnet.subnet_principal)
        .map_or(
            (
                SubnetSpecialization::None,
                GeographicScope::Global,
                subnet.classification.subnet_kind.as_str(),
                ClassificationSource::Computed,
            ),
            |rule| {
                (
                    rule.specialization,
                    rule.geographic_scope,
                    rule.specialization.as_str(),
                    ClassificationSource::Curated,
                )
            },
        );
    SubnetClassification {
        subnet_specialization: specialization,
        geographic_scope,
        subnet_label: label.to_string(),
        subnet_specialization_source: source,
        geographic_scope_source: source,
        subnet_label_source: source,
        registry_subnet_type: subnet.classification.registry_subnet_type,
        subnet_kind: subnet.classification.subnet_kind,
        subnet_kind_source: subnet.classification.subnet_kind_source,
    }
}

#[cfg(all(test, feature = "subnet-catalog-host"))]
mod tests;