canic-host 0.110.43

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

//! Exact default Ledger account observations, separate from native and reserved cycles.

use candid::Principal;
use std::collections::BTreeMap;

/// One explicitly selected default account on the source Cycles Ledger.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct CompletedLedgerAccountView {
    pub owner: Principal,
    pub cycles: u128,
}

/// Source operator/Root accounts reconcile with original receipts; other accounts
/// remain separate observations and cannot offset historical native cycle losses.
#[derive(Debug)]
pub struct CompletedLedgerBalancesView {
    pub(in crate::fleet_ensure) ledger: Principal,
    pub(in crate::fleet_ensure) operator: CompletedLedgerAccountView,
    pub(in crate::fleet_ensure) root_accounts: BTreeMap<String, CompletedLedgerAccountView>,
    pub(in crate::fleet_ensure) other_canister_accounts:
        BTreeMap<String, CompletedLedgerAccountView>,
    pub(in crate::fleet_ensure) total_canister_ledger_cycles: u128,
}

impl CompletedLedgerBalancesView {
    /// Exact source Cycles Ledger principal on the authenticated source network.
    #[must_use]
    pub const fn ledger(&self) -> Principal {
        self.ledger
    }

    /// Operator balance after exactly the already-audited original debits.
    #[must_use]
    pub const fn operator(&self) -> &CompletedLedgerAccountView {
        &self.operator
    }

    /// Each original Root default account, without rebasing its starting balance.
    #[must_use]
    pub const fn root_accounts(&self) -> &BTreeMap<String, CompletedLedgerAccountView> {
        &self.root_accounts
    }

    /// Coordinator, Store and application/pool default accounts. These balances
    /// were outside the original Root account baseline and are never assumed zero.
    #[must_use]
    pub const fn other_canister_accounts(&self) -> &BTreeMap<String, CompletedLedgerAccountView> {
        &self.other_canister_accounts
    }

    /// Sum of all observed canister default accounts, excluding the operator.
    /// This is not a complete native/reserved/Ledger conservation assessment.
    #[must_use]
    pub const fn total_canister_ledger_cycles(&self) -> u128 {
        self.total_canister_ledger_cycles
    }
}