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

//! Module: sns::report::build::neurons
//!
//! Responsibility: build SNS neuron list reports.
//! Does not own: command parsing, cache file primitives, row rendering, or amount formatting.
//! Boundary: routes cache-backed sorts to cache reports or live API reads to assembly.

use crate::report::ReportProvenance;
use crate::sns::report::SnsReportContext;
use crate::sns::report::{
    SnsHostError, SnsNeuronCollection, SnsNeuronsReport, SnsNeuronsRequest,
    assemble::sns_neurons_report_from_rows,
    live::LiveSnsSource,
    neurons_cache,
    source::{SnsNeuronsSource, validate_mainnet_sns_neurons},
    target::resolve_neuron_target,
};

pub async fn build_sns_neurons_report(
    request: &SnsNeuronsRequest,
) -> Result<SnsNeuronsReport, SnsHostError> {
    build_sns_neurons_report_with_source(request, &LiveSnsSource::default()).await
}

pub async fn build_sns_neurons_report_with_source(
    request: &SnsNeuronsRequest,
    source: &dyn SnsNeuronsSource,
) -> Result<SnsNeuronsReport, SnsHostError> {
    let owner_principal_id = match &request.collection {
        SnsNeuronCollection::Cached { cache_root, sort } => {
            return neurons_cache::build_sns_neurons_report_from_cache(request, cache_root, *sort);
        }
        SnsNeuronCollection::Live { owner_principal_id } => owner_principal_id,
    };

    let lookup = resolve_neuron_target(&request.target)?;
    if let Some(owner) = owner_principal_id {
        crate::principal_text::validate_canonical(
            owner,
            |reason| SnsHostError::InvalidPrincipal {
                field: "owner_principal_id",
                reason,
            },
            |_| SnsHostError::InvalidPrincipal {
                field: "owner_principal_id",
                reason: "expected canonical principal text".to_string(),
            },
        )?;
    }
    let neurons = source
        .fetch_sns_neurons(
            &lookup.fetch_request,
            &lookup.governance_canister_id,
            request.limit,
            owner_principal_id.as_deref(),
        )
        .await?;
    validate_mainnet_sns_neurons(&neurons, request.limit)?;
    if let Some(owner) = owner_principal_id
        && neurons.iter().any(|neuron| {
            !neuron
                .permissions
                .iter()
                .any(|permission| permission.principal == *owner)
        })
    {
        return Err(SnsHostError::InvalidSourceData {
            capability: "SNS neurons",
            reason: "returned a neuron without permissions for the requested principal".to_string(),
        });
    }

    let total_neuron_count = neurons.len();
    Ok(sns_neurons_report_from_rows(
        request,
        SnsReportContext::from_live(lookup.fetch_request, lookup.governance_canister_id),
        ReportProvenance::live(),
        owner_principal_id.clone(),
        total_neuron_count,
        neurons,
    ))
}