solid-core 0.1.5

Core for the `solid` crate. Not intended to be used directly.
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
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
use crate::{
    bytes::Bytes,
    decode::Decode,
    encode::Encode,
    Error,
    Result,
};
use serde::{
    de::{
        self,
        DeserializeSeed,
        SeqAccess,
        Visitor,
    },
    Deserialize,
};

pub struct Deserializer<'de> {
    buf: &'de [u8],
    index: usize,
}

impl<'de> Deserializer<'de> {
    pub fn from_bytes(buf: &'de [u8]) -> Self {
        Deserializer { buf, index: 0 }
    }
}

/// Function to call to decode a Solidity response into a struct that implements `serde::Deserialize`
pub fn from_bytes<'a, T>(buf: &'a [u8]) -> Result<T>
where
    T: Deserialize<'a>,
{
    let mut deserializer = Deserializer::from_bytes(buf);
    Ok(T::deserialize(&mut deserializer)?)
}

impl<'de> Deserializer<'de> {
    fn decode<T>(&mut self) -> Result<T>
    where
        T: Decode<'de> + Encode,
    {
        let value = if T::is_dynamic() {
            let offset = u64::decode(&self.buf[self.index * 32..(self.index + 1) * 32]);
            T::decode(&self.buf[offset as usize..])
        } else {
            T::decode(&self.buf[self.index * 32..(self.index + 1) * 32])
        };
        self.index += 1;
        Ok(value)
    }
}

