canic-core 0.70.3

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

//! Module: workflow::bootstrap::nonroot
//!
//! Responsibility: run asynchronous local bootstrap work for non-root canisters.
//! Does not own: topology creation, self-registration, or cross-canister orchestration.
//! Boundary: lifecycle schedules this after synchronous runtime initialization succeeds.

#[cfg(feature = "sharding")]
use crate::workflow::placement::sharding::ShardingWorkflow;
use crate::workflow::runtime::auth::RuntimeAuthWorkflow;
use crate::{
    InternalError,
    ops::runtime::ready::ReadyOps,
    workflow::{placement::scaling::ScalingWorkflow, prelude::*},
};

///
/// Bootstrap workflow for non-root canisters during init.
///
/// This function is scheduled asynchronously after the IC `init` hook
/// returns and after runtime initialization has completed.
///
/// At this point:
/// - Environment identity is fully initialized.
/// - Stable memory invariants hold.
/// - The canister is safe to run asynchronous tasks.
///
/// Failures in this phase are non-fatal:
/// - Errors are propagated to the lifecycle adapter.
/// - The adapter logs failures but does not abort canister initialization.
///
/// `_args` are opaque, user-provided bootstrap arguments forwarded from init.
/// They are currently unused.
///
/// This function is safe to retry and safe to run multiple times.
///
pub async fn bootstrap_init_nonroot_canister(_args: Option<Vec<u8>>) -> Result<(), InternalError> {
    log!(Topic::Init, Info, "bootstrap (nonroot): init start");

    #[cfg(feature = "sharding")]
    ShardingWorkflow::bootstrap_configured_initial_shards().await?;

    ScalingWorkflow::bootstrap_configured_initial_workers().await?;

    RuntimeAuthWorkflow::check_issuer_canister_signature_support().await?;

    log!(Topic::Init, Info, "bootstrap (nonroot): init complete");
    ReadyOps::mark_ready();

    Ok(())
}

///
/// Bootstrap workflow for non-root canisters after upgrade.
///
/// This function runs asynchronously after a successful upgrade,
/// once runtime initialization has re-established all invariants.
///
/// This phase:
/// - Must be idempotent.
/// - Must tolerate repeated execution.
/// - Must not assume ordering relative to other canisters.
///
/// Errors are propagated to the lifecycle adapter, matching init bootstrap
/// semantics.
///
pub async fn bootstrap_post_upgrade_nonroot_canister() -> Result<(), InternalError> {
    log!(Topic::Init, Info, "bootstrap (nonroot): post-upgrade start");
    RuntimeAuthWorkflow::check_issuer_canister_signature_support().await?;
    log!(
        Topic::Init,
        Info,
        "bootstrap (nonroot): post-upgrade complete"
    );
    ReadyOps::mark_ready();

    Ok(())
}