ic-query 0.101.0

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

//! Module: sns::report::assemble
//!
//! Responsibility: assemble live and cached SNS neuron list reports.
//! Does not own: neuron fetching, sorting, cache loading, or rendering.
//! Boundary: carries source scope and pre-limit totals supplied by each caller.

use crate::report::{CollectionSourceRequest, ReportProvenance};
use crate::snapshot_cache::SnapshotEnvelope;
use crate::sns::report::SnsReportContext;
use crate::sns::report::{
    SNS_NEURONS_REPORT_SCHEMA_VERSION, SnsNeuronRow, SnsNeuronsReport, SnsNeuronsRequest,
};
use crate::sns::report::{SnsInstanceContext, cache_storage::SnsCacheMetadata};

/// Assemble selected neuron rows with their original acquisition scope and total.
pub(in crate::sns::report) fn sns_neurons_report_from_rows(
    request: &SnsNeuronsRequest,
    context: SnsReportContext,
    provenance: ReportProvenance,
    owner_principal_id: Option<String>,
    total_neuron_count: usize,
    neurons: Vec<SnsNeuronRow>,
) -> SnsNeuronsReport {
    SnsNeuronsReport {
        provenance,
        schema_version: SNS_NEURONS_REPORT_SCHEMA_VERSION,
        context,
        requested_limit: request.limit,
        owner_principal_id,

        sort: request.collection.sort_label().to_string(),
        total_neuron_count,

        neurons,
    }
}

impl SnsReportContext {
    pub(in crate::sns::report) fn from_snapshot<Data>(
        cache: SnapshotEnvelope<SnsCacheMetadata, Data>,
    ) -> (Self, Data) {
        (
            Self {
                instance: SnsInstanceContext {
                    network: cache.network,
                    fetched_at: cache.fetched_at,
                    source_endpoint: cache.source_endpoint,
                    fetched_by: cache.fetched_by,
                },
                governance_canister_id: cache.metadata.governance_canister_id,
            },
            cache.data,
        )
    }
    pub(in crate::sns::report) fn from_live(
        request: CollectionSourceRequest,
        governance_canister_id: String,
    ) -> Self {
        Self {
            instance: SnsInstanceContext {
                network: request.network,
                fetched_at: request.fetched_at,
                source_endpoint: request.endpoint,
                fetched_by: request.fetched_by,
            },
            governance_canister_id,
        }
    }
}