ic-query 0.2.21

Internet Computer query CLI for NNS, SNS, and related 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

//! Module: sns::report::model::reports::proposals::cache
//!
//! Responsibility: define SNS proposal cache list and status report DTOs.
//! Does not own: cache discovery, cache file reads, or text rendering.
//! Boundary: preserves cache metadata fields for text and JSON reports.

use super::SnsProposalsRefreshAttemptStatus;
use crate::sns::report::SnsCacheSummarySortKey;

use serde::Serialize;

///
/// SnsProposalsCacheListReport
///
/// Serializable report listing complete local SNS proposal caches.
///

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct SnsProposalsCacheListReport {
    pub schema_version: u32,
    pub network: String,
    pub cache_root: String,
    pub cache_count: usize,
    pub caches: Vec<SnsProposalsCacheSummary>,
}

///
/// SnsProposalsCacheStatusReport
///
/// Serializable report describing one expected or discovered SNS proposal cache.
///

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct SnsProposalsCacheStatusReport {
    pub schema_version: u32,
    pub network: String,
    pub cache_root: String,
    pub input: String,
    pub found: bool,
    pub cache: Option<SnsProposalsCacheSummary>,
    pub expected_cache_path: Option<String>,
    pub refresh_attempt_path: Option<String>,
    pub latest_attempt: Option<SnsProposalsRefreshAttemptStatus>,
}

///
/// SnsProposalsCacheSummary
///
/// Serializable summary of one complete SNS proposal snapshot cache.
///

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct SnsProposalsCacheSummary {
    pub id: usize,
    pub name: String,
    pub root_canister_id: String,
    pub governance_canister_id: String,
    pub complete: bool,
    pub row_count: usize,
    pub page_count: u32,
    pub page_size: u32,
    pub fetched_at: String,
    pub source_endpoint: String,
    pub cache_path: String,
    pub refresh_attempt_path: String,
    pub latest_attempt: Option<SnsProposalsRefreshAttemptStatus>,
}

impl SnsCacheSummarySortKey for SnsProposalsCacheSummary {
    fn id(&self) -> usize {
        self.id
    }

    fn root_canister_id(&self) -> &str {
        &self.root_canister_id
    }
}