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 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
use candid::{CandidType, Nat, Principal};
use serde::{Deserialize, Serialize};
/// Canister ID is Principal.
pub type CanisterId = Principal;
/// Canister settings.
///
/// See [`settings`](https://internetcomputer.org/docs/current/references/ic-interface-spec/#ic-create_canister).
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Default,
)]
pub struct CanisterSettings {
/// A list of principals. Must be between 0 and 10 in size.
pub controllers: Option<Vec<Principal>>,
/// Must be a number between 0 and 100, inclusively.
pub compute_allocation: Option<Nat>,
/// Must be a number between 0 and 2^48^ (i.e 256TB), inclusively.
pub memory_allocation: Option<Nat>,
/// Must be a number between 0 and 2^64^-1, inclusively, and indicates a length of time in seconds.
pub freezing_threshold: Option<Nat>,
/// Must be a number between 0 and 2^128^-1, inclusively, and indicates the
/// upper limit on cycles in the `reserved_cycles` balance of the canister.
pub reserved_cycles_limit: Option<Nat>,
}
/// Argument type of [create_canister](super::create_canister).
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Default,
)]
pub struct CreateCanisterArgument {
/// See [CanisterSettings].
pub settings: Option<CanisterSettings>,
}
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Default,
)]
pub(crate) struct CreateCanisterArgumentExtended {
/// See [CanisterSettings].
pub settings: Option<CanisterSettings>,
/// sender_canister_version must be set to ic_cdk::api::canister_version()
pub sender_canister_version: Option<u64>,
}
/// Argument type of [update_settings](super::update_settings).
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone,
)]
pub struct UpdateSettingsArgument {
/// Principle of the canister.
pub canister_id: CanisterId,
/// See [CanisterSettings].
pub settings: CanisterSettings,
}
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone,
)]
pub(crate) struct UpdateSettingsArgumentExtended {
/// Principle of the canister.
pub canister_id: CanisterId,
/// See [CanisterSettings].
pub settings: CanisterSettings,
/// sender_canister_version must be set to ic_cdk::api::canister_version()
pub sender_canister_version: Option<u64>,
}
/// The mode with which a canister is installed.
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy,
)]
// #[serde(rename_all = "lowercase")]
pub enum CanisterInstallMode {
/// A fresh install of a new canister.
#[serde(rename = "install")]
Install,
/// Reinstalling a canister that was already installed.
#[serde(rename = "reinstall")]
Reinstall,
/// Upgrade an existing canister.
#[serde(rename = "upgrade")]
Upgrade,
}
/// WASM module.
pub type WasmModule = Vec<u8>;
/// Argument type of [install_code](super::install_code).
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone,
)]
pub struct InstallCodeArgument {
/// See [CanisterInstallMode].
pub mode: CanisterInstallMode,
/// Principle of the canister.
pub canister_id: CanisterId,
/// Code to be installed.
pub wasm_module: WasmModule,
/// The argument to be passed to `canister_init` or `canister_post_upgrade`.
pub arg: Vec<u8>,
}
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone,
)]
pub(crate) struct InstallCodeArgumentExtended {
/// See [CanisterInstallMode].
pub mode: CanisterInstallMode,
/// Principle of the canister.
pub canister_id: CanisterId,
/// Code to be installed.
pub wasm_module: WasmModule,
/// The argument to be passed to `canister_init` or `canister_post_upgrade`.
pub arg: Vec<u8>,
/// sender_canister_version must be set to ic_cdk::api::canister_version()
pub sender_canister_version: Option<u64>,
}
/// A wrapper of canister id.
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy,
)]
pub struct CanisterIdRecord {
/// Principle of the canister.
pub canister_id: CanisterId,
}
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy,
)]
pub(crate) struct CanisterIdRecordExtended {
/// Principle of the canister.
pub canister_id: CanisterId,
/// sender_canister_version must be set to ic_cdk::api::canister_version()
pub sender_canister_version: Option<u64>,
}
/// Status of a canister.
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy,
)]
pub enum CanisterStatusType {
/// The canister is running.
#[serde(rename = "running")]
Running,
/// The canister is stopping.
#[serde(rename = "stopping")]
Stopping,
/// The canister is stopped.
#[serde(rename = "stopped")]
Stopped,
}
/// Like [CanisterSettings].
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Default,
)]
pub struct DefiniteCanisterSettings {
/// Controllers of the canister.
pub controllers: Vec<Principal>,
/// Compute allocation.
pub compute_allocation: Nat,
/// Memory allocation.
pub memory_allocation: Nat,
/// Freezing threshold.
pub freezing_threshold: Nat,
/// Reserved cycles limit.
pub reserved_cycles_limit: Nat,
}
/// Query statistics, returned by [canister_status](super::canister_status).
#[derive(
CandidType, Clone, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize,
)]
pub struct QueryStats {
/// Total number of query calls.
pub num_calls_total: candid::Nat,
/// Total number of instructions executed by query calls.
pub num_instructions_total: candid::Nat,
/// Total number of payload bytes use for query call requests.
pub request_payload_bytes_total: candid::Nat,
/// Total number of payload bytes use for query call responses.
pub response_payload_bytes_total: candid::Nat,
}
/// Argument type of [canister_status](super::canister_status).
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone,
)]
pub struct CanisterStatusResponse {
/// See [CanisterStatusType].
pub status: CanisterStatusType,
/// See [DefiniteCanisterSettings].
pub settings: DefiniteCanisterSettings,
/// A SHA256 hash of the module installed on the canister. This is null if the canister is empty.
pub module_hash: Option<Vec<u8>>,
/// The memory size taken by the canister.
pub memory_size: Nat,
/// The cycle balance of the canister.
pub cycles: Nat,
/// Amount of cycles burned per day.
pub idle_cycles_burned_per_day: Nat,
/// Query statistics
pub query_stats: QueryStats,
/// The reserved cycles balance of the canister.
/// These are cycles that are reserved by the resource reservation mechanism
/// on storage allocation. See also the `reserved_cycles_limit` parameter in
/// canister settings.
pub reserved_cycles: Nat,
}
/// Details about a canister change initiated by a user.
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone,
)]
pub struct FromUserRecord {
/// Principle of the user.
pub user_id: Principal,
}
/// Details about a canister change initiated by a canister (called _originator_).
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone,
)]
pub struct FromCanisterRecord {
/// Principle of the originator.
pub canister_id: Principal,
/// Canister version of the originator when the originator initiated the change.
/// This is null if the original does not include its canister version
/// in the field `sender_canister_version` of the management canister payload.
pub canister_version: Option<u64>,
}
/// Provides details on who initiated a canister change.
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone,
)]
pub enum CanisterChangeOrigin {
/// See [FromUserRecord].
#[serde(rename = "from_user")]
FromUser(FromUserRecord),
/// See [FromCanisterRecord].
#[serde(rename = "from_canister")]
FromCanister(FromCanisterRecord),
}
/// Details about a canister creation.
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone,
)]
pub struct CreationRecord {
/// Initial set of canister controllers.
pub controllers: Vec<Principal>,
}
/// Details about a canister code deployment.
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone,
)]
pub struct CodeDeploymentRecord {
/// See [CanisterInstallMode].
pub mode: CanisterInstallMode,
/// A SHA256 hash of the new module installed on the canister.
pub module_hash: Vec<u8>,
}
/// Details about updating canister controllers.
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone,
)]
pub struct ControllersChangeRecord {
/// The full new set of canister controllers.
pub controllers: Vec<Principal>,
}
/// Provides details on the respective canister change.
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone,
)]
pub enum CanisterChangeDetails {
/// See [CreationRecord].
#[serde(rename = "creation")]
Creation(CreationRecord),
/// Uninstalling canister's module.
#[serde(rename = "code_uninstall")]
CodeUninstall,
/// See [CodeDeploymentRecord].
#[serde(rename = "code_deployment")]
CodeDeployment(CodeDeploymentRecord),
/// See [ControllersChangeRecord].
#[serde(rename = "controllers_change")]
ControllersChange(ControllersChangeRecord),
}
/// Represents a canister change as stored in the canister history.
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone,
)]
pub struct CanisterChange {
/// The system timestamp (in nanoseconds since Unix Epoch) at which the change was performed
pub timestamp_nanos: u64,
/// The canister version after performing the change.
pub canister_version: u64,
/// The change's origin (a user or a canister).
pub origin: CanisterChangeOrigin,
/// The change's details.
pub details: CanisterChangeDetails,
}
/// Argument type of [canister_info](super::canister_info).
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone,
)]
pub struct CanisterInfoRequest {
/// Principle of the canister.
pub canister_id: Principal,
/// Number of most recent changes requested to be retrieved from canister history.
/// No changes are retrieved if this field is null.
pub num_requested_changes: Option<u64>,
}
/// Return type of [canister_info](super::canister_info).
#[derive(
CandidType, Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone,
)]
pub struct CanisterInfoResponse {
/// Total number of changes ever recorded in canister history.
/// This might be higher than the number of canister changes in `recent_changes`
/// because the IC might drop old canister changes from its history
/// (with `20` most recent canister changes to always remain in the list).
pub total_num_changes: u64,
/// The canister changes stored in the order from the oldest to the most recent.
pub recent_changes: Vec<CanisterChange>,
/// A SHA256 hash of the module installed on the canister. This is null if the canister is empty.
pub module_hash: Option<Vec<u8>>,
/// Controllers of the canister.
pub controllers: Vec<Principal>,
}