ic-query 0.75.10

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

//! Module: sns::report::build::upgrade
//!
//! Responsibility: build bounded SNS upgrade reports.
//! Does not own: command parsing, transport internals, or rendering.
//! Boundary: resolves SNS identity, validates one source result, and assembles the report.

use crate::sns::report::{
    MainnetSns, MainnetSnsUpgrade, SNS_UPGRADE_QUERY_COUNT, SNS_UPGRADE_REPORT_SCHEMA_VERSION,
    SnsHostError, SnsLookupRequest, SnsSourceRequest, SnsUpgradeReport, SnsUpgradeSource,
    live::LiveSnsSource, lookup::resolve_sns_lookup, source::canonicalize_mainnet_sns_upgrade,
};

/// Build a live bounded upgrade report for one deployed SNS.
pub async fn build_sns_upgrade_report(
    request: &SnsLookupRequest,
) -> Result<SnsUpgradeReport, SnsHostError> {
    build_sns_upgrade_report_with_source(request, &LiveSnsSource::default()).await
}

/// Build a bounded upgrade report through a custom SNS source capability.
pub async fn build_sns_upgrade_report_with_source(
    request: &SnsLookupRequest,
    source: &dyn SnsUpgradeSource,
) -> Result<SnsUpgradeReport, SnsHostError> {
    let lookup = resolve_sns_lookup(request, source).await?;
    let upgrade = source
        .fetch_sns_upgrade(&lookup.fetch_request, &lookup.sns)
        .await?;
    canonicalize_mainnet_sns_upgrade(&upgrade, &lookup.sns.canisters.governance_canister_id)?;
    Ok(sns_upgrade_report_from_parts(
        lookup.fetch_request,
        lookup.sns,
        upgrade,
    ))
}

fn sns_upgrade_report_from_parts(
    fetch_request: SnsSourceRequest,
    sns: MainnetSns,
    upgrade: MainnetSnsUpgrade,
) -> SnsUpgradeReport {
    let component_gap_count = usize::from(upgrade.next_version_gap.is_some());
    SnsUpgradeReport {
        schema_version: SNS_UPGRADE_REPORT_SCHEMA_VERSION,
        network: fetch_request.network,
        sns_wasm_canister_id: upgrade.sns_wasm_canister_id,
        fetched_at: fetch_request.fetched_at,
        source_endpoint: fetch_request.endpoint,
        fetched_by: fetch_request.fetched_by,
        id: sns.id,
        name: sns.name,
        root_canister_id: sns.canisters.root_canister_id,
        governance_canister_id: upgrade.governance_canister_id,
        running_version_method: upgrade.running_version_method,
        next_version_method: upgrade.next_version_method,
        point_in_time_guaranteed: upgrade.point_in_time_guaranteed,
        component_query_count: SNS_UPGRADE_QUERY_COUNT,
        successful_component_query_count: SNS_UPGRADE_QUERY_COUNT - component_gap_count,
        component_gap_count,
        deployed_version: upgrade.deployed_version,
        pending_upgrade: upgrade.pending_upgrade,
        next_version: upgrade.next_version,
        next_version_gap: upgrade.next_version_gap,
    }
}