ckb_jsonrpc_types/
fixed_bytes.rs

1use ckb_types::{packed, prelude::*};
2use faster_hex::{hex_decode, hex_encode};
3use std::fmt;
4
5/// Fixed-length 32 bytes binary encoded as a 0x-prefixed hex string in JSON.
6///
7/// ## Example
8///
9/// ```text
10/// 0xd495a106684401001e47c0ae1d5930009449d26e32380000000721efd0030000
11/// ```
12#[derive(Clone, Default, PartialEq, Eq, Hash, Debug)]
13pub struct Byte32(pub [u8; 32]);
14
15impl Byte32 {
16    /// Creates Bytes from the array.
17    pub fn new(inner: [u8; 32]) -> Self {
18        Byte32(inner)
19    }
20}
21
22impl From<packed::Byte32> for Byte32 {
23    fn from(packed: packed::Byte32) -> Self {
24        let mut inner: [u8; 32] = Default::default();
25        inner.copy_from_slice(&packed.raw_data());
26        Byte32(inner)
27    }
28}
29
30impl From<Byte32> for packed::Byte32 {
31    fn from(json: Byte32) -> Self {
32        Self::from_slice(&json.0).expect("impossible: fail to read inner array")
33    }
34}
35
36struct Byte32Visitor;
37
38impl<'b> serde::de::Visitor<'b> for Byte32Visitor {
39    type Value = Byte32;
40
41    fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
42        write!(formatter, "a 0x-prefixed hex string")
43    }
44
45    fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
46    where
47        E: serde::de::Error,
48    {
49        if v.len() < 2 || &v.as_bytes()[0..2] != b"0x" || v.len() != 66 {
50            return Err(E::invalid_value(serde::de::Unexpected::Str(v), &self));
51        }
52        let mut buffer = [0u8; 32]; // we checked length
53        hex_decode(&v.as_bytes()[2..], &mut buffer)
54            .map_err(|e| E::custom(format_args!("{e:?}")))?;
55        Ok(Byte32(buffer))
56    }
57
58    fn visit_string<E>(self, v: String) -> Result<Self::Value, E>
59    where
60        E: serde::de::Error,
61    {
62        self.visit_str(&v)
63    }
64}
65
66impl serde::Serialize for Byte32 {
67    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
68    where
69        S: serde::Serializer,
70    {
71        let mut buffer = [0u8; 66];
72        buffer[0] = b'0';
73        buffer[1] = b'x';
74        hex_encode(&self.0, &mut buffer[2..])
75            .map_err(|e| serde::ser::Error::custom(format!("{e}")))?;
76        serializer.serialize_str(unsafe { ::std::str::from_utf8_unchecked(&buffer) })
77    }
78}
79
80impl<'de> serde::Deserialize<'de> for Byte32 {
81    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
82    where
83        D: serde::Deserializer<'de>,
84    {
85        deserializer.deserialize_str(Byte32Visitor)
86    }
87}