canic-core 0.110.2

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
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

//! Module: api::role
//!
//! Responsibility: adapt the compiled role contract into immutable status verification.
//! Does not own: capability derivation, endpoint emission, authorization, or mutable state.
//! Boundary: maps internal capability keys to the closed public role overview values.

use crate::{
    dto::{
        metadata::CanicMetadataResponse,
        role::{RoleCapability, RoleOverviewResponse},
        state::BootstrapStatusResponse,
    },
    ids::CanisterRole,
    role_contract::RoleCapabilityKey,
};
use std::collections::BTreeSet;

/// Endpoint-facing adapter for immutable compiled-role verification.
pub struct RoleOverviewApi;

impl RoleOverviewApi {
    /// Build one overview from the already resolved build-time capability authority.
    #[must_use]
    pub fn overview(
        role: CanisterRole,
        capabilities: &BTreeSet<RoleCapabilityKey>,
        protocol_profile_digest: [u8; 32],
        metadata: CanicMetadataResponse,
        bootstrap: BootstrapStatusResponse,
    ) -> RoleOverviewResponse {
        let mut capabilities = capabilities
            .iter()
            .copied()
            .filter_map(capability_view)
            .collect::<Vec<_>>();
        capabilities.sort_unstable();

        RoleOverviewResponse {
            role,
            capabilities,
            protocol_profile_digest,
            metadata,
            bootstrap,
        }
    }
}

const fn capability_view(capability: RoleCapabilityKey) -> Option<RoleCapability> {
    Some(match capability {
        RoleCapabilityKey::AutomaticTopup => RoleCapability::AutomaticTopup,
        RoleCapabilityKey::ChildProvisioning => RoleCapability::ChildProvisioning,
        RoleCapabilityKey::DelegatedTokenIssuer => RoleCapability::DelegatedTokenIssuer,
        RoleCapabilityKey::DelegatedTokenVerifier => RoleCapability::DelegatedTokenVerifier,
        RoleCapabilityKey::FleetAdmissionProjection => RoleCapability::FleetAdmissionProjection,
        RoleCapabilityKey::FleetCoordinator => RoleCapability::FleetCoordinator,
        RoleCapabilityKey::Index => RoleCapability::Index,
        RoleCapabilityKey::Icrc21 => RoleCapability::Icrc21,
        RoleCapabilityKey::LocalApplicationAuthorization => return None,
        RoleCapabilityKey::RoleAttestationSigner => RoleCapability::RoleAttestationSigner,
        RoleCapabilityKey::RoleAttestationVerifier => RoleCapability::RoleAttestationVerifier,
        RoleCapabilityKey::Root => RoleCapability::Root,
        RoleCapabilityKey::RootControlPlane => RoleCapability::RootControlPlane,
        RoleCapabilityKey::Runtime => RoleCapability::Runtime,
        RoleCapabilityKey::Scaling => RoleCapability::Scaling,
        RoleCapabilityKey::Sharding => RoleCapability::Sharding,
        RoleCapabilityKey::WasmStore => RoleCapability::WasmStore,
    })
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn overview_projects_public_capabilities_in_lexical_order() {
        let capabilities = BTreeSet::from([
            RoleCapabilityKey::AutomaticTopup,
            RoleCapabilityKey::ChildProvisioning,
            RoleCapabilityKey::DelegatedTokenIssuer,
            RoleCapabilityKey::DelegatedTokenVerifier,
            RoleCapabilityKey::FleetAdmissionProjection,
            RoleCapabilityKey::FleetCoordinator,
            RoleCapabilityKey::Index,
            RoleCapabilityKey::Icrc21,
            RoleCapabilityKey::LocalApplicationAuthorization,
            RoleCapabilityKey::RoleAttestationSigner,
            RoleCapabilityKey::RoleAttestationVerifier,
            RoleCapabilityKey::Root,
            RoleCapabilityKey::RootControlPlane,
            RoleCapabilityKey::Runtime,
            RoleCapabilityKey::Scaling,
            RoleCapabilityKey::Sharding,
            RoleCapabilityKey::WasmStore,
        ]);
        let overview = RoleOverviewApi::overview(
            CanisterRole::new("app"),
            &capabilities,
            [9; 32],
            CanicMetadataResponse {
                package_name: "app".to_string(),
                package_version: "0.1.0".to_string(),
                package_description: "test".to_string(),
                canic_version: "0.103.0".to_string(),
                canister_version: 4,
            },
            BootstrapStatusResponse {
                ready: true,
                phase: "ready".to_string(),
                last_error: None,
            },
        );

        assert_eq!(
            overview.capabilities,
            vec![
                RoleCapability::AutomaticTopup,
                RoleCapability::ChildProvisioning,
                RoleCapability::DelegatedTokenIssuer,
                RoleCapability::DelegatedTokenVerifier,
                RoleCapability::FleetAdmissionProjection,
                RoleCapability::FleetCoordinator,
                RoleCapability::Icrc21,
                RoleCapability::Index,
                RoleCapability::RoleAttestationSigner,
                RoleCapability::RoleAttestationVerifier,
                RoleCapability::Root,
                RoleCapability::RootControlPlane,
                RoleCapability::Runtime,
                RoleCapability::Scaling,
                RoleCapability::Sharding,
                RoleCapability::WasmStore,
            ]
        );
        assert_eq!(overview.protocol_profile_digest, [9; 32]);
    }
}