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

//! Canonical SNS canister identities shared by discovery, joined catalogs and reports.

use serde::{Deserialize, Serialize};

///
/// MainnetSnsCanisters
///
/// Complete canister identities for one deployed SNS shared by sources and reports.
///

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct MainnetSnsCanisters {
    /// SNS Root canister principal.
    pub root_canister_id: String,
    /// SNS Governance canister principal.
    pub governance_canister_id: String,
    /// SNS ledger canister principal.
    pub ledger_canister_id: String,
    /// SNS decentralization-swap canister principal.
    pub swap_canister_id: String,
    /// SNS ledger index canister principal.
    pub index_canister_id: String,
}

///
/// SnsInstanceContext
///
/// SNS instance identity and acquisition metadata shared by lookup reports.
///

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct SnsInstanceContext {
    /// Requested IC network identity.
    pub network: String,
    /// SNS-W canister used for discovery.
    pub sns_wasm_canister_id: String,
    /// UTC collection timestamp.
    pub fetched_at: String,
    /// Explicit collection endpoint.
    pub source_endpoint: String,
    /// Collector identity.
    pub fetched_by: String,
    /// Current SNS-W list position.
    pub id: usize,
    /// Current SNS display name.
    pub name: String,
    /// Stable SNS Root canister identity.
    pub root_canister_id: String,
}

///
/// SnsReportContext
///
/// SNS identity and collection provenance shared by governance report envelopes.
///

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct SnsReportContext {
    /// Shared record, flattened in JSON.
    #[serde(flatten)]
    pub instance: SnsInstanceContext,
    /// Stable SNS Governance canister identity.
    pub governance_canister_id: String,
}

impl<'de> Deserialize<'de> for SnsReportContext {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        // A strict parent must see every consumed key; nested Serde flattening cannot track them.
        #[derive(Deserialize)]
        struct Fields {
            network: String,
            sns_wasm_canister_id: String,
            fetched_at: String,
            source_endpoint: String,
            fetched_by: String,
            id: usize,
            name: String,
            root_canister_id: String,
            governance_canister_id: String,
        }
        let fields = Fields::deserialize(deserializer)?;
        Ok(Self {
            instance: SnsInstanceContext {
                network: fields.network,
                sns_wasm_canister_id: fields.sns_wasm_canister_id,
                fetched_at: fields.fetched_at,
                source_endpoint: fields.source_endpoint,
                fetched_by: fields.fetched_by,
                id: fields.id,
                name: fields.name,
                root_canister_id: fields.root_canister_id,
            },
            governance_canister_id: fields.governance_canister_id,
        })
    }
}