rustic 0.1.9

Library for building canisters on 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

//! Utility functions.

use candid::Principal;

// Anonymous callers can be dangerous if not properly validated
// example: `#[rustic_macros::modifiers("not_anonymous@caller")]`
#[allow(dead_code)]
fn not_anonymous(principal: Principal) -> Result<(), String> {
    (principal != candid::Principal::anonymous())
        .then_some(())
        .ok_or("Anonymous caller is not allowed".to_string())
}

// Macro for displaying `type_name_of`
#[macro_export]
macro_rules! function {
    () => {{
        fn f() {}
        fn type_name_of<T>(_: T) -> &'static str {
            std::any::type_name::<T>()
        }
        let name = type_name_of(f);
        &name[..name.len() - 3]
    }};
}

// Methods that wrap `ic_cdk::api` to allow for both testing and production use
#[inline]
pub fn canister_caller() -> Principal {
    #[cfg(not(test))]
    return ic_cdk::api::caller();

    #[cfg(test)]
    return super::testing::mock_caller();
}

#[inline]
pub fn canister_id() -> Principal {
    #[cfg(not(test))]
    return ic_cdk::api::id();

    #[cfg(test)]
    return super::testing::mock_id();
}

#[inline]
pub fn canister_version() -> u64 {
    #[cfg(not(test))]
    return ic_cdk::api::canister_version();

    #[cfg(test)]
    return super::testing::mock_version();
}

#[inline]
pub fn canister_time() -> u64 {
    #[cfg(not(test))]
    return ic_cdk::api::time();

    #[cfg(test)]
    return super::testing::mock_time();
}

#[inline]
pub fn canister_balance() -> u64 {
    #[cfg(not(test))]
    return ic_cdk::api::canister_balance();

    #[cfg(test)]
    return super::testing::mock_balance() as u64;
}

#[inline]
pub fn canister_balance128() -> u128 {
    #[cfg(not(test))]
    return ic_cdk::api::canister_balance128();

    #[cfg(test)]
    return super::testing::mock_balance();
}

#[inline]
pub fn instruction_counter() -> u64 {
    #[cfg(not(test))]
    return ic_cdk::api::instruction_counter();

    #[cfg(test)]
    return super::testing::mock_instruction_counter();
}

#[inline]
#[allow(unused_variables)]
pub fn performance_counter(counter_type: u32) -> u64 {
    #[cfg(not(test))]
    return ic_cdk::api::performance_counter(counter_type);

    #[cfg(test)]
    return super::testing::mock_instruction_counter();
}

#[inline]
pub fn is_controller(caller: &Principal) -> bool {
    #[cfg(not(test))]
    return ic_cdk::api::is_controller(caller);

    #[cfg(test)]
    return super::testing::is_mock_controller(caller);
}

#[inline]
pub fn canister_print<S: std::convert::AsRef<str>>(s: S) {
    #[cfg(not(test))]
    ic_cdk::api::print(s);

    #[cfg(test)]
    println!("{}", s.as_ref()); // Does not print anything during `cargo test`
}

#[inline]
pub fn canister_trap(message: &str) {
    #[cfg(not(test))]
    ic_cdk::api::call::reject(message);

    #[cfg(test)]
    panic!("{}", message);
}