canic-core 0.61.0

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

pub mod query;

use crate::{
    InternalError,
    dto::state::{AppCommand, AppCommandResponse},
    ops::{runtime::env::EnvOps, storage::state::app::AppStateOps},
    workflow::{
        cascade::{snapshot::StateSnapshotBuilder, state::StateCascadeWorkflow},
        runtime::auth::RuntimeAuthWorkflow,
    },
};

///
/// AppStateWorkflow
/// Orchestrates application state mutations and downstream cascades
///

pub struct AppStateWorkflow;

impl AppStateWorkflow {
    /// Apply an application-level command (internal).
    ///
    /// Workflow-level orchestration for mutating application state.
    /// This function:
    /// - enforces execution context (root-only)
    /// - applies the command via storage ops
    /// - rebuilds the relevant state snapshot
    /// - cascades state changes to dependent components
    ///
    /// Returns internal [`InternalError`]. Public error mapping is handled
    /// exclusively at the API boundary.
    pub async fn execute_command(cmd: AppCommand) -> Result<AppCommandResponse, InternalError> {
        EnvOps::require_root()?;
        let response = AppStateOps::apply_command(cmd);
        if !app_command_response_changed(response) {
            return Ok(response);
        }

        RuntimeAuthWorkflow::publish_root_delegated_key_to_subnet_state().await?;

        let snapshot = StateSnapshotBuilder::new()?
            .with_app_state()
            .with_subnet_state()
            .build();
        StateCascadeWorkflow::root_cascade_state(&snapshot).await?;

        Ok(response)
    }
}

const fn app_command_response_changed(response: AppCommandResponse) -> bool {
    match response {
        AppCommandResponse::Status(status) => status.changed,
        AppCommandResponse::CyclesFundingEnabled(enabled) => enabled.changed,
    }
}