feat(rust): Create new jormungandr-vote-tx crate (#76)

Mr-Leshiy · web-flow · commit fdbd960b3753 · 2024-11-01T11:23:47.000+02:00
* add new jormungandr-vote-tx crate

* move code from the catalyst-voting crate to jorm-vote-tx

* update doc test

* fix link

* refactor Arbitrary impl

* refactor proptest::Arbitrary impl

* wip

* fix earthfile

* fix cargo deny

* remove feature flags
diff --git a/rust/Cargo.toml b/rust/Cargo.toml
@@ -7,7 +7,7 @@ members = [
     "cbork",
     "cbork-abnf-parser",
     "cbork-cddl-parser",
-    "catalyst-voting",
+    "catalyst-voting", "jormungandr-vote-tx",
 ]
 
 [workspace.package]
diff --git a/rust/Earthfile b/rust/Earthfile
@@ -10,7 +10,7 @@ COPY_SRC:
         .cargo .config \
         c509-certificate \
         cardano-chain-follower \
-        catalyst-voting \
+        catalyst-voting jormungandr-vote-tx \
         cbork cbork-abnf-parser cbork-cddl-parser \
         hermes-ipfs \
         .
@@ -53,7 +53,7 @@ build:
         --cmd="/scripts/std_build.py" \
         --args1="--libs=c509-certificate --libs=cardano-chain-follower --libs=hermes-ipfs" \
         --args2="--libs=cbork-cddl-parser --libs=cbork-abnf-parser" \
-        --args3="--libs=catalyst-voting" \
+        --args3="--libs=catalyst-voting --libs=jormungandr-vote-tx" \
         --args4="--bins=cbork/cbork" \
         --args5="--cov_report=$HOME/build/coverage-report.info" \
         --output="release/[^\./]+" \
diff --git a/rust/catalyst-voting/Cargo.toml b/rust/catalyst-voting/Cargo.toml
@@ -24,10 +24,10 @@ curve25519-dalek = { version = "4.1.3", features = ["digest", "rand_core"] }
 ed25519-dalek = { version = "2.1.1", features = ["rand_core"] }
 blake2b_simd = "1.0.2"
 rayon = "1.10.0"
+proptest = { version = "1.5.0" }
 
 [dev-dependencies]
 criterion = "0.5.1"
-proptest = { version = "1.5.0" }
 # Potentially it could be replaced with using `proptest::property_test` attribute macro,
 # after this PR will be merged https://github.com/proptest-rs/proptest/pull/523
 test-strategy = "0.4.0"
diff --git a/rust/catalyst-voting/benches/vote_protocol.rs b/rust/catalyst-voting/benches/vote_protocol.rs
@@ -12,7 +12,7 @@
 )]
 
 use catalyst_voting::{
-    crypto::default_rng,
+    crypto::rng::default_rng,
     vote_protocol::{
         committee::{ElectionPublicKey, ElectionSecretKey},
         tally::{
diff --git a/rust/catalyst-voting/src/crypto/ed25519/mod.rs b/rust/catalyst-voting/src/crypto/ed25519/mod.rs
@@ -5,7 +5,8 @@ mod decoding;
 use ed25519_dalek::{
     ed25519::signature::Signer, Signature as Ed25519Signature, SigningKey, VerifyingKey,
 };
-use rand_core::CryptoRngCore;
+
+use crate::crypto::rng::rand_core::CryptoRngCore;
 
 /// `Ed25519` private key struct.
 #[must_use]
@@ -45,12 +46,11 @@ pub fn verify_signature(pk: &PublicKey, msg: &[u8], sig: &Signature) -> bool {
     pk.0.verify_strict(msg, &sig.0).is_ok()
 }
 
-#[cfg(test)]
-mod tests {
+#[allow(missing_docs, clippy::missing_docs_in_private_items)]
+mod arbitrary_impl {
     use proptest::prelude::{any, Arbitrary, BoxedStrategy, Strategy};
-    use test_strategy::proptest;
 
-    use super::*;
+    use super::{PrivateKey, SigningKey};
 
     impl Arbitrary for PrivateKey {
         type Parameters = ();
@@ -62,6 +62,13 @@ mod tests {
                 .boxed()
         }
     }
+}
+
+#[cfg(test)]
+mod tests {
+    use test_strategy::proptest;
+
+    use super::*;
 
     #[proptest]
     fn sign_test(private_key: PrivateKey, msg: Vec<u8>) {
diff --git a/rust/catalyst-voting/src/crypto/elgamal/mod.rs b/rust/catalyst-voting/src/crypto/elgamal/mod.rs
@@ -66,15 +66,14 @@ impl Add<&Ciphertext> for &Ciphertext {
     }
 }
 
-#[cfg(test)]
-mod tests {
+#[allow(missing_docs, clippy::missing_docs_in_private_items)]
+mod arbitrary_impl {
     use proptest::{
         arbitrary::any,
         prelude::{Arbitrary, BoxedStrategy, Strategy},
     };
-    use test_strategy::proptest;
 
-    use super::*;
+    use super::{Ciphertext, GroupElement};
 
     impl Arbitrary for Ciphertext {
         type Parameters = ();
@@ -86,6 +85,13 @@ mod tests {
                 .boxed()
         }
     }
+}
+
+#[cfg(test)]
+mod tests {
+    use test_strategy::proptest;
+
+    use super::*;
 
     #[proptest]
     fn ciphertext_add_test(e1: Scalar, e2: Scalar, e3: Scalar, e4: Scalar) {
diff --git a/rust/catalyst-voting/src/crypto/group/ristretto255/mod.rs b/rust/catalyst-voting/src/crypto/group/ristretto255/mod.rs
@@ -15,9 +15,11 @@ use curve25519_dalek::{
     traits::Identity,
     RistrettoPoint,
 };
-use rand_core::CryptoRngCore;
 
-use crate::crypto::hash::digest::{consts::U64, Digest};
+use crate::crypto::{
+    hash::digest::{consts::U64, Digest},
+    rng::rand_core::CryptoRngCore,
+};
 
 /// Ristretto group scalar.
 #[derive(Debug, Clone, PartialEq, Eq)]
@@ -157,15 +159,14 @@ impl Sub<&GroupElement> for &GroupElement {
     }
 }
 
-#[cfg(test)]
-mod tests {
+#[allow(missing_docs, clippy::missing_docs_in_private_items)]
+mod arbitrary_impl {
     use proptest::{
         arbitrary::any,
         prelude::{Arbitrary, BoxedStrategy, Strategy},
     };
-    use test_strategy::proptest;
 
-    use super::*;
+    use super::{GroupElement, Mul, Scalar};
 
     impl Arbitrary for Scalar {
         type Parameters = ();
@@ -186,6 +187,13 @@ mod tests {
                 .boxed()
         }
     }
+}
+
+#[cfg(test)]
+mod tests {
+    use test_strategy::proptest;
+
+    use super::*;
 
     #[proptest]
     fn scalar_arithmetic_tests(e1: Scalar, e2: Scalar, e3: Scalar) {
diff --git a/rust/catalyst-voting/src/crypto/mod.rs b/rust/catalyst-voting/src/crypto/mod.rs
@@ -1,20 +1,10 @@
 //! Crypto primitives which are used by voting protocol.
 
-// cspell: words Seedable
-
-use rand_chacha::ChaCha8Rng;
-use rand_core::{CryptoRngCore, SeedableRng};
-
 pub mod babystep_giantstep;
 pub mod ed25519;
 pub mod elgamal;
 pub mod group;
 pub mod hash;
+pub mod rng;
 pub mod zk_dl_equality;
 pub mod zk_unit_vector;
-
-/// Default random number generator `rand_chacha::ChaCha8Rng`.
-#[must_use]
-pub fn default_rng() -> impl CryptoRngCore {
-    ChaCha8Rng::from_entropy()
-}
diff --git a/rust/catalyst-voting/src/crypto/rng.rs b/rust/catalyst-voting/src/crypto/rng.rs
@@ -0,0 +1,14 @@
+//! Random number generator objects.
+
+// cspell: words Seedable
+
+use rand_chacha::ChaCha8Rng;
+pub use rand_core;
+use rand_core::{CryptoRngCore, SeedableRng};
+
+/// Default random number generator `rand_chacha::ChaCha8Rng`.
+#[must_use]
+#[allow(clippy::module_name_repetitions)]
+pub fn default_rng() -> impl CryptoRngCore {
+    ChaCha8Rng::from_entropy()
+}
diff --git a/rust/catalyst-voting/src/crypto/zk_unit_vector/mod.rs b/rust/catalyst-voting/src/crypto/zk_unit_vector/mod.rs
@@ -16,14 +16,14 @@ use std::ops::Mul;
 
 use challenges::{calculate_first_challenge_hash, calculate_second_challenge_hash};
 use polynomial::{calculate_polynomial_val, generate_polynomial, Polynomial};
-use rand_core::CryptoRngCore;
 use randomness_announcements::{Announcement, BlindingRandomness, ResponseRandomness};
 use rayon::iter::{IndexedParallelIterator, IntoParallelRefIterator, ParallelIterator};
 use utils::get_bit;
 
 use crate::crypto::{
     elgamal::{encrypt, Ciphertext},
     group::{GroupElement, Scalar},
+    rng::rand_core::CryptoRngCore,
 };
 
 /// Unit vector proof struct
@@ -235,16 +235,14 @@ fn check_2(
     &right_1 + &right_2 == left
 }
 
-#[cfg(test)]
-mod tests {
+#[allow(missing_docs, clippy::missing_docs_in_private_items)]
+mod arbitrary_impl {
     use proptest::{
         prelude::{any_with, Arbitrary, BoxedStrategy, Strategy},
         sample::size_range,
     };
-    use rand_core::OsRng;
-    use test_strategy::proptest;
 
-    use super::{super::elgamal::generate_public_key, *};
+    use super::{Announcement, Ciphertext, ResponseRandomness, Scalar, UnitVectorProof};
 
     impl Arbitrary for UnitVectorProof {
         type Parameters = usize;
@@ -263,6 +261,15 @@ mod tests {
             .boxed()
         }
     }
+}
+
+#[cfg(test)]
+mod tests {
+    use proptest::sample::size_range;
+    use rand_core::OsRng;
+    use test_strategy::proptest;
+
+    use super::{super::elgamal::generate_public_key, *};
 
     fn is_unit_vector(vector: &[Scalar]) -> bool {
         let ones = vector.iter().filter(|s| s == &&Scalar::one()).count();
diff --git a/rust/catalyst-voting/src/crypto/zk_unit_vector/randomness_announcements.rs b/rust/catalyst-voting/src/crypto/zk_unit_vector/randomness_announcements.rs
@@ -4,9 +4,10 @@
 
 use std::ops::Mul;
 
-use rand_core::CryptoRngCore;
-
-use crate::crypto::group::{GroupElement, Scalar};
+use crate::crypto::{
+    group::{GroupElement, Scalar},
+    rng::rand_core::CryptoRngCore,
+};
 
 /// Randomness generated in the proof, used for the hiding property.
 #[derive(Clone, Debug, Eq, PartialEq)]
@@ -78,14 +79,14 @@ impl ResponseRandomness {
     }
 }
 
-#[cfg(test)]
-mod tests {
+#[allow(missing_docs, clippy::missing_docs_in_private_items)]
+mod arbitrary_impl {
     use proptest::{
         arbitrary::any,
         prelude::{Arbitrary, BoxedStrategy, Strategy},
     };
 
-    use super::*;
+    use super::{Announcement, BlindingRandomness, GroupElement, ResponseRandomness, Scalar};
 
     impl Arbitrary for BlindingRandomness {
         type Parameters = ();
diff --git a/rust/catalyst-voting/src/lib.rs b/rust/catalyst-voting/src/lib.rs
@@ -1,6 +1,5 @@
 //! Voting primitives which are used among Catalyst ecosystem.
 
 pub mod crypto;
-pub mod txs;
 mod utils;
 pub mod vote_protocol;
diff --git a/rust/catalyst-voting/src/txs/mod.rs b/rust/catalyst-voting/src/txs/mod.rs
diff --git a/rust/catalyst-voting/src/utils.rs b/rust/catalyst-voting/src/utils.rs
@@ -2,30 +2,6 @@
 
 use std::io::Read;
 
-/// Read a single byte from the reader.
-#[inline]
-pub(crate) fn read_be_u8<R: Read>(reader: &mut R) -> anyhow::Result<u8> {
-    let mut buf = [0u8; 1];
-    reader.read_exact(&mut buf)?;
-    Ok(u8::from_be_bytes(buf))
-}
-
-/// Read a big-endian u32 from the reader.
-#[inline]
-pub(crate) fn read_be_u32<R: Read>(reader: &mut R) -> anyhow::Result<u32> {
-    let mut buf = [0u8; 4];
-    reader.read_exact(&mut buf)?;
-    Ok(u32::from_be_bytes(buf))
-}
-
-/// Read a big-endian u64 from the reader.
-#[inline]
-pub(crate) fn read_be_u64<R: Read>(reader: &mut R) -> anyhow::Result<u64> {
-    let mut buf = [0u8; 8];
-    reader.read_exact(&mut buf)?;
-    Ok(u64::from_be_bytes(buf))
-}
-
 /// Read a N-byte array from the reader.
 #[inline]
 pub(crate) fn read_array<R: Read, const N: usize>(reader: &mut R) -> anyhow::Result<[u8; N]> {
diff --git a/rust/catalyst-voting/src/vote_protocol/committee/mod.rs b/rust/catalyst-voting/src/vote_protocol/committee/mod.rs
@@ -2,12 +2,10 @@
 
 mod decoding;
 
-use rand_core::CryptoRngCore;
-
 use crate::crypto::{
-    default_rng,
     elgamal::generate_public_key,
     group::{GroupElement, Scalar},
+    rng::{default_rng, rand_core::CryptoRngCore},
 };
 
 /// Election secret key.
@@ -38,11 +36,11 @@ impl ElectionSecretKey {
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct ElectionPublicKey(pub(crate) GroupElement);
 
-#[cfg(test)]
-mod tests {
+#[allow(missing_docs, clippy::missing_docs_in_private_items)]
+mod arbitrary_impl {
     use proptest::prelude::{any, Arbitrary, BoxedStrategy, Strategy};
 
-    use super::*;
+    use super::{ElectionSecretKey, Scalar};
 
     impl Arbitrary for ElectionSecretKey {
         type Parameters = ();
diff --git a/rust/catalyst-voting/src/vote_protocol/tally/proof.rs b/rust/catalyst-voting/src/vote_protocol/tally/proof.rs
@@ -3,13 +3,11 @@
 
 use std::ops::Mul;
 
-use rand_core::CryptoRngCore;
-
 use super::EncryptedTally;
 use crate::{
     crypto::{
-        default_rng,
         group::{GroupElement, Scalar},
+        rng::{default_rng, rand_core::CryptoRngCore},
         zk_dl_equality::{generate_dleq_proof, verify_dleq_proof, DleqProof},
     },
     vote_protocol::committee::{ElectionPublicKey, ElectionSecretKey},
diff --git a/rust/catalyst-voting/src/vote_protocol/voter/decoding.rs b/rust/catalyst-voting/src/vote_protocol/voter/decoding.rs
@@ -12,7 +12,8 @@ use crate::{
 
 impl EncryptedVote {
     /// Get an underlying vector length.
-    pub(crate) fn size(&self) -> usize {
+    #[must_use]
+    pub fn size(&self) -> usize {
         self.0.len()
     }
 
diff --git a/rust/catalyst-voting/src/vote_protocol/voter/mod.rs b/rust/catalyst-voting/src/vote_protocol/voter/mod.rs
diff --git a/rust/catalyst-voting/src/vote_protocol/voter/proof.rs b/rust/catalyst-voting/src/vote_protocol/voter/proof.rs
diff --git a/rust/jormungandr-vote-tx/Cargo.toml b/rust/jormungandr-vote-tx/Cargo.toml
diff --git a/rust/jormungandr-vote-tx/src/decoding.rs b/rust/jormungandr-vote-tx/src/decoding.rs
diff --git a/rust/jormungandr-vote-tx/src/lib.rs b/rust/jormungandr-vote-tx/src/lib.rs
diff --git a/rust/jormungandr-vote-tx/src/utils.rs b/rust/jormungandr-vote-tx/src/utils.rs

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ members = [`
`7`	`7`	`"cbork",`
`8`	`8`	`"cbork-abnf-parser",`
`9`	`9`	`"cbork-cddl-parser",`
`10`		`- "catalyst-voting",`
	`10`	`+ "catalyst-voting", "jormungandr-vote-tx",`
`11`	`11`	`]`
`12`	`12`
`13`	`13`	`[workspace.package]`