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
use crate::call::{CallBuilder, CallReply};
use crate::canister::Canister;
use crate::types::*;
use ic_kit_sys::types::RejectionCode;
use ic_types::Principal;
use std::collections::HashMap;
use std::future::Future;
use std::panic::{RefUnwindSafe, UnwindSafe};
use tokio::sync::{mpsc, oneshot};
pub struct Replica {
sender: mpsc::UnboundedSender<ReplicaMessage>,
}
pub struct CanisterHandle<'a> {
replica: &'a Replica,
canister_id: Principal,
}
struct CanisterMessage {
message: Message,
reply_sender: Option<oneshot::Sender<CallReply>>,
}
enum ReplicaMessage {
CanisterAdded {
canister_id: Principal,
channel: mpsc::UnboundedSender<CanisterMessage>,
},
CanisterRequest {
canister_id: Principal,
message: Message,
reply_sender: Option<oneshot::Sender<CallReply>>,
},
CanisterReply {
canister_id: Principal,
message: Message,
},
}
impl Replica {
pub fn new(canisters: Vec<Canister>) -> Self {
let tmp = Replica::default();
for canister in canisters {
tmp.add_canister(canister);
}
tmp
}
pub fn add_canister(&self, canister: Canister) -> CanisterHandle {
let canister_id = canister.id();
let replica_sender = self.sender.clone();
let (tx, rx) = mpsc::unbounded_channel();
replica_sender
.send(ReplicaMessage::CanisterAdded {
canister_id,
channel: tx,
})
.unwrap_or_else(|_| panic!("ic-kit-runtime: could not send message to replica"));
tokio::spawn(async move {
let canister_id = canister.id();
let mut rx = rx;
let mut canister = canister;
while let Some(message) = rx.recv().await {
let perform_call = canister
.process_message(message.message, message.reply_sender)
.await;
for call in perform_call {
let request_id = call.request_id;
let (tx, rx) = oneshot::channel();
replica_sender
.send(ReplicaMessage::CanisterRequest {
canister_id: call.callee,
message: call.into(),
reply_sender: Some(tx),
})
.unwrap_or_else(|_| {
panic!("ic-kit-runtime: could not send message to replica")
});
let rs = replica_sender.clone();
tokio::spawn(async move {
let replica_sender = rs;
let response = rx.await.expect(
"ic-kit-runtime: Could not get the response of inter-canister call.",
);
let message = response.to_message(request_id);
replica_sender
.send(ReplicaMessage::CanisterReply {
canister_id,
message,
})
.unwrap_or_else(|_| {
panic!("ic-kit-runtime: could not send message to replica")
});
});
}
}
});
CanisterHandle {
replica: self,
canister_id,
}
}
pub fn get_canister(&self, canister_id: Principal) -> CanisterHandle {
CanisterHandle {
replica: &self,
canister_id,
}
}
pub(crate) fn enqueue_request(
&self,
canister_id: Principal,
message: Message,
reply_sender: Option<oneshot::Sender<CallReply>>,
) {
self.sender
.send(ReplicaMessage::CanisterRequest {
canister_id,
message,
reply_sender,
})
.unwrap_or_else(|_| panic!("ic-kit-runtime: could not send message to replica"));
}
pub(crate) fn perform_call(&self, call: CanisterCall) -> impl Future<Output = CallReply> {
let canister_id = call.callee;
let message = Message::from(call);
let (tx, rx) = oneshot::channel();
self.enqueue_request(canister_id, message, Some(tx));
async {
rx.await
.expect("ic-kit-runtime: Could not retrieve the response from the call.")
}
}
pub fn new_call<S: Into<String>>(&self, id: Principal, method: S) -> CallBuilder {
CallBuilder::new(&self, id, method.into())
}
}
impl Default for Replica {
fn default() -> Self {
let (sender, rx) = mpsc::unbounded_channel::<ReplicaMessage>();
tokio::spawn(async move {
let mut rx = rx;
let mut canisters = HashMap::<Principal, mpsc::UnboundedSender<CanisterMessage>>::new();
while let Some(m) = rx.recv().await {
match m {
ReplicaMessage::CanisterAdded { canister_id, .. }
if canisters.contains_key(&canister_id) =>
{
panic!(
"Canister '{}' is already defined in the replica.",
canister_id
)
}
ReplicaMessage::CanisterAdded {
canister_id,
channel,
} => {
canisters.insert(canister_id, channel);
}
ReplicaMessage::CanisterRequest {
canister_id,
message,
reply_sender,
} => {
if let Some(chan) = canisters.get(&canister_id) {
chan.send(CanisterMessage {
message,
reply_sender,
})
.unwrap_or_else(|_| {
panic!("ic-kit-runtime: Could not enqueue the request.")
});
} else {
let cycles_refunded = match message {
Message::CustomTask { env, .. } => env.cycles_available,
Message::Request { env, .. } => env.cycles_refunded,
Message::Reply { .. } => 0,
};
reply_sender
.unwrap()
.send(CallReply::Reject {
rejection_code: RejectionCode::DestinationInvalid,
rejection_message: format!(
"Canister '{}' does not exists",
canister_id
),
cycles_refunded,
})
.expect("ic-kit-runtime: Could not send the response.");
}
}
ReplicaMessage::CanisterReply {
canister_id,
message,
} => {
let chan = canisters.get(&canister_id).unwrap();
chan.send(CanisterMessage {
message,
reply_sender: None,
})
.unwrap_or_else(|_| {
panic!("ic-kit-runtime: Could not enqueue the response request.")
});
}
}
}
});
Replica { sender }
}
}
impl<'a> CanisterHandle<'a> {
pub fn new_call<S: Into<String>>(&self, method_name: S) -> CallBuilder {
CallBuilder::new(self.replica, self.canister_id, method_name.into())
}
pub async fn custom<F: FnOnce() + Send + RefUnwindSafe + UnwindSafe + 'static>(
&self,
f: F,
env: Env,
) -> CallReply {
let (tx, rx) = oneshot::channel();
self.replica.enqueue_request(
self.canister_id,
Message::CustomTask {
request_id: RequestId::new(),
task: Box::new(f),
env,
},
Some(tx),
);
rx.await.unwrap()
}
pub async fn run_env(&self, env: Env) -> CallReply {
let (tx, rx) = oneshot::channel();
self.replica.enqueue_request(
self.canister_id,
Message::Request {
request_id: RequestId::new(),
env,
},
Some(tx),
);
rx.await.unwrap()
}
pub async fn init(&self) -> CallReply {
self.run_env(Env::init()).await
}
pub async fn pre_upgrade(&self) -> CallReply {
self.run_env(Env::pre_upgrade()).await
}
pub async fn post_upgrade(&self) -> CallReply {
self.run_env(Env::post_upgrade()).await
}
pub async fn heartbeat(&self) -> CallReply {
self.run_env(Env::heartbeat()).await
}
}