ic_mple_client 0.19.0

Simple client abstraction to interact with the Internet Computer canisters
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

use std::future::Future;

use candid::CandidType;
use candid::utils::ArgumentEncoder;
use serde::de::DeserializeOwned;

use crate::CanisterClientResult;

/// Generic client for interacting with a canister.
/// This is used to abstract away the differences between the IC Agent and the
/// IC Canister.
/// The IC Agent is used for interaction through the dfx tool, while the IC
/// Canister is used for interacting with the EVM canister in wasm environments.
pub trait CanisterClient: Send + Clone {
    /// Call an update method on the canister.
    ///
    /// # Arguments
    ///
    /// * `method` - The method name.
    /// * `args` - The arguments to the method.
    ///
    /// # Returns
    ///
    /// The result of the method call.
    fn update<T, R>(
        &self,
        method: &str,
        args: T,
    ) -> impl Future<Output = CanisterClientResult<R>> + Send
    where
        T: ArgumentEncoder + Send + Sync,
        R: DeserializeOwned + CandidType + Send;

    /// Call a query method on the canister.
    ///
    /// # Arguments
    ///
    /// * `method` - The method name.
    /// * `args` - The arguments to the method.
    ///
    /// # Returns
    ///
    /// The result of the method call.
    fn query<T, R>(
        &self,
        method: &str,
        args: T,
    ) -> impl Future<Output = CanisterClientResult<R>> + Send
    where
        T: ArgumentEncoder + Send + Sync,
        R: DeserializeOwned + CandidType + Send;
}