Skip to content

Commit

Permalink
Added serde feature to enable serde Serialize and Deserialize for…
Browse files Browse the repository at this point in the history
… execution-core
  • Loading branch information
d-sonuga committed Nov 25, 2024
1 parent b3807b5 commit 81a1600
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 0 deletions.
4 changes: 4 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,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 }
rayon = { version = "1.8", optional = true }
serde = { version = "1.0.210", optional = true }
bs58 = { version = "0.4.0" , optional = true }
serde_json = { version = "1.0.128", optional = true }

[dev-dependencies]
rand = "0.8"
Expand All @@ -34,3 +37,4 @@ rkyv-impl = [
"bytecheck",
]
parallel = ["dep:rayon"]
serde = ["dep:serde", "bs58", "serde_json"]
3 changes: 3 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ pub use keys::{
};
pub use signatures::{MultisigSignature, Signature};

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

#[cfg(feature = "rkyv-impl")]
pub use crate::keys::{
public::{
Expand Down
46 changes: 46 additions & 0 deletions src/serde_support.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
// 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 crate::keys::public::PublicKey;
use alloc::format;
use alloc::string::String;
use bs58;
use dusk_bytes::Serializable;
use serde::{de, Deserialize, Deserializer, Serialize, Serializer};

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 mut bytes: [u8; Self::SIZE] = [0; Self::SIZE];
match bs58::decode(&s).into(&mut bytes) {
Ok(n) => {
if n != Self::SIZE {
return Err(de::Error::custom(
"failed to deserialize AccountPublicKey",
));
}
}
Err(err) => return Err(de::Error::custom(format!("{err:?}"))),
}
let pubk = PublicKey::from_bytes(&bytes)
.map_err(|err| de::Error::custom(format!("{err:?}")))?;
Ok(pubk)
}
}
10 changes: 10 additions & 0 deletions tests/keys.rs
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,13 @@ fn apk_identity_fails() {
Error::InvalidPoint
);
}

#[cfg(feature = "serde")]
#[test]
fn pk_serde() {
let mut rng = StdRng::seed_from_u64(42);
let pk = PublicKey::from(&SecretKey::random(&mut rng));
let ser = serde_json::to_string(&pk);
let deser = serde_json::from_str(&ser.unwrap());
assert_eq!(pk, deser.unwrap());
}

0 comments on commit 81a1600

Please sign in to comment.