canic-core 0.82.10

Canic — a canister orchestration and management toolkit for the Internet Computer
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

//! Module: domain::blob_storage
//!
//! Responsibility: define pure blob-storage value enums shared by billing
//! status builders and boundary DTOs.
//! Does not own: Cashier request/result DTOs, blob-storage lifecycle storage,
//! billing API orchestration, or gateway sync side effects.
//! Boundary: DTO modules re-export these values to preserve public API paths
//! while status builders import the domain owner directly.

#[cfg(feature = "blob-storage-billing")]
use candid::{CandidType, Nat};
#[cfg(feature = "blob-storage-billing")]
use serde::{Deserialize, Serialize};

///
/// BlobStoragePaymentModelStatus
///

#[cfg(feature = "blob-storage-billing")]
#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum BlobStoragePaymentModelStatus {
    NotConfigured,
    ProjectAsPaymentAccount,
}

///
/// BlobStorageGatewayPrincipalSyncAction
///

#[cfg(feature = "blob-storage-billing")]
#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum BlobStorageGatewayPrincipalSyncAction {
    NotRequested,
    SkippedConfigMissing,
    SkippedReadOnlyStatus,
}

///
/// BlobStorageFundingStatus
///

#[cfg(feature = "blob-storage-billing")]
#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum BlobStorageFundingStatus {
    NotConfigured,
    NotNeeded,
    FundingRequired {
        requested_cycles: Nat,
    },
    BalanceUnavailable,
    BalanceMalformed,
    ReserveWouldBeViolated {
        requested_cycles: Nat,
        transferable_cycles: Nat,
    },
}

///
/// BlobStorageReadinessBlocker
///

#[cfg(feature = "blob-storage-billing")]
#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum BlobStorageReadinessBlocker {
    NotConfigured,
    GatewayPrincipalsMissing,
    CashierBalanceUnavailable,
    CashierBalanceMalformed,
    InsufficientCashierBalance,
    ReserveWouldBeViolated,
}

///
/// BlobStorageBillingWarning
///

#[cfg(feature = "blob-storage-billing")]
#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum BlobStorageBillingWarning {
    GatewayPrincipalSetEmpty,
    CashierBalanceUnavailable,
    CashierBalanceMalformed,
    SyncRequestedButStatusIsReadOnly,
}