solabi 0.3.0

Solidity ABI implementation in Rust
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

//! Module implementing additiona tuple encoding associated functions.
//!
//! This allows tuples to be encoded by references to their fields instead of
//! requiring an owned `Value::Tuple` value.

use super::{Decodable, Encodable, Value, ValueKind};
use crate::{
    decode::{
        context::{self, DecodeContext},
        DecodeError, Decoder,
    },
    encode::{BufferSizeError, Encode, Encoder, Size},
    function::Selector,
};

impl Value {
    /// Encodes a tuple by references to its fields.
    pub fn encode_tuple(fields: &[Self]) -> Vec<u8> {
        crate::encode(&TupleRef(fields))
    }

    /// Encodes a `Value` with a function selector.
    ///
    /// See [`Value::encode`] for more details.
    pub fn encode_tuple_with_selector(selector: Selector, fields: &[Self]) -> Vec<u8> {
        crate::encode_with_selector(selector, &TupleRef(fields))
    }

    /// Encodes a `Value` with a prefix.
    ///
    /// See [`Value::encode`] for more details.
    pub fn encode_tuple_with_prefix(prefix: &[u8], fields: &[Self]) -> Vec<u8> {
        crate::encode_with_prefix(prefix, &TupleRef(fields))
    }

    /// Encodes a `Value` to the specified buffer.
    ///
    /// See [`Value::encode`] for more details.
    pub fn encode_tuple_to(fields: &[Self], buffer: &mut [u8]) -> Result<(), BufferSizeError> {
        crate::encode_to(buffer, &TupleRef(fields))
    }

    /// Decodes a `Value`.
    ///
    /// Note that `Value`s can't use the [`crate::decode()`] method directly as
    /// it requires runtime type information for proper decoding.
    pub fn decode_tuple(kinds: &[ValueKind], bytes: &[u8]) -> Result<Vec<Self>, DecodeError> {
        dbg!(kinds, bytes);
        Ok(context::decode::<Tuple>(bytes, kinds)?.0)
    }

    /// Decodes a `Value` from data prefixed with a selector.
    ///
    /// See [`Value::decode`] for more details.
    pub fn decode_tuple_with_selector(
        kinds: &[ValueKind],
        selector: Selector,
        bytes: &[u8],
    ) -> Result<Vec<Self>, DecodeError> {
        Ok(context::decode_with_selector::<Tuple>(selector, bytes, kinds)?.0)
    }

    /// Decodes a `Value` from data with an expected byte prefix.
    ///
    /// See [`Value::decode`] for more details.
    pub fn decode_tuple_with_prefix(
        kinds: &[ValueKind],
        prefix: &[u8],
        bytes: &[u8],
    ) -> Result<Vec<Self>, DecodeError> {
        Ok(context::decode_with_prefix::<Tuple>(prefix, bytes, kinds)?.0)
    }
}

/// An internal type to facilitate encoding tuples by slice of their fields.
struct TupleRef<'a>(&'a [Value]);

impl Encode for TupleRef<'_> {
    fn size(&self) -> Size {
        Size::tuple(self.0.iter().map(|item| Encodable(item).size()))
    }

    fn encode(&self, encoder: &mut Encoder) {
        for value in self.0 {
            encoder.write(&Encodable(value))
        }
    }
}

/// An internal type used to facilisate decoding tuples without having to unwrap
/// the parent `Value`.
struct Tuple(Vec<Value>);

impl DecodeContext for Tuple {
    type Context = [ValueKind];

    fn is_dynamic_context(context: &Self::Context) -> bool {
        context.iter().any(Decodable::is_dynamic_context)
    }

    fn decode_context(decoder: &mut Decoder, context: &Self::Context) -> Result<Self, DecodeError> {
        Ok(Self(
            context
                .iter()
                .map(|kind| Ok(decoder.read_context::<Decodable>(kind)?.0))
                .collect::<Result<_, _>>()?,
        ))
    }
}