canic-core 0.27.2

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

mod capability;

use crate::{
    cdk::{candid::CandidType, types::Principal},
    dto::{
        capability::{
            NonrootCyclesCapabilityEnvelopeV1, NonrootCyclesCapabilityResponseV1,
            RootCapabilityEnvelopeV1, RootCapabilityResponseV1,
        },
        error::Error,
        rpc::{
            CreateCanisterParent, CreateCanisterResponse, CyclesResponse, UpgradeCanisterResponse,
        },
    },
    ids::CanisterRole,
    workflow::rpc::request::RpcRequestWorkflow,
};

///
/// RpcApi
///
/// Public, user-callable wrappers for Canic's internal RPC workflows.
///
/// These functions:
/// - form part of the public API surface
/// - are safe to call from downstream canister `lib.rs` code
/// - return [`Error`] suitable for IC boundaries
///
/// Internally, they delegate to workflow-level RPC implementations,
/// preserving the layering:
///
///   user canister -> api -> workflow -> ops -> infra
///
/// Workflow returns internal [`InternalError`]; conversion to [`Error`]
/// happens exclusively at this API boundary.
///

pub struct RpcApi;

impl RpcApi {
    /// Compute the canonical root capability hash used for proof binding.
    pub fn root_capability_hash(
        target_canister: Principal,
        capability_version: u16,
        capability: &crate::dto::rpc::Request,
    ) -> Result<[u8; 32], Error> {
        capability::root_capability_hash(target_canister, capability_version, capability)
    }

    /// Dispatch the full root capability envelope verifier/orchestrator path.
    pub async fn response_capability_v1_root(
        envelope: RootCapabilityEnvelopeV1,
    ) -> Result<RootCapabilityResponseV1, Error> {
        capability::response_capability_v1_root(envelope).await
    }

    /// Dispatch the non-root structural cycles capability path.
    pub async fn response_capability_v1_nonroot(
        envelope: NonrootCyclesCapabilityEnvelopeV1,
    ) -> Result<NonrootCyclesCapabilityResponseV1, Error> {
        capability::response_capability_v1_nonroot(envelope).await
    }

    pub async fn create_canister_request<A>(
        canister_role: &CanisterRole,
        parent: CreateCanisterParent,
        extra: Option<A>,
    ) -> Result<CreateCanisterResponse, Error>
    where
        A: CandidType + Send + Sync,
    {
        RpcRequestWorkflow::create_canister_request(canister_role, parent, extra)
            .await
            .map_err(Error::from)
    }

    pub async fn upgrade_canister_request(
        canister_pid: Principal,
    ) -> Result<UpgradeCanisterResponse, Error> {
        RpcRequestWorkflow::upgrade_canister_request(canister_pid)
            .await
            .map_err(Error::from)
    }

    pub async fn request_cycles(cycles: u128) -> Result<CyclesResponse, Error> {
        RpcRequestWorkflow::request_cycles(cycles)
            .await
            .map_err(Error::from)
    }

    pub async fn response_capability_v1(
        envelope: RootCapabilityEnvelopeV1,
    ) -> Result<RootCapabilityResponseV1, Error> {
        capability::response_capability_v1_root(envelope).await
    }
}