canic-core 0.110.8

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

//! Module: workflow::rpc::request
//!
//! Responsibility: expose workflow entry points for root RPC request creation.
//! Does not own: endpoint authentication, request execution, or storage mutation.
//! Boundary: delegates request construction and outbound calls to RPC ops.

pub mod handler;

use crate::{
    InternalError,
    cdk::candid::CandidType,
    dto::rpc::{CreateCanisterParent, CreateCanisterResponse, CyclesResponse},
    ids::CanisterRole,
    model::replay::OperationId,
    ops::rpc::request::RequestOps,
};

///
/// RpcRequestWorkflow
///
/// Workflow facade for creating root-bound RPC requests.
///

pub struct RpcRequestWorkflow;

impl RpcRequestWorkflow {
    /// Create an operation-bound child Canister request through the configured RPC ops.
    pub async fn create_canister_request<A>(
        operation_id: [u8; 32],
        canister_role: &CanisterRole,
        parent: CreateCanisterParent,
        extra: Option<A>,
    ) -> Result<CreateCanisterResponse, InternalError>
    where
        A: CandidType + Send + Sync,
    {
        if operation_id == [0; 32] {
            return Err(InternalError::invalid_input());
        }
        RequestOps::create_canister(
            OperationId::from_bytes(operation_id),
            canister_role,
            parent,
            extra,
        )
        .await
    }

    /// Create a cycles funding request for the current canister context.
    pub async fn request_cycles(cycles: u128) -> Result<CyclesResponse, InternalError> {
        RequestOps::request_cycles(cycles).await
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use futures::executor::block_on;

    #[test]
    fn child_creation_rejects_zero_operation_identity_before_transport() {
        let error = block_on(RpcRequestWorkflow::create_canister_request(
            [0; 32],
            &CanisterRole::new("project_ledger"),
            CreateCanisterParent::ThisCanister,
            Option::<()>::None,
        ))
        .expect_err("zero child creation operation identity must reject");

        assert_eq!(
            error.public_error().code(),
            crate::diagnostics::codes::REQUEST_INVALID.raw_code()
        );
    }
}