Skip to content

Commit

Permalink
Added serde support
Browse files Browse the repository at this point in the history
  • Loading branch information
d-sonuga committed Dec 10, 2024
1 parent 256fa23 commit 30a209e
Show file tree
Hide file tree
Showing 5 changed files with 448 additions and 2 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/dusk_ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
uses: dusk-network/.github/.github/workflows/code-analysis.yml@main
with:
clippy_default: false
clippy_args: --features=rkyv/size_32,zk
clippy_args: --features=rkyv/size_32,zk,serde

dusk_analyzer:
name: Dusk Analyzer
Expand All @@ -26,7 +26,7 @@ jobs:
name: Nightly tests
uses: dusk-network/.github/.github/workflows/run-tests.yml@main
with:
test_flags: --features=zk,alloc
test_flags: --features=zk,alloc,serde

test_nightly_multisig_compiles:
name: Nightly multisig tests compile
Expand Down
8 changes: 8 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ zeroize = { version = "1", default-features = false, features = ["derive"] }
rkyv = { version = "0.7", optional = true, default-features = false }
bytecheck = { version = "0.6", optional = true, default-features = false }
dusk-plonk = { version = "0.20", default-features = false, features = ["alloc"], optional = true }
serde = { version = "1.0", optional = true }
bs58 = { version = "0.4" , optional = true }
serde_json = { version = "1.0", optional = true }

[dev-dependencies]
rkyv = { version = "0.7", default-features = false, features = ["size_32"] }
Expand Down Expand Up @@ -62,6 +65,11 @@ rkyv-impl = [
"rkyv",
"bytecheck",
]
serde = [
"dep:serde",
"bs58",
"serde_json"
]

[[test]]
name = "gadgets"
Expand Down
3 changes: 3 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ mod signatures;
#[cfg(feature = "zk")]
pub mod gadgets;

#[cfg(feature = "serde")]
mod serde_support;

pub use error::Error;
pub use keys::public::PublicKey;
pub use keys::secret::SecretKey;
Expand Down
235 changes: 235 additions & 0 deletions src/serde_support.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,235 @@
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
//
// Copyright (c) DUSK NETWORK. All rights reserved.

extern crate alloc;

use alloc::format;
use alloc::string::String;

use dusk_bytes::Serializable;
use serde::de::Error as SerdeError;
use serde::{Deserialize, Deserializer, Serialize, Serializer};

use crate::{
PublicKey, PublicKeyDouble, PublicKeyVarGen, SecretKey, SecretKeyVarGen,
Signature, SignatureDouble, SignatureVarGen,
};

impl Serialize for PublicKey {
fn serialize<S: Serializer>(
&self,
serializer: S,
) -> Result<S::Ok, S::Error> {
let s = bs58::encode(self.to_bytes()).into_string();
serializer.serialize_str(&s)
}
}

impl<'de> Deserialize<'de> for PublicKey {
fn deserialize<D: Deserializer<'de>>(
deserializer: D,
) -> Result<Self, D::Error> {
let s = String::deserialize(deserializer)?;
let decoded =
bs58::decode(&s).into_vec().map_err(SerdeError::custom)?;
let decoded_len = decoded.len();
let byte_length_str = format!("{}", Self::SIZE);
let bytes: [u8; Self::SIZE] = decoded.try_into().map_err(|_| {
SerdeError::invalid_length(decoded_len, &byte_length_str.as_str())
})?;
PublicKey::from_bytes(&bytes)
.map_err(|err| SerdeError::custom(format!("{err:?}")))
}
}

impl Serialize for SecretKey {
fn serialize<S: Serializer>(
&self,
serializer: S,
) -> Result<S::Ok, S::Error> {
let s = bs58::encode(self.to_bytes()).into_string();
serializer.serialize_str(&s)
}
}

impl<'de> Deserialize<'de> for SecretKey {
fn deserialize<D: Deserializer<'de>>(
deserializer: D,
) -> Result<Self, D::Error> {
let s = String::deserialize(deserializer)?;
let decoded =
bs58::decode(&s).into_vec().map_err(SerdeError::custom)?;
let decoded_len = decoded.len();
let byte_length_str = format!("{}", Self::SIZE);
let bytes: [u8; Self::SIZE] = decoded.try_into().map_err(|_| {
SerdeError::invalid_length(decoded_len, &byte_length_str.as_str())
})?;
SecretKey::from_bytes(&bytes)
.map_err(|err| SerdeError::custom(format!("{err:?}")))
}
}

impl Serialize for Signature {
fn serialize<S: Serializer>(
&self,
serializer: S,
) -> Result<S::Ok, S::Error> {
let s = bs58::encode(self.to_bytes()).into_string();
serializer.serialize_str(&s)
}
}

impl<'de> Deserialize<'de> for Signature {
fn deserialize<D: Deserializer<'de>>(
deserializer: D,
) -> Result<Self, D::Error> {
let s = String::deserialize(deserializer)?;
let decoded =
bs58::decode(&s).into_vec().map_err(SerdeError::custom)?;
let decoded_len = decoded.len();
let byte_length_str = format!("{}", Self::SIZE);
let bytes: [u8; Self::SIZE] = decoded.try_into().map_err(|_| {
SerdeError::invalid_length(decoded_len, &byte_length_str.as_str())
})?;
Signature::from_bytes(&bytes)
.map_err(|err| SerdeError::custom(format!("{err:?}")))
}
}

