canic-core 0.110.54

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

//! Module: dto::caller_authority
//!
//! Protected managed-caller publication and original-operation receipt boundaries.

use crate::{
    dto::prelude::*,
    ids::{CallerComponentInstallation, CallerInstallation, CallerReceiverAuthority},
};

/// Exact source or receiver lifecycle change issued by the owning Root.
#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq)]
pub enum CallerAuthorityChange {
    StageSource(CallerInstallation),
    Grant(CallerInstallation),
    DenySource(CallerInstallation),
    DenyComponent(CallerComponentInstallation),
    OpenReceiver,
    RetireReceiver,
}

/// Immutable recipient-specific original publication; generation and hash are issuer-owned.
#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq)]
pub struct CallerAuthorityPublication {
    pub operation_id: [u8; 32],
    pub authority: CallerReceiverAuthority,
    pub previous_generation: u64,
    pub generation: u64,
    pub change: CallerAuthorityChange,
    pub content_hash: [u8; 32],
}

/// Protected publication phases, serialized with source membership changes.
#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq)]
pub enum CallerAuthorityCommand {
    Prepare(CallerAuthorityPublication),
    Commit(CallerAuthorityPublication),
    Complete(CallerAuthorityPublication),
}

/// Exact durable receiver progress for lost-response reconciliation.
#[derive(CandidType, Clone, Copy, Debug, Deserialize, Eq, PartialEq)]
pub enum CallerAuthorityPhase {
    Prepared,
    Committed,
    Complete,
}

/// Retained immutable original publication and observed durable phase.
#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq)]
pub struct CallerAuthorityReceipt {
    pub publication: CallerAuthorityPublication,
    pub phase: CallerAuthorityPhase,
}

/// Receiver authority and optional original-operation receipt, without copying the source census.
#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq)]
pub struct CallerAuthorityStatus {
    pub readiness: CallerAuthorityReadiness,
    pub authority: CallerReceiverAuthority,
    pub generation: u64,
    pub open: bool,
    pub retired: bool,
    pub entries: u32,
    pub reserved_bytes: u32,
    pub pending_operation: Option<[u8; 32]>,
    pub receipt: Option<CallerAuthorityReceipt>,
}

/// Framework bootstrap may finish before protected application initialization and fixtures.
#[derive(CandidType, Clone, Copy, Debug, Deserialize, Eq, PartialEq)]
pub enum CallerAuthorityReadiness {
    FrameworkPending,
    FrameworkReady,
    ApplicationReady,
}