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

//! Module: sns::report::neurons_cache::collection
//!
//! Responsibility: drive paged SNS neuron collection refreshes.
//! Does not own: cache paths, snapshot publishing, report assembly, or CLI parsing.
//! Boundary: adapts SNS neuron page fetching to the shared paged snapshot runner.

use crate::{
    QueryProgress,
    snapshot_cache::{PagedCollectionPage, PagedCollectionState},
    sns::report::{
        SnsHostError, SnsNeuronRow,
        cache_attempt::SnsRefreshContext,
        cache_collection::{SnsCollectionPages, collect_sns_snapshot},
        hex_bytes,
        neurons_cache::model::CompleteSnsNeurons,
        source::{SnsNeuronId, SnsNeuronsSource, validate_mainnet_sns_neuron_page},
    },
};

/// Fetch every neuron page required for a complete SNS neuron snapshot.
pub(in crate::sns::report::neurons_cache) async fn fetch_complete_sns_neurons(
    context: SnsRefreshContext<'_>,
    source: &dyn SnsNeuronsSource,
    progress: &mut dyn QueryProgress,
) -> Result<CompleteSnsNeurons, SnsHostError> {
    collect_sns_snapshot(context, SnsNeuronsRefreshPages { source }, progress).await
}

///
/// SnsNeuronsRefreshPages
///
/// Paged refresh runner state for complete SNS neuron collection.
///

struct SnsNeuronsRefreshPages<'a> {
    source: &'a dyn SnsNeuronsSource,
}

impl SnsCollectionPages for SnsNeuronsRefreshPages<'_> {
    type Row = SnsNeuronRow;
    type Cursor = SnsNeuronId;
    const PROGRESS_COLLECTION: crate::QueryProgressCollection =
        crate::QueryProgressCollection::SnsNeurons;

    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 mut page = self
                .source
                .fetch_sns_neuron_page(
                    context.fetch_request,
                    context.governance_canister_id,
                    context.request.page_size,
                    pages.next_cursor(),
                    None,
                )
                .await?;
            validate_mainnet_sns_neuron_page(
                &page,
                context.request.page_size,
                pages.next_cursor(),
            )?;
            let page_len = page.neurons.len();
            // Ordered pages can repeat only the requested boundary; retain its first observation.
            if let Some(cursor) = pages.next_cursor()
                && page
                    .neurons
                    .first()
                    .is_some_and(|neuron| neuron.neuron_id == hex_bytes(&cursor.id))
            {
                page.neurons.remove(0);
            }
            Ok(context.ingest_page(pages, page.neurons, page_len, page.last_cursor))
        })
    }

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