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

//! Module: sns::report::live::query
//!
//! Responsibility: low-level live SNS query helpers.
//! Does not own: report assembly, Candid wire type definitions, or rendering.
//! Boundary: builds agents, parses principals, and maps query failures to typed errors.

use super::SnsHostError;
use crate::report::CollectionSourceRequest;
use crate::{agent::MAX_IC_AGENT_RESPONSE_BODY_BYTES, sns::report::enforce_mainnet_network};
use ic_platform::agent::Agent;
use ic_platform::candid::contract::Principal;

crate::candid_call::impl_candid_call_error!(SnsHostError);

/// Build an IC agent after enforcing one explicit SNS source request.
pub(super) fn sns_agent<'a>(
    source: &'a crate::sns::LiveSnsSource,
    request: &CollectionSourceRequest,
) -> Result<&'a Agent, SnsHostError> {
    enforce_mainnet_network(&request.network)?;
    crate::agent::endpoint_agent(
        &source.agent,
        &request.endpoint,
        MAX_IC_AGENT_RESPONSE_BODY_BYTES,
        |reason| SnsHostError::AgentBuild {
            endpoint: request.endpoint.clone(),
            reason,
        },
    )
}

/// Parse a principal text field into a typed principal or host error.
pub(super) fn principal_from_text(
    value: &str,
    field: &'static str,
) -> Result<Principal, SnsHostError> {
    Principal::from_text(value).map_err(|err| SnsHostError::InvalidPrincipal {
        field,
        reason: err.to_string(),
    })
}