junobuild-shared 0.8.0

Shared utilities for Juno.
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

use candid::Principal;

#[cfg(target_arch = "wasm32")]
use ic_cdk::api::{
    canister_self, debug_print, is_controller as ic_is_controller, msg_caller, time as ic_time,
};

/// Returns the **principal** of the current module.
///
/// This is a shorthand for [`ic_cdk::api::canister_self`],
/// kept for readability and to align with the concise naming convention
/// used our helpers.
///
/// # Example
/// ```ignore
/// let current_module = ic::api::id();
/// ```
#[cfg(target_arch = "wasm32")]
pub fn id() -> Principal {
    canister_self()
}

#[cfg(not(target_arch = "wasm32"))]
pub fn id() -> Principal {
    Principal::from_text("ck4tp-3iaaa-aaaal-ab7da-cai").unwrap()
}

/// Returns the **principal** of the caller that invoked the current module.
///
/// This is a shorthand for [`ic_cdk::api::msg_caller`],
/// kept for readability and to align with the concise naming convention
/// used our helpers.
///
/// # Example
/// ```ignore
/// let user = ic::api::caller();
/// ```
#[cfg(target_arch = "wasm32")]
pub fn caller() -> Principal {
    msg_caller()
}

#[cfg(not(target_arch = "wasm32"))]
pub fn caller() -> Principal {
    Principal::from_text("bphsl-fvy2d-emlkg-wuhfe-fylew-25w4a-vpdm3-ajsos-ao4x5-sxn5j-jqe").unwrap()
}

/// Prints a debug message to the Juno runtime logs.
///
/// This is a shorthand for [`ic_cdk::api::debug_print`],  
/// kept for readability and to align with the concise naming convention
/// used in our helpers.
///
/// In the Juno Console, these messages appear in the logs of the current module.
///
/// # Example
/// ```ignore
/// ic::api::print("Satellite started successfully");
/// ```
#[cfg(target_arch = "wasm32")]
pub fn print<S: AsRef<str>>(s: S) {
    debug_print(s)
}

#[cfg(not(target_arch = "wasm32"))]
pub fn print<S: AsRef<str>>(_s: S) {
    // Noop
}

/// Returns the current timestamp in nanoseconds since the UNIX epoch.
///
/// This is a shorthand for [`ic_cdk::api::time`] useful for
/// test in wasm32 environment.
///
/// # Example
/// ```ignore
/// let now = ic::api::time();
/// ```
#[cfg(target_arch = "wasm32")]
pub fn time() -> u64 {
    ic_time()
}

#[cfg(not(target_arch = "wasm32"))]
pub fn time() -> u64 {
    use std::time::{SystemTime, UNIX_EPOCH};
    SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .unwrap()
        .as_nanos() as u64
}

#[cfg(target_arch = "wasm32")]
pub fn is_canister_controller(principal: &Principal) -> bool {
    ic_is_controller(principal)
}

#[cfg(not(target_arch = "wasm32"))]
pub fn is_canister_controller(principal: &Principal) -> bool {
    // For tests, return true for specific test principals or implement mock logic
    // This is a simple mock - adjust based on your needs
    *principal == Principal::from_text("ck4tp-3iaaa-aaaal-ab7da-cai").unwrap()
}