canic-host 0.110.22

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
109
110
111
112
113
114
115
116
117
118
119

//! Passive operator input and browser handoff records.
//!
//! No credentials, controller lists or Fleet mutation authority belong in these records.

use candid::Principal;
use canic_core::ids::{CanisterRole, CanonicalNetworkId};
use serde::{Deserialize, Serialize};
use std::path::PathBuf;

///
/// FrontendUploadedInput
///
/// Exact local handoff and external target for read-only post-sync verification.
///

pub struct FrontendUploadedInput {
    pub directory: PathBuf,
    pub manifest_sha256: String,
    pub environment: String,
    pub network: CanonicalNetworkId,
    pub canister_id: Principal,
    pub prefix: String,
}

/// Explicit finite limits for an external asset payload review.
pub struct FrontendAssetCapacityInput {
    pub environment: String,
    pub canister_id: Principal,
    pub payload_directory: PathBuf,
    pub minimum_native_cycles: u128,
    pub maximum_payload_bytes: u64,
    pub maximum_files: u32,
}

/// Exact role instance explicitly selected for browser use.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(deny_unknown_fields)]
pub struct FrontendRoleInput {
    pub role: CanisterRole,
    pub canister_id: Principal,
}

/// Internet Identity provider and the caller namespace retained by the frontend.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(deny_unknown_fields)]
pub struct FrontendIdentityInput {
    pub canister_id: Principal,
    pub provider_origin: String,
    pub derivation_origin: String,
    /// Complete contents of the certified II alternative-origins asset.
    pub alternative_origins: Vec<String>,
}

/// External static-asset identity; Canic neither uploads assets nor controls this canister.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(deny_unknown_fields)]
pub struct FrontendAssetInput {
    pub canister_id: Principal,
    pub origin: String,
}

/// Selected-environment input to a bounded frontend export.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(deny_unknown_fields)]
pub struct FrontendEnvironmentInput {
    pub schema_version: u16,
    pub environment: String,
    pub canonical_network_id: CanonicalNetworkId,
    pub api_origin: String,
    pub identity: FrontendIdentityInput,
    pub asset: Option<FrontendAssetInput>,
    pub roles: Vec<FrontendRoleInput>,
}

/// File identity included in the browser bundle digest.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(deny_unknown_fields)]
pub struct FrontendFileRecord {
    pub path: String,
    pub sha256: String,
    pub bytes: u64,
}

/// Public identity and exact generated binding artifacts for one selected instance.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(deny_unknown_fields)]
pub struct FrontendRoleRecord {
    pub role: CanisterRole,
    pub canister_id: Principal,
    pub release_identity: String,
    pub module_sha256: String,
    pub candid: FrontendFileRecord,
    pub javascript: FrontendFileRecord,
    pub typescript: FrontendFileRecord,
}

/// Integrity-covered browser data derived from one terminal Fleet review.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(deny_unknown_fields)]
pub struct FrontendManifestRecord {
    pub schema_version: u16,
    pub manifest_sha256: String,
    pub generator: String,
    pub app: String,
    pub fleet: String,
    pub fleet_id: String,
    pub source_plan_sha256: String,
    pub environment: String,
    pub canonical_network_id: CanonicalNetworkId,
    pub api_origin: String,
    /// Present only for an explicitly enrolled local network; never fetched by the browser.
    #[serde(deserialize_with = "Option::deserialize")]
    pub local_root_key_der_hex: Option<String>,
    pub identity: FrontendIdentityInput,
    pub alternative_origins: FrontendFileRecord,
    #[serde(deserialize_with = "Option::deserialize")]
    pub asset: Option<FrontendAssetInput>,
    pub roles: Vec<FrontendRoleRecord>,
}