Refactor protocol demo types

Also remove the 'allow_skip_signer_certification' feature that was misused.
Use directly 'mithril-stm' as dependency in this crate to retrieve protocol types.

Author: jpraynaud

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "mithrildemo"
-version = "0.1.0"
+version = "0.1.1"
 authors = { workspace = true }
 edition = { workspace = true }
 documentation = { workspace = true }
@@ -10,14 +10,23 @@ repository = { workspace = true }
 
 [dependencies]
 base64 = "0.13.0"
+blake2 = "0.10.4"
 clap = { version = "4.0.18", features = ["derive"] }
 hex = "0.4.3"
 log = "0.4.14"
-mithril-common = { path = "../../mithril-common", features = ["allow_skip_signer_certification"] }
+mithril-common = { path = "../../mithril-common" }
 rand_chacha = "0.3.1"
 rand_core   = "0.6.3"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 
+[target.'cfg(not(windows))'.dependencies]
+# non-windows: use default rug backend
+mithril-stm = { path = "../../mithril-stm" }
+
+[target.'cfg(windows)'.dependencies]
+# Windows doesn't support rug backend, fallback to num-integer
+mithril-stm = { path = "../../mithril-stm", default-features = false, features = ["num-integer-backend"] }
+
 [features]
-portable = ["mithril-common/portable"]
+portable = ["mithril-common/portable", "mithril-stm/portable"]

demo/protocol-demo/Cargo.toml

@@ -7,11 +7,12 @@ use std::fs;
 use std::io::Write;
 use std::path;
 
