canic-core 0.110.22

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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

use crate::{
    config::RoleRuntimeAuthority,
    dto::{
        abi::v1::CanisterInitPayload, env::EnvBootstrapArgs,
        fleet_subnet_root::FleetSubnetWasmStoreInitArgs,
    },
    ids::{CanisterRole, ManagedCanisterBinding},
    lifecycle,
};

///
/// LifecycleApi
///

pub struct LifecycleApi;

impl LifecycleApi {
    #[doc(hidden)]
    pub fn configure_component_runtime_with_automatic_topup(
        request: crate::dto::component_registry::ComponentRuntimeDirectoryPreparationRequest,
    ) -> Result<
        crate::view::fleet_activation::ComponentRuntimeActivationTransition,
        crate::dto::error::Error,
    > {
        crate::workflow::component_runtime::configure_with_automatic_topup(request)
            .map_err(Into::into)
    }

    /// Return the immutable Registry-issued identity retained by this application Canister.
    pub fn managed_binding() -> Result<ManagedCanisterBinding, crate::dto::error::Error> {
        crate::ops::runtime::env::EnvOps::managed_binding().map_err(Into::into)
    }

    pub fn init_nonroot_canister_before_bootstrap(
        role: CanisterRole,
        payload: CanisterInitPayload,
        application_init_args: Option<Vec<u8>>,
        embedded_release_build_id: Option<&str>,
        authority: RoleRuntimeAuthority,
    ) {
        lifecycle::init::nonroot::init_nonroot_canister_before_bootstrap(
            role,
            payload,
            application_init_args,
            embedded_release_build_id,
            authority,
        );
    }

    pub fn init_wasm_store_before_bootstrap(
        input: FleetSubnetWasmStoreInitArgs,
        embedded_release_build_id: Option<&str>,
        authority: RoleRuntimeAuthority,
    ) {
        lifecycle::init::nonroot::init_wasm_store_before_bootstrap(
            input,
            embedded_release_build_id,
            authority,
        );
    }

    pub fn schedule_init_nonroot_bootstrap() {
        lifecycle::init::nonroot::schedule_init_nonroot_bootstrap();
    }

    pub fn init_local_nonroot_canister_before_bootstrap(
        role: CanisterRole,
        env: EnvBootstrapArgs,
        authority: RoleRuntimeAuthority,
    ) {
        lifecycle::init::nonroot::init_local_nonroot_canister_before_bootstrap(
            role, env, authority,
        );
    }

    #[doc(hidden)]
    pub fn init_local_nonroot_canister_with_automatic_topup_before_bootstrap(
        role: CanisterRole,
        env: EnvBootstrapArgs,
        authority: RoleRuntimeAuthority,
    ) {
        lifecycle::init::nonroot::init_local_nonroot_canister_with_automatic_topup_before_bootstrap(
            role, env, authority,
        );
    }

    #[must_use]
    pub fn post_upgrade_nonroot_canister_before_bootstrap(
        role: CanisterRole,
        embedded_release_build_id: Option<&str>,
        authority: RoleRuntimeAuthority,
    ) -> bool {
        lifecycle::upgrade::nonroot::post_upgrade_nonroot_canister_before_bootstrap(
            role,
            embedded_release_build_id,
            authority,
        )
    }

    #[doc(hidden)]
    #[must_use]
    pub fn post_upgrade_nonroot_canister_with_automatic_topup_before_bootstrap(
        role: CanisterRole,
        embedded_release_build_id: Option<&str>,
        authority: RoleRuntimeAuthority,
    ) -> bool {
        lifecycle::upgrade::nonroot::post_upgrade_nonroot_canister_with_automatic_topup_before_bootstrap(
            role,
            embedded_release_build_id,
            authority,
        )
    }

    pub fn schedule_post_upgrade_nonroot_bootstrap() {
        lifecycle::upgrade::nonroot::schedule_post_upgrade_nonroot_bootstrap();
    }

    #[must_use]
    pub fn post_upgrade_local_nonroot_canister_before_bootstrap(
        role: CanisterRole,
        authority: RoleRuntimeAuthority,
    ) -> bool {
        lifecycle::upgrade::nonroot::post_upgrade_local_nonroot_canister_before_bootstrap(
            role, authority,
        )
    }

    #[doc(hidden)]
    #[must_use]
    pub fn post_upgrade_local_nonroot_canister_with_automatic_topup_before_bootstrap(
        role: CanisterRole,
        authority: RoleRuntimeAuthority,
    ) -> bool {
        lifecycle::upgrade::nonroot::post_upgrade_local_nonroot_canister_with_automatic_topup_before_bootstrap(
            role,
            authority,
        )
    }
}