junobuild-satellite 0.6.0

Core implementation of a Juno Satellite.
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

use crate::memory::manager::{
    get_memory_assets, get_memory_content_chunks, get_memory_db, get_memory_polyfill,
    get_memory_proposal_assets, get_memory_proposal_content_chunks, get_memory_proposals,
    get_memory_upgrades,
};
use crate::types::state::StableState;
use ic_stable_structures::StableBTreeMap;
use junobuild_shared::types::memory::Memory;

pub fn get_memory_for_upgrade() -> Memory {
    get_memory_upgrades()
}

pub fn init_stable_state() -> StableState {
    StableState {
        db: StableBTreeMap::init(get_memory_db()),
        assets: StableBTreeMap::init(get_memory_assets()),
        content_chunks: StableBTreeMap::init(get_memory_content_chunks()),
        proposals_assets: StableBTreeMap::init(get_memory_proposal_assets()),
        proposals_content_chunks: StableBTreeMap::init(get_memory_proposal_content_chunks()),
        proposals: StableBTreeMap::init(get_memory_proposals()),
    }
}

type InitPolyfillMemoryFn = fn(Memory);

/// Registers a memory for a polyfill and initializes it using a provided function.
///
/// # Parameters
/// - `init_fn`: A function that takes `Memory` and performs initialization.
///
/// # ⚠️ Warning
/// **This is a reserved function and should not be used by developers writing serverless functions.**
/// Improper use may lead to **unpredictable issues**, including memory corruption or unexpected failures.
/// Serverless functions should rely on the provided execution environment instead.
///
/// # Notes
/// - This function **encapsulates** memory access, ensuring that the correct
///   memory region (`POLYFILL`) is used.
/// - The initialization function **must not assume memory is already initialized**.
#[doc(hidden)]
pub fn register_polyfill_memory(init_fn: InitPolyfillMemoryFn) {
    let memory = get_memory_polyfill();
    init_fn(memory);
}