sui_graphql/
bcs.rs

1//! BCS encoding/decoding utilities.
2
3use std::borrow::Cow;
4
5use base64ct::Base64;
6use base64ct::Encoding;
7use serde::Deserialize;
8use serde::Serialize;
9use serde::de::DeserializeOwned;
10
11use crate::error::Error;
12
13/// A wrapper for BCS-encoded values.
14///
15/// - Deserializes from a Base64-encoded BCS string.
16/// - Serializes to a Base64-encoded BCS string.
17pub struct Bcs<T>(pub T);
18
19impl<'de, T: DeserializeOwned> Deserialize<'de> for Bcs<T> {
20    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
21    where
22        D: serde::Deserializer<'de>,
23    {
24        let b64 = <Cow<'_, str>>::deserialize(deserializer)?;
25        let bytes = Base64::decode_vec(&b64).map_err(serde::de::Error::custom)?;
26        let value = bcs::from_bytes(&bytes).map_err(serde::de::Error::custom)?;
27        Ok(Bcs(value))
28    }
29}
30
31impl<T: Serialize> Serialize for Bcs<T> {
32    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
33    where
34        S: serde::Serializer,
35    {
36        let bytes = bcs::to_bytes(&self.0).map_err(serde::ser::Error::custom)?;
37        let b64 = Base64::encode_string(&bytes);
38        b64.serialize(serializer)
39    }
40}
41
42/// Raw BCS bytes that can be deserialized into any type.
43///
44/// This type deserializes from a Base64-encoded string and stores the raw bytes.
45/// Use `deserialize::<T>()` to convert to a concrete type.
46#[derive(Debug, Clone)]
47pub struct BcsBytes(pub Vec<u8>);
48
49impl BcsBytes {
50    /// Deserialize the BCS bytes into a concrete type.
51    pub fn deserialize<T: DeserializeOwned>(&self) -> Result<T, Error> {
52        bcs::from_bytes(&self.0).map_err(|e| Error::Deserialization(format!("bcs decode: {e}")))
53    }
54}
55
56impl<'de> Deserialize<'de> for BcsBytes {
57    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
58    where
59        D: serde::Deserializer<'de>,
60    {
61        let b64 = <Cow<'_, str>>::deserialize(deserializer)?;
62        let bytes = Base64::decode_vec(&b64).map_err(serde::de::Error::custom)?;
63        Ok(BcsBytes(bytes))
64    }
65}