Add serde serialization for Ledger

chain-addr/Cargo.toml

@@ -16,6 +16,8 @@ chain-crypto = { path = "../chain-crypto" }
 cryptoxide = "0.1"
 cfg-if = "0.1"
 quickcheck = { version = "0.8", optional = true }
+serde = "^1.0"
+serde_derive = "^1.0"
 
 [dev-dependencies]
 quickcheck = "0.8"

chain-addr/src/lib.rs

@@ -51,7 +51,7 @@ cfg_if! {
 // Allow to differentiate between address in
 // production and testing setting, so that
 // one type of address is not used in another setting.
-#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, serde_derive::Serialize)]
 pub enum Discrimination {
     Production,
     Test,
@@ -445,6 +445,17 @@ impl property::Deserialize for Address {
     }
 }
 
+impl serde::Serialize for Address {
+    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: serde::Serializer,
+    {
+        // FIXME: we don't want to encode as a string in binary
+        // serialization formats.
+        serializer.serialize_str(&AddressReadable::from_address(&self).as_string())
+    }
+}
+
 fn chain_crypto_err(e: chain_crypto::PublicKeyError) -> ReadError {
     match e {
         PublicKeyError::SizeInvalid => {

chain-crypto/Cargo.toml

@@ -20,6 +20,7 @@ ed25519-bip32 = "0.1"
 quickcheck = {version = "0.8", optional = true }
 rand_chacha = {version = "0.1", optional = true }
 cfg-if = "0.1"
+serde = "^1.0"
 
 [dev-dependencies]
 quickcheck = "0.8"

chain-crypto/src/key.rs

@@ -248,6 +248,17 @@ impl<A: AsymmetricKey> Bech32 for SecretKey<A> {
     }
 }
 
+impl<A: AsymmetricPublicKey> serde::Serialize for PublicKey<A> {
+    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: serde::Serializer,
+    {
+        // FIXME: we don't want to encode as a string in binary
+        // serialization formats.
+        serializer.serialize_str(&self.to_bech32_str())
+    }
+}
+
 #[cfg(test)]
 mod test {
     use super::*;

chain-impl-mockchain/Cargo.toml

@@ -12,20 +12,22 @@ edition = "2018"
 [dependencies]
 num-traits = "0.2"
 num-derive = "0.2"
-serde = { version = "^1.0", optional = true }
-serde_derive = { version = "^1.0", optional = true }
+serde = { version = "^1.0", features = ["rc"] }
+serde_derive = "^1.0"
+serde_json = "1.0"
 chain-core = { path = "../chain-core" }
 chain-addr = { path = "../chain-addr" }
 chain-crypto = { path = "../chain-crypto" }
 chain-storage = { path = "../chain-storage" }
 chain-time = { path = "../chain-time" }
-cardano = { path= "../cardano" }
+cardano = { path= "../cardano", features=["generic-serialization"] }
 rand = "0.6"
 imhamt = { path = "../imhamt" }
 lazy_static = "1.3.0"
 strum = "0.15.0"
 strum_macros = "0.15.0"
 custom_error = "1.6"
+base64 = "0.9"
 
 [dev-dependencies]
 quickcheck = "0.8"

chain-impl-mockchain/src/account.rs

@@ -11,7 +11,7 @@ pub use account::{LedgerError, SpendingCounter};
 pub type AccountAlg = Ed25519;
 
 /// Account Identifier (also used as Public Key)
-#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
+#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, serde_derive::Serialize)]
 pub struct Identifier(PublicKey<AccountAlg>);
 
 impl From<PublicKey<AccountAlg>> for Identifier {

chain-impl-mockchain/src/accounting/account.rs

@@ -37,7 +37,7 @@ impl From<InsertError> for LedgerError {
     }
 }
 
-#[derive(Clone)]
+#[derive(Clone, serde_derive::Serialize)]
 pub struct AccountState<Extra> {
     counter: SpendingCounter,
     delegation: Option<StakePoolId>,
@@ -126,7 +126,7 @@ impl<Extra: Clone> AccountState<Extra> {
 /// the counter is incremented. A matching counter
 /// needs to be used in the spending phase to make
 /// sure we have non-replayability of a transaction.
-#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, serde_derive::Serialize)]
 pub struct SpendingCounter(u32);
 
 impl SpendingCounter {
@@ -166,7 +166,7 @@ impl<'a, ID, Extra> Iterator for Iter<'a, ID, Extra> {
 }
 
 /// The public ledger of all accounts associated with their current state
-#[derive(Clone)]
+#[derive(Clone, serde_derive::Serialize)]
 pub struct Ledger<ID: Hash + Eq, Extra>(Hamt<DefaultHasher, ID, AccountState<Extra>>);
 
 impl<ID: Clone + Eq + Hash, Extra: Clone> Ledger<ID, Extra> {

chain-impl-mockchain/src/block/header.rs

@@ -31,7 +31,7 @@ pub struct Common {
     pub chain_length: ChainLength,
 }
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, serde_derive::Serialize)]
 pub struct ChainLength(pub(crate) u32);
 
 /// FIXME SECURITY : we want to sign Common + everything in proof except the signature

chain-impl-mockchain/src/block/version.rs

@@ -83,6 +83,7 @@ impl BlockVersion {
     PartialOrd,
     Ord,
     Hash,
+    serde_derive::Serialize,
 )]
 pub enum ConsensusVersion {
     #[strum(to_string = "bft")]

chain-impl-mockchain/src/config.rs

@@ -42,7 +42,7 @@ impl Into<ReadError> for Error {
     }
 }
 
-#[derive(Clone, Debug, Eq, PartialEq)]
+#[derive(Clone, Debug, Eq, PartialEq, serde_derive::Serialize)]
 pub enum ConfigParam {
     Block0Date(Block0Date),
     Discrimination(Discrimination),
@@ -201,7 +201,7 @@ trait ConfigParamVariant: Clone + Eq + PartialEq {
 }
 
 /// Seconds elapsed since 1-Jan-1970 (unix time)
-#[derive(Debug, Clone, Copy, Eq, PartialEq)]
+#[derive(Debug, Clone, Copy, Eq, PartialEq, serde_derive::Serialize)]
 pub struct Block0Date(pub u64);
 
 impl ConfigParamVariant for Block0Date {

chain-impl-mockchain/src/date.rs

@@ -6,7 +6,7 @@ use std::{error, fmt, num::ParseIntError, str};
 /// Non unique identifier of the transaction position in the
 /// blockchain. There may be many transactions related to the same
 /// `SlotId`.
-#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, serde_derive::Serialize)]
 pub struct BlockDate {
     pub epoch: Epoch,
     pub slot_id: SlotId,

chain-impl-mockchain/src/fee.rs

@@ -5,7 +5,7 @@ use chain_addr::Address;
 
 /// Linear fee using the basic affine formula
 /// `COEFFICIENT * bytes(COUNT(tx.inputs) + COUNT(tx.outputs)) + CONSTANT + CERTIFICATE*COUNT(certificates)`.
-#[derive(PartialEq, Eq, PartialOrd, Debug, Clone, Copy)]
+#[derive(PartialEq, Eq, PartialOrd, Debug, Clone, Copy, serde_derive::Serialize)]
 pub struct LinearFee {
     pub constant: u64,
     pub coefficient: u64,

chain-impl-mockchain/src/key.rs

@@ -6,6 +6,7 @@ use chain_core::property;
 use chain_crypto as crypto;
 use chain_crypto::{AsymmetricKey, AsymmetricPublicKey, SigningAlgorithm, VerificationAlgorithm};
 
+use base64;
 use std::str::FromStr;
 
 pub type SpendingPublicKey = crypto::PublicKey<crypto::Ed25519>;
@@ -222,6 +223,17 @@ impl property::Deserialize for Hash {
     }
 }
 
+impl serde::Serialize for Hash {
+    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: serde::Serializer,
+    {
+        // FIXME: we don't want to encode as a string in binary
+        // serialization formats.
+        serializer.serialize_str(&base64::encode(self.as_ref()))
+    }
+}
+
 impl Readable for Hash {
     fn read<'a>(buf: &mut ReadBuf<'a>) -> Result<Self, ReadError> {
         let bytes = <[u8; crypto::Blake2b256::HASH_SIZE]>::read(buf)?;

chain-impl-mockchain/src/leadership/bft.rs

@@ -11,7 +11,7 @@ use std::sync::Arc;
 
 pub type BftVerificationAlg = Ed25519;
 
-#[derive(Debug, Clone, PartialEq, Eq, Hash)]
+#[derive(Debug, Clone, PartialEq, Eq, Hash, serde_derive::Serialize)]
 pub struct LeaderId(pub(crate) PublicKey<BftVerificationAlg>);
 
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]

chain-impl-mockchain/src/leadership/genesis/mod.rs

@@ -16,7 +16,7 @@ pub use vrfeval::{ActiveSlotsCoeff, ActiveSlotsCoeffError, Nonce, Witness, Witne
 use vrfeval::{PercentStake, VrfEvaluator};
 
 /// Praos Leader consisting of the KES public key and VRF public key
-#[derive(Debug, Clone, PartialEq, Eq, Hash)]
+#[derive(Debug, Clone, PartialEq, Eq, Hash, serde_derive::Serialize)]
 pub struct GenesisPraosLeader {
     pub kes_public_key: PublicKey<SumEd25519_12>,
     pub vrf_public_key: PublicKey<Curve25519_2HashDH>,

chain-impl-mockchain/src/leadership/genesis/vrfeval.rs

@@ -14,7 +14,7 @@ use std::error::Error;
 use std::fmt::{self, Display, Formatter};
 
 /// Nonce gathered per block
-#[derive(Debug, Clone, PartialEq, Eq)]
+#[derive(Debug, Clone, PartialEq, Eq, serde_derive::Serialize)]
 pub struct Nonce([u8; 32]);
 
 impl Nonce {
@@ -50,7 +50,7 @@ impl Error for ActiveSlotsCoeffError {}
 /// Active slots coefficient used for calculating minimum stake to become slot leader candidate
 /// Described in Ouroboros Praos paper, also referred to as parameter F of phi function
 /// Always in range (0, 1]
-#[derive(Clone, Copy, Debug, Eq, PartialEq)]
+#[derive(Clone, Copy, Debug, Eq, PartialEq, serde_derive::Serialize)]
 pub struct ActiveSlotsCoeff(pub(crate) Milli);
 
 impl TryFrom<Milli> for ActiveSlotsCoeff {

chain-impl-mockchain/src/ledger.rs

@@ -19,7 +19,7 @@ use std::sync::Arc;
 use std::time::{Duration, SystemTime};
 
 // static parameters, effectively this is constant in the parameter of the blockchain
-#[derive(Clone)]
+#[derive(Clone, serde_derive::Serialize)]
 pub struct LedgerStaticParameters {
     pub block0_initial_hash: HeaderHash,
     pub block0_start_time: config::Block0Date,
@@ -40,7 +40,7 @@ pub struct LedgerParameters {
 ///
 /// The ledger can be easily and cheaply cloned despite containing reference
 /// to a lot of data (millions of utxos, thousands of accounts, ..)
-#[derive(Clone)]
+#[derive(Clone, serde_derive::Serialize)]
 pub struct Ledger {
     pub(crate) utxos: utxo::Ledger<Address>,
     pub(crate) oldutxos: utxo::Ledger<legacy::OldAddress>,

chain-impl-mockchain/src/message/config.rs

@@ -2,12 +2,7 @@ use crate::config::ConfigParam;
 use chain_core::mempack::{ReadBuf, ReadError, Readable};
 use chain_core::property;
 
-#[derive(Debug, Clone, PartialEq, Eq)]
-#[cfg_attr(
-    feature = "generic-serialization",
-    derive(serde_derive::Serialize, serde_derive::Deserialize),
-    serde(transparent)
-)]
+#[derive(Debug, Clone, PartialEq, Eq, serde_derive::Serialize)]
 pub struct ConfigParams(pub(crate) Vec<ConfigParam>);
 
 impl ConfigParams {

chain-impl-mockchain/src/milli.rs

@@ -3,7 +3,7 @@ use std::{fmt, iter};
 
 const MILLI_MULTIPLIER: u64 = 1000;
 
-#[derive(Clone, Copy, Debug, Default, Eq, Ord, PartialEq, PartialOrd)]
+#[derive(Clone, Copy, Debug, Default, Eq, Ord, PartialEq, PartialOrd, serde_derive::Serialize)]
 pub struct Milli(u64);
 
 impl Milli {

chain-impl-mockchain/src/multisig/declaration.rs

@@ -5,7 +5,7 @@ use super::index::{Index, TreeIndex, LEVEL_MAXLIMIT};
 pub use crate::transaction::WitnessMultisigData;
 
 /// Account Identifier (also used as Public Key)
-#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
+#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, serde_derive::Serialize)]
 pub struct Identifier(key::Hash);
 
 impl AsRef<[u8]> for Identifier {
@@ -39,7 +39,7 @@ impl std::fmt::Display for Identifier {
 ///
 /// * a threshold that need to be between 1 and the size of owners
 /// * a bunch of owners which is either a hash of a key, or a sub declaration
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, serde_derive::Serialize)]
 pub struct Declaration {
     pub(crate) threshold: u8, // between 1 and len(owners)
     pub(crate) owners: Vec<DeclElement>,
@@ -55,7 +55,7 @@ impl Declaration {
     }
 }
 
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, serde_derive::Serialize)]
 pub enum DeclElement {
     Sub(Declaration),
     Owner(key::Hash),

chain-impl-mockchain/src/multisig/ledger.rs

@@ -5,7 +5,7 @@ use super::declaration::{Declaration, DeclarationError, Identifier};
 use crate::accounting::account::{self, SpendingCounter};
 use crate::value::{Value, ValueError};
 
-#[derive(Clone)]
+#[derive(Clone, serde_derive::Serialize)]
 pub struct Ledger {
     // TODO : investigate about merging the declarations and the accounts in
     // one with an extension on the account::Ledger

chain-impl-mockchain/src/setting.rs

@@ -14,7 +14,7 @@ use chain_time::era::TimeEra;
 use std::convert::TryFrom;
 use std::sync::Arc;
 
-#[derive(Clone, Debug, Eq, PartialEq)]
+#[derive(Clone, Debug, Eq, PartialEq, serde_derive::Serialize)]
 pub struct Settings {
     pub era: TimeEra,
     pub consensus_version: ConsensusVersion,

chain-impl-mockchain/src/stake/delegation.rs

@@ -7,7 +7,7 @@ use crate::transaction::AccountIdentifier;
 pub type PoolTable = Hamt<DefaultHasher, StakePoolId, StakePoolInfo>;
 
 /// A structure that keeps track of stake keys and stake pools.
-#[derive(Clone)]
+#[derive(Clone, serde_derive::Serialize)]
 pub struct DelegationState {
     pub(crate) stake_pools: PoolTable,
 }

chain-impl-mockchain/src/stake/role.rs

@@ -5,10 +5,10 @@ use crate::leadership::genesis::GenesisPraosLeader;
 use chain_core::mempack::{ReadBuf, ReadError, Readable};
 use chain_core::property;
 
-#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
+#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord, serde_derive::Serialize)]
 pub struct StakePoolId(Hash);
 
-#[derive(Debug, Clone, PartialEq, Eq)]
+#[derive(Debug, Clone, PartialEq, Eq, serde_derive::Serialize)]
 pub struct StakePoolInfo {
     pub serial: u128,
     pub owners: Vec<account::Identifier>,

chain-impl-mockchain/src/transaction/transfer.rs

@@ -183,7 +183,7 @@ impl Readable for Input {
 
 /// Information how tokens are spent.
 /// A value of tokens is sent to the address.
-#[derive(Debug, Clone, PartialEq, Eq, Hash)]
+#[derive(Debug, Clone, PartialEq, Eq, Hash, serde_derive::Serialize)]
 pub struct Output<Address> {
     pub address: Address,
     pub value: Value,

chain-impl-mockchain/src/update.rs

@@ -7,7 +7,7 @@ use chain_crypto::{Ed25519, Ed25519Extended, PublicKey, SecretKey, Verification}
 use std::collections::{BTreeMap, HashSet};
 use std::iter;
 
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, serde_derive::Serialize)]
 pub struct UpdateState {
     // Note: we use a BTreeMap to ensure that proposals are processed
     // in a well-defined (sorted) order.
@@ -132,7 +132,7 @@ impl UpdateState {
     }
 }
 
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, serde_derive::Serialize)]
 pub struct UpdateProposalState {
     pub proposal: UpdateProposal,
     pub proposal_date: BlockDate,
@@ -215,7 +215,7 @@ impl std::error::Error for Error {}
 pub type UpdateProposalId = crate::message::MessageId;
 pub type UpdateVoterId = bft::LeaderId;
 
-#[derive(Clone, Debug, PartialEq, Eq)]
+#[derive(Clone, Debug, PartialEq, Eq, serde_derive::Serialize)]
 pub struct UpdateProposal {
     pub changes: ConfigParams,
 }
@@ -446,4 +446,6 @@ mod test {
             }
         }
     }
+
+    // FIXME: add update tests
 }