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
// Copyright 2025 RISC Zero, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Serde related helpers.
use alloy_eips::{
    eip2718::{Eip2718Envelope, Encodable2718},
    Typed2718,
};
use alloy_primitives::{bytes::BufMut, hex, keccak256, Sealable, Sealed, B256};
use alloy_rlp::{Decodable, Encodable};
use serde::{de, Deserialize, Deserializer, Serialize, Serializer};
use std::{
    fmt::{self, Debug},
    ops,
};

/// An efficient wrapper for header types that do not support serde serialization.
///
/// It implements deserialization using RLP encoding and does not discard the RLP data after
/// decoding, instead keeping it for faster hash computation.
#[derive(Clone, Debug)]
pub struct RlpHeader<H: Encodable> {
    inner: H,
    rlp: Option<Box<[u8]>>,
}

impl<H: Encodable> ops::Deref for RlpHeader<H> {
    type Target = H;

    #[inline]
    fn deref(&self) -> &Self::Target {
        &self.inner
    }
}

impl<H: Encodable> RlpHeader<H> {
    #[must_use]
    pub const fn new(inner: H) -> Self {
        Self { inner, rlp: None }
    }

    pub fn inner(&self) -> &H {
        &self.inner
    }

    pub fn inner_mut(&mut self) -> &mut H {
        &mut self.inner
    }

    pub fn into_inner(self) -> H {
        self.inner
    }
}

impl<H: Encodable> Sealable for RlpHeader<H> {
    #[inline]
    fn hash_slow(&self) -> B256 {
        match &self.rlp {
            Some(rlp) => keccak256(rlp),
            None => keccak256(alloy_rlp::encode(&self.inner)),
        }
    }

    #[inline]
    fn seal_unchecked(mut self, seal: B256) -> Sealed<Self> {
        self.rlp = None;
        Sealed::new_unchecked(self, seal)
    }
}

impl<H: Encodable> Serialize for RlpHeader<H> {
    #[inline]
    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        let encoded = alloy_rlp::encode(&self.inner);
        if serializer.is_human_readable() {
            hex::serialize(&encoded, serializer)
        } else {
            serializer.serialize_bytes(&encoded)
        }
    }
}

impl<'de, H: Encodable + Decodable> Deserialize<'de> for RlpHeader<H> {
    #[inline]
    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        let rlp = if deserializer.is_human_readable() {
            deserializer.deserialize_any(BytesVisitor)?
        } else {
            deserializer.deserialize_byte_buf(BytesVisitor)?
        };
        let inner = alloy_rlp::decode_exact(&rlp).map_err(de::Error::custom)?;

        Ok(RlpHeader {
            inner,
            rlp: Some(rlp.into_boxed_slice()),
        })
    }
}

#[cfg(feature = "host")]
impl<H, I> TryFrom<alloy::rpc::types::Header<H>> for RlpHeader<I>
where
    I: Encodable + Decodable + TryFrom<H>,
{
    type Error = <I as TryFrom<H>>::Error;

    #[inline]
    fn try_from(value: alloy::rpc::types::Header<H>) -> Result<Self, Self::Error> {
        Ok(Self::new(value.inner.try_into()?))
    }
}

/// An efficient wrapper for [Eip2718Envelope] types that do not support serde serialization.
///
/// It implements deserialization using the EIP-2718 RLP encoding and does not discard the RLP data
/// after decoding, instead keeping it for faster RLP encoding of the deserialized type.
#[derive(Clone, Debug)]
pub struct Eip2718Wrapper<T: Eip2718Envelope> {
    inner: T,
    encoding: Option<Box<[u8]>>,
}

impl<T: Eip2718Envelope> Eip2718Wrapper<T> {
    #[must_use]
    pub const fn new(inner: T) -> Self {
        Self {
            inner,
            encoding: None,
        }
    }

    pub fn inner(&self) -> &T {
        &self.inner
    }

    pub fn into_inner(self) -> T {
        self.inner
    }
}

impl<T: Eip2718Envelope> ops::Deref for Eip2718Wrapper<T> {
    type Target = T;

    #[inline]
    fn deref(&self) -> &Self::Target {
        &self.inner
    }
}

impl<T: Eip2718Envelope> Encodable for Eip2718Wrapper<T> {
    fn encode(&self, out: &mut dyn BufMut) {
        self.encode_2718(out);
    }

    fn length(&self) -> usize {
        self.encode_2718_len()
    }
}

impl<T: Eip2718Envelope> Typed2718 for Eip2718Wrapper<T> {
    fn ty(&self) -> u8 {
        self.inner().ty()
    }
}

