canic-host 0.111.0

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

//! Frontend environment and exact binding handoff.
//!
//! The host exports browser data; Fleet admission and external asset ownership stay separate.

pub mod model;
pub mod ops;
pub mod policy;
#[cfg(test)]
mod tests;
pub mod view;
pub mod workflow;

use thiserror::Error;

/// Typed rejection at the frontend handoff boundary.
#[derive(Debug, Error)]
pub enum FrontendError {
    #[error("uploaded frontend asset differs from the handoff: {key}")]
    AssetMismatch { key: String },

    #[error("asset prefix must be an absolute path with ordinary nonempty segments")]
    AssetPrefix,

    #[error("asset query failed: {0}")]
    AssetQuery(#[source] Box<ic_agent::AgentError>),

    #[error("asset query returned an invalid or oversized Candid response")]
    AssetResponse,

    #[error("asset verification exceeded its query deadline")]
    AssetTimeout,

    #[error(transparent)]
    Management(#[from] Box<crate::icp::IcpManagementCallError>),

    #[error("frontend derivation origin differs from the reviewed Fleet admission namespace")]
    AdmissionOrigin,

    #[error("frontend artifact exceeds the configured {0} bound")]
    Bound(&'static str),

    #[error("invalid frontend Candid: {0}")]
    Candid(String),

    #[error("frontend environment or network differs from the terminal Fleet")]
    Environment,

    #[error("frontend bundle digest or artifact identity differs from the expected handoff")]
    Integrity,

    #[error(transparent)]
    Icp(#[from] crate::icp::IcpCommandError),

    #[error(transparent)]
    Inventory(#[from] crate::fleet_ensure::CurrentFleetInventoryError),

    #[error(transparent)]
    Io(#[from] std::io::Error),

    #[error(transparent)]
    Json(#[from] serde_json::Error),

    #[error(transparent)]
    Network(#[from] crate::network::NetworkIdentityError),

    #[error("external asset canister has no exact native cycle balance in its management status")]
    NativeBalance,

    #[error(
        "external asset native cycles {available} are below the reviewed floor {required}; top up the canister's native balance before upload"
    )]
    NativeCapacity { available: u128, required: u128 },

    #[error(
        "frontend origin must be canonical HTTPS, or explicit loopback HTTP for local use: {0}"
    )]
    Origin(String),

    #[error("frontend origins must be unique and authorize the selected asset origin")]
    OriginSet,

    #[error("frontend canister Principal must identify a concrete canister")]
    Principal,

    #[error(transparent)]
    ProtocolBinding(#[from] crate::protocol_binding::ProtocolBindingError),

    #[error("frontend selection has no unique terminal role binding: {0}")]
    Role(String),

    #[error("unsupported frontend schema version")]
    Schema,

    #[error(transparent)]
    State(#[from] crate::fleet_ensure::ops::EnsureStateError),
}