ic-query 0.29.4

Internet Computer query library for 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

//! 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::{
    ClassificationSource, GeographicScope, RawSubnetCatalog, SubnetInfo, SubnetSpecialization,
};
#[cfg(feature = "subnet-catalog-host")]
use crate::hex::hex_bytes;
#[cfg(feature = "subnet-catalog-host")]
use sha2::{Digest, Sha256};

/// 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")]
const FIDUCIARY_SUBNET: &str = "pzp6e-ekpqk-3c5x7-2h6so-njoeq-mt45d-h3h6c-q3mxf-vpeq5-fk5o7-yae";
#[cfg(feature = "subnet-catalog-host")]
const EUROPEAN_SUBNET: &str = "bkfrj-6k62g-dycql-7h53p-atvkj-zg4to-gaogh-netha-ptybj-ntsgw-rqe";

#[cfg(feature = "subnet-catalog-host")]
const CLASSIFICATION_POLICY: &str = concat!(
    "ic-query/subnet-catalog/classification/v1;",
    "subnet_type:0=unknown,1=application,2=system,4=application,5=cloud_engine,other=unknown;",
    "charges:application|cloud_engine;",
    "defaults:specialization=none,geographic_scope=global,label=subnet_kind,sources=registry|computed;",
    "fiduciary:pzp6e-ekpqk-3c5x7-2h6so-njoeq-mt45d-h3h6c-q3mxf-vpeq5-fk5o7-yae=",
    "fiduciary|global|fiduciary;",
    "european:bkfrj-6k62g-dycql-7h53p-atvkj-zg4to-gaogh-netha-ptybj-ntsgw-rqe=",
    "european|europe|european;",
    "subnet_order=canonical_principal_text;",
    "routing_order=principal_bytes(start,end),subnet_principal",
);

#[cfg(feature = "subnet-catalog-host")]
#[must_use]
pub(super) fn classification_policy_digest() -> String {
    hex_bytes(&Sha256::digest(CLASSIFICATION_POLICY.as_bytes()))
}

#[cfg(feature = "subnet-catalog-host")]
pub(super) fn apply_mainnet_classification_policy(catalog: &mut RawSubnetCatalog) {
    for subnet in &mut catalog.subnets {
        apply_default_classification(subnet);
        match subnet.subnet_principal.as_str() {
            FIDUCIARY_SUBNET => apply_curated_classification(
                subnet,
                SubnetSpecialization::Fiduciary,
                GeographicScope::Global,
                "fiduciary",
            ),
            EUROPEAN_SUBNET => apply_curated_classification(
                subnet,
                SubnetSpecialization::European,
                GeographicScope::Europe,
                "european",
            ),
            _ => {}
        }
    }
}

#[cfg(feature = "subnet-catalog-host")]
fn apply_default_classification(subnet: &mut SubnetInfo) {
    subnet.subnet_specialization = SubnetSpecialization::None;
    subnet.subnet_specialization_source = ClassificationSource::Computed;
    subnet.geographic_scope = GeographicScope::Global;
    subnet.geographic_scope_source = ClassificationSource::Computed;
    subnet.subnet_label = subnet.subnet_kind.as_str().to_string();
    subnet.subnet_label_source = ClassificationSource::Computed;
}

#[cfg(feature = "subnet-catalog-host")]
fn apply_curated_classification(
    subnet: &mut SubnetInfo,
    specialization: SubnetSpecialization,
    geographic_scope: GeographicScope,
    label: &str,
) {
    subnet.subnet_specialization = specialization;
    subnet.subnet_specialization_source = ClassificationSource::Curated;
    subnet.geographic_scope = geographic_scope;
    subnet.geographic_scope_source = ClassificationSource::Curated;
    subnet.subnet_label = label.to_string();
    subnet.subnet_label_source = ClassificationSource::Curated;
}