canic-host 0.110.53

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

//! Module: fleet_ensure::view::continuation
//!
//! Responsibility: distinguish reviewed work from dependent live discovery.
//! Boundary: these projections never authorize an effect or enlarge a debit bound.

use serde::Serialize;

/// Operator preview of the current review and its unresolved continuation work.
#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct ContinuationForecast {
    pub authority: ContinuationAuthority,
    pub reviewed_actions: usize,
    pub maximum_successor_actions: Option<u32>,
    #[serde(with = "crate::fleet_ensure::model::u128_text")]
    pub maximum_operator_debit_cycles: u128,
    pub imports: Vec<ContinuationImport>,
    pub dependent_funding: Vec<DependentPoolFunding>,
    pub requires_live_discovery: Vec<ContinuationDiscovery>,
}

/// The authority available for future protocol work; extra paid effects always need review.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum ContinuationAuthority {
    Complete,
    SeparateReview,
    WithinReviewedProtocolBounds,
}

/// Known import target, with readiness deliberately left to current Root evidence.
#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct ContinuationImport {
    pub root: String,
    pub canister: String,
    pub principal: Option<String>,
    pub state: ContinuationImportState,
    pub headroom: Option<ImportHeadroom>,
}

/// Advance import estimate from retained observations; final import owns exact debit approval.
#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct ImportHeadroom {
    #[serde(with = "crate::fleet_ensure::model::u128_text")]
    pub minimum_ready_cycles: u128,
    #[serde(with = "crate::fleet_ensure::model::u128_text")]
    pub maximum_source_debit_cycles: u128,
    pub assessment: ImportHeadroomAssessment,
}

/// Unknown balances remain explicit until the current Root can observe its held sources.
#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
#[serde(tag = "state", rename_all = "snake_case")]
pub enum ImportHeadroomAssessment {
    AwaitingCurrentRootObservation,
    InvalidBounds,
    Observed {
        #[serde(with = "crate::fleet_ensure::model::u128_text")]
        required_cycles: u128,
        #[serde(with = "crate::fleet_ensure::model::u128_text")]
        available_cycles: u128,
        #[serde(with = "crate::fleet_ensure::model::u128_text")]
        shortfall_cycles: u128,
    },
}

/// Distinguish an already reviewed import from an initialization-dependent candidate.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum ContinuationImportState {
    PostInitializationObservation,
    ReviewedReconciliation,
}

/// A known dependent top-up estimate that is not included in continuation authority.
#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct DependentPoolFunding {
    pub root: String,
    pub principal: String,
    #[serde(with = "crate::fleet_ensure::model::u128_text")]
    pub amount_cycles: u128,
    #[serde(with = "crate::fleet_ensure::model::u128_text")]
    pub ledger_fee_cycles: u128,
}

/// Missing evidence that prevents a complete remaining-work or funding quote.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum ContinuationDiscovery {
    PoolReadiness,
    PoolFundingAndCapacity,
    PublicationAndProvisioning,
}