impl<'de, 'a> de::Deserializer<'de> for &'a mut Deserializer<'de> {
    type Error = Error;

    fn deserialize_any<V: Visitor<'de>>(self, _visitor: V) -> Result<V::Value> {
        unimplemented!()
    }

    fn deserialize_bool<V: Visitor<'de>>(self, visitor: V) -> Result<V::Value> {
        visitor.visit_bool(self.decode::<bool>()?)
    }

    fn deserialize_i8<V: Visitor<'de>>(self, visitor: V) -> Result<V::Value> {
        visitor.visit_i8(self.decode::<i8>()?)
    }

    fn deserialize_i16<V: Visitor<'de>>(self, visitor: V) -> Result<V::Value> {
        visitor.visit_i16(self.decode::<i16>()?)
    }

    fn deserialize_i32<V: Visitor<'de>>(self, visitor: V) -> Result<V::Value> {
        visitor.visit_i32(self.decode::<i32>()?)
    }

    fn deserialize_i64<V: Visitor<'de>>(self, visitor: V) -> Result<V::Value> {
        visitor.visit_i64(self.decode::<i64>()?)
    }

    fn deserialize_i128<V: Visitor<'de>>(self, visitor: V) -> Result<V::Value> {
        visitor.visit_i128(self.decode::<i128>()?)
    }

    fn deserialize_u8<V: Visitor<'de>>(self, visitor: V) -> Result<V::Value> {
        visitor.visit_u8(self.decode::<u8>()?)
    }

    fn deserialize_u16<V: Visitor<'de>>(self, visitor: V) -> Result<V::Value> {
        visitor.visit_u16(self.decode::<u16>()?)
    }

    fn deserialize_u32<V: Visitor<'de>>(self, visitor: V) -> Result<V::Value> {
        visitor.visit_u32(self.decode::<u32>()?)
    }

    fn deserialize_u64<V: Visitor<'de>>(self, visitor: V) -> Result<V::Value> {
        visitor.visit_u64(self.decode::<u64>()?)
    }

    fn deserialize_u128<V: Visitor<'de>>(self, visitor: V) -> Result<V::Value> {
        visitor.visit_u128(self.decode::<u128>()?)
    }

    // UNSUPPORTED
    fn deserialize_f32<V: Visitor<'de>>(self, _visitor: V) -> Result<V::Value> {
        unimplemented!()
    }

    // UNSUPPORTED
    fn deserialize_f64<V: Visitor<'de>>(self, _visitor: V) -> Result<V::Value> {
        unimplemented!()
    }

    // UNSUPPORTED
    fn deserialize_char<V: Visitor<'de>>(self, _visitor: V) -> Result<V::Value> {
        unimplemented!()
    }

    fn deserialize_str<V: Visitor<'de>>(self, _visitor: V) -> Result<V::Value> {
        todo!();
        // visitor.visit_borrowed_str(&self.decode::<String>()?)
    }

    fn deserialize_string<V: Visitor<'de>>(self, visitor: V) -> Result<V::Value> {
        visitor.visit_string(self.decode::<String>()?)
    }

    fn deserialize_byte_buf<V: Visitor<'de>>(self, visitor: V) -> Result<V::Value> {
        visitor.visit_byte_buf(self.decode::<Bytes>()?.0.to_vec())
    }

    // The `Serializer` implementation on the previous page serialized byte
    // arrays as JSON arrays of bytes. Handle that representation here.
    fn deserialize_bytes<V: Visitor<'de>>(self, visitor: V) -> Result<V::Value> {
        visitor.visit_borrowed_bytes(&self.decode::<Bytes>()?.0)
    }

    // An absent optional is represented as the JSON `null` and a present
    // optional is represented as just the contained value.
    //
    // As commented in `Serializer` implementation, this is a lossy
    // representation. For example the values `Some(())` and `None` both
    // serialize as just `null`. Unfortunately this is typically what people
    // expect when working with JSON. Other formats are encouraged to behave
    // more intelligently if possible.
    fn deserialize_option<V: Visitor<'de>>(self, _visitor: V) -> Result<V::Value> {
        unimplemented!()
    }

    // In Serde, unit means an anonymous value containing no data.
    fn deserialize_unit<V: Visitor<'de>>(self, visitor: V) -> Result<V::Value> {
        visitor.visit_unit()
    }

    // Unit struct means a named value containing no data.
    fn deserialize_unit_struct<V: Visitor<'de>>(
        self,
        _name: &'static str,
        visitor: V,
    ) -> Result<V::Value> {
        self.deserialize_unit(visitor)
    }

    // As is done here, serializers are encouraged to treat newtype structs as
    // insignificant wrappers around the data they contain. That means not
    // parsing anything other than the contained value.
    fn deserialize_newtype_struct<V: Visitor<'de>>(
        self,
        _name: &'static str,
        visitor: V,
    ) -> Result<V::Value> {
        let mut deserializer = Deserializer {
            buf: &self.buf[self.index * 32..],
            index: 0,
        };
        Ok(visitor.visit_seq(Struct::new(&mut deserializer))?)
    }

    // Deserialization of compound types like sequences and maps happens by
    // passing the visitor an "Access" object that gives it the ability to
    // iterate through the data contained in the sequence.
    fn deserialize_seq<V: Visitor<'de>>(self, visitor: V) -> Result<V::Value> {
        let offset = self.decode::<u64>()? as usize;
        let len = u64::decode(&self.buf[offset..offset + 32]);

        let mut deserializer = Deserializer {
            buf: &self.buf[offset + 32..],
            index: 0,
        };

        Ok(visitor.visit_seq(VecDeserializer::new(&mut deserializer, len as usize))?)
    }

    // Tuples look just like sequences in JSON. Some formats may be able to
    // represent tuples more efficiently.
    //
    // As indicated by the length parameter, the `Deserialize` implementation
    // for a tuple in the Serde data model is required to know the length of the
    // tuple before even looking at the input data.
    fn deserialize_tuple<V: Visitor<'de>>(self, _len: usize, visitor: V) -> Result<V::Value> {
        let mut deserializer = Deserializer {
            buf: &self.buf[self.index * 32..],
            index: 0,
        };
        Ok(visitor.visit_seq(Struct::new(&mut deserializer))?)
    }

    // Tuple structs look just like sequences in JSON.
    fn deserialize_tuple_struct<V: Visitor<'de>>(
        self,
        _name: &'static str,
        _len: usize,
        visitor: V,
    ) -> Result<V::Value> {
        let mut deserializer = Deserializer {
            buf: &self.buf[self.index * 32..],
            index: 0,
        };
        Ok(visitor.visit_seq(Struct::new(&mut deserializer))?)
    }

    // Much like `deserialize_seq` but calls the visitors `visit_map` method
    // with a `MapAccess` implementation, rather than the visitor's `visit_seq`
    // method with a `SeqAccess` implementation.
    fn deserialize_map<V: Visitor<'de>>(self, _visitor: V) -> Result<V::Value> {
        unimplemented!()
        // Ok(visitor.visit_map(Struct::new(&mut self))?)
    }

    // Structs look just like maps in JSON.
    //
    // Notice the `fields` parameter - a "struct" in the Serde data model means
    // that the `Deserialize` implementation is required to know what the fields
    // are before even looking at the input data. Any key-value pairing in which
    // the fields cannot be known ahead of time is probably a map.
    fn deserialize_struct<V: Visitor<'de>>(
        self,
        _name: &'static str,
        _fields: &'static [&'static str],
        visitor: V,
    ) -> Result<V::Value> {
        let mut deserializer = Deserializer {
            buf: &self.buf[self.index * 32..],
            index: 0,
        };
        Ok(visitor.visit_seq(Struct::new(&mut deserializer))?)
    }

    fn deserialize_enum<V: Visitor<'de>>(
        self,
        _name: &'static str,
        _variants: &'static [&'static str],
        _visitor: V,
    ) -> Result<V::Value> {
        unimplemented!()
    }

    fn deserialize_identifier<V: Visitor<'de>>(self, _visitor: V) -> Result<V::Value> {
        Err(Error::Message(
            "Solidity does not support Deserializer::deserialize_identifier".to_string(),
        ))
    }

    fn deserialize_ignored_any<V: Visitor<'de>>(self, _visitor: V) -> Result<V::Value> {
        unimplemented!()
        // self.deserialize_any(visitor)
    }
}

