canic-core 0.110.26

Canic — a canister orchestration and management toolkit for the Internet Computer
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

//! Module: api::ic::mgmt
//!
//! Responsibility: expose management observations to authenticated endpoint adapters.
//! Does not own: transport, authorization, or effect recovery decisions.
//! Boundary: delegates immediately to the management workflow.

use crate::{
    cdk::types::Principal,
    dto::{
        canister::{
            CanisterHistoryResponse, CanisterInspectionOutcome, CanisterInspectionReserveResponse,
        },
        error::Error,
    },
    workflow::ic::mgmt::MgmtWorkflow,
};

///
/// MgmtApi
///

pub struct MgmtApi;

impl MgmtApi {
    /// Observe a controller-selected target's inspection reserve without an IC call.
    pub fn canister_inspection_reserve(
        pid: Principal,
    ) -> Result<CanisterInspectionReserveResponse, Error> {
        MgmtWorkflow::canister_inspection_reserve(pid).map_err(Error::from)
    }

    /// Inspect the latest replicated management history of an authenticated target.
    pub async fn canister_history(pid: Principal) -> Result<CanisterHistoryResponse, Error> {
        MgmtWorkflow::canister_history(pid)
            .await
            .map_err(Error::from)
    }

    /// Inspect a target while retaining protected numerical reserve failures.
    pub async fn canister_inspection(pid: Principal) -> Result<CanisterInspectionOutcome, Error> {
        MgmtWorkflow::canister_inspection(pid)
            .await
            .map_err(Error::from)
    }
}