ic-query 0.26.1

Internet Computer query library for 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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

//! Module: sns::report::live::fetch::neurons
//!
//! Responsibility: fetch SNS governance neurons.
//! Does not own: lookup resolution, cache storage, sorting, or rendering.
//! Boundary: queries bounded and paged neuron data for live reports and refreshes.

use super::block_on_sns;
use crate::sns::report::{
    SnsHostError,
    live::{
        convert::{mainnet_sns_neuron, sns_neuron_row},
        fetch::governance_canister,
        query::{principal_from_text, query_canister, sns_agent},
        types::{
            GetNeuronRequest, GetNeuronResponse, GetNeuronResult, ListNeuronsRequest,
            ListNeuronsResponse,
        },
    },
    source::{
        MainnetSns, MainnetSnsNeuron, MainnetSnsNeuronPage, MainnetSnsNeurons, SnsNeuronId,
        SnsSourceRequest, sns_neuron_id_from_text, validate_mainnet_sns_neuron,
        validate_mainnet_sns_neuron_page,
    },
};

const GET_NEURON_METHOD: &str = "get_neuron";

/// Fetch one exact full SNS neuron for one resolved mainnet SNS.
pub(in crate::sns::report::live) fn fetch_mainnet_sns_neuron(
    request: &SnsSourceRequest,
    sns: &MainnetSns,
    neuron_id: &str,
) -> Result<MainnetSnsNeuron, SnsHostError> {
    block_on_sns(fetch_mainnet_sns_neuron_async(request, sns, neuron_id))
}

/// Fetch a bounded SNS neuron listing for one resolved mainnet SNS.
pub(in crate::sns::report::live) fn fetch_mainnet_sns_neurons(
    request: &SnsSourceRequest,
    sns: &MainnetSns,
    limit: u32,
    owner_principal_id: Option<&str>,
) -> Result<MainnetSnsNeurons, SnsHostError> {
    block_on_sns(fetch_mainnet_sns_neurons_async(
        request,
        sns,
        limit,
        owner_principal_id,
    ))
}

/// Fetch one SNS neuron page for complete snapshot refresh.
pub(in crate::sns::report::live) fn fetch_mainnet_sns_neuron_page(
    request: &SnsSourceRequest,
    sns: &MainnetSns,
    limit: u32,
    start_page_at: Option<&SnsNeuronId>,
    owner_principal_id: Option<&str>,
) -> Result<MainnetSnsNeuronPage, SnsHostError> {
    block_on_sns(fetch_mainnet_sns_neuron_page_async(
        request,
        sns,
        limit,
        start_page_at,
        owner_principal_id,
    ))
}

async fn fetch_mainnet_sns_neurons_async(
    request: &SnsSourceRequest,
    sns: &MainnetSns,
    limit: u32,
    owner_principal_id: Option<&str>,
) -> Result<MainnetSnsNeurons, SnsHostError> {
    let page =
        fetch_mainnet_sns_neuron_page_async(request, sns, limit, None, owner_principal_id).await?;
    Ok(MainnetSnsNeurons {
        neurons: page.neurons,
    })
}

async fn fetch_mainnet_sns_neuron_async(
    request: &SnsSourceRequest,
    sns: &MainnetSns,
    neuron_id: &str,
) -> Result<MainnetSnsNeuron, SnsHostError> {
    let parsed_neuron_id = sns_neuron_id_from_text(neuron_id)?;
    let agent = sns_agent(request)?;
    let governance_canister = governance_canister(sns)?;
    let response: GetNeuronResponse = query_canister(
        &agent,
        &governance_canister,
        GET_NEURON_METHOD,
        "GetNeuronRequest",
        "GetNeuronResponse",
        &GetNeuronRequest {
            neuron_id: Some(parsed_neuron_id),
        },
    )
    .await?;
    let neuron = match response
        .result
        .ok_or(SnsHostError::MissingGovernanceResult {
            method: GET_NEURON_METHOD,
        })? {
        GetNeuronResult::Neuron(neuron) => mainnet_sns_neuron(*neuron)?,
        GetNeuronResult::Error(error) => {
            return Err(SnsHostError::GovernanceError {
                method: GET_NEURON_METHOD,
                error_type: error.error_type,
                message: error.error_message,
            });
        }
    };
    validate_mainnet_sns_neuron(&neuron, neuron_id)?;
    Ok(neuron)
}

async fn fetch_mainnet_sns_neuron_page_async(
    request: &SnsSourceRequest,
    sns: &MainnetSns,
    limit: u32,
    start_page_at: Option<&SnsNeuronId>,
    owner_principal_id: Option<&str>,
) -> Result<MainnetSnsNeuronPage, SnsHostError> {
    let agent = sns_agent(request)?;
    let governance_canister = governance_canister(sns)?;
    let owner_principal = owner_principal_id
        .map(|principal| principal_from_text(principal, "owner_principal_id"))
        .transpose()?;
    let response: ListNeuronsResponse = query_canister(
        &agent,
        &governance_canister,
        "list_neurons",
        "ListNeuronsRequest",
        "ListNeuronsResponse",
        &ListNeuronsRequest {
            of_principal: owner_principal,
            limit,
            start_page_at: start_page_at.cloned(),
        },
    )
    .await?;
    let last_cursor = response.neurons.last().and_then(|neuron| neuron.id.clone());
    let neurons = response
        .neurons
        .into_iter()
        .map(sns_neuron_row)
        .collect::<Result<Vec<_>, _>>()?;
    let page = MainnetSnsNeuronPage {
        neurons,
        last_cursor,
    };
    validate_mainnet_sns_neuron_page(&page, limit)?;
    Ok(page)
}