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
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

//! Module: sns::report::live::fetch::upgrade
//!
//! Responsibility: fetch one SNS running version and its next blessed version.
//! Does not own: discovery, source validation, report assembly, cache IO, or rendering.
//! Boundary: performs exactly two bounded native queries and retains only next-version failure.
use crate::candid_call::query_canister;
use crate::sns::report::{
    MAINNET_SNS_WASM_CANISTER_ID, MainnetSns, MainnetSnsUpgrade, SnsCanisterMethod, SnsHostError,
    SnsRunningVersionResponse, SnsSourceRequest, SnsUpgradeQueryGap,
    live::{
        convert::{sns_pending_upgrade, sns_running_version_response, sns_version},
        query::{principal_from_text, sns_agent},
        types::{
            GetNextSnsVersionRequest, GetNextSnsVersionResponse, GetRunningSnsVersionRequest,
            GetRunningSnsVersionResponse,
        },
    },
};
use candid::Principal;
use ic_agent::Agent;

pub(in crate::sns::report::live) async fn fetch_mainnet_sns_upgrade(
    source: &crate::sns::LiveSnsSource,
    request: &SnsSourceRequest,
    sns: &MainnetSns,
) -> Result<MainnetSnsUpgrade, SnsHostError> {
    let agent = sns_agent(source, request)?;
    let governance_canister =
        principal_from_text(&sns.governance_canister_id, "governance_canister_id")?;
    let sns_wasm_canister =
        principal_from_text(MAINNET_SNS_WASM_CANISTER_ID, "sns_wasm_canister_id")?;

    let running = query_running_sns_version(agent, &governance_canister).await?;
    let deployed_wire =
        running
            .deployed_version
            .ok_or_else(|| SnsHostError::MissingRunningSnsVersion {
                method: SnsCanisterMethod::GetRunningSnsVersion.as_str(),
                governance_canister_id: sns.governance_canister_id.clone(),
            })?;
    let deployed_version = sns_version(deployed_wire.clone());
    let pending_upgrade = running.pending_version.map(sns_pending_upgrade);

    let next_request = GetNextSnsVersionRequest {
        governance_canister_id: Some(governance_canister),
        current_version: Some(deployed_wire),
    };
    let (next_version, next_version_gap) =
        match query_canister::<_, GetNextSnsVersionResponse, SnsHostError>(
            agent,
            &sns_wasm_canister,
            SnsCanisterMethod::GetNextSnsVersion.as_str(),
            "GetNextSnsVersionRequest",
            "GetNextSnsVersionResponse",
            &next_request,
        )
        .await
        {
            Ok(response) => (response.next_version.map(sns_version), None),
            Err(error) => {
                let reason = error.to_string();
                (
                    None,
                    Some(SnsUpgradeQueryGap {
                        method: SnsCanisterMethod::GetNextSnsVersion,
                        reason: reason.trim().to_string(),
                    }),
                )
            }
        };

    Ok(MainnetSnsUpgrade {
        governance_canister_id: sns.governance_canister_id.clone(),
        sns_wasm_canister_id: MAINNET_SNS_WASM_CANISTER_ID.to_string(),
        running_version_method: SnsCanisterMethod::GetRunningSnsVersion,
        next_version_method: SnsCanisterMethod::GetNextSnsVersion,
        point_in_time_guaranteed: false,
        deployed_version,
        pending_upgrade,
        next_version,
        next_version_gap,
    })
}

pub(in crate::sns::report::live) async fn fetch_mainnet_sns_running_version(
    source: &crate::sns::LiveSnsSource,
    request: &SnsSourceRequest,
    sns: &MainnetSns,
) -> Result<SnsRunningVersionResponse, SnsHostError> {
    let agent = sns_agent(source, request)?;
    let governance_canister =
        principal_from_text(&sns.governance_canister_id, "governance_canister_id")?;
    let response = query_running_sns_version(agent, &governance_canister).await?;
    Ok(sns_running_version_response(response))
}

async fn query_running_sns_version(
    agent: &Agent,
    governance_canister: &Principal,
) -> Result<GetRunningSnsVersionResponse, SnsHostError> {
    query_canister::<_, _, SnsHostError>(
        agent,
        governance_canister,
        SnsCanisterMethod::GetRunningSnsVersion.as_str(),
        "GetRunningSnsVersionRequest",
        "GetRunningSnsVersionResponse",
        &GetRunningSnsVersionRequest {},
    )
    .await
}