-use mithril_common::crypto_helper::{
-    key_decode_hex, key_encode_hex, ProtocolClerk, ProtocolInitializerNotCertified,
-    ProtocolKeyRegistrationNotCertified, ProtocolMultiSignature, ProtocolParameters,
-    ProtocolPartyId, ProtocolSigner, ProtocolSignerVerificationKey, ProtocolSingleSignature,
-    ProtocolStake,
+use mithril_common::crypto_helper::{key_decode_hex, key_encode_hex};
+
+use crate::types::{
+    ProtocolClerk, ProtocolInitializerNotCertified, ProtocolKeyRegistrationNotCertified,
+    ProtocolMultiSignature, ProtocolParameters, ProtocolPartyId, ProtocolSigner,
+    ProtocolSignerVerificationKey, ProtocolSingleSignature, ProtocolStake,
 };
 
 /// Player artifacts

demo/protocol-demo/src/demonstrator.rs

@@ -1,4 +1,5 @@
 mod demonstrator;
+mod types;
 
 use crate::demonstrator::{Demonstrator, ProtocolDemonstrator};
 use clap::Parser;

demo/protocol-demo/src/main.rs

@@ -0,0 +1,40 @@
+use mithril_stm::key_reg::KeyReg;
+use mithril_stm::stm::{
+    Stake, StmAggrSig, StmClerk, StmInitializer, StmParameters, StmSig, StmSigner,
+    StmVerificationKeyPoP,
+};
+
+use blake2::{digest::consts::U32, Blake2b};
+
+// Protocol types alias
+type D = Blake2b<U32>;
+
+/// The id of a mithril party.
+pub type ProtocolPartyId = String;
+
+/// Alias of [MithrilStm:Stake](type@mithril_stm::stm::Stake).
+pub type ProtocolStake = Stake;
+
+/// Alias of [MithrilStm::StmParameters](struct@mithril_stm::stm::StmParameters).
+pub type ProtocolParameters = StmParameters;
+
+/// Alias of [MithrilStm:StmSigner](struct@mithril_stm::stm::StmSigner).
+pub type ProtocolSigner = StmSigner<D>;
+
+/// Alias of [MithrilStm:StmClerk](struct@mithril_stm::stm::StmClerk).
+pub type ProtocolClerk = StmClerk<D>;
+
+/// Alias of [MithrilStm:StmInitializer](struct@mithril_stm::stm::StmInitializer).
+pub type ProtocolInitializerNotCertified = StmInitializer;
+
+/// Alias of [MithrilStm:KeyReg](struct@mithril_stm::key_reg::KeyReg). (Test only)
+pub type ProtocolKeyRegistrationNotCertified = KeyReg;
+
+/// Alias of [MithrilStm:StmSig](struct@mithril_stm::stm::StmSig).
+pub type ProtocolSingleSignature = StmSig;
+
+/// Alias of [MithrilStm:StmAggrSig](struct@mithril_stm::stm::StmAggrSig).
+pub type ProtocolMultiSignature = StmAggrSig<D>;
+
+/// Alias of [MithrilStm:StmVerificationKeyPoP](type@mithril_stm::stm::StmVerificationKeyPoP).
+pub type ProtocolSignerVerificationKey = StmVerificationKeyPoP;

demo/protocol-demo/src/types.rs

@@ -25,27 +25,24 @@ where
 
 #[cfg(test)]
 pub mod tests {
-    use super::super::tests_setup::*;
-    use super::super::types::*;
-    use super::*;
+    use serde::{Deserialize, Serialize};
 
-    use rand_chacha::ChaCha20Rng;
-    use rand_core::SeedableRng;
+    use super::{key_decode_hex, key_encode_hex};
+
+    #[derive(Debug, PartialEq, Serialize, Deserialize)]
+    struct TestSerialize {
+        inner_string: String,
+    }
 
     #[test]
     fn test_key_encode_decode_hex() {
-        let protocol_params = setup_protocol_parameters();
-        let stake = 100;
-        let seed = [0u8; 32];
-        let mut rng = ChaCha20Rng::from_seed(seed);
-        let protocol_initializer =
-            ProtocolInitializerNotCertified::setup(protocol_params, stake, &mut rng);
-        let verification_key: ProtocolSignerVerificationKey =
-            protocol_initializer.verification_key();
-        let verification_key_hex =
-            key_encode_hex(verification_key).expect("unexpected hex encoding error");
-        let verification_key_restored =
-            key_decode_hex(&verification_key_hex).expect("unexpected hex decoding error");
-        assert_eq!(verification_key, verification_key_restored);
+        let test_to_serialize = TestSerialize {
+            inner_string: "my inner string".to_string(),
+        };
+        let test_to_serialize_hex =
+            key_encode_hex(&test_to_serialize).expect("unexpected hex encoding error");
+        let test_to_serialize_restored =
+            key_decode_hex(&test_to_serialize_hex).expect("unexpected hex decoding error");
+        assert_eq!(test_to_serialize, test_to_serialize_restored);
     }
 }

mithril-common/src/crypto_helper/codec.rs

@@ -8,9 +8,6 @@ use mithril_stm::stm::{
 };
 use mithril_stm::AggregationError;
 
-#[cfg(any(test, feature = "allow_skip_signer_certification"))]
-use mithril_stm::{key_reg::KeyReg, stm::StmInitializer};
-
 use blake2::{digest::consts::U32, Blake2b};
 use ed25519_dalek;
 use kes_summed_ed25519::kes::Sum6KesSig;
@@ -78,12 +75,3 @@ pub type ProtocolRegistrationError = ProtocolRegistrationErrorWrapper;
 
 /// Alias of [MithrilStm:AggregationError](enum@mithril_stm::AggregationError).
 pub type ProtocolAggregationError = AggregationError;
-
-// Test only
-/// (Test only) Alias of [MithrilStm:StmInitializer](struct@mithril_stm::stm::StmInitializer).
-#[cfg(any(test, feature = "allow_skip_signer_certification"))]
-pub type ProtocolInitializerNotCertified = StmInitializer;
-
-/// (Test only) Alias of [MithrilStm:KeyReg](struct@mithril_stm::key_reg::KeyReg). (Test only)
-#[cfg(any(test, feature = "allow_skip_signer_certification"))]
-pub type ProtocolKeyRegistrationNotCertified = KeyReg;