canic-core 0.100.97

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

//! Module: workflow::rpc::lifecycle
//!
//! Responsibility: define the root capability lifecycle driver boundary.
//! Does not own: Component Registry persistence, replay storage, or endpoint authentication.
//! Boundary: core replay orchestration delegates protected child lifecycle to the control plane.

use crate::{
    InternalError,
    cdk::types::Principal,
    dto::component_registry::ComponentRegistryHead,
    ids::{CanisterRole, ComponentInstanceId},
};
use async_trait::async_trait;

///
/// RootComponentChildProvisionRequest
///
/// Exact replay-bound Component Child lifecycle authority passed to the control plane.
///

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct RootComponentChildProvisionRequest {
    pub operation_id: [u8; 32],
    pub component: ComponentInstanceId,
    pub expected_registry: ComponentRegistryHead,
    pub child_role: CanisterRole,
    pub application_init_args: Option<Vec<u8>>,
}

///
/// RootComponentChildRecycleRequest
///
/// Exact replay-bound Component Child subtree-removal authority.
///

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct RootComponentChildRecycleRequest {
    pub operation_id: [u8; 32],
    pub component: ComponentInstanceId,
    pub expected_registry: ComponentRegistryHead,
    pub target_canister_id: Principal,
}

/// Bounded result of one resumable Component Child recycle invocation.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum RootComponentChildRecycleOutcome {
    Completed,
    InProgress,
}

///
/// RootCapabilityLifecycleExecutor
///
/// Driver implemented by the root control plane for Component-bound lifecycle effects.
///

#[async_trait]
pub trait RootCapabilityLifecycleExecutor: Send + Sync {
    /// Resume one exact child operation through active Registry membership.
    async fn provision_component_child(
        &self,
        request: RootComponentChildProvisionRequest,
    ) -> Result<Principal, InternalError>;

    /// Advance one exact Component Child subtree removal through a bounded work slice.
    async fn recycle_component_child(
        &self,
        request: RootComponentChildRecycleRequest,
    ) -> Result<RootComponentChildRecycleOutcome, InternalError>;
}