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

//! Module: sns::report::model::reports::proposals::report
//!
//! Responsibility: define SNS proposal list and detail report DTOs.
//! Does not own: live governance calls, row conversion, cache reads, or rendering.
//! Boundary: preserves report-level fields for text and JSON output.

use super::row::SnsProposalRow;
use crate::report::ReportProvenance;
use crate::sns::report::SnsReportContext;
use serde::Serialize;

///
/// SnsProposalReport
///
/// Serializable report for one SNS governance proposal detail lookup.
///

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct SnsProposalReport {
    pub schema_version: u32,
    /// SNS identity and provenance, serialized as flat report fields.
    #[serde(flatten)]
    pub context: SnsReportContext,
    pub proposal_id: u64,
    pub verbose: bool,
    pub show_ballots: bool,
    /// Shared record, flattened in serialized output.
    #[serde(flatten)]
    pub provenance: ReportProvenance,
    pub proposal: SnsProposalRow,
}

///
/// SnsProposalsReport
///
/// Serializable report for a bounded SNS governance proposal listing.
///

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct SnsProposalsReport {
    pub schema_version: u32,
    /// SNS identity and provenance, serialized as flat report fields.
    #[serde(flatten)]
    pub context: SnsReportContext,
    pub requested_limit: u32,
    pub before_proposal_id: Option<u64>,
    pub status_filter: String,
    pub topic_filter: String,
    pub eligibility_filter: String,
    pub proposer_filter: Option<String>,
    pub query_filter: Option<String>,
    pub sort: String,
    pub sort_direction: String,
    pub verbose: bool,
    /// Shared record, flattened in serialized output.
    #[serde(flatten)]
    pub provenance: ReportProvenance,
    pub proposal_count: usize,
    pub proposals: Vec<SnsProposalRow>,
}