impl Serialize for PublicKeyDouble {
fn serialize<S: Serializer>(
&self,
serializer: S,
) -> Result<S::Ok, S::Error> {
let s = bs58::encode(self.to_bytes()).into_string();
serializer.serialize_str(&s)
}
}

impl<'de> Deserialize<'de> for PublicKeyDouble {
fn deserialize<D: Deserializer<'de>>(
deserializer: D,
) -> Result<Self, D::Error> {
let s = String::deserialize(deserializer)?;
let decoded =
bs58::decode(&s).into_vec().map_err(SerdeError::custom)?;
let decoded_len = decoded.len();
let byte_length_str = format!("{}", Self::SIZE);
let bytes: [u8; Self::SIZE] = decoded.try_into().map_err(|_| {
SerdeError::invalid_length(decoded_len, &byte_length_str.as_str())
})?;
PublicKeyDouble::from_bytes(&bytes)
.map_err(|err| SerdeError::custom(format!("{err:?}")))
}
}

impl Serialize for SignatureDouble {
fn serialize<S: Serializer>(
&self,
serializer: S,
) -> Result<S::Ok, S::Error> {
let s = bs58::encode(self.to_bytes()).into_string();
serializer.serialize_str(&s)
}
}

impl<'de> Deserialize<'de> for SignatureDouble {
fn deserialize<D: Deserializer<'de>>(
deserializer: D,
) -> Result<Self, D::Error> {
let s = String::deserialize(deserializer)?;
let decoded =
bs58::decode(&s).into_vec().map_err(SerdeError::custom)?;
let decoded_len = decoded.len();
let byte_length_str = format!("{}", Self::SIZE);
let bytes: [u8; Self::SIZE] = decoded.try_into().map_err(|_| {
SerdeError::invalid_length(decoded_len, &byte_length_str.as_str())
})?;
SignatureDouble::from_bytes(&bytes)
.map_err(|err| SerdeError::custom(format!("{err:?}")))
}
}

impl Serialize for PublicKeyVarGen {
fn serialize<S: Serializer>(
&self,
serializer: S,
) -> Result<S::Ok, S::Error> {
let s = bs58::encode(self.to_bytes()).into_string();
serializer.serialize_str(&s)
}
}

impl<'de> Deserialize<'de> for PublicKeyVarGen {
fn deserialize<D: Deserializer<'de>>(
deserializer: D,
) -> Result<Self, D::Error> {
let s = String::deserialize(deserializer)?;
let decoded =
bs58::decode(&s).into_vec().map_err(SerdeError::custom)?;
let decoded_len = decoded.len();
let byte_length_str = format!("{}", Self::SIZE);
let bytes: [u8; Self::SIZE] = decoded.try_into().map_err(|_| {
SerdeError::invalid_length(decoded_len, &byte_length_str.as_str())
})?;
PublicKeyVarGen::from_bytes(&bytes)
.map_err(|err| SerdeError::custom(format!("{err:?}")))
}
}

impl Serialize for SecretKeyVarGen {
fn serialize<S: Serializer>(
&self,
serializer: S,
) -> Result<S::Ok, S::Error> {
let s = bs58::encode(self.to_bytes()).into_string();
serializer.serialize_str(&s)
}
}

impl<'de> Deserialize<'de> for SecretKeyVarGen {
fn deserialize<D: Deserializer<'de>>(
deserializer: D,
) -> Result<Self, D::Error> {
let s = String::deserialize(deserializer)?;
let decoded =
bs58::decode(&s).into_vec().map_err(SerdeError::custom)?;
let decoded_len = decoded.len();
let byte_length_str = format!("{}", Self::SIZE);
let bytes: [u8; Self::SIZE] = decoded.try_into().map_err(|_| {
SerdeError::invalid_length(decoded_len, &byte_length_str.as_str())
})?;
SecretKeyVarGen::from_bytes(&bytes)
.map_err(|err| SerdeError::custom(format!("{err:?}")))
}
}

impl Serialize for SignatureVarGen {
fn serialize<S: Serializer>(
&self,
serializer: S,
) -> Result<S::Ok, S::Error> {
let s = bs58::encode(self.to_bytes()).into_string();
serializer.serialize_str(&s)
}
}

impl<'de> Deserialize<'de> for SignatureVarGen {
fn deserialize<D: Deserializer<'de>>(
deserializer: D,
) -> Result<Self, D::Error> {
let s = String::deserialize(deserializer)?;
let decoded =
bs58::decode(&s).into_vec().map_err(SerdeError::custom)?;
let decoded_len = decoded.len();
let byte_length_str = format!("{}", Self::SIZE);
let bytes: [u8; Self::SIZE] = decoded.try_into().map_err(|_| {
SerdeError::invalid_length(decoded_len, &byte_length_str.as_str())
})?;
SignatureVarGen::from_bytes(&bytes)
.map_err(|err| SerdeError::custom(format!("{err:?}")))
}
}
Loading

0 comments on commit 30a209e

Please sign in to comment.