canic-core 0.86.1

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

//! Module: storage::stable::registry::app
//!
//! Responsibility: persist subnet-to-root application registry bindings.
//! Does not own: topology policy, workflow orchestration, or endpoint DTOs.
//! Boundary: exports canonical app-registry data for storage ops consumers.

use crate::cdk::structures::btreemap::BTreeMap as StableBtreeMap;
use crate::{
    cdk::structures::{DefaultMemoryImpl, memory::VirtualMemory},
    role_contract::allocation::memory::topology::APP_REGISTRY_ID,
    storage::prelude::*,
};
use std::cell::RefCell;

//
// APP_REGISTRY
// An application-wide map of every subnet principal to its
// corresponding root principal
//

eager_static! {
    static APP_REGISTRY: RefCell<StableBtreeMap<Principal, Principal, VirtualMemory<DefaultMemoryImpl>>> =
        RefCell::new(StableBtreeMap::init(crate::ic_memory_key!(authority = CANIC_CORE_MEMORY_AUTHORITY, key = "canic.core.app_registry.v1", ty = AppRegistry, id = APP_REGISTRY_ID)));
}

///
/// AppRegistryEntryRecord
///
/// One logical app-registry row.
///

#[derive(Clone, Debug)]
pub struct AppRegistryEntryRecord {
    pub subnet_pid: Principal,
    pub root_pid: Principal,
}

impl AppRegistryEntryRecord {
    pub const STATE_CONTRACT_NAME: &'static str = "AppRegistryEntryRecord";
}

///
/// AppRegistryData
///
/// Canonical app-registry export snapshot.
///

#[derive(Clone, Debug)]
pub struct AppRegistryData {
    pub entries: Vec<AppRegistryEntryRecord>,
}

impl AppRegistryData {
    pub const STATE_CONTRACT_NAME: &'static str = "AppRegistryData";
}

///
/// AppRegistry
///
/// Stable-memory–backed model relation mapping subnet principals to their
/// corresponding root principals.
///
/// This registry is authoritative and is populated via internal lifecycle
/// operations. It is exported for snapshot/view construction but is not
/// imported wholesale.
///

pub struct AppRegistry;

impl AppRegistry {
    /// Insert or replace the root principal recorded for a subnet.
    pub(crate) fn upsert(subnet_pid: Principal, root_pid: Principal) {
        APP_REGISTRY.with_borrow_mut(|map| {
            map.insert(subnet_pid, root_pid);
        });
    }

    #[must_use]
    pub(crate) fn export() -> AppRegistryData {
        AppRegistryData {
            entries: APP_REGISTRY.with_borrow(|map| {
                map.iter()
                    .map(|entry| AppRegistryEntryRecord {
                        subnet_pid: *entry.key(),
                        root_pid: entry.value(),
                    })
                    .collect()
            }),
        }
    }
}