canic-host 0.109.15

Host-side App build and desired-state Fleet reconciliation library for Canic workspaces
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

use std::{collections::BTreeSet, path::PathBuf};

use canic_core::{
    ids::CanisterRole,
    role_contract::{ProtocolProfileDigest, RoleCapabilityKey},
};

pub(super) const FLEET_COORDINATOR_ROLE: &str = "fleet_coordinator";
pub(super) const WASM_STORE_ROLE: &str = "wasm_store";
pub(super) const WASM_TARGET: &str = "wasm32-unknown-unknown";

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub(super) enum CanisterArtifactSource {
    DeclaredRole,
    FleetCoordinator,
    WasmStore,
}

impl CanisterArtifactSource {
    #[must_use]
    pub(super) fn for_role(role: &str) -> Self {
        match role {
            FLEET_COORDINATOR_ROLE => Self::FleetCoordinator,
            WASM_STORE_ROLE => Self::WasmStore,
            _ => Self::DeclaredRole,
        }
    }
}

/// Exact package and output paths admitted before one role build starts.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct CanisterArtifactBuildSpec {
    pub(crate) role: String,
    pub(crate) package_name: String,
    pub(crate) package_version: String,
    pub(crate) canic_version: String,
    pub(crate) capabilities:
        std::collections::BTreeSet<canic_core::role_contract::RoleCapabilityKey>,
    pub(crate) package_manifest_path: PathBuf,
    pub(crate) cargo_workspace_root: PathBuf,
    pub(crate) artifact_root: PathBuf,
    pub(crate) wasm_path: PathBuf,
    pub(crate) wasm_gz_path: PathBuf,
    pub(crate) did_path: PathBuf,
}

///
/// CanisterArtifactBuildOutput
///
/// Canonical package identity and artifact outputs produced by one admitted build.
/// Owned by the host build boundary and consumed by provenance and install planning.
///

#[derive(Clone, Debug)]
pub struct CanisterArtifactBuildOutput {
    pub package_name: String,
    pub package_version: String,
    pub protocol_release_identity: String,
    pub protocol_role: CanisterRole,
    pub protocol_capabilities: BTreeSet<RoleCapabilityKey>,
    pub artifact_root: PathBuf,
    pub wasm_path: PathBuf,
    pub wasm_gz_path: PathBuf,
    pub did_path: PathBuf,
    pub candid_sha256: [u8; 32],
    pub protocol_profile_digest: ProtocolProfileDigest,
    pub transforms: Vec<ArtifactTransformOutput>,
}

/// One configured role and its successfully materialized artifact outputs.
#[derive(Clone, Debug)]
pub struct ConfiguredCanisterArtifactBuildOutput {
    pub role: String,
    pub output: CanisterArtifactBuildOutput,
}

/// One optional artifact-changing tool invocation owned by the host builder.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct ArtifactTransformOutput {
    pub transform: ArtifactTransformKind,
    pub tool_version: Option<String>,
    pub outcome: ArtifactTransformOutcome,
}

impl ArtifactTransformOutput {
    pub(crate) const fn not_requested(transform: ArtifactTransformKind) -> Self {
        Self {
            transform,
            tool_version: None,
            outcome: ArtifactTransformOutcome::NotRequested,
        }
    }
}

/// Optional `ic-wasm` operation that can change one emitted Wasm artifact.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum ArtifactTransformKind {
    Shrink,
    CandidMetadata,
}

/// Result of one optional artifact transform decision.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum ArtifactTransformOutcome {
    Applied,
    ToolUnavailable,
    NotRequested,
}