ic-query 0.47.9

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
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

//! 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, PagedSnapshotRefresh,
        run_paged_snapshot_refresh_with_progress,
    },
    sns::report::{
        SnsHostError, SnsNeuronRow,
        cache_attempt::{SnsRefreshContext, write_running_sns_refresh_page},
        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) fn fetch_complete_sns_neurons(
    context: SnsRefreshContext<'_>,
    source: &dyn SnsNeuronsSource,
    progress: &mut dyn QueryProgress,
) -> Result<CompleteSnsNeurons, SnsHostError> {
    run_paged_snapshot_refresh_with_progress(
        SnsNeuronsRefreshPages {
            context,
            source,
            pages: PagedCollectionState::new(),
        },
        progress,
    )
}

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

struct SnsNeuronsRefreshPages<'a> {
    context: SnsRefreshContext<'a>,
    source: &'a dyn SnsNeuronsSource,
    pages: PagedCollectionState<SnsNeuronRow, SnsNeuronId>,
}

impl PagedSnapshotRefresh for SnsNeuronsRefreshPages<'_> {
    type Complete = CompleteSnsNeurons;
    type Error = SnsHostError;

    fn progress_text(&self) -> String {
        self.context
            .progress_text("neurons", self.pages.page_count(), self.pages.row_count())
    }

    fn max_pages_reached(&self) -> bool {
        self.context.max_pages_reached(self.pages.page_count())
    }

    fn incomplete_refresh_error(&self, reason: &'static str) -> Self::Error {
        SnsRefreshContext::incomplete_refresh_error(
            self.pages.page_count(),
            self.pages.row_count(),
            reason,
        )
    }

    fn fetch_next_page(&mut self) -> Result<PagedCollectionPage, Self::Error> {
        let mut page = self.source.fetch_sns_neuron_page(
            self.context.fetch_request,
            self.context.sns,
            self.context.request.page_size(),
            self.pages.next_cursor(),
            None,
        )?;
        validate_mainnet_sns_neuron_page(
            &page,
            self.context.request.page_size(),
            self.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) = self.pages.next_cursor()
            && page
                .neurons
                .first()
                .is_some_and(|neuron| neuron.neuron_id == hex_bytes(&cursor.id))
        {
            page.neurons.remove(0);
        }
        Ok(self
            .pages
            .ingest_page(page.neurons, page_len, page.last_cursor, |cursor| {
                hex_bytes(&cursor.id)
            }))
    }

    fn write_running_attempt(&self, page: &PagedCollectionPage) -> Result<(), Self::Error> {
        write_running_sns_refresh_page(
            self.context,
            self.pages.page_count(),
            self.pages.row_count(),
            page,
        )
    }

    fn page_exhausts_collection(&self, page: &PagedCollectionPage) -> bool {
        self.context
            .page_exhausts_collection(page, self.pages.has_next_cursor())
    }

    fn into_complete(self) -> Self::Complete {
        self.pages.into_complete(|cursor| hex_bytes(&cursor.id))
    }
}