ic_mple_client 0.8.1

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
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

use std::path::Path;
use std::time::Duration;

use candid::Principal;
use ic_agent::agent::EnvelopeContent;
use ic_agent::identity::{BasicIdentity, Secp256k1Identity};
use ic_agent::{Agent, Identity};

use super::AgentError;

pub enum GenericIdentity {
    Secp256k1Identity(Secp256k1Identity),
    BasicIdentity(BasicIdentity),
}

impl TryFrom<&Path> for GenericIdentity {
    type Error = AgentError;

    fn try_from(path: &Path) -> std::result::Result<Self, Self::Error> {
        Secp256k1Identity::from_pem_file(path)
            .map(GenericIdentity::from)
            .or(BasicIdentity::from_pem_file(path).map(GenericIdentity::from))
            .map_err(|e| AgentError::PemError(path.to_path_buf(), e))
    }
}

impl Identity for GenericIdentity {
    fn sender(&self) -> std::result::Result<Principal, String> {
        match self {
            Self::BasicIdentity(identity) => identity.sender(),
            Self::Secp256k1Identity(identity) => identity.sender(),
        }
    }

    fn sign(&self, blob: &EnvelopeContent) -> std::result::Result<ic_agent::Signature, String> {
        match self {
            Self::BasicIdentity(identity) => identity.sign(blob),
            Self::Secp256k1Identity(identity) => identity.sign(blob),
        }
    }

    fn public_key(&self) -> Option<Vec<u8>> {
        match self {
            Self::BasicIdentity(identity) => identity.public_key(),
            Self::Secp256k1Identity(identity) => identity.public_key(),
        }
    }
}

impl From<Secp256k1Identity> for GenericIdentity {
    fn from(value: Secp256k1Identity) -> Self {
        Self::Secp256k1Identity(value)
    }
}

impl From<BasicIdentity> for GenericIdentity {
    fn from(value: BasicIdentity) -> Self {
        Self::BasicIdentity(value)
    }
}

/// Initialize an IC Agent
pub async fn init_agent(
    identity_path: impl AsRef<Path>,
    url: &str,
    timeout: Option<Duration>,
) -> super::Result<Agent> {
    let identity = GenericIdentity::try_from(identity_path.as_ref())?;

    let timeout = timeout.unwrap_or(Duration::from_secs(120));

    let client = ic_agent::agent::http_transport::reqwest_transport::reqwest::ClientBuilder::new()
        .timeout(timeout)
        .build()
        .map_err(|e| {
            AgentError::ConfigurationError(format!(
                "error configuring transport client. Err: {e:?}"
            ))
        })?;

    let agent = Agent::builder()
        .with_http_client(client)
        .with_url(url)
        .with_identity(identity)
        .with_ingress_expiry(timeout)
        .build()?;

    agent.fetch_root_key().await?;

    Ok(agent)
}

#[cfg(test)]
mod test {

    use std::path::Path;

    use super::*;

    #[test]
    fn should_get_identity_from_pem_file() {
        let path = Path::new("./tests/identity/identity.pem");

        assert!(GenericIdentity::try_from(path).is_ok());
        assert!(matches!(
            GenericIdentity::try_from(path).unwrap(),
            GenericIdentity::Secp256k1Identity(_)
        ));
    }

    #[test]
    fn should_get_sender_from_identity() {
        let path = Path::new("./tests/identity/identity.pem");
        let identity = GenericIdentity::try_from(path).unwrap();
        let expected =
            Principal::from_text("zrrb4-gyxmq-nx67d-wmbky-k6xyt-byhmw-tr5ct-vsxu4-nuv2g-6rr65-aae")
                .unwrap();

        let principal = identity.sender().unwrap();

        assert_eq!(expected, principal);
    }

    #[test]
    fn identity_should_sign() {
        let path = Path::new("./tests/identity/identity.pem");
        let identity = GenericIdentity::try_from(path).unwrap();

        let envelop = EnvelopeContent::Query {
            ingress_expiry: 123,
            sender: Principal::anonymous(),
            canister_id: Principal::anonymous(),
            method_name: "some".to_owned(),
            arg: vec![],
            nonce: None,
        };

        let signature = identity.sign(&envelop).unwrap();

        assert!(signature.signature.is_some());
    }
}