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 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
use crate::constants::{CREATE_CANISTER_CYCLES, WASM_MEMORY_LIMIT};
use crate::types::ic::WasmArg;
use crate::types::interface::DepositCyclesArgs;
use crate::types::state::{
SegmentCanisterSettings, SegmentCanisterStatus, SegmentStatus, SegmentStatusResult,
};
use candid::{Nat, Principal};
use ic_cdk::api::call::CallResult;
use ic_cdk::api::management_canister::main::{
canister_status as ic_canister_status, create_canister, delete_canister,
deposit_cycles as ic_deposit_cycles, install_code as ic_install_code, stop_canister,
update_settings, CanisterId, CanisterIdRecord, CanisterInstallMode, CanisterSettings,
CreateCanisterArgument, InstallCodeArgument, UpdateSettingsArgument,
};
use ic_cdk::api::{canister_balance128, time};
/// Asynchronously creates a new canister and installs provided Wasm code with additional cycles.
///
/// # Arguments
/// - `controllers`: A list of `Principal` IDs to set as controllers of the new canister.
/// - `wasm_arg`: Wasm binary and arguments to install in the new canister (`WasmArg` struct).
/// - `cycles`: Additional cycles to deposit during canister creation on top of `CREATE_CANISTER_CYCLES`.
///
/// # Returns
/// - `Ok(Principal)`: On success, returns the `Principal` ID of the newly created canister.
/// - `Err(String)`: On failure, returns an error message.
pub async fn create_canister_install_code(
controllers: Vec<Principal>,
wasm_arg: &WasmArg,
cycles: u128,
) -> Result<Principal, String> {
let record = create_canister(
CreateCanisterArgument {
settings: Some(CanisterSettings {
controllers: Some(controllers.clone()),
compute_allocation: None,
memory_allocation: None,
freezing_threshold: None,
reserved_cycles_limit: None,
wasm_memory_limit: Some(Nat::from(WASM_MEMORY_LIMIT)),
}),
},
CREATE_CANISTER_CYCLES + cycles,
)
.await;
match record {
Err((_, message)) => Err(["Failed to create canister.", &message].join(" - ")),
Ok(record) => {
let canister_id = record.0.canister_id;
let install = install_code(canister_id, wasm_arg, CanisterInstallMode::Install).await;
match install {
Err(_) => Err("Failed to install code in canister.".to_string()),
Ok(_) => Ok(canister_id),
}
}
}
}
/// Asynchronously installs code on a specified canister.
///
/// # Arguments
/// - `canister_id`: `Principal` ID of the target canister.
/// - `wasm_arg`: Contains the Wasm module and installation arguments.
/// - `mode`: Installation mode defined by `CanisterInstallMode`.
///
/// # Returns
/// - A `CallResult<()>` indicating success or failure.
async fn install_code(
canister_id: Principal,
WasmArg { wasm, install_arg }: &WasmArg,
mode: CanisterInstallMode,
) -> CallResult<()> {
let arg = InstallCodeArgument {
mode,
canister_id,
wasm_module: wasm.clone(),
arg: install_arg.clone(),
};
ic_install_code(arg).await
}
/// Asynchronously updates the controller list of a specified canister.
///
/// # Arguments
/// - `canister_id`: `Principal` ID of the target canister.
/// - `controllers`: New list of `Principal` IDs to set as controllers.
///
/// # Returns
/// - A `CallResult<()>` indicating success or failure.
pub async fn update_canister_controllers(
canister_id: Principal,
controllers: Vec<Principal>,
) -> CallResult<()> {
// Not including a setting in the settings record means not changing that field.
// In other words, setting wasm_memory_limit to None here means keeping the actual value of wasm_memory_limit.
let arg = UpdateSettingsArgument {
canister_id,
settings: CanisterSettings {
controllers: Some(controllers),
compute_allocation: None,
memory_allocation: None,
freezing_threshold: None,
reserved_cycles_limit: None,
wasm_memory_limit: None,
},
};
update_settings(arg).await
}
/// Fetches the status of a segment (canister), including its configuration and resource usage.
///
/// # Arguments
/// - `canister_id`: The `CanisterId` of the segment canister.
///
/// # Returns
/// - `SegmentStatusResult`: Contains detailed status and settings of the canister on success.
/// - `Err(String)`: On failure, returns an error message.
pub async fn segment_status(canister_id: CanisterId) -> SegmentStatusResult {
let status = ic_canister_status(CanisterIdRecord { canister_id }).await;
match status {
Ok((canister_status,)) => {
let settings: SegmentCanisterSettings = SegmentCanisterSettings {
controllers: canister_status.settings.controllers,
compute_allocation: canister_status.settings.compute_allocation,
memory_allocation: canister_status.settings.memory_allocation,
freezing_threshold: canister_status.settings.freezing_threshold,
};
Ok(SegmentStatus {
id: canister_id,
metadata: None,
status: SegmentCanisterStatus {
status: canister_status.status,
settings,
module_hash: canister_status.module_hash,
memory_size: canister_status.memory_size,
cycles: canister_status.cycles,
idle_cycles_burned_per_day: canister_status.idle_cycles_burned_per_day,
},
status_at: time(),
})
}
Err((_, message)) => Err(["Failed to get canister status: ".to_string(), message].join("")),
}
}
/// Deposits cycles into a specified canister from the calling canister's balance.
///
/// # Arguments
/// - `args`: `DepositCyclesArgs` struct containing the destination canister ID and cycle amount.
///
/// # Returns
/// - `Ok(())`: On successful deposit.
/// - `Err(String)`: If the balance is insufficient or on failure to deposit.
pub async fn deposit_cycles(
DepositCyclesArgs {
destination_id,
cycles,
}: DepositCyclesArgs,
) -> Result<(), String> {
let balance = canister_balance128();
if balance < cycles {
return Err(format!(
"Balance ({}) is lower than the amount of cycles {} to deposit.",
balance, cycles
));
}
let result = ic_deposit_cycles(
CanisterIdRecord {
canister_id: destination_id,
},
cycles,
)
.await;
match result {
Err((_, message)) => Err(["Deposit cycles failed.", &message].join(" - ")),
Ok(_) => Ok(()),
}
}
/// Stops the execution of a specified segment (canister).
///
/// # Arguments
/// - `canister_id`: The `CanisterId` of the canister to stop.
///
/// # Returns
/// - `Ok(())`: If the canister is successfully stopped.
/// - `Err(String)`: On failure, returns an error message.
pub async fn stop_segment(canister_id: CanisterId) -> Result<(), String> {
let result = stop_canister(CanisterIdRecord { canister_id }).await;
match result {
Err((_, message)) => Err(["Cannot stop segment.", &message].join(" - ")),
Ok(_) => Ok(()),
}
}
/// Deletes a specified segment (canister).
///
/// # Arguments
/// - `canister_id`: The `CanisterId` of the canister to delete.
///
/// # Returns
/// - `Ok(())`: If the canister is successfully deleted.
/// - `Err(String)`: On failure, returns an error message.
pub async fn delete_segment(canister_id: CanisterId) -> Result<(), String> {
let result = delete_canister(CanisterIdRecord { canister_id }).await;
match result {
Err((_, message)) => Err(["Cannot delete segment.", &message].join(" - ")),
Ok(_) => Ok(()),
}
}