canic-core 0.100.14

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

//! Passive contracts for one Fleet Subnet Root's initial local Wasm Store bootstrap.

use crate::ids::{
    CanisterRole, ComponentSpecId, ComponentTopologyDigest, FleetSubnetRootReleaseSet,
    ReleaseBuildId,
};
use candid::{CandidType, Principal};
use serde::{Deserialize, Serialize};

/// Maximum canonical root release-set manifest bytes admitted at the runtime boundary.
pub const ROOT_STORE_RELEASE_SET_MANIFEST_MAX_BYTES: u64 = 16 * 1_024 * 1_024;
/// Stable template prefix for a chunk-staged canonical root release-set manifest.
pub const ROOT_STORE_RELEASE_SET_TEMPLATE_PREFIX: &str = "root-release-set:";
/// Stable template prefix for one chunk-staged application artifact.
pub const ROOT_STORE_ARTIFACT_TEMPLATE_PREFIX: &str = "component:";

///
/// RootStoreArtifact
///
/// Qualified immutable application artifact carried by one root release-set entry.
///

#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(deny_unknown_fields)]
pub struct RootStoreArtifact {
    pub role: CanisterRole,
    pub package: String,
    pub release_build_id: ReleaseBuildId,
    pub wasm_relative_path: String,
    pub wasm_size_bytes: u64,
    pub wasm_sha256_hex: String,
    pub wasm_gz_relative_path: String,
    pub wasm_gz_size_bytes: u64,
    pub wasm_gz_sha256_hex: String,
}

///
/// RootStoreReleaseSetEntryKind
///
/// Structural use of one artifact within one exact Component Spec closure.
///

#[derive(
    CandidType, Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize,
)]
#[serde(rename_all = "snake_case")]
pub enum RootStoreReleaseSetEntryKind {
    Component,
    ComponentChild,
}

///
/// RootStoreReleaseSetEntry
///
/// One Spec-scoped artifact authorization from the canonical root release-set manifest.
///

#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(deny_unknown_fields)]
pub struct RootStoreReleaseSetEntry {
    pub component_spec: ComponentSpecId,
    pub kind: RootStoreReleaseSetEntryKind,
    pub artifact: RootStoreArtifact,
}

///
/// RootStoreReleaseSetManifest
///
/// Runtime decoding shape for the host's exact canonical root release-set JSON bytes.
///

#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(deny_unknown_fields)]
pub struct RootStoreReleaseSetManifest {
    pub release_build_id: ReleaseBuildId,
    pub component_topology_digest: ComponentTopologyDigest,
    pub entries: Vec<RootStoreReleaseSetEntry>,
}

///
/// RootStoreBootstrapRequest
///
/// Small bootstrap request referencing an already chunk-staged canonical manifest.
///

#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct RootStoreBootstrapRequest {
    pub manifest_payload_size_bytes: u64,
}

///
/// RootStoreCatalogEntry
///
/// Exact byte identity observed in the one live root-local Store.
///

#[derive(CandidType, Clone, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
pub struct RootStoreCatalogEntry {
    pub role: CanisterRole,
    pub payload_hash: [u8; 32],
    pub payload_size_bytes: u64,
}

///
/// RootStoreBootstrapResponse
///
/// Exact live Store evidence returned after root-side publication and verification.
///

#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct RootStoreBootstrapResponse {
    pub fleet_subnet_root: Principal,
    pub wasm_store: Principal,
    pub release_set: FleetSubnetRootReleaseSet,
    pub catalog: Vec<RootStoreCatalogEntry>,
}