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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
use crate::call::{AsyncCaller, SyncCaller};
use candid::utils::ArgumentEncoder;
use candid::{parser::value::IDLValue, ser::IDLBuilder, utils::ArgumentDecoder, CandidType};
use garcon::Waiter;
use ic_agent::{ic_types::Principal, Agent, AgentError, RequestId};
use std::convert::TryInto;
use std::fmt;
use thiserror::Error;
#[derive(Debug, Error)]
pub enum CanisterBuilderError {
#[error("Getting the Canister ID returned an error: {0}")]
PrincipalError(#[from] Box<dyn std::error::Error + std::marker::Send + std::marker::Sync>),
#[error("Must specify an Agent")]
MustSpecifyAnAgent(),
#[error("Must specify a Canister ID")]
MustSpecifyCanisterId(),
}
#[derive(Debug, Default)]
pub struct CanisterBuilder<'agent> {
agent: Option<&'agent Agent>,
canister_id: Option<Result<Principal, CanisterBuilderError>>,
}
impl<'agent> CanisterBuilder<'agent> {
pub fn new() -> CanisterBuilder<'static> {
Default::default()
}
pub fn with_canister_id<E, P>(self, canister_id: P) -> Self
where
E: 'static + std::error::Error + std::marker::Send + std::marker::Sync,
P: TryInto<Principal, Error = E>,
{
Self {
canister_id: Some(
canister_id
.try_into()
.map_err(|e| CanisterBuilderError::PrincipalError(Box::new(e))),
),
..self
}
}
pub fn with_agent(self, agent: &'agent Agent) -> Self {
CanisterBuilder {
agent: Some(agent),
..self
}
}
pub fn build(self) -> Result<Canister<'agent>, CanisterBuilderError> {
let canister_id = if let Some(cid) = self.canister_id {
cid?
} else {
return Err(CanisterBuilderError::MustSpecifyCanisterId());
};
let agent = self
.agent
.ok_or(CanisterBuilderError::MustSpecifyAnAgent())?;
Ok(Canister { agent, canister_id })
}
}
#[derive(Debug, Clone)]
pub struct Canister<'agent> {
pub(super) agent: &'agent Agent,
pub(super) canister_id: Principal,
}
impl<'agent> Canister<'agent> {
pub fn canister_id_<'canister: 'agent>(&'canister self) -> &Principal {
&self.canister_id
}
pub fn update_<'canister: 'agent>(
&'canister self,
method_name: &str,
) -> AsyncCallBuilder<'agent, 'canister> {
AsyncCallBuilder::new(self, method_name)
}
pub fn query_<'canister: 'agent>(
&'canister self,
method_name: &str,
) -> SyncCallBuilder<'agent, 'canister> {
SyncCallBuilder::new(self, method_name)
}
pub async fn wait<'canister: 'agent, W>(
&'canister self,
request_id: RequestId,
waiter: W,
disable_range_check: bool,
) -> Result<Vec<u8>, AgentError>
where
W: Waiter,
{
self.agent
.wait(request_id, self.canister_id, disable_range_check, waiter)
.await
}
pub fn clone_with_(&self, id: Principal) -> Self {
Self {
agent: self.agent,
canister_id: id,
}
}
pub fn builder() -> CanisterBuilder<'agent> {
Default::default()
}
}
enum ArgumentType {
Raw(Vec<u8>),
Idl(IDLBuilder),
}
impl fmt::Debug for ArgumentType {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self {
Self::Raw(v) => f.debug_tuple("ArgumentType::Raw").field(v).finish(),
Self::Idl(_) => f.debug_struct("ArgumentType::Idl").finish_non_exhaustive(),
}
}
}
#[derive(Debug)]
pub struct Argument(Result<ArgumentType, AgentError>);
impl Argument {
pub fn push_idl_arg<A: CandidType>(&mut self, arg: A) {
match self.0 {
Ok(ArgumentType::Idl(ref mut idl_builder)) => {
let result = idl_builder.arg(&arg);
if let Err(e) = result {
self.0 = Err(AgentError::CandidError(Box::new(e)))
}
}
Ok(ArgumentType::Raw(_)) => {
self.0 = Err(AgentError::MessageError(
"Cannot overwrite a Raw Argument with a non-raw argument.".to_owned(),
))
}
_ => {}
}
}
pub fn push_value_arg(&mut self, arg: IDLValue) {
match self.0 {
Ok(ArgumentType::Idl(ref mut idl_builder)) => {
let result = idl_builder.value_arg(&arg);
if let Err(e) = result {
self.0 = Err(AgentError::CandidError(Box::new(e)))
}
}
Ok(ArgumentType::Raw(_)) => {
self.0 = Err(AgentError::MessageError(
"Cannot overwrite a Raw Argument with a non-raw argument.".to_owned(),
))
}
_ => {}
}
}
pub fn set_raw_arg(&mut self, arg: Vec<u8>) {
if self.0.is_ok() {
self.0 = Ok(ArgumentType::Raw(arg));
}
}
pub fn serialize(self) -> Result<Vec<u8>, AgentError> {
match self.0 {
Ok(ArgumentType::Idl(mut idl_builder)) => idl_builder
.serialize_to_vec()
.map_err(|e| AgentError::CandidError(Box::new(e))),
Ok(ArgumentType::Raw(vec)) => Ok(vec),
Err(e) => Err(e),
}
}
pub fn reset(&mut self) {
*self = Default::default();
}
pub fn new() -> Self {
Default::default()
}
pub fn from_raw(raw: Vec<u8>) -> Self {
Self(Ok(ArgumentType::Raw(raw)))
}
pub fn from_candid(tuple: impl ArgumentEncoder) -> Self {
let mut builder = IDLBuilder::new();
Self(
tuple
.encode(&mut builder)
.map(|_| ArgumentType::Idl(builder))
.map_err(|e| AgentError::CandidError(Box::new(e))),
)
}
}
impl Default for Argument {
fn default() -> Self {
Self(Ok(ArgumentType::Idl(IDLBuilder::new())))
}
}
#[derive(Debug)]
pub struct SyncCallBuilder<'agent, 'canister: 'agent> {
canister: &'canister Canister<'agent>,
method_name: String,
effective_canister_id: Principal,
arg: Argument,
}
impl<'agent, 'canister: 'agent> SyncCallBuilder<'agent, 'canister> {
pub(super) fn new<M: Into<String>>(
canister: &'canister Canister<'agent>,
method_name: M,
) -> Self {
Self {
canister,
method_name: method_name.into(),
effective_canister_id: canister.canister_id_().to_owned(),
arg: Default::default(),
}
}
}
impl<'agent, 'canister: 'agent> SyncCallBuilder<'agent, 'canister> {
pub fn with_arg<Argument>(mut self, arg: Argument) -> SyncCallBuilder<'agent, 'canister>
where
Argument: CandidType + Sync + Send,
{
self.arg.push_idl_arg(arg);
self
}
pub fn with_value_arg(mut self, arg: IDLValue) -> SyncCallBuilder<'agent, 'canister> {
self.arg.push_value_arg(arg);
self
}
pub fn with_arg_raw(mut self, arg: Vec<u8>) -> SyncCallBuilder<'agent, 'canister> {
self.arg.set_raw_arg(arg);
self
}
pub fn with_effective_canister_id(
mut self,
canister_id: Principal,
) -> SyncCallBuilder<'agent, 'canister> {
self.effective_canister_id = canister_id;
self
}
pub fn build<Output>(self) -> SyncCaller<'canister, Output>
where
Output: for<'de> ArgumentDecoder<'de> + Send + Sync,
{
let c = self.canister;
SyncCaller {
agent: c.agent,
effective_canister_id: self.effective_canister_id,
canister_id: c.canister_id,
method_name: self.method_name.clone(),
arg: self.arg.serialize(),
expiry: Default::default(),
phantom_out: std::marker::PhantomData,
}
}
}
#[derive(Debug)]
pub struct AsyncCallBuilder<'agent, 'canister: 'agent> {
canister: &'canister Canister<'agent>,
method_name: String,
effective_canister_id: Principal,
arg: Argument,
}
impl<'agent, 'canister: 'agent> AsyncCallBuilder<'agent, 'canister> {
pub(super) fn new(
canister: &'canister Canister<'agent>,
method_name: &str,
) -> AsyncCallBuilder<'agent, 'canister> {
Self {
canister,
method_name: method_name.to_string(),
effective_canister_id: canister.canister_id_().to_owned(),
arg: Default::default(),
}
}
}
impl<'agent, 'canister: 'agent> AsyncCallBuilder<'agent, 'canister> {
pub fn with_arg<Argument>(mut self, arg: Argument) -> AsyncCallBuilder<'agent, 'canister>
where
Argument: CandidType + Sync + Send,
{
self.arg.push_idl_arg(arg);
self
}
pub fn with_arg_raw(mut self, arg: Vec<u8>) -> AsyncCallBuilder<'agent, 'canister> {
self.arg.set_raw_arg(arg);
self
}
pub fn with_effective_canister_id(
mut self,
canister_id: Principal,
) -> AsyncCallBuilder<'agent, 'canister> {
self.effective_canister_id = canister_id;
self
}
pub fn build<Output>(self) -> AsyncCaller<'canister, Output>
where
Output: for<'de> ArgumentDecoder<'de> + Send + Sync,
{
let c = self.canister;
AsyncCaller {
agent: c.agent,
effective_canister_id: self.effective_canister_id,
canister_id: c.canister_id,
method_name: self.method_name.clone(),
arg: self.arg.serialize(),
expiry: Default::default(),
phantom_out: std::marker::PhantomData,
}
}
}
#[cfg(test)]
mod tests {
use super::super::interfaces::ManagementCanister;
use crate::call::AsyncCall;
use ic_agent::agent::http_transport::ReqwestHttpReplicaV2Transport;
use ic_agent::identity::BasicIdentity;
#[ignore]
#[tokio::test]
async fn simple() {
use super::Canister;
use garcon::Delay;
let rng = ring::rand::SystemRandom::new();
let key_pair = ring::signature::Ed25519KeyPair::generate_pkcs8(&rng)
.expect("Could not generate a key pair.");
let identity = BasicIdentity::from_key_pair(
ring::signature::Ed25519KeyPair::from_pkcs8(key_pair.as_ref())
.expect("Could not read the key pair."),
);
let agent = ic_agent::Agent::builder()
.with_transport(ReqwestHttpReplicaV2Transport::create("http://localhost:8001").unwrap())
.with_identity(identity)
.build()
.unwrap();
agent.fetch_root_key().await.unwrap();
let management_canister = ManagementCanister::from_canister(
Canister::builder()
.with_agent(&agent)
.with_canister_id("aaaaa-aa")
.build()
.unwrap(),
);
let (new_canister_id,) = management_canister
.create_canister()
.call_and_wait(Delay::throttle(std::time::Duration::from_secs(1)))
.await
.unwrap();
let (status,) = management_canister
.canister_status(&new_canister_id)
.call_and_wait(Delay::throttle(std::time::Duration::from_secs(1)))
.await
.unwrap();
assert_eq!(format!("{}", status.status), "Running");
let canister_wasm = b"\0asm\x01\0\0\0";
management_canister
.install_code(&new_canister_id, canister_wasm)
.call_and_wait(Delay::throttle(std::time::Duration::from_secs(1)))
.await
.unwrap();
let canister = Canister::builder()
.with_agent(&agent)
.with_canister_id(new_canister_id)
.build()
.unwrap();
assert!(canister
.update_("hello")
.build::<()>()
.call_and_wait(Delay::throttle(std::time::Duration::from_secs(1)))
.await
.is_err());
}
}