Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

perf: drop useless allocation in deserialization #492

Merged
merged 1 commit into from
Nov 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 21 additions & 8 deletions starknet-core/src/serde/byte_array.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
pub mod base64 {
use alloc::{format, string::String, vec::Vec};
use alloc::{fmt::Formatter, format, vec::Vec};

use base64::{engine::general_purpose::STANDARD, Engine};
use serde::{Deserialize, Deserializer, Serializer};
use serde::{de::Visitor, Deserializer, Serializer};

struct Base64Visitor;

pub fn serialize<S, T>(value: T, serializer: S) -> Result<S::Ok, S::Error>
where
Expand All @@ -16,12 +18,23 @@ pub mod base64 {
where
D: Deserializer<'de>,
{
let value = String::deserialize(deserializer)?;
match STANDARD.decode(value) {
Ok(value) => Ok(value),
Err(err) => Err(serde::de::Error::custom(format!(
"invalid base64 string: {err}"
))),
deserializer.deserialize_any(Base64Visitor)
}

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

fn expecting(&self, formatter: &mut Formatter) -> alloc::fmt::Result {
write!(formatter, "string")
}

fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
where
E: serde::de::Error,
{
STANDARD
.decode(v)
.map_err(|err| serde::de::Error::custom(format!("invalid base64 string: {err}")))
}
}
}
28 changes: 20 additions & 8 deletions starknet-core/src/serde/num_hex.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
pub mod u64 {
use alloc::{format, string::String};
use alloc::{fmt::Formatter, format};

use serde::{Deserialize, Deserializer, Serializer};
use serde::{de::Visitor, Deserializer, Serializer};

struct NumHexVisitor;

pub fn serialize<S>(value: &u64, serializer: S) -> Result<S::Ok, S::Error>
where
Expand All @@ -14,12 +16,22 @@ pub mod u64 {
where
D: Deserializer<'de>,
{
let value = String::deserialize(deserializer)?;
match u64::from_str_radix(value.trim_start_matches("0x"), 16) {
Ok(value) => Ok(value),
Err(err) => Err(serde::de::Error::custom(format!(
"invalid u64 hex string: {err}"
))),
deserializer.deserialize_any(NumHexVisitor)
}

impl<'de> Visitor<'de> for NumHexVisitor {
type Value = u64;

fn expecting(&self, formatter: &mut Formatter) -> alloc::fmt::Result {
write!(formatter, "string")
}

fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
where
E: serde::de::Error,
{
u64::from_str_radix(v.trim_start_matches("0x"), 16)
.map_err(|err| serde::de::Error::custom(format!("invalid u64 hex string: {err}")))
}
}
}
74 changes: 61 additions & 13 deletions starknet-core/src/serde/unsigned_field_element.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
use alloc::{format, string::String};
use alloc::{fmt::Formatter, format};

use serde::{de::Error as DeError, Deserialize, Deserializer, Serializer};
use serde::{
de::{Error as DeError, Visitor},
Deserializer, Serializer,
};
use serde_with::{DeserializeAs, SerializeAs};

use crate::types::FieldElement;
Expand All @@ -11,6 +14,10 @@ pub struct UfeHexOption;

pub struct UfePendingBlockHash;

struct UfeHexVisitor;
struct UfeHexOptionVisitor;
struct UfePendingBlockHashVisitor;

impl SerializeAs<FieldElement> for UfeHex {
fn serialize_as<S>(value: &FieldElement, serializer: S) -> Result<S::Ok, S::Error>
where
Expand All @@ -25,11 +32,23 @@ impl<'de> DeserializeAs<'de, FieldElement> for UfeHex {
where
D: Deserializer<'de>,
{
let value = String::deserialize(deserializer)?;
match FieldElement::from_hex_be(&value) {
Ok(value) => Ok(value),
Err(err) => Err(DeError::custom(format!("invalid hex string: {err}"))),
}
deserializer.deserialize_any(UfeHexVisitor)
}
}

impl<'de> Visitor<'de> for UfeHexVisitor {
type Value = FieldElement;

fn expecting(&self, formatter: &mut Formatter) -> alloc::fmt::Result {
write!(formatter, "string")
}

fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
where
E: DeError,
{
FieldElement::from_hex_be(v)
.map_err(|err| DeError::custom(format!("invalid hex string: {err}")))
}
}

Expand All @@ -50,10 +69,24 @@ impl<'de> DeserializeAs<'de, Option<FieldElement>> for UfeHexOption {
where
D: Deserializer<'de>,
{
let value = String::deserialize(deserializer)?;
match value.as_str() {
deserializer.deserialize_any(UfeHexOptionVisitor)
}
}

impl<'de> Visitor<'de> for UfeHexOptionVisitor {
type Value = Option<FieldElement>;

fn expecting(&self, formatter: &mut Formatter) -> alloc::fmt::Result {
write!(formatter, "string")
}

fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
where
E: DeError,
{
match v {
"" => Ok(None),
_ => match FieldElement::from_hex_be(&value) {
_ => match FieldElement::from_hex_be(v) {
Ok(value) => Ok(Some(value)),
Err(err) => Err(DeError::custom(format!("invalid hex string: {err}"))),
},
Expand All @@ -79,11 +112,25 @@ impl<'de> DeserializeAs<'de, Option<FieldElement>> for UfePendingBlockHash {
where
D: Deserializer<'de>,
{
let value = String::deserialize(deserializer)?;
if value.is_empty() || value == "pending" || value == "None" {
deserializer.deserialize_any(UfePendingBlockHashVisitor)
}
}

impl<'de> Visitor<'de> for UfePendingBlockHashVisitor {
type Value = Option<FieldElement>;

fn expecting(&self, formatter: &mut Formatter) -> alloc::fmt::Result {
write!(formatter, "string")
}

fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
where
E: DeError,
{
if v.is_empty() || v == "pending" || v == "None" {
Ok(None)
} else {
match FieldElement::from_hex_be(&value) {
match FieldElement::from_hex_be(v) {
Ok(value) => Ok(Some(value)),
Err(err) => Err(DeError::custom(format!("invalid hex string: {err}"))),
}
Expand All @@ -95,6 +142,7 @@ impl<'de> DeserializeAs<'de, Option<FieldElement>> for UfePendingBlockHash {
mod tests {
use super::*;

use serde::Deserialize;
use serde_with::serde_as;

#[serde_as]
Expand Down
25 changes: 20 additions & 5 deletions starknet-core/src/types/eth_address.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use alloc::{format, string::String};
use alloc::{fmt::Formatter, format};
use core::str::FromStr;

use serde::{Deserialize, Serialize};
use serde::{de::Visitor, Deserialize, Serialize};
use starknet_ff::FieldElement;

// 0xFFfFfFffFFfffFFfFFfFFFFFffFFFffffFfFFFfF
Expand All @@ -17,6 +17,8 @@ pub struct EthAddress {
inner: [u8; 20],
}

struct EthAddressVisitor;

mod errors {
use core::fmt::{Display, Formatter, Result};

Expand Down Expand Up @@ -84,9 +86,22 @@ impl<'de> Deserialize<'de> for EthAddress {
where
D: serde::Deserializer<'de>,
{
let value = String::deserialize(deserializer)?;
value
.parse()
deserializer.deserialize_any(EthAddressVisitor)
}
}

impl<'de> Visitor<'de> for EthAddressVisitor {
type Value = EthAddress;

fn expecting(&self, formatter: &mut Formatter) -> alloc::fmt::Result {
write!(formatter, "string")
}

fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
where
E: serde::de::Error,
{
v.parse()
.map_err(|err| serde::de::Error::custom(format!("{}", err)))
}
}
Expand Down
30 changes: 26 additions & 4 deletions starknet-ff/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -552,10 +552,18 @@ impl fmt::UpperHex for FieldElement {

#[cfg(feature = "serde")]
mod serde_field_element {
#[cfg(feature = "std")]
use core::fmt::{Formatter, Result as FmtResult};

use super::*;
#[cfg(not(feature = "std"))]
use alloc::string::{String, ToString};
use serde::{Deserialize, Serialize};
use alloc::{
fmt::{Formatter, Result as FmtResult},
string::ToString,
};
use serde::{de::Visitor, Deserialize, Serialize};

struct FieldElementVisitor;

impl Serialize for FieldElement {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
Expand All @@ -571,8 +579,22 @@ mod serde_field_element {
where
D: serde::Deserializer<'de>,
{
let value = String::deserialize(deserializer)?;
Self::from_str(&value).map_err(serde::de::Error::custom)
deserializer.deserialize_any(FieldElementVisitor)
}
}

impl<'de> Visitor<'de> for FieldElementVisitor {
type Value = FieldElement;

fn expecting(&self, formatter: &mut Formatter) -> FmtResult {
write!(formatter, "string")
}

fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
where
E: serde::de::Error,
{
FieldElement::from_str(v).map_err(serde::de::Error::custom)
}
}
}
Expand Down
Loading