ic-query 0.9.0

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

//! Module: sns::report::neurons_cache::collection::fetch::state
//!
//! Responsibility: maintain SNS neuron collection paging state.
//! Does not own: live fetching, cache writing, report construction, or CLI parsing.
//! Boundary: deduplicates rows, tracks cursors, and produces a complete neuron collection.

use crate::snapshot_cache::{PagedCollectionPage, PagedCollectionState};
use crate::sns::report::{
    SnsHostError, SnsNeuronRow, hex_bytes,
    neurons_cache::model::CompleteSnsNeurons,
    source::{MainnetSnsNeuronPage, SnsNeuronId},
};

///
/// SnsNeuronsCollectionState
///
/// Accumulated page state for a complete SNS neuron snapshot refresh.
///

pub(super) struct SnsNeuronsCollectionState {
    pages: PagedCollectionState<SnsNeuronRow, SnsNeuronId>,
}

impl SnsNeuronsCollectionState {
    pub(super) fn new() -> Self {
        Self {
            pages: PagedCollectionState::new(),
        }
    }

    pub(super) const fn page_count(&self) -> u32 {
        self.pages.page_count()
    }

    pub(super) const fn row_count(&self) -> usize {
        self.pages.row_count()
    }

    pub(super) const fn start_page_at(&self) -> Option<&SnsNeuronId> {
        self.pages.next_cursor()
    }

    pub(super) const fn has_next_cursor(&self) -> bool {
        self.pages.has_next_cursor()
    }

    pub(super) fn ingest_page(
        &mut self,
        page: MainnetSnsNeuronPage,
    ) -> Result<PagedCollectionPage, SnsHostError> {
        if page
            .neurons
            .iter()
            .any(|neuron| !valid_neuron_id(&neuron.neuron_id))
        {
            return Err(SnsHostError::InvalidNeuronId);
        }
        Ok(self.pages.ingest_page(
            page.neurons,
            page.last_cursor,
            |cursor| hex_bytes(&cursor.id),
            |neuron| neuron.neuron_id.clone(),
        ))
    }

    pub(super) fn into_complete(self) -> CompleteSnsNeurons {
        let complete = self.pages.into_complete(|cursor| hex_bytes(&cursor.id));
        CompleteSnsNeurons {
            neurons: complete.rows,
            page_count: complete.page_count,
            last_cursor: complete.last_cursor,
        }
    }
}

fn valid_neuron_id(neuron_id: &str) -> bool {
    !neuron_id.is_empty()
        && neuron_id.len().is_multiple_of(2)
        && neuron_id.bytes().all(|byte| byte.is_ascii_hexdigit())
}