b3_utils 0.13.1

Utility functions for building 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

use candid::CandidType;
use ic_cdk::api::{
    call::{call, call_with_payment, call_with_payment128},
    management_canister::{
        main::{
            CanisterInfoRequest, CanisterInfoResponse, CanisterStatusResponse,
            CreateCanisterArgument, InstallCodeArgument, UpdateSettingsArgument,
        },
        provisional::CanisterIdRecord,
    },
};
use serde::de::DeserializeOwned;

use crate::{constants::MANAGMENT_CANISTER_ID, types::CanisterId};

use self::error::ManagementError;

pub mod error;

mod inter;
pub use inter::*;

mod types;
pub use types::*;

mod app;
pub use app::*;

pub struct Management;

impl Management {
    pub async fn call<A, R>(method: &str, args: A, cycles: CallCycles) -> Result<R, ManagementError>
    where
        A: CandidType,
        R: CandidType + DeserializeOwned,
    {
        let res: Result<(R,), _> = match cycles {
            CallCycles::Pay128(cycles) => {
                call_with_payment128(MANAGMENT_CANISTER_ID, method, (args,), cycles).await
            }
            CallCycles::Pay(cycles) => {
                call_with_payment(MANAGMENT_CANISTER_ID, method, (args,), cycles).await
            }
            CallCycles::NoPay => call(MANAGMENT_CANISTER_ID, method, (args,)).await,
        };

        match res {
            Ok((res,)) => Ok(res),
            Err(e) => Err(ManagementError::CallError(method.to_string(), e.1)),
        }
    }

    pub async fn create_canister(
        arg: CreateCanisterArgument,
        cycles: u128,
    ) -> Result<CanisterIdRecord, ManagementError> {
        Management::call("create_canister", arg, CallCycles::Pay128(cycles)).await
    }

    pub async fn install_code(arg: InstallCodeArgument) -> Result<(), ManagementError> {
        Management::call("install_code", arg, CallCycles::NoPay).await
    }

    pub async fn update_settings(arg: UpdateSettingsArgument) -> Result<(), ManagementError> {
        Management::call("update_settings", arg, CallCycles::NoPay).await
    }

    pub async fn canister_status(
        canister_id: CanisterId,
    ) -> Result<CanisterStatusResponse, ManagementError> {
        let arg = CanisterIdRecord { canister_id };

        Management::call("canister_status", arg, CallCycles::NoPay).await
    }

    pub async fn start_canister(canister_id: CanisterId) -> Result<(), ManagementError> {
        let arg = CanisterIdRecord { canister_id };

        Management::call("start_canister", arg, CallCycles::NoPay).await
    }

    pub async fn stop_canister(canister_id: CanisterId) -> Result<(), ManagementError> {
        let arg = CanisterIdRecord { canister_id };

        Management::call("stop_canister", arg, CallCycles::NoPay).await
    }

    pub async fn delete_canister(canister_id: CanisterId) -> Result<(), ManagementError> {
        let arg = CanisterIdRecord { canister_id };

        Management::call("delete_canister", arg, CallCycles::NoPay).await
    }

    pub async fn uninstall_code(canister_id: CanisterId) -> Result<(), ManagementError> {
        let arg = CanisterIdRecord { canister_id };

        Management::call("uninstall_code", arg, CallCycles::NoPay).await
    }

    pub async fn deposit_cycles(
        canister_id: CanisterId,
        cycles: u128,
    ) -> Result<(), ManagementError> {
        let arg = CanisterIdRecord { canister_id };

        Management::call("deposit_cycles", arg, CallCycles::Pay128(cycles)).await
    }

    pub async fn raw_rand() -> Result<Vec<u8>, ManagementError> {
        Management::call("raw_rand", (), CallCycles::NoPay).await
    }

    pub async fn canister_info(
        canister_id: CanisterId,
        num_requested_changes: Option<u64>,
    ) -> Result<CanisterInfoResponse, ManagementError> {
        let arg = CanisterInfoRequest {
            canister_id,
            num_requested_changes,
        };

        Management::call("canister_info", arg, CallCycles::NoPay).await
    }
}