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

#![cfg(feature = "pausable")]

//! OpenZeppelin style pausable feature.
//!
//! Note that on the IC canisters have system stopping capabilities.
//! This is unrelated to this pausable feature. This feature is entirely implemented on the application level.
//!
//! The pausable feature is especially useful when certain public-facing functions
//! need to be disabled whilst other functions can still be called normally.
//!
//! By default only `admins` can pause/resume.

use crate::access_control::*;
use crate::global_flags::*;
#[cfg(test)]
use crate::testing::*;
use crate::types::*;
use ic_cdk_macros::{query, update};
use rustic_macros::modifiers;

/// Guard method for validating when a canister is not paused.
/// This is typically used in conjunction with the [`modifiers`] macro.
pub fn when_not_paused() -> Result<(), String> {
    #[allow(clippy::unwrap_used)] // unwrap desired
    if GLOBAL_FLAGS.with(|f| f.borrow().get().0.clone().unwrap().paused) {
        Err("Contract is paused".to_string())
    } else {
        Ok(())
    }
}

/// Guard method for validating when a canister is paused.
/// This is typically used in conjunction with the [`modifiers`] macro.
pub fn when_paused() -> Result<(), String> {
    #[allow(clippy::unwrap_used)] // unwrap desired
    if GLOBAL_FLAGS.with(|f| f.borrow().get().0.clone().unwrap().paused) {
        Ok(())
    } else {
        Err("Contract is not paused".to_string())
    }
}

/// Query method to get the current pause status.
#[query]
pub fn is_paused() -> bool {
    #[allow(clippy::unwrap_used)] // unwrap desired
    GLOBAL_FLAGS.with(|f| f.borrow().get().0.clone().unwrap().paused)
}

/// Pauses the canister. Can only be called by admins.
#[update]
#[modifiers("only_admin")]
pub fn pause() {
    GLOBAL_FLAGS.with(|f| {
        let mut f = f.borrow_mut();
        #[allow(clippy::unwrap_used)] // unwrap desired
        let mut flags = f.get().0.clone().unwrap();
        flags.paused = true;
        #[allow(clippy::expect_used)] // unwrap desired
        f.set(Cbor(Some(flags))).expect("Pause failed");
    });
}

/// Resumes the canister. Can only be called by admins.
#[update]
#[modifiers("only_admin")]
pub fn resume() {
    GLOBAL_FLAGS.with(|f| {
        let mut f = f.borrow_mut();
        #[allow(clippy::unwrap_used)] // unwrap desired
        let mut flags = f.get().0.clone().unwrap();
        flags.paused = false;
        #[allow(clippy::expect_used)] // unwrap desired
        f.set(Cbor(Some(flags))).expect("Resume failed");
    });
}

// TODO: add pause/resume from roles

#[cfg(test)]
mod unit_tests {
    use super::*;
    use candid::Principal;

    #[test]
    fn test_pause() {
        set_mock_caller(Principal::from_text("a4gq6-oaaaa-aaaab-qaa4q-cai").unwrap());
        global_flags_init();
        assert!(!is_paused());
        pause();
        assert!(is_paused());
        resume();
        assert!(!is_paused());
    }
}