canic-core 0.69.5

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

//! Module: storage::stable::sharding::lifecycle
//!
//! Responsibility: persist the active shard set in stable memory.
//! Does not own: sharding placement policy, workflow orchestration, or DTOs.
//! Boundary: stable-memory schema and mutation primitives for shard lifecycle state.

use crate::{
    cdk::structures::{DefaultMemoryImpl, Memory, memory::VirtualMemory},
    storage::{prelude::*, stable::memory::placement::SHARDING_ACTIVE_SET_ID},
};
use ic_memory::stable_structures::btreemap::BTreeMap as StableBtreeMap;
use std::cell::RefCell;

const PRESENT: u8 = 1;

//
// SHARDING_LIFECYCLE CORE
//

eager_static! {
    static SHARDING_LIFECYCLE: RefCell<ShardingLifecycleCore<VirtualMemory<DefaultMemoryImpl>>> =
        RefCell::new(ShardingLifecycleCore::new(
            StableBtreeMap::init(crate::ic_memory_key!("canic.core.sharding_active_set.v1", ShardingActiveSet, SHARDING_ACTIVE_SET_ID)),
        ));
}

///
/// ShardingLifecycle
///
/// Stable storage accessor for the active shard set.
///

pub struct ShardingLifecycle;

impl ShardingLifecycle {
    pub(crate) fn with<F, R>(f: F) -> R
    where
        F: FnOnce(&ShardingLifecycleCore<VirtualMemory<DefaultMemoryImpl>>) -> R,
    {
        SHARDING_LIFECYCLE.with_borrow(f)
    }

    pub(crate) fn with_mut<F, R>(f: F) -> R
    where
        F: FnOnce(&mut ShardingLifecycleCore<VirtualMemory<DefaultMemoryImpl>>) -> R,
    {
        SHARDING_LIFECYCLE.with_borrow_mut(f)
    }

    // ---------------------------------------------------------------------
    // Queries
    // ---------------------------------------------------------------------

    #[must_use]
    pub(crate) fn active_shards() -> Vec<Principal> {
        Self::with(|core| core.active.iter().map(|entry| *entry.key()).collect())
    }

    // ---------------------------------------------------------------------
    // Mutations
    // ---------------------------------------------------------------------

    pub(crate) fn set_active(pid: Principal) {
        Self::with_mut(|core| {
            core.active.insert(pid, PRESENT);
        });
    }
}

///
/// ShardingActiveSet
///
/// Stable-memory marker type for the active shard set memory region.
///

pub struct ShardingActiveSet;

//
// ShardingLifecycleCore
//

///
/// ShardingLifecycleCore
///
/// Stable-memory core containing active shard records.
///

pub struct ShardingLifecycleCore<M: Memory> {
    active: StableBtreeMap<Principal, u8, M>,
}

impl<M: Memory> ShardingLifecycleCore<M> {
    pub const fn new(active: StableBtreeMap<Principal, u8, M>) -> Self {
        Self { active }
    }
}