struct Struct<'a, 'de> {
    de: &'a mut Deserializer<'de>,
}

impl<'a, 'de> Struct<'a, 'de> {
    fn new(de: &'a mut Deserializer<'de>) -> Self {
        Struct { de }
    }
}

impl<'de, 'a> SeqAccess<'de> for Struct<'a, 'de> {
    type Error = Error;

    fn next_element_seed<T: DeserializeSeed<'de>>(&mut self, seed: T) -> Result<Option<T::Value>> {
        seed.deserialize(&mut *self.de).map(Some)
    }
}

struct VecDeserializer<'a, 'de> {
    de: &'a mut Deserializer<'de>,
    len: usize,
}

impl<'a, 'de> VecDeserializer<'a, 'de> {
    fn new(de: &'a mut Deserializer<'de>, len: usize) -> Self {
        Self { de, len }
    }
}

impl<'de, 'a> SeqAccess<'de> for VecDeserializer<'a, 'de> {
    type Error = Error;

    fn next_element_seed<T: DeserializeSeed<'de>>(&mut self, seed: T) -> Result<Option<T::Value>> {
        if self.len == 0 {
            Ok(None)
        } else {
            self.len -= 1;
            seed.deserialize(&mut *self.de).map(Some)
        }
    }
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    #[rustfmt::skip]
    fn de_number_test() -> Result<()> {
        #[derive(Debug, Deserialize)]
        struct Response {
            r#i8: i8,
            r#u8: u8,
            r#i16: i16,
            r#u16: u16,
            r#i32: i32,
            r#u32: u32,
            r#i64: i64,
            r#u64: u64,
            r#i128: i128,
            r#u128: u128,
        }

        let value = hex::decode(
            "\
            00000000000000000000000000000000000000000000000000000000000000FF\
            00000000000000000000000000000000000000000000000000000000000000FF\
            000000000000000000000000000000000000000000000000000000000000FFFF\
            000000000000000000000000000000000000000000000000000000000000FFFF\
            00000000000000000000000000000000000000000000000000000000FFFFFFFF\
            00000000000000000000000000000000000000000000000000000000FFFFFFFF\
            000000000000000000000000000000000000000000000000FFFFFFFFFFFFFFFF\
            000000000000000000000000000000000000000000000000FFFFFFFFFFFFFFFF\
            00000000000000000000000000000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF\
            00000000000000000000000000000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
        )
            .unwrap();
        let value: Response = from_bytes(&value)?;

        assert_eq!(value.r#i8,   0xFFu8 as i8);
        assert_eq!(value.r#u8,   0xFFu8);
        assert_eq!(value.r#i16,  0xFFFFu16 as i16);
        assert_eq!(value.r#u16,  0xFFFFu16);
        assert_eq!(value.r#i32,  0xFFFFFFFFu32 as i32);
        assert_eq!(value.r#u32,  0xFFFFFFFFu32);
        assert_eq!(value.r#i64,  0xFFFFFFFFFFFFFFFFu64 as i64);
        assert_eq!(value.r#u64,  0xFFFFFFFFFFFFFFFFu64);
        assert_eq!(value.r#i128, 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFu128 as i128);
        assert_eq!(value.r#u128, 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFu128);

        Ok(())
    }

    #[test]
    #[rustfmt::skip]
    fn de_string_test() -> Result<()> {
        #[derive(Debug, Deserialize)]
        struct Response<'a> {
            string: String,
            bytes: &'a [u8],
        }

        let value = hex::decode(
            "\
0000000000000000000000000000000000000000000000000000000000000040\
0000000000000000000000000000000000000000000000000000000000000080\
000000000000000000000000000000000000000000000000000000000000000C\
72616E646F6D2062797465730000000000000000000000000000000000000000\
000000000000000000000000000000000000000000000000000000000000000C\
72616E646F6D2062797465730000000000000000000000000000000000000000\
",
        )
        .unwrap();

        let value: Response = from_bytes(&value)?;

        assert_eq!(value.string.len(), 12);
        assert_eq!(value.string, "random bytes");

        assert_eq!(value.bytes.len(), 12);
        assert_eq!(value.bytes, &b"random bytes"[..]);

        Ok(())
    }

    #[test]
    #[rustfmt::skip]
    fn de_string_array_test() -> Result<()> {
        #[derive(Debug, Deserialize)]
        struct Response {
            strings: Vec<String>,
        }

        let value = hex::decode(
            "\
    0000000000000000000000000000000000000000000000000000000000000020\
    0000000000000000000000000000000000000000000000000000000000000002\
    0000000000000000000000000000000000000000000000000000000000000040\
    0000000000000000000000000000000000000000000000000000000000000080\
    000000000000000000000000000000000000000000000000000000000000000C\
    72616E646F6D2062797465730000000000000000000000000000000000000000\
    000000000000000000000000000000000000000000000000000000000000000C\
    72616E646F6D2062797465730000000000000000000000000000000000000000\
    ",
        )
        .unwrap();

        let value: Response = from_bytes(&value)?;

        assert_eq!(value.strings.len(), 2);
        assert_eq!(value.strings[0].as_str(), "random bytes");
        assert_eq!(value.strings[1].as_str(), "random bytes");

        Ok(())
    }

    #[test]
    #[rustfmt::skip]
    fn de_bytes_array_test() -> Result<()> {
        #[derive(Debug, Deserialize)]
        struct Response<'a> {
            #[serde(borrow)]
            bytes: Vec<&'a [u8]>,
        }

        let value = hex::decode(
            "\
            0000000000000000000000000000000000000000000000000000000000000020\
            0000000000000000000000000000000000000000000000000000000000000002\
            0000000000000000000000000000000000000000000000000000000000000040\
            0000000000000000000000000000000000000000000000000000000000000080\
            000000000000000000000000000000000000000000000000000000000000000C\
            72616E646F6D2062797465730000000000000000000000000000000000000000\
            000000000000000000000000000000000000000000000000000000000000000C\
            72616E646F6D2062797465730000000000000000000000000000000000000000\
            ",
        )
            .unwrap();

        let value: Response = from_bytes(&value)?;

        assert_eq!(value.bytes.len(), 2);
        assert_eq!(value.bytes[0], &b"random bytes"[..]);
        assert_eq!(value.bytes[1], &b"random bytes"[..]);

        Ok(())
    }
}