ic-query 0.30.0

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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

//! Module: subnet_catalog::resolver::model
//!
//! Defines resolver options and outputs for subnet catalog lookups.

use crate::subnet_catalog::{RoutingRange, SubnetCatalogProvenance, SubnetInfo};
use candid::Principal;
use serde::{Deserialize, Serialize};
use std::str::FromStr;

///
/// ResolveAs
///
/// Caller-requested interpretation for an ambiguous principal input.
///

#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum ResolveAs {
    /// Resolve the input as a subnet principal.
    Subnet,
    /// Resolve the input as a canister principal.
    Canister,
}

impl ResolveAs {
    /// Returns the stable snake_case value used in CLI options and reports.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Subnet => "subnet",
            Self::Canister => "canister",
        }
    }
}

impl FromStr for ResolveAs {
    type Err = String;

    fn from_str(value: &str) -> Result<Self, Self::Err> {
        match value {
            "subnet" => Ok(Self::Subnet),
            "canister" => Ok(Self::Canister),
            other => Err(format!("invalid value {other}; use subnet or canister")),
        }
    }
}

///
/// ResolvedSubnetSubject
///
/// Subject type chosen by the resolver.
///

#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum ResolvedSubnetSubject {
    /// Resolver matched a subnet principal.
    Subnet,
    /// Resolver matched a canister principal through routing ranges.
    Canister,
}

impl ResolvedSubnetSubject {
    /// Returns the stable snake_case value used in reports.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Subnet => "subnet",
            Self::Canister => "canister",
        }
    }
}

///
/// ResolvedSubnet
///
/// Resolved subnet match and the evidence used to produce it.
///

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct ResolvedSubnet {
    pub input_principal: String,
    pub resolved_as: ResolvedSubnetSubject,
    pub resolved_from: String,
    pub subnet: SubnetInfo,
    pub matched_canister_principal: Option<String>,
    pub matched_routing_range: Option<RoutingRange>,
    /// Lowercase SHA-256 digest of the raw catalog supplying the match.
    pub catalog_digest: String,
    /// Complete provenance supplied by the raw catalog.
    pub provenance: SubnetCatalogProvenance,
}

///
/// ResolvedCanisterRoute
///
/// Authority-bearing route tied to the exact validated catalog that proved it.
///

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct ResolvedCanisterRoute {
    /// Canonical canister principal resolved through the routing table.
    pub canister: Principal,
    /// Canonical target Subnet principal.
    pub subnet: Principal,
    /// Complete validated Subnet classification matched by the route.
    pub subnet_info: SubnetInfo,
    /// Inclusive validated range containing the canister principal.
    pub matched_range: RoutingRange,
    /// Exact Registry version of the validated catalog.
    pub registry_version: u64,
    /// Binary SHA-256 digest of the validated catalog authority payload.
    pub catalog_digest: [u8; 32],
    /// Complete provenance of the validated catalog.
    pub provenance: SubnetCatalogProvenance,
}