ethereum_serde_utils 0.8.1

Serialization and deserialization utilities for JSON representations of Ethereum types
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

use alloy_primitives::Address;
use serde::de::Error;
use serde::{Deserializer, Serializer};

use crate::hex::PrefixedHexVisitor;

pub fn serialize<S>(address: &Address, serializer: S) -> Result<S::Ok, S::Error>
where
    S: Serializer,
{
    let mut hex_string: String = "0x".to_string();
    hex_string.push_str(&hex::encode(&address));

    serializer.serialize_str(&hex_string)
}

pub fn deserialize<'de, D>(deserializer: D) -> Result<Address, D::Error>
where
    D: Deserializer<'de>,
{
    let decoded = deserializer.deserialize_str(PrefixedHexVisitor)?;

    if decoded.len() != 20 {
        return Err(D::Error::custom(format!(
            "expected {} bytes for array, got {}",
            20,
            decoded.len()
        )));
    }

    let mut array = [0; 20];
    array.copy_from_slice(&decoded);
    Ok(array.into())
}

#[cfg(test)]
mod test {
    use std::str::FromStr;

    use alloy_primitives::Address;
    use serde::{Deserialize, Serialize};
    use serde_json;

    #[derive(Debug, PartialEq, Serialize, Deserialize)]
    #[serde(transparent)]
    struct Wrapper {
        #[serde(with = "super")]
        val: Address,
    }

    #[test]
    fn encoding() {
        assert_eq!(
            &serde_json::to_string(&Wrapper {
                val: Address::from_str("0000000000000000000000000000000000000000").unwrap()
            })
            .unwrap(),
            "\"0x0000000000000000000000000000000000000000\""
        );
        assert_eq!(
            &serde_json::to_string(&Wrapper {
                val: Address::from_str("0000000000000000000000000000000000000001").unwrap()
            })
            .unwrap(),
            "\"0x0000000000000000000000000000000000000001\""
        );
        assert_eq!(
            &serde_json::to_string(&Wrapper {
                val: Address::from_str("1000000000000000000000000000000000000000").unwrap()
            })
            .unwrap(),
            "\"0x1000000000000000000000000000000000000000\""
        );
        assert_eq!(
            &serde_json::to_string(&Wrapper {
                val: Address::from_str("1234567890000000000000000000000000000000").unwrap()
            })
            .unwrap(),
            "\"0x1234567890000000000000000000000000000000\""
        );
        assert_eq!(
            &serde_json::to_string(&Wrapper { val: Address::ZERO }).unwrap(),
            "\"0x0000000000000000000000000000000000000000\""
        );
    }

    #[test]
    fn decoding() {
        assert_eq!(
            serde_json::from_str::<Wrapper>("\"0x0000000000000000000000000000000000000000\"")
                .unwrap(),
            Wrapper { val: Address::ZERO },
        );
        assert_eq!(
            serde_json::from_str::<Wrapper>("\"0x0000000000000000000000000000000000000001\"")
                .unwrap(),
            Wrapper {
                val: Address::from_str("0000000000000000000000000000000000000001").unwrap()
            },
        );
        assert_eq!(
            serde_json::from_str::<Wrapper>("\"0x1000000000000000000000000000000000000000\"")
                .unwrap(),
            Wrapper {
                val: Address::from_str("1000000000000000000000000000000000000000").unwrap()
            },
        );
        assert_eq!(
            serde_json::from_str::<Wrapper>("\"0x1234567890000000000000000000000000000000\"")
                .unwrap(),
            Wrapper {
                val: Address::from_str("1234567890000000000000000000000000000000").unwrap()
            },
        );
        // Wrong length.
        serde_json::from_str::<Wrapper>("\"0x0\"").unwrap_err();
        serde_json::from_str::<Wrapper>("\"0x0400\"").unwrap_err();
        serde_json::from_str::<Wrapper>("\"0x12345678900000000000000000000000000000001\"")
            .unwrap_err();
        // Requires 0x.
        serde_json::from_str::<Wrapper>("\"1234567890000000000000000000000000000000\"")
            .unwrap_err();
        serde_json::from_str::<Wrapper>("\"ff34567890000000000000000000000000000000\"")
            .unwrap_err();
        // Contains invalid characters.
        serde_json::from_str::<Wrapper>("\"0x-100000000000000000000000000000000000000\"")
            .unwrap_err();
    }
}