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
//! Cairo ABI tokens.
//!
//! TODO.
mod array;
mod basic;
mod composite;
mod constants;
mod function;
mod genericity;
mod non_zero;
mod option;
mod result;
mod tuple;
use std::collections::HashMap;
pub use array::Array;
pub use basic::CoreBasic;
pub use composite::{Composite, CompositeInner, CompositeInnerKind, CompositeType};
pub use function::{Function, FunctionOutputKind, StateMutability};
pub use non_zero::NonZero;
pub use option::Option;
pub use result::Result;
pub use tuple::Tuple;
use crate::{CainomeResult, Error};
#[derive(Debug, Clone, PartialEq)]
pub enum Token {
CoreBasic(CoreBasic),
Array(Array),
Tuple(Tuple),
Composite(Composite),
Function(Function),
Option(Option),
Result(Result),
NonZero(NonZero),
}
impl Token {
pub fn parse(type_path: &str) -> CainomeResult<Self> {
if let Ok(b) = CoreBasic::parse(type_path) {
return Ok(Token::CoreBasic(b));
}
if let Ok(a) = Array::parse(type_path) {
return Ok(Token::Array(a));
}
if let Ok(t) = Tuple::parse(type_path) {
return Ok(Token::Tuple(t));
}
if let Ok(o) = Option::parse(type_path) {
return Ok(Token::Option(o));
}
if let Ok(r) = Result::parse(type_path) {
return Ok(Token::Result(r));
}
if let Ok(n) = NonZero::parse(type_path) {
return Ok(Token::NonZero(n));
}
if let Ok(c) = Composite::parse(type_path) {
return Ok(Token::Composite(c));
}
Err(Error::TokenInitFailed(format!(
"Couldn't initialize a Token from type path `{}`",
type_path,
)))
}
pub fn type_name(&self) -> String {
match self {
Token::CoreBasic(t) => t.type_name(),
Token::Array(_) => "array".to_string(),
Token::Tuple(_) => "tuple".to_string(),
Token::Composite(t) => t.type_name(),
Token::Function(_) => "function".to_string(),
Token::Option(_) => "option".to_string(),
Token::Result(_) => "result".to_string(),
Token::NonZero(_) => "non_zero".to_string(),
}
}
pub fn type_path(&self) -> String {
match self {
Token::CoreBasic(t) => t.type_path.to_string(),
Token::Array(t) => t.type_path.to_string(),
Token::Tuple(t) => t.type_path.to_string(),
Token::Composite(t) => t.type_path_no_generic(),
Token::Function(t) => t.name.clone(),
Token::Option(t) => t.type_path.to_string(),
Token::Result(t) => t.type_path.to_string(),
Token::NonZero(t) => t.type_path.to_string(),
}
}
// TODO: we may remove these two functions...! And change types somewhere..
pub fn to_composite(&self) -> CainomeResult<&Composite> {
match self {
Token::Composite(t) => Ok(t),
_ => Err(Error::ConversionFailed(format!(
"Can't convert token into composite, got {:?}",
self
))),
}
}
pub fn to_function(&self) -> CainomeResult<&Function> {
match self {
Token::Function(t) => Ok(t),
_ => Err(Error::ConversionFailed(format!(
"Can't convert token into function, got {:?}",
self
))),
}
}
pub fn apply_alias(&mut self, type_path: &str, alias: &str) {
match self {
Token::Array(t) => t.apply_alias(type_path, alias),
Token::Tuple(t) => t.apply_alias(type_path, alias),
Token::Composite(t) => t.apply_alias(type_path, alias),
Token::Function(t) => t.apply_alias(type_path, alias),
Token::Option(t) => t.apply_alias(type_path, alias),
Token::Result(t) => t.apply_alias(type_path, alias),
_ => (),
}
}
/// Recursively hydrates nested tokens
///
/// Once abi is parsed, a flat list of tokens defined in cairo code is generated from parsed
/// json abi string.
/// Then token list are filtered to only keep single copy of each token.
/// Some tokens can have nested tokens that may not have inners defined inside thus leading to
/// confusion while using tokens. i.e Enums does not have inner variants defined.
///
/// # Arguments
///
/// * `token` - The token to hydrate.
/// * `filtered` - A map of type path to token that have already been hydrated.
/// * `recursion_max_depth` - Max depth recursion for token to hydrate.
/// * `iteration_count` - Current iteration count.
///
pub fn hydrate(
token: Self,
filtered: &HashMap<String, Token>,
recursion_max_depth: usize,
iteration_count: usize,
) -> Self {
if recursion_max_depth < iteration_count {
return token;
}
match token {
Token::CoreBasic(_) => token,
Token::Array(arr) => Token::Array(Array {
inner: Box::new(Self::hydrate(
*arr.inner,
filtered,
recursion_max_depth,
iteration_count + 1,
)),
type_path: arr.type_path,
is_legacy: arr.is_legacy,
}),
Token::Tuple(tup) => Token::Tuple(Tuple {
inners: tup
.inners
.into_iter()
.map(|inner| {
Self::hydrate(inner, filtered, recursion_max_depth, iteration_count + 1)
})
.collect(),
type_path: tup.type_path,
}),
Token::Option(opt) => Token::Option(Option {
type_path: opt.type_path,
inner: Box::new(Self::hydrate(
*opt.inner,
filtered,
recursion_max_depth,
iteration_count + 1,
)),
}),
Token::NonZero(non_zero) => Token::NonZero(NonZero {
type_path: non_zero.type_path,
inner: Box::new(Self::hydrate(
*non_zero.inner,
filtered,
recursion_max_depth,
iteration_count + 1,
)),
}),
Token::Result(res) => Token::Result(Result {
type_path: res.type_path,
inner: Box::new(Self::hydrate(
*res.inner,
filtered,
recursion_max_depth,
iteration_count + 1,
)),
error: Box::new(Self::hydrate(
*res.error,
filtered,
recursion_max_depth,
iteration_count + 1,
)),
}),
Token::Composite(comp) => {
let type_path = comp.type_path_no_generic();
if comp.r#type == CompositeType::Unknown && !comp.is_builtin() {
if let Some(hydrated) = filtered.get(&type_path) {
return Token::hydrate(
hydrated.clone(),
filtered,
recursion_max_depth,
iteration_count + 1,
);
} else {
panic!("Composite {} not found in filtered tokens", type_path);
}
}
Token::Composite(Composite {
type_path,
inners: comp
.inners
.into_iter()
.map(|i| CompositeInner {
index: i.index,
name: i.name,
kind: i.kind,
token: Self::hydrate(
i.token,
filtered,
recursion_max_depth,
iteration_count + 1,
),
})
.collect(),
generic_args: comp
.generic_args
.into_iter()
.map(|(name, token)| {
(
name,
Self::hydrate(
token,
filtered,
recursion_max_depth,
iteration_count + 1,
),
)
})
.collect(),
r#type: comp.r#type,
is_event: comp.is_event,
alias: comp.alias,
})
}
Token::Function(func) => Token::Function(Function {
name: func.name,
inputs: func
.inputs
.into_iter()
.map(|(name, token)| {
(
name,
Self::hydrate(
token,
filtered,
recursion_max_depth,
iteration_count + 1,
),
)
})
.collect(),
outputs: func
.outputs
.into_iter()
.map(|token| {
Self::hydrate(token, filtered, recursion_max_depth, iteration_count + 1)
})
.collect(),
named_outputs: func
.named_outputs
.into_iter()
.map(|(name, token)| {
(
name,
Self::hydrate(
token,
filtered,
recursion_max_depth,
iteration_count + 1,
),
)
})
.collect(),
state_mutability: func.state_mutability,
}),
}
}
}