hyperfuel-format 4.1.0

fuel network format library
Documentation
use super::Hex;
use crate::{Error, Result};
use serde::de::{self, Visitor};
use serde::{Deserialize, Deserializer, Serialize, Serializer};
use std::borrow::Cow;
use std::fmt;
use std::result::Result as StdResult;

#[derive(Clone, PartialEq, Eq, Hash, derive_more::From, derive_more::Into, derive_more::Deref)]
pub struct Quantity(Box<[u8]>);

impl AsRef<[u8]> for Quantity {
    fn as_ref(&self) -> &[u8] {
        &self.0
    }
}

impl From<Vec<u8>> for Quantity {
    fn from(buf: Vec<u8>) -> Self {
        assert!(!buf.is_empty());
        assert!(buf.len() == 1 || buf[0] != 0);

        Self(buf.into())
    }
}

impl From<u64> for Quantity {
    fn from(value: u64) -> Self {
        if value == 0 {
            return Quantity::default();
        }
        let bytes = value.to_be_bytes();
        let first_non_zero = bytes.iter().position(|b| *b != 0).unwrap();
        Self(bytes[first_non_zero..].to_vec().into())
    }
}

impl From<&[u8]> for Quantity {
    fn from(buf: &[u8]) -> Self {
        assert!(!buf.is_empty());
        assert!(buf.len() == 1 || buf[0] != 0);

        Self(buf.into())
    }
}

impl Default for Quantity {
    fn default() -> Quantity {
        Quantity(Box::new([0]))
    }
}

impl<const N: usize> From<[u8; N]> for Quantity {
    fn from(buf: [u8; N]) -> Self {
        Self(buf.into())
    }
}

struct QuantityVisitor;

impl<'de> Visitor<'de> for QuantityVisitor {
    type Value = Quantity;

    fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        formatter.write_str("hex string for a quantity")
    }

    fn visit_str<E>(self, value: &str) -> StdResult<Self::Value, E>
    where
        E: de::Error,
    {
        let buf: Vec<u8> = decode_hex(value).map_err(|e| E::custom(e.to_string()))?;

        Ok(Quantity::from(buf))
    }
}

impl<'de> Deserialize<'de> for Quantity {
    fn deserialize<D>(deserializer: D) -> StdResult<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        deserializer.deserialize_str(QuantityVisitor)
    }
}

impl Serialize for Quantity {
    fn serialize<S>(&self, serializer: S) -> StdResult<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_str(&encode_hex(self))
    }
}

impl Hex for Quantity {
    fn encode_hex(&self) -> String {
        encode_hex(&self.0)
    }

    fn decode_hex(hex: &str) -> Result<Self> {
        let hex = decode_hex(hex)?;
        Ok(Self::from(hex))
    }
}

pub fn decode_hex(value: &str) -> Result<Vec<u8>> {
    if value == "0x0" {
        return Ok(vec![0]);
    }

    let val = value
        .strip_prefix("0x")
        .ok_or_else(|| Error::InvalidHexPrefix(value.to_owned()))?;

    if val.is_empty() || val.starts_with('0') {
        return Err(Error::UnexpectedQuantity(value.to_owned()));
    }

    let mut val: Cow<_> = val.into();

    if val.len() % 2 != 0 {
        val = format!("0{val}").into();
    }

    super::util::decode_hex(val.as_ref()).map_err(Error::DecodeHex)
}

pub fn encode_hex(buf: &[u8]) -> String {
    let hex_val = faster_hex::hex_string(buf);

    match hex_val.find(|c| c != '0') {
        Some(idx) => format!("0x{}", &hex_val[idx..]),
        None => "0x0".into(),
    }
}

impl fmt::Debug for Quantity {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Quantity({})", self.encode_hex())
    }
}

#[cfg(test)]
mod tests {
    use super::Quantity;
    use hex_literal::hex;
    use serde_test::{assert_de_tokens, assert_ser_tokens, assert_tokens, Token};

    #[test]
    fn test_serde_zero() {
        assert_eq!(Quantity::default(), Quantity::from(vec![0]));
        assert_tokens(&Quantity::default(), &[Token::Str("0x0")]);
    }

    #[test]
    fn test_serialize() {
        assert_ser_tokens(&Quantity::from(hex!("004200")), &[Token::Str("0x4200")]);
        assert_ser_tokens(&Quantity::from(hex!("420000")), &[Token::Str("0x420000")]);
        assert_ser_tokens(&Quantity::from(hex!("000042")), &[Token::Str("0x42")]);
    }

    #[test]
    fn test_deserialize() {
        assert_de_tokens(&Quantity::from(hex!("420000")), &[Token::Str("0x420000")]);
    }

    #[test]
    #[should_panic]
    fn test_deserialize_leading_zeroes() {
        assert_de_tokens(
            &Quantity::from(hex!("00420000")),
            &[Token::Str("0x00420000")],
        );
    }

    #[test]
    #[should_panic(expected = "Unexpected quantity")]
    fn test_deserialize_empty() {
        assert_de_tokens(&Quantity::default(), &[Token::Str("0x")]);
    }

    #[test]
    fn test_from_vec_zero() {
        assert_eq!(Quantity::default(), Quantity::from(vec![0]))
    }

    #[test]
    #[should_panic]
    fn test_from_vec_empty() {
        let _ = Quantity::from(Vec::new());
    }

    #[test]
    #[should_panic]
    fn test_from_vec_leading_zeroes() {
        let _ = Quantity::from(vec![0, 1]);
    }

    #[test]
    fn test_from_slice_zero() {
        assert_eq!(Quantity::default(), Quantity::from(vec![0].as_slice()))
    }

    #[test]
    #[should_panic]
    fn test_from_slice_empty() {
        let _ = Quantity::from(Vec::new().as_slice());
    }

    #[test]
    #[should_panic]
    fn test_from_slice_leading_zeroes() {
        let _ = Quantity::from(vec![0, 1].as_slice());
    }

    #[test]
    fn test_from_u64_canonical() {
        assert_eq!(Quantity::from(0u64), Quantity::default());
        assert_eq!(Quantity::from(5u64), Quantity::from(vec![5]));
        assert_eq!(Quantity::from(0x4200u64), Quantity::from(hex!("4200")));
        assert_eq!(
            Quantity::from(u64::MAX),
            Quantity::from(hex!("ffffffffffffffff"))
        );
    }
}