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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

//! Module: fleet_ensure::workflow::funding::operator
//!
//! Responsibility: bind conversion recovery to the original first withdrawal.
//! Boundary: never resets its intent, proves nonpayment or submits another withdrawal.

use crate::fleet_ensure::{
    model::{
        EffectState, EnsureAction, FleetEnsureCompletion, FleetEnsureJournalRecord,
        FleetEnsurePlan, FundingPauseRecord, FundingReviewRecord,
    },
    ops::{EnsurePaths, EnsurePlatform, action_sha256, funding as records, write_journal},
    policy::operator_mint::operator_source,
    workflow::{EnsureWorkflowError, ordered_actions},
};
use canic_contracts::cycles::Cycles;

pub(super) fn applicable(plan: &FleetEnsurePlan, journal: &FleetEnsureJournalRecord) -> bool {
    let Some(effect) = journal.effects.first() else {
        return false;
    };
    journal.completion == FleetEnsureCompletion::InProgress
        && journal.effects.len() == 1
        && effect.state == EffectState::Intent
        && effect.receipt.is_none()
        && journal.initial_operator_cycles < plan.conservation.maximum_operator_debit_cycles
        && ordered_actions(plan).first().is_some_and(|action| {
            matches!(action, EnsureAction::Fund { .. })
                && action_sha256(action) == effect.action_sha256
        })
}

pub(super) fn verify<E: std::error::Error + 'static>(
    plan: &FleetEnsurePlan,
    journal: &FleetEnsureJournalRecord,
) -> Result<(), EnsureWorkflowError<E>> {
    let Some(desired) = plan
        .reviewed_desired
        .as_ref()
        .map(|reviewed| reviewed.desired())
    else {
        if journal
            .funding_reviews
            .iter()
            .any(|review| matches!(review.pause, FundingPauseRecord::Operator(_)))
        {
            return Err(EnsureWorkflowError::JournalIntegrity);
        }
        return Ok(());
    };
    for review in &journal.funding_reviews {
        let FundingPauseRecord::Operator(pause) = &review.pause else {
            continue;
        };
        let action = ordered_actions(plan)
            .first()
            .copied()
            .ok_or(EnsureWorkflowError::JournalIntegrity)?;
        let fee = desired
            .ledger_fee_cycles
            .parse::<Cycles>()
            .map_err(|_| EnsureWorkflowError::PlanIntegrity)?
            .to_u128();
        let expected = records::operator_review(
            action,
            &desired.operator,
            pause.available_cycles,
            plan.conservation.maximum_operator_debit_cycles,
            fee,
        )
        .ok_or(EnsureWorkflowError::JournalIntegrity)?;
        let exact = review.action == expected.action
            && review.pause == expected.pause
            && review.review_sha256 == expected.review_sha256
            && review.effect.is_none()
            && pause.cycles_ledger == desired.cycles_ledger
            && journal.initial_operator_cycles < plan.conservation.maximum_operator_debit_cycles;
        let retained = journal
            .effects
            .first()
            .is_some_and(|effect| effect.action_sha256 == pause.action_sha256);
        if !exact || !retained {
            return Err(EnsureWorkflowError::JournalIntegrity);
        }
    }
    Ok(())
}

pub(super) fn prepare<P: EnsurePlatform>(
    paths: &EnsurePaths,
    plan: &FleetEnsurePlan,
    journal: &mut FleetEnsureJournalRecord,
    platform: &mut P,
) -> Result<Option<FundingReviewRecord>, EnsureWorkflowError<P::Error>> {
    if !applicable(plan, journal) {
        return Ok(None);
    }
    let desired = plan
        .reviewed_desired
        .as_ref()
        .ok_or(EnsureWorkflowError::PlanIntegrity)?
        .desired();
    let observed = platform
        .observe_operator_funding()
        .map_err(EnsureWorkflowError::Platform)?
        .ok_or(EnsureWorkflowError::DriftedBeforeApply)?;
    let fee = desired
        .ledger_fee_cycles
        .parse::<Cycles>()
        .map_err(|_| EnsureWorkflowError::PlanIntegrity)?
        .to_u128();
    let source = operator_source(journal).ok_or(EnsureWorkflowError::JournalIntegrity)?;
    // The original receipt-less request remains ambiguous. A debit may already have
    // happened; unexplained credits must never become a new starting balance.
    if observed.cycles_ledger != desired.cycles_ledger
        || observed.ledger_fee_cycles != fee
        || source
            .checked_sub(observed.operator_cycles)
            .is_none_or(|debit| debit > plan.conservation.maximum_operator_debit_cycles)
    {
        return Err(EnsureWorkflowError::DriftedBeforeApply);
    }
    if observed.operator_cycles >= plan.conservation.maximum_operator_debit_cycles {
        return Ok(None);
    }
    let action = ordered_actions(plan)
        .first()
        .copied()
        .ok_or(EnsureWorkflowError::JournalIntegrity)?;
    let review = records::operator_review(
        action,
        &desired.operator,
        observed.operator_cycles,
        plan.conservation.maximum_operator_debit_cycles,
        fee,
    )
    .ok_or(EnsureWorkflowError::JournalIntegrity)?;
    journal.funding_reviews.push(review.clone());
    verify(plan, journal)?;
    write_journal(paths, journal)?;
    Ok(Some(review))
}