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

//! Module: fleet_ensure::policy::recovery::startup
//!
//! Responsibility: attribute configuration-bound startup and continuation funding.
//! Does not own: live balance discovery, funding permission or runtime reuse evidence.
//! Boundary: the same conservative demand feeds prepayment and informational forecasts.

use crate::fleet_ensure::{
    model::{
        DesiredFleet, DesiredFleetArtifacts, RootStartupFundingForecast,
        StartupFundingReuseAssumption,
    },
    policy::{
        CycleBounds, EnsurePolicyError, canister_cycle_policy, checked_add,
        recovery::continuation_step_burn,
    },
};

pub(in crate::fleet_ensure::policy) fn startup_forecasts(
    desired: &DesiredFleet,
    artifacts: &DesiredFleetArtifacts,
    bounds: CycleBounds,
) -> Result<Vec<RootStartupFundingForecast>, EnsurePolicyError> {
    let (Some(bootstrap), Some(protocol)) = (&desired.bootstrap, &desired.protocol) else {
        return Ok(Vec::new());
    };
    let per_step = continuation_step_burn(bounds)?;
    let mut forecasts = Vec::new();
    for root in &bootstrap.roots {
        if !protocol
            .component_group_placements
            .iter()
            .any(|placement| placement.root == root.root)
        {
            continue;
        }
        let demand = artifacts
            .startup_funding_by_root
            .get(&root.root)
            .ok_or_else(|| EnsurePolicyError::MissingArtifactIdentity {
                kind: "startup funding",
                name: root.root.clone(),
            })?;
        if demand.maximum_continuation_steps == 0 {
            return Err(EnsurePolicyError::MissingArtifactIdentity {
                kind: "startup continuation steps",
                name: root.root.clone(),
            });
        }
        let configured = desired
            .canisters
            .iter()
            .find(|canister| canister.name == root.root)
            .ok_or_else(|| EnsurePolicyError::MissingObservation {
                name: root.root.clone(),
            })?;
        let configured_minimum_cycles = canister_cycle_policy(configured)?.minimum_cycles;
        let continuation_allowance_cycles = per_step
            .checked_mul(u128::from(demand.maximum_continuation_steps))
            .ok_or(EnsurePolicyError::ArithmeticOverflow {
                field: "startup continuation reserve",
            })?;
        let minimum = checked_add(
            demand.minimum_native_cycles,
            continuation_allowance_cycles,
            "startup continuation minimum",
        )?;
        forecasts.push(RootStartupFundingForecast {
            root: root.root.clone(),
            startup_minimum_cycles: demand.minimum_native_cycles,
            maximum_continuation_steps: demand.maximum_continuation_steps,
            continuation_allowance_cycles,
            configured_minimum_cycles,
            required_native_cycles: minimum.max(configured_minimum_cycles),
            reuse_assumption: StartupFundingReuseAssumption::FreshChildrenAndFullPublication,
            unfunded_role: demand.unfunded_role.clone(),
        });
    }
    Ok(forecasts)
}