ic-query 0.37.1

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

//! Module: sns::report::proposals_cache::reports
//!
//! Responsibility: group proposal cache report builders.
//! Does not own: refresh locking, page fetching, cache loading internals, or rendering.
//! Boundary: exposes cache-backed proposal list, cache list, and status reports.

mod cache_projection;
mod cached_detail;
mod cached_report;

use super::{
    SNS_PROPOSALS_CACHE_LIST_REPORT_SCHEMA_VERSION,
    SNS_PROPOSALS_CACHE_STATUS_REPORT_SCHEMA_VERSION, paths::SnsProposalsCacheCollection,
};
use crate::sns::report::{
    SnsCacheListReport, SnsCacheListRequest, SnsCacheStatusReport, SnsCacheStatusRequest,
    SnsHostError, build_sns_cache_list_report, cache_status::build_sns_cache_status_report,
};

pub(in crate::sns::report) use cached_detail::build_sns_proposal_report_from_cache;
pub(in crate::sns::report) use cached_report::build_sns_proposals_report_from_cache_or_refresh;

/// Build a local SNS proposal cache list report.
pub fn build_sns_proposals_cache_list_report(
    request: &SnsCacheListRequest,
) -> Result<SnsCacheListReport, SnsHostError> {
    build_sns_cache_list_report::<SnsProposalsCacheCollection>(
        request,
        SNS_PROPOSALS_CACHE_LIST_REPORT_SCHEMA_VERSION,
    )
}

/// Build an SNS proposal cache status report for one SNS input.
pub fn build_sns_proposals_cache_status_report(
    request: &SnsCacheStatusRequest,
) -> Result<SnsCacheStatusReport, SnsHostError> {
    build_sns_cache_status_report::<SnsProposalsCacheCollection>(
        request,
        SNS_PROPOSALS_CACHE_STATUS_REPORT_SCHEMA_VERSION,
    )
}