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

//! Module: sns::report::model::reports::list
//!
//! Responsibility: deployed SNS list and info report DTOs.
//! Does not own: SNS-W fetching, metadata lookup, sorting, or rendering.
//! Boundary: preserves raw report fields for text and JSON output writers.

use crate::report::ReportDataSource;
use crate::sns::report::model::MainnetSnsCanisters;
use serde::Serialize;

///
/// SnsListReport
///
/// Serializable report for deployed SNS listings.
///

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct SnsListReport {
    pub schema_version: u32,
    pub network: String,
    pub sns_wasm_canister_id: String,
    pub fetched_at: String,
    pub source_endpoint: String,
    pub fetched_by: String,
    /// Whether the rows came from a live collection or the joined catalog cache.
    pub data_source: ReportDataSource,
    /// Complete snapshot path when `data_source` is `cache`.
    pub cache_path: Option<String>,
    /// Whether the cache provenance represents an API-exhausted complete snapshot.
    pub cache_complete: Option<bool>,
    /// Whether the view includes SNS instances outside the normal visible lifecycle set.
    pub all_lifecycles: bool,
    pub verbose: bool,
    pub sort: String,
    /// Number of SNS instances in the complete joined catalog before view filtering.
    pub catalog_sns_count: usize,
    /// Number of catalog rows excluded by lifecycle filtering.
    pub excluded_sns_count: usize,
    pub sns_count: usize,
    pub metadata_error_count: usize,
    /// Number of returned rows carrying a bounded lifecycle query error.
    pub lifecycle_error_count: usize,
    pub sns_instances: Vec<SnsListRow>,
}

///
/// SnsListRow
///
/// Serializable row for one deployed SNS in a list report.
///

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct SnsListRow {
    pub id: usize,
    pub name: String,
    /// Complete deployed-SNS canister identity, serialized as the existing flat fields.
    #[serde(flatten)]
    pub canisters: MainnetSnsCanisters,
    pub metadata_error: Option<String>,
    /// Native Swap lifecycle discriminant, when the lifecycle query succeeded.
    pub lifecycle: Option<i32>,
    /// Bounded lifecycle query failure retained instead of dropping the SNS row.
    pub lifecycle_error: Option<String>,
}

///
/// SnsInfoReport
///
/// Serializable report for one deployed SNS resolved by id or root principal.
///

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct SnsInfoReport {
    pub schema_version: u32,
    pub network: String,
    pub sns_wasm_canister_id: String,
    pub fetched_at: String,
    pub source_endpoint: String,
    pub fetched_by: String,
    pub id: usize,
    pub name: String,
    pub description: Option<String>,
    pub url: Option<String>,
    /// Complete deployed-SNS canister identity, serialized as the existing flat fields.
    #[serde(flatten)]
    pub canisters: MainnetSnsCanisters,
    pub metadata_error: Option<String>,
}