impl<T: Eip2718Envelope> Encodable2718 for Eip2718Wrapper<T> {
    fn type_flag(&self) -> Option<u8> {
        self.inner.type_flag()
    }

    fn encode_2718_len(&self) -> usize {
        match &self.encoding {
            None => self.inner.encode_2718_len(),
            Some(bytes) => bytes.len(),
        }
    }

    fn encode_2718(&self, out: &mut dyn BufMut) {
        match &self.encoding {
            Some(bytes) => out.put_slice(bytes),
            None => self.inner.encode_2718(out),
        }
    }
}

impl<T: Eip2718Envelope> Serialize for Eip2718Wrapper<T> {
    #[inline]
    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        let encoded = self.inner.encoded_2718();
        if serializer.is_human_readable() {
            hex::serialize(&encoded, serializer)
        } else {
            serializer.serialize_bytes(&encoded)
        }
    }
}

impl<'de, T: Eip2718Envelope> Deserialize<'de> for Eip2718Wrapper<T> {
    #[inline]
    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        let bytes = if deserializer.is_human_readable() {
            deserializer.deserialize_any(BytesVisitor)?
        } else {
            deserializer.deserialize_byte_buf(BytesVisitor)?
        };
        let mut buf = bytes.as_slice();
        let inner = T::decode_2718(&mut buf).map_err(de::Error::custom)?;
        if !buf.is_empty() {
            return Err(de::Error::custom("unexpected length"));
        }

        Ok(Eip2718Wrapper {
            inner,
            encoding: Some(bytes.into_boxed_slice()),
        })
    }
}

struct BytesVisitor;

impl<'de> de::Visitor<'de> for BytesVisitor {
    type Value = Vec<u8>;

    fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        formatter.write_str("bytes represented as a hex string, sequence or raw bytes")
    }
    fn visit_str<E: de::Error>(self, v: &str) -> Result<Self::Value, E> {
        hex::decode(v).map_err(de::Error::custom)
    }
    fn visit_bytes<E: de::Error>(self, v: &[u8]) -> Result<Self::Value, E> {
        Ok(v.to_vec())
    }
    fn visit_byte_buf<E: de::Error>(self, v: Vec<u8>) -> Result<Self::Value, E> {
        Ok(v)
    }
    fn visit_seq<A: de::SeqAccess<'de>>(self, mut seq: A) -> Result<Self::Value, A::Error> {
        let mut values = Vec::with_capacity(seq.size_hint().unwrap_or(0));
        while let Some(value) = seq.next_element()? {
            values.push(value);
        }
        Ok(values)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use alloy_consensus::{Header, ReceiptEnvelope};
    use alloy_primitives::Sealable;

    #[test]
    fn bincode_rlp_header() {
        let value = RlpHeader::new(Header::default());
        assert_eq!(value.hash_slow(), value.inner().hash_slow());

        let bin = bincode::serialize(&value).unwrap();
        let de: RlpHeader<Header> = bincode::deserialize(&bin).unwrap();
        assert_eq!(de.inner(), value.inner());
        assert_eq!(de.hash_slow(), value.inner().hash_slow());
    }

    #[test]
    fn serde_rlp_header() {
        let value = RlpHeader::new(Header::default());
        assert_eq!(value.hash_slow(), value.inner().hash_slow());

        let json = serde_json::to_string(&value).unwrap();
        let de: RlpHeader<Header> = serde_json::from_str(&json).unwrap();
        assert_eq!(de.inner(), value.inner());
        assert_eq!(de.hash_slow(), value.inner().hash_slow());
    }

    #[test]
    fn bincode_eip2718_wrapper() {
        let value = Eip2718Wrapper::new(ReceiptEnvelope::Eip2930(Default::default()));
        assert_eq!(value.encoded_2718(), value.inner().encoded_2718());

        let bin = bincode::serialize(&value).unwrap();
        let de: Eip2718Wrapper<ReceiptEnvelope> = bincode::deserialize(&bin).unwrap();
        assert_eq!(de.inner(), value.inner());
        assert_eq!(de.encoded_2718(), value.inner().encoded_2718());
    }

    #[test]
    fn serde_eip2718_wrapper() {
        let value = Eip2718Wrapper::new(ReceiptEnvelope::Eip2930(Default::default()));
        assert_eq!(value.encoded_2718(), value.inner().encoded_2718());

        let json = serde_json::to_string(&value).unwrap();
        let de: Eip2718Wrapper<ReceiptEnvelope> = serde_json::from_str(&json).unwrap();
        assert_eq!(de.inner(), value.inner());
        assert_eq!(de.encoded_2718(), value.inner().encoded_2718());
    }
}