Skip to main content

canic_host/icp/
model.rs

1use std::path::PathBuf;
2
3use serde::{Deserialize, Serialize};
4
5pub(super) const LOCAL_ICP_TARGET: &str = "local";
6pub const REQUIRED_ICP_CLI_VERSION: &str = "1.0.0";
7pub const ICP_CLI_SUPPORTED_VERSION_RANGE: &str = ">=1.0.0, <2.0.0";
8
9/// Direct local replica endpoint used when ICP project state is unavailable.
10///
11#[derive(Clone, Debug, Eq, PartialEq)]
12pub struct LocalReplicaTarget {
13    pub url: String,
14    pub root_key: String,
15}
16
17///
18/// IcpRawOutput
19///
20
21#[derive(Clone, Debug, Eq, PartialEq)]
22pub struct IcpRawOutput {
23    pub success: bool,
24    pub status: String,
25    pub stdout: Vec<u8>,
26    pub stderr: Vec<u8>,
27}
28
29///
30/// IcpCli
31///
32
33#[derive(Clone, Debug, Eq, PartialEq)]
34pub struct IcpCli {
35    pub(super) executable: String,
36    pub(super) environment: Option<String>,
37    pub(super) cwd: Option<PathBuf>,
38    pub(super) local_replica: Option<LocalReplicaTarget>,
39}
40
41///
42/// IcpCliVersion
43///
44#[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
45pub struct IcpCliVersion {
46    pub major: u64,
47    pub minor: u64,
48    pub patch: u64,
49}
50
51///
52/// IcpSnapshotCreateReceipt
53///
54
55#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
56pub struct IcpSnapshotCreateReceipt {
57    pub snapshot_id: String,
58    pub taken_at_timestamp: Option<u64>,
59    pub total_size_bytes: Option<u64>,
60}
61
62///
63/// IcpCanisterStatusReport
64///
65
66#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
67pub struct IcpCanisterStatusReport {
68    pub id: String,
69    pub name: Option<String>,
70    pub status: String,
71    pub settings: Option<IcpCanisterStatusSettings>,
72    pub module_hash: Option<String>,
73    pub memory_size: Option<String>,
74    pub cycles: Option<String>,
75    pub reserved_cycles: Option<String>,
76    pub idle_cycles_burned_per_day: Option<String>,
77}
78
79///
80/// IcpCanisterStatusSettings
81///
82
83#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
84pub struct IcpCanisterStatusSettings {
85    #[serde(default)]
86    pub controllers: Vec<String>,
87    pub compute_allocation: Option<String>,
88    pub memory_allocation: Option<String>,
89    pub freezing_threshold: Option<String>,
90    pub reserved_cycles_limit: Option<String>,
91    pub wasm_memory_limit: Option<String>,
92    pub wasm_memory_threshold: Option<String>,
93    pub log_memory_limit: Option<String>,
94}