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
use std::collections::HashMap;
use candid::CandidType;
use serde::{Deserialize, Serialize};
/// 有的名字作为 key 需要加双引号
fn wrapped_key_word(name: &str) -> String {
if match name {
"bool" => true,
"nat" => true,
"int" => true,
"nat8" => true,
"nat16" => true,
"nat32" => true,
"nat64" => true,
"int8" => true,
"int16" => true,
"int32" => true,
"int64" => true,
"float32" => true,
"float64" => true,
"null" => true,
"text" => true,
"principal" => true,
"vec" => true,
"opt" => true,
"record" => true,
"variant" => true,
// "tuple" => true, // 不是关键字
"unknown" => true,
"empty" => true,
"reserved" => true,
"func" => true,
"service" => true,
"rec" => true, // 可能是关键字
_ => false,
} || name.contains(' ')
|| name.contains('\\')
{
format!("\"{}\"", name)
} else {
name.to_string()
}
}
/// 函数的注解 update 无注解
#[derive(Debug, Copy, Clone, CandidType, Serialize, Deserialize, Eq, PartialEq)]
pub enum FunctionAnnotation {
/// 查询函数, 可以用查询机制简化消耗的 cycles
#[serde(rename = "query")]
Query,
/// 用于不关心返回值的函数, 触发即忘场景
#[serde(rename = "oneway")]
Oneway,
}
/// 函数结构体
#[derive(Debug, Clone, CandidType, Serialize, Deserialize, Eq, PartialEq)]
pub struct WrappedCandidTypeFunction {
/// args
#[serde(rename = "args", skip_serializing_if = "Vec::is_empty")]
pub args: Vec<WrappedCandidType>,
/// results
#[serde(rename = "rets", skip_serializing_if = "Vec::is_empty")]
pub rets: Vec<WrappedCandidType>,
/// annotation update query
#[serde(rename = "annotation", skip_serializing_if = "Option::is_none")]
pub annotation: Option<FunctionAnnotation>,
}
impl WrappedCandidTypeFunction {
/// 文本
pub fn to_text(&self) -> String {
let Self {
args,
rets,
annotation,
} = self;
format!(
"func ({}) -> ({}){}",
args.iter()
.map(|t| t.to_text())
.collect::<Vec<_>>()
.join(", "),
rets.iter()
.map(|t| t.to_text())
.collect::<Vec<_>>()
.join(", "),
match annotation.as_ref() {
Some(annotation) => match annotation {
FunctionAnnotation::Query => " query",
FunctionAnnotation::Oneway => " oneway",
},
None => "",
}
)
}
}
/// service 结构体
#[derive(Debug, Clone, CandidType, Serialize, Deserialize, Eq, PartialEq)]
pub struct WrappedCandidTypeService {
/// args
#[serde(rename = "args", skip_serializing_if = "Vec::is_empty")]
pub args: Vec<WrappedCandidType>,
/// methods
#[serde(rename = "methods", skip_serializing_if = "Vec::is_empty")]
pub methods: Vec<(String, WrappedCandidTypeFunction)>,
}
impl WrappedCandidTypeService {
/// 文本
pub fn to_text(&self) -> String {
let Self { args, methods } = self;
format!(
"service :{} {{\n{}\n}}",
if args.is_empty() {
"".to_string()
} else {
format!(
" ({}) ->",
args.iter()
.map(|t| t.to_text())
.collect::<Vec<_>>()
.join(", ")
)
},
methods
.iter()
.map(|(name, func)| format!(" {} : {};", wrapped_key_word(name), func.to_text()))
.collect::<Vec<_>>()
.join("\n"),
)
}
/// 转化为方法
pub fn to_methods(&self) -> HashMap<String, String> {
self.methods
.iter()
.map(|(method, candid)| {
(method.to_string(), {
let func = candid.to_text();
if let Some(func) = func.strip_prefix("func ") {
func.to_string()
} else {
func
}
})
})
.collect()
}
}
/// 循环 结构体
#[derive(Debug, Clone, CandidType, Serialize, Deserialize, Eq, PartialEq)]
pub struct WrappedCandidTypeRecursion {
/// type
#[serde(rename = "ty")]
pub ty: Box<WrappedCandidType>,
/// 分配的序号
#[serde(rename = "id")]
pub id: u32,
/// 有时候有名字
#[serde(rename = "name", skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
}
impl WrappedCandidTypeRecursion {
/// 文本
pub fn to_text(&self) -> String {
let Self { ty, id, .. } = self;
format!("μrec_{}.{}", id, ty.to_text())
}
}
/// 循环 结构体
#[derive(Debug, Clone, CandidType, Serialize, Deserialize, Eq, PartialEq)]
pub struct WrappedCandidTypeReference {
/// 分配的序号
#[serde(rename = "id")]
pub id: u32,
/// 有时候有名字
#[serde(rename = "name", skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
}
impl WrappedCandidTypeReference {
/// 文本
pub fn to_text(&self) -> String {
let Self { id, .. } = self;
format!("rec_{}", id,)
}
}
/// 自定义的包装 Candid 类型
#[derive(Debug, Clone, CandidType, Serialize, Deserialize, Eq, PartialEq)]
pub enum WrappedCandidType {
// 基本类型
/// bool
/// boolean type: true false Motoko Bool / Rust bool / JavaScript true false
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-bool
#[serde(rename = "bool")]
Bool,
/// nat
/// nature number: Motoko Nat / Rust candid:Nat or u128 / JavaScript BigInt(10000) or 10000n
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-nat
#[serde(rename = "nat")]
Nat,
/// int
/// integer number: Motoko Int / Rust candid::Int or i128 / JavaScript BigInt(-10000) or -10000n
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-int
#[serde(rename = "int")]
Int,
/// nat8
/// integer with limit bits
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-natn-and-intn
#[serde(rename = "nat8")]
Nat8,
/// nat16
/// integer with limit bits
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-natn-and-intn
#[serde(rename = "nat16")]
Nat16,
/// nat32
/// integer with limit bits
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-natn-and-intn
#[serde(rename = "nat32")]
Nat32,
/// nat64
/// integer with limit bits
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-natn-and-intn
#[serde(rename = "nat64")]
Nat64,
/// int8
/// integer with limit bits
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-natn-and-intn
#[serde(rename = "int8")]
Int8,
/// int16
/// integer with limit bits
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-natn-and-intn
#[serde(rename = "int16")]
Int16,
/// int32
/// integer with limit bits
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-natn-and-intn
#[serde(rename = "int32")]
Int32,
/// int64
/// integer with limit bits
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-natn-and-intn
#[serde(rename = "int64")]
Int64,
/// float32
/// float number: Motoko Float is 64 bits / Rust f32 f64 / JavaScript float
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-float32-and-float64
#[serde(rename = "float32")]
Float32,
/// float64
/// float number: Motoko Float is 64 bits / Rust f32 f64 / JavaScript float
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-float32-and-float64
#[serde(rename = "float64")]
Float64,
/// null
/// null type: only value is null Motoko Null / Rust None / JavaScript null
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-null
#[serde(rename = "null")]
Null,
/// text
/// text type: Motoko Text / Rust String or &str / JavaScript string
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-text
#[serde(rename = "text")]
Text,
/// principal
/// principal type: like "zwigo-aiaaa-aaaaa-qaa3a-cai" Motoko Principal / candid::Principal / JavaScript Principal.fromText("aaaaa-aa")
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-principal
#[serde(rename = "principal")]
Principal,
// Blob, // 一律以 vec nat8 替代
// 子类型
/// vec T
/// binary data: vec nat8 Motoko Blob / Rust Vec<u8> or &[u8] / JavaScript [1, 2, 3]
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-blob
/// array of some type: vec {1,3} Motoko [T] / Rust Vec<T> &[T] / JavaScript Array
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-vec-t
#[serde(rename = "vec")]
Vec(Box<WrappedCandidType>),
/// opt T
/// option type: null opt t Motoko ?T / Rust Option<T> / [] [t]
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-opt-t
#[serde(rename = "opt")]
Opt(Box<WrappedCandidType>),
// 多个子类型
/// record { .. } // name=T
/// object type: record { name="123"; } Motoko record { name: "123" } / Rust struct / JavaScript object
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-record--n--t--
#[serde(rename = "record")]
Record(Vec<(String, WrappedCandidType)>),
/// variant { .. }
/// enumerate type: variant { ok : nat; error : text } / Rust enum / JavaScript { dot: null }
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-variant--n--t--
#[serde(rename = "variant")]
Variant(Vec<(String, Option<WrappedCandidType>)>),
/// tuple record { .. } // T
/// tuple type: subitem has no name
/// JavaScript array value
#[serde(rename = "tuple")]
Tuple(Vec<WrappedCandidType>),
// 特殊类型
/// unknown
/// unknown type
#[serde(rename = "unknown")]
Unknown,
/// empty
/// empty type
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-empty
#[serde(rename = "empty")]
Empty, // 没有值的类型, 是其他类型的子类型
/// reserved
/// reserved type: some function arguments can be ignore
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-reserved
#[serde(rename = "reserved")]
Reserved, // 占位不使用的类型
/// func
/// func type
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-func---
#[serde(rename = "func")]
Func(WrappedCandidTypeFunction),
/// service
/// service type: canister's api
/// https://internetcomputer.org/docs/current/references/candid-ref/#type-service-
#[serde(rename = "service")]
Service(WrappedCandidTypeService),
/// rec
/// object type: some subtype or subitem is recursion
#[serde(rename = "rec")]
Rec(WrappedCandidTypeRecursion), // 循环类型中的主类型
/// ref
#[serde(rename = "ref")]
Reference(WrappedCandidTypeReference), // 循环类型中的引用类型
}
impl WrappedCandidType {
/// 文本
pub fn to_text(&self) -> String {
match self {
Self::Bool => String::from("bool"),
Self::Nat => String::from("nat"),
Self::Int => String::from("int"),
Self::Nat8 => String::from("nat8"),
Self::Nat16 => String::from("nat16"),
Self::Nat32 => String::from("nat32"),
Self::Nat64 => String::from("nat64"),
Self::Int8 => String::from("int8"),
Self::Int16 => String::from("int16"),
Self::Int32 => String::from("int32"),
Self::Int64 => String::from("int64"),
Self::Float32 => String::from("float32"),
Self::Float64 => String::from("float64"),
Self::Null => String::from("null"),
Self::Text => String::from("text"),
Self::Principal => String::from("principal"),
Self::Vec(subtype) => format!("vec {}", subtype.to_text()),
Self::Opt(subtype) => format!("opt {}", subtype.to_text()),
Self::Record(subitems) => format!(
"record {{ {} }}",
subitems
.iter()
.map(|(name, subtype)| format!(
"{} : {}",
wrapped_key_word(name),
subtype.to_text()
))
.collect::<Vec<_>>()
.join("; ")
),
Self::Variant(subitems) => format!(
"variant {{ {} }}",
subitems
.iter()
.map(|(name, subtype)| {
if let Some(subtype) = subtype {
format!("{} : {}", wrapped_key_word(name), subtype.to_text())
} else {
wrapped_key_word(name)
}
})
.collect::<Vec<_>>()
.join("; ")
),
Self::Tuple(subitems) => format!(
"variant {{ {} }}",
subitems
.iter()
.map(|subtype| subtype.to_text())
.collect::<Vec<_>>()
.join("; ")
),
Self::Unknown => String::from("unknown"),
Self::Empty => String::from("empty"),
Self::Reserved => String::from("reserved"),
Self::Func(func) => func.to_text(),
Self::Service(service) => service.to_text(),
Self::Rec(recursion) => recursion.to_text(),
Self::Reference(reference) => reference.to_text(),
}
}
}