ic-query 0.75.6

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

//! Module: sns::report::proposals_cache::collection
//!
//! Responsibility: fetch complete SNS proposal collections page by page.
//! Does not own: cache publication, command parsing, or report rendering.
//! Boundary: drives proposal paging and refresh-attempt progress updates.

use crate::{
    QueryProgress,
    snapshot_cache::{PagedCollectionPage, PagedCollectionState},
    sns::report::{
        SnsHostError, SnsProposalRow,
        cache_attempt::SnsRefreshContext,
        cache_collection::{SnsCollectionPages, collect_sns_snapshot},
        proposals_cache::model::CompleteSnsProposals,
        source::{SnsProposalsSource, validate_mainnet_sns_proposal_page},
    },
};

/// Fetch every proposal page required for a complete SNS proposal snapshot.
pub(in crate::sns::report::proposals_cache) async fn fetch_complete_sns_proposals(
    context: SnsRefreshContext<'_>,
    source: &dyn SnsProposalsSource,
    progress: &mut dyn QueryProgress,
) -> Result<CompleteSnsProposals, SnsHostError> {
    collect_sns_snapshot(context, SnsProposalsRefreshPages { source }, progress).await
}

///
/// SnsProposalsRefreshPages
///
/// Paged refresh runner state for complete SNS proposal collection.
///

struct SnsProposalsRefreshPages<'a> {
    source: &'a dyn SnsProposalsSource,
}

impl SnsCollectionPages for SnsProposalsRefreshPages<'_> {
    type Row = SnsProposalRow;
    type Cursor = u64;
    const COLLECTION: &'static str = "proposals";

    fn fetch_next_page<'a>(
        &'a mut self,
        context: SnsRefreshContext<'a>,
        pages: &'a mut PagedCollectionState<Self::Row, Self::Cursor>,
    ) -> crate::report::SourceFuture<'a, Result<PagedCollectionPage, SnsHostError>> {
        Box::pin(async move {
            let page = self
                .source
                .fetch_sns_proposal_page(
                    context.fetch_request,
                    context.sns,
                    context.request.page_size,
                    pages.next_cursor().copied(),
                )
                .await?;
            validate_mainnet_sns_proposal_page(
                &page,
                context.request.page_size,
                pages.next_cursor().copied(),
            )?;
            let last_cursor = page.iter().map(|proposal| proposal.proposal_id).min();
            let page_len = page.len();
            Ok(pages.ingest_page(page, page_len, last_cursor, ToString::to_string))
        })
    }

    fn cursor_text(cursor: &Self::Cursor) -> String {
        cursor.to_string()
    }
}