ic-query 0.59.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

//! Module: nns::governance_query
//!
//! Responsibility: perform typed query calls against mainnet NNS Governance.
//! Does not own: report-specific errors, wire projections, or cache policy.
//! Boundary: retains NNS agent policy while sharing Candid query mechanics.

use crate::nns::{
    MAINNET_GOVERNANCE_CANISTER_ID, NnsSourceRequest,
    governance::{MAX_NNS_GOVERNANCE_RESPONSE_BYTES, NnsGovernanceError},
};
use candid::{CandidType, Deserialize, Principal};
use ic_agent::Agent;

pub async fn query_nns_governance<Arg, Response>(
    source: &crate::nns::LiveNnsSource,
    request: &NnsSourceRequest,
    method: &'static str,
    request_message: &'static str,
    response_message: &'static str,
    arg: &Arg,
) -> Result<Response, NnsGovernanceError>
where
    Arg: CandidType + Sync,
    Response: for<'de> Deserialize<'de> + CandidType,
{
    let arg = crate::candid_call::encode_request((arg,), request_message)?;
    let (agent, canister) = governance_target(source, request)?;
    crate::candid_call::query_encoded(agent, &canister, method, response_message, arg).await
}

pub async fn query_nns_governance_no_args<Response>(
    source: &crate::nns::LiveNnsSource,
    request: &NnsSourceRequest,
    method: &'static str,
    response_message: &'static str,
) -> Result<Response, NnsGovernanceError>
where
    Response: for<'de> Deserialize<'de> + CandidType,
{
    let arg = crate::candid_call::encode_request((), "()")?;
    let (agent, canister) = governance_target(source, request)?;
    crate::candid_call::query_encoded(agent, &canister, method, response_message, arg).await
}

fn governance_target<'a>(
    source: &'a crate::nns::LiveNnsSource,
    request: &NnsSourceRequest,
) -> Result<(&'a Agent, Principal), NnsGovernanceError> {
    let agent = source.agent.get(
        &request.endpoint,
        MAX_NNS_GOVERNANCE_RESPONSE_BYTES,
        |reason| NnsGovernanceError::AgentBuild {
            endpoint: request.endpoint.clone(),
            reason,
        },
    )?;
    let canister = Principal::from_text(MAINNET_GOVERNANCE_CANISTER_ID).map_err(|error| {
        NnsGovernanceError::CandidDecode {
            message: "governance_canister_id",
            reason: error.to_string(),
        }
    })?;
    Ok((agent, canister))
}