Add "serde" feature to derive serde::Serialize for Streamable

Chia-Network · Feb 1, 2023 · 5dbe0f0 · 5dbe0f0
1 parent ae0f25d
commit 5dbe0f0
Show file tree

Hide file tree

Showing 24 changed files with 70 additions and 0 deletions.
diff --git a/chia-protocol/Cargo.toml b/chia-protocol/Cargo.toml
@@ -10,6 +10,7 @@ repository = "https://github.com/Chia-Network/chia_rs/chia-protocol/"
 
 [features]
 py-bindings = ["dep:pyo3", "dep:chia_py_streamable_macro"]
+serde = ["dep:serde"]
 
 [dependencies]
 pyo3 = { version = "=0.15.1", features = ["extension-module", "multiple-pymethods"], optional = true }
@@ -18,6 +19,7 @@ hex = "=0.4.3"
 chia_streamable_macro = { version = "=0.2.4", path = "../chia_streamable_macro" }
 chia_py_streamable_macro = { path = "../chia_py_streamable_macro", version = "=0.1.3", optional = true }
 clvmr = "=0.2.2"
+serde = { version = "1.0.152", features = ["derive"], optional = true }
 
 [lib]
 crate-type = ["rlib"]
diff --git a/chia-protocol/src/bls.rs b/chia-protocol/src/bls.rs
@@ -11,11 +11,15 @@ use crate::to_json_dict::ToJsonDict;
 use chia_py_streamable_macro::PyStreamable;
 #[cfg(feature = "py-bindings")]
 use pyo3::prelude::*;
+#[cfg(feature = "serde")]
+use serde::{Serialize};
 
 #[cfg_attr(feature = "py-bindings", pyclass, derive(PyStreamable))]
+#[cfg_attr(feature = "serde", derive(Serialize))]
 #[derive(Streamable, Hash, Debug, Clone, Eq, PartialEq)]
 pub struct G1Element(Bytes48);
 
 #[cfg_attr(feature = "py-bindings", pyclass, derive(PyStreamable))]
+#[cfg_attr(feature = "serde", derive(Serialize))]
 #[derive(Streamable, Hash, Debug, Clone, Eq, PartialEq)]
 pub struct G2Element(Bytes96);
diff --git a/chia-protocol/src/bytes.rs b/chia-protocol/src/bytes.rs
@@ -13,6 +13,8 @@ use std::ops::Deref;
 use pyo3::prelude::*;
 #[cfg(feature = "py-bindings")]
 use pyo3::types::PyBytes;
+#[cfg(feature = "serde")]
+use serde::{Serialize, Serializer};
 
 #[derive(Hash, Debug, Clone, Eq, PartialEq, PartialOrd, Ord)]
 pub struct Bytes(Vec<u8>);
@@ -72,6 +74,14 @@ impl fmt::Display for Bytes {
     }
 }
 
+#[cfg(feature = "serde")]
+impl Serialize for Bytes {
+    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
+        let s = format!("0x{}", hex::encode(&self.0));
+        serializer.serialize_str(&s)
+    }
+}
+
 #[derive(Hash, PartialEq, Eq, Copy, Clone, PartialOrd, Ord)]
 pub struct BytesImpl<const N: usize>([u8; N]);
 
@@ -159,6 +169,14 @@ impl<const N: usize> fmt::Display for BytesImpl<N> {
     }
 }
 
+#[cfg(feature = "serde")]
+impl<const N: usize> Serialize for BytesImpl<N> {
+    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
+        let s = format!("0x{}", hex::encode(&self.0));
+        serializer.serialize_str(&s)
+    }
+}
+
 pub type Bytes32 = BytesImpl<32>;
 pub type Bytes48 = BytesImpl<48>;
 pub type Bytes96 = BytesImpl<96>;

diff --git a/chia-protocol/src/chia_error.rs b/chia-protocol/src/chia_error.rs
@@ -5,7 +5,10 @@ use std::fmt;
 use pyo3::exceptions;
 #[cfg(feature = "py-bindings")]
 use pyo3::PyErr;
