ic-query 0.5.8

Internet Computer query library for NNS, SNS, ICRC, 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
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

//! Module: nns::proposals::report::assemble
//!
//! Responsibility: assemble NNS proposal list and detail reports.
//! Does not own: proposal fetching, cache loading, view filtering/sorting, or rendering.
//! Boundary: maps resolved proposal rows and provenance into serializable report DTOs.

use crate::nns::proposals::report::{
    NNS_PROPOSAL_LIST_REPORT_SCHEMA_VERSION, NNS_PROPOSAL_REPORT_SCHEMA_VERSION,
    model::{
        NnsProposalListReport, NnsProposalListSort, NnsProposalReport,
        NnsProposalRewardStatusFilter, NnsProposalRow, NnsProposalSortDirection,
        NnsProposalStatusFilter, NnsProposalTopicFilter,
    },
};
use std::path::Path;

///
/// NnsProposalReportProvenance
///
/// Shared source metadata attached to NNS proposal reports.
///

pub(in crate::nns::proposals::report) struct NnsProposalReportProvenance {
    pub(in crate::nns::proposals::report) data_source: String,
    pub(in crate::nns::proposals::report) cache_path: Option<String>,
    pub(in crate::nns::proposals::report) cache_complete: Option<bool>,
    pub(in crate::nns::proposals::report) result_scope: String,
}

impl NnsProposalReportProvenance {
    /// Build provenance for live NNS governance reports.
    pub(in crate::nns::proposals::report) fn live() -> Self {
        Self {
            data_source: "live".to_string(),
            cache_path: None,
            cache_complete: None,
            result_scope: "bounded-live".to_string(),
        }
    }

    /// Build provenance for complete-cache NNS governance reports.
    pub(in crate::nns::proposals::report) fn cache(
        cache_path: &Path,
        cache_complete: bool,
    ) -> Self {
        Self {
            data_source: "cache".to_string(),
            cache_path: Some(cache_path.display().to_string()),
            cache_complete: Some(cache_complete),
            result_scope: "complete-cache".to_string(),
        }
    }
}

///
/// NnsProposalListReportParts
///
/// Inputs needed to assemble one NNS proposal list report.
///

pub(in crate::nns::proposals::report) struct NnsProposalListReportParts {
    pub(in crate::nns::proposals::report) network: String,
    pub(in crate::nns::proposals::report) governance_canister_id: String,
    pub(in crate::nns::proposals::report) fetched_at: String,
    pub(in crate::nns::proposals::report) source_endpoint: String,
    pub(in crate::nns::proposals::report) fetched_by: String,
    pub(in crate::nns::proposals::report) requested_limit: u32,
    pub(in crate::nns::proposals::report) before_proposal_id: Option<u64>,
    pub(in crate::nns::proposals::report) status: NnsProposalStatusFilter,
    pub(in crate::nns::proposals::report) reward_status: NnsProposalRewardStatusFilter,
    pub(in crate::nns::proposals::report) topic: NnsProposalTopicFilter,
    pub(in crate::nns::proposals::report) proposer_neuron_id: Option<u64>,
    pub(in crate::nns::proposals::report) query: Option<String>,
    pub(in crate::nns::proposals::report) sort: NnsProposalListSort,
    pub(in crate::nns::proposals::report) sort_direction: NnsProposalSortDirection,
    pub(in crate::nns::proposals::report) verbose: bool,
    pub(in crate::nns::proposals::report) provenance: NnsProposalReportProvenance,
    pub(in crate::nns::proposals::report) proposals: Vec<NnsProposalRow>,
}

///
/// NnsProposalReportParts
///
/// Inputs needed to assemble one NNS proposal detail report.
///

pub(in crate::nns::proposals::report) struct NnsProposalReportParts {
    pub(in crate::nns::proposals::report) network: String,
    pub(in crate::nns::proposals::report) governance_canister_id: String,
    pub(in crate::nns::proposals::report) fetched_at: String,
    pub(in crate::nns::proposals::report) source_endpoint: String,
    pub(in crate::nns::proposals::report) fetched_by: String,
    pub(in crate::nns::proposals::report) proposal_id: u64,
    pub(in crate::nns::proposals::report) show_ballots: bool,
    pub(in crate::nns::proposals::report) verbose: bool,
    pub(in crate::nns::proposals::report) provenance: NnsProposalReportProvenance,
    pub(in crate::nns::proposals::report) proposal: NnsProposalRow,
}

/// Assemble an NNS proposal list report from resolved proposal parts.
pub(in crate::nns::proposals::report) fn nns_proposal_list_report_from_parts(
    parts: NnsProposalListReportParts,
) -> NnsProposalListReport {
    let proposal_count = parts.proposals.len();
    NnsProposalListReport {
        schema_version: NNS_PROPOSAL_LIST_REPORT_SCHEMA_VERSION,
        network: parts.network,
        governance_canister_id: parts.governance_canister_id,
        fetched_at: parts.fetched_at,
        source_endpoint: parts.source_endpoint,
        fetched_by: parts.fetched_by,
        data_source: parts.provenance.data_source,
        cache_path: parts.provenance.cache_path,
        cache_complete: parts.provenance.cache_complete,
        requested_limit: parts.requested_limit,
        before_proposal_id: parts.before_proposal_id,
        status_filter: parts.status.as_str().to_string(),
        reward_status_filter: parts.reward_status.as_str().to_string(),
        topic_filter: parts.topic.as_str().to_string(),
        proposer_filter: parts.proposer_neuron_id,
        query_filter: parts.query,
        sort: parts.sort.as_str().to_string(),
        sort_direction: parts.sort.direction_label(parts.sort_direction).to_string(),
        result_scope: parts.provenance.result_scope,
        verbose: parts.verbose,
        proposal_count,
        proposals: parts.proposals,
    }
}

/// Assemble an NNS proposal detail report from resolved proposal parts.
pub(in crate::nns::proposals::report) fn nns_proposal_report_from_parts(
    parts: NnsProposalReportParts,
) -> NnsProposalReport {
    NnsProposalReport {
        schema_version: NNS_PROPOSAL_REPORT_SCHEMA_VERSION,
        network: parts.network,
        governance_canister_id: parts.governance_canister_id,
        fetched_at: parts.fetched_at,
        source_endpoint: parts.source_endpoint,
        fetched_by: parts.fetched_by,
        data_source: parts.provenance.data_source,
        cache_path: parts.provenance.cache_path,
        cache_complete: parts.provenance.cache_complete,
        proposal_id: parts.proposal_id,
        show_ballots: parts.show_ballots,
        verbose: parts.verbose,
        proposal: parts.proposal,
    }
}