+#[cfg(feature = "serde")]
+use serde::{Serialize};
 
+#[cfg_attr(feature = "serde", derive(Serialize))]
 #[derive(Debug, PartialEq, Eq)]
 pub enum Error {
     InvalidBool,

diff --git a/chia-protocol/src/chia_protocol.rs b/chia-protocol/src/chia_protocol.rs
@@ -16,9 +16,12 @@ use chia_py_streamable_macro::PyStreamable;
 use pyo3::prelude::*;
 #[cfg(feature = "py-bindings")]
 use std::io::Cursor;
+#[cfg(feature = "serde")]
+use serde::{Serialize};
 
 #[repr(u8)]
 #[cfg_attr(feature = "py-bindings", derive(PyStreamable))]
+#[cfg_attr(feature = "serde", derive(Serialize))]
 #[derive(Streamable, Hash, Debug, Copy, Clone, Eq, PartialEq)]
 pub enum ProtocolMessageTypes {
     // Shared protocol (all services)
@@ -138,6 +141,7 @@ pub trait ChiaProtocolMessage {
 
 #[repr(u8)]
 #[cfg_attr(feature = "py-bindings", derive(PyStreamable))]
+#[cfg_attr(feature = "serde", derive(Serialize))]
 #[derive(Streamable, Hash, Debug, Copy, Clone, Eq, PartialEq)]
 pub enum NodeType {
     FullNode = 1,

diff --git a/chia-protocol/src/classgroup.rs b/chia-protocol/src/classgroup.rs
@@ -12,6 +12,8 @@ use crate::to_json_dict::ToJsonDict;
 use chia_py_streamable_macro::PyStreamable;
 #[cfg(feature = "py-bindings")]
 use pyo3::prelude::*;
+#[cfg(feature = "serde")]
+use serde::{Serialize};
 
 streamable_struct!(ClassgroupElement { data: Bytes100 });
 

diff --git a/chia-protocol/src/coin.rs b/chia-protocol/src/coin.rs
@@ -16,6 +16,8 @@ use chia_py_streamable_macro::PyStreamable;
 use pyo3::prelude::*;
 #[cfg(feature = "py-bindings")]
 use pyo3::types::PyBytes;
+#[cfg(feature = "serde")]
+use serde::{Serialize};
 
 streamable_struct!(Coin {
     parent_coin_info: Bytes32,

diff --git a/chia-protocol/src/coin_spend.rs b/chia-protocol/src/coin_spend.rs
@@ -14,6 +14,8 @@ use crate::to_json_dict::ToJsonDict;
 use chia_py_streamable_macro::PyStreamable;
 #[cfg(feature = "py-bindings")]
 use pyo3::prelude::*;
+#[cfg(feature = "serde")]
+use serde::{Serialize};
 
 streamable_struct!(CoinSpend {
     coin: Coin,

diff --git a/chia-protocol/src/coin_state.rs b/chia-protocol/src/coin_state.rs
@@ -12,6 +12,8 @@ use crate::to_json_dict::ToJsonDict;
 use chia_py_streamable_macro::PyStreamable;
 #[cfg(feature = "py-bindings")]
 use pyo3::prelude::*;
+#[cfg(feature = "serde")]
+use serde::{Serialize};
 
 streamable_struct! (CoinState {
     coin: Coin,

diff --git a/chia-protocol/src/end_of_sub_slot_bundle.rs b/chia-protocol/src/end_of_sub_slot_bundle.rs
@@ -16,6 +16,8 @@ use crate::to_json_dict::ToJsonDict;
 use chia_py_streamable_macro::PyStreamable;
 #[cfg(feature = "py-bindings")]
 use pyo3::prelude::*;
+#[cfg(feature = "serde")]
+use serde::{Serialize};
 
 streamable_struct! (EndOfSubSlotBundle {
     challenge_chain: ChallengeChainSubSlot,

diff --git a/chia-protocol/src/fee_estimate.rs b/chia-protocol/src/fee_estimate.rs
@@ -12,6 +12,8 @@ use crate::to_json_dict::ToJsonDict;
 use chia_py_streamable_macro::PyStreamable;
 #[cfg(feature = "py-bindings")]
 use pyo3::prelude::*;
+#[cfg(feature = "serde")]
+use serde::{Serialize};
 
 streamable_struct!(FeeRate {
     // Represents Fee Rate in mojos divided by CLVM Cost.

diff --git a/chia-protocol/src/foliage.rs b/chia-protocol/src/foliage.rs
@@ -16,6 +16,8 @@ use crate::to_json_dict::ToJsonDict;
 use chia_py_streamable_macro::PyStreamable;
 #[cfg(feature = "py-bindings")]
 use pyo3::prelude::*;
+#[cfg(feature = "serde")]
+use serde::{Serialize};
 
 streamable_struct! (TransactionsInfo {
     // Information that goes along with each transaction block

diff --git a/chia-protocol/src/fullblock.rs b/chia-protocol/src/fullblock.rs
@@ -17,6 +17,8 @@ use crate::to_json_dict::ToJsonDict;
 use chia_py_streamable_macro::PyStreamable;
 #[cfg(feature = "py-bindings")]
 use pyo3::prelude::*;
+#[cfg(feature = "serde")]
+use serde::{Serialize};
 
 streamable_struct! (FullBlock {
     finished_sub_slots: Vec<EndOfSubSlotBundle>,

diff --git a/chia-protocol/src/header_block.rs b/chia-protocol/src/header_block.rs
@@ -17,6 +17,8 @@ use crate::to_json_dict::ToJsonDict;
 use chia_py_streamable_macro::PyStreamable;
 #[cfg(feature = "py-bindings")]
 use pyo3::prelude::*;
+#[cfg(feature = "serde")]
+use serde::{Serialize};
 
 streamable_struct! (HeaderBlock {
     // If first sb

diff --git a/chia-protocol/src/message_struct.rs b/chia-protocol/src/message_struct.rs
@@ -2,6 +2,7 @@
 macro_rules! message_struct {
     ($name:ident {$($field:ident: $t:ty $(,)? )*}) => {
         #[cfg_attr(feature = "py-bindings", pyclass, derive(PyStreamable))]
+        #[cfg_attr(feature = "serde", derive(Serialize))]
         #[derive(Streamable, Hash, Debug, Clone, Eq, PartialEq)]
         pub struct $name {
             $(pub $field: $t),*
@@ -19,6 +20,7 @@ macro_rules! message_struct {
 macro_rules! streamable_struct {
     ($name:ident {$($field:ident: $t:ty $(,)? )*}) => {
         #[cfg_attr(feature = "py-bindings", pyclass, derive(PyStreamable))]
+        #[cfg_attr(feature = "serde", derive(Serialize))]
         #[derive(Streamable, Hash, Debug, Clone, Eq, PartialEq)]
         pub struct $name {
             $(pub $field: $t),*

diff --git a/chia-protocol/src/pool_target.rs b/chia-protocol/src/pool_target.rs
@@ -13,6 +13,8 @@ use crate::to_json_dict::ToJsonDict;
 use chia_py_streamable_macro::PyStreamable;
 #[cfg(feature = "py-bindings")]
 use pyo3::prelude::*;
+#[cfg(feature = "serde")]
+use serde::{Serialize};
 
 streamable_struct!(PoolTarget {
     puzzle_hash: Bytes32,

diff --git a/chia-protocol/src/program.rs b/chia-protocol/src/program.rs
@@ -15,8 +15,11 @@ use crate::to_json_dict::ToJsonDict;
 use chia_py_streamable_macro::PyStreamable;
 #[cfg(feature = "py-bindings")]
 use pyo3::prelude::*;
+#[cfg(feature = "serde")]
+use serde::{Serialize};
 
 #[cfg_attr(feature = "py-bindings", pyclass, derive(PyStreamable))]
+#[cfg_attr(feature = "serde", derive(Serialize))]
 #[derive(Hash, Debug, Clone, Eq, PartialEq)]
 pub struct Program(Bytes);
 

diff --git a/chia-protocol/src/proof_of_space.rs b/chia-protocol/src/proof_of_space.rs
@@ -13,6 +13,8 @@ use crate::to_json_dict::ToJsonDict;
 use chia_py_streamable_macro::PyStreamable;
 #[cfg(feature = "py-bindings")]
 use pyo3::prelude::*;
+#[cfg(feature = "serde")]
+use serde::{Serialize};
 
 streamable_struct! (ProofOfSpace {
     challenge: Bytes32,

diff --git a/chia-protocol/src/reward_chain_block.rs b/chia-protocol/src/reward_chain_block.rs
@@ -16,6 +16,8 @@ use crate::to_json_dict::ToJsonDict;
 use chia_py_streamable_macro::PyStreamable;
 #[cfg(feature = "py-bindings")]
 use pyo3::prelude::*;
+#[cfg(feature = "serde")]
+use serde::{Serialize};
 
 streamable_struct! (RewardChainBlockUnfinished {
     total_iters: u128,

diff --git a/chia-protocol/src/slots.rs b/chia-protocol/src/slots.rs
@@ -17,6 +17,8 @@ use crate::to_json_dict::ToJsonDict;
 use chia_py_streamable_macro::PyStreamable;
 #[cfg(feature = "py-bindings")]
 use pyo3::prelude::*;
+#[cfg(feature = "serde")]
+use serde::{Serialize};
 
 // The hash of this is used as the challenge_hash for the ICC VDF
 streamable_struct! (ChallengeBlockInfo {

diff --git a/chia-protocol/src/spend_bundle.rs b/chia-protocol/src/spend_bundle.rs
@@ -14,6 +14,8 @@ use crate::to_json_dict::ToJsonDict;
 use chia_py_streamable_macro::PyStreamable;
 #[cfg(feature = "py-bindings")]
 use pyo3::prelude::*;
+#[cfg(feature = "serde")]
+use serde::{Serialize};
 
 streamable_struct! (SpendBundle {
     coin_spends: Vec<CoinSpend>,

diff --git a/chia-protocol/src/vdf.rs b/chia-protocol/src/vdf.rs
@@ -14,6 +14,8 @@ use crate::to_json_dict::ToJsonDict;
 use chia_py_streamable_macro::PyStreamable;
 #[cfg(feature = "py-bindings")]
 use pyo3::prelude::*;
+#[cfg(feature = "serde")]
+use serde::{Serialize};
 
 streamable_struct!(VDFInfo {
     challenge: Bytes32,

diff --git a/chia-protocol/src/wallet_protocol.rs b/chia-protocol/src/wallet_protocol.rs
@@ -22,6 +22,8 @@ use crate::to_json_dict::ToJsonDict;
 use chia_py_streamable_macro::PyStreamable;
 #[cfg(feature = "py-bindings")]
 use pyo3::prelude::*;
+#[cfg(feature = "serde")]
+use serde::{Serialize};
 
 message_struct!(RequestPuzzleSolution {
     coin_name: Bytes32,

diff --git a/chia-protocol/src/weight_proof.rs b/chia-protocol/src/weight_proof.rs
@@ -14,6 +14,8 @@ use crate::to_json_dict::ToJsonDict;
 use chia_py_streamable_macro::PyStreamable;
 #[cfg(feature = "py-bindings")]
 use pyo3::prelude::*;
+#[cfg(feature = "serde")]
+use serde::{Serialize};
 
 streamable_struct! (SubSlotData {
     proof_of_space: Option<ProofOfSpace>,