Merge branch 'main' into block_ser_ledger

cong-or · web-flow · commit 19a81ef31fb9 · 2024-11-14T09:38:10.000Z
diff --git a/.github/workflows/semantic_pull_request.yml b/.github/workflows/semantic_pull_request.yml
@@ -20,6 +20,8 @@ jobs:
         rust/cardano-chain-follower
         rust/catalyst-voting
         rust/immutable-ledger
+        rust/vote-tx-v1
+        rust/vote-tx-v2
         rust/cbork
         rust/hermes-ipfs
         dart
diff --git a/docs/src/architecture/08_concepts/catalyst_voting/cddl/gen_vote_tx.cddl b/docs/src/architecture/08_concepts/catalyst_voting/cddl/gen_vote_tx.cddl
@@ -7,7 +7,7 @@ tx-body<choice-t, proof-t, prop-id-t> = [
     vote-type
     event,
     votes<choice-t, proof-t, prop-id-t>,
-    voters-data,
+    voter-data,
 ]
 
 vote-type = UUID ; e.g. Public or Private vote
@@ -25,7 +25,7 @@ choice<choice-t> = #6.24(bytes .cbor choice-t) ; encoded-cbor
 proof<proof-t> = #6.24(bytes .cbor proof-t) ; encoded-cbor
 prop-id<prop-id-t> = #6.24(bytes .cbor prop-id-t) ; encoded-cbor
 
-voters-data = encoded-cbor
+voter-data = encoded-cbor
 
 UUID = #6.37(bytes) ; UUID type
 signature = #6.98(cose.COSE_Sign) ; COSE signature
diff --git a/docs/src/architecture/08_concepts/catalyst_voting/gen_vote_tx.md b/docs/src/architecture/08_concepts/catalyst_voting/gen_vote_tx.md
@@ -42,7 +42,7 @@ Vote:
   so it's redundant to provide an additional identifier for the proposal,
   so it could be placed `null`.
 
-`voters-data` - an any additional voter's specific data.
+`voter-data` - an any additional voter's specific data.
 
 ### Transaction signing
 
diff --git a/rust/Cargo.toml b/rust/Cargo.toml
@@ -10,6 +10,8 @@ members = [
     "catalyst-voting",
     "catalyst-voting", "jormungandr-vote-tx",
     "immutable-ledger",
+    "vote-tx-v1",
+    "vote-tx-v2",
 ]
 
 [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 jormungandr-vote-tx \
+        catalyst-voting vote-tx-v1 vote-tx-v2 \
         cbork cbork-abnf-parser cbork-cddl-parser \
         hermes-ipfs \
         immutable-ledger .
@@ -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 --libs=jormungandr-vote-tx" \
+        --args3="--libs=catalyst-voting --libs=vote-tx-v1 --libs=vote-tx-v2" \
         --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/src/crypto/ed25519/mod.rs b/rust/catalyst-voting/src/crypto/ed25519/mod.rs
@@ -6,6 +6,7 @@ use ed25519_dalek::{
     ed25519::signature::Signer, Signature as Ed25519Signature, SigningKey, VerifyingKey,
 };
 
+use super::rng::default_rng;
 use crate::crypto::rng::rand_core::CryptoRngCore;
 
 /// `Ed25519` private key struct.
@@ -19,6 +20,11 @@ impl PrivateKey {
         Self(SigningKey::generate(rng))
     }
 
+    /// Randomly generate the `ElectionSecretKey` with the `crypto::default_rng`.
+    pub fn random_with_default_rng() -> Self {
+        Self::random(&mut default_rng())
+    }
+
     /// Get associated `Ed25519` public key.
     pub fn public_key(&self) -> PublicKey {
         PublicKey(self.0.verifying_key())
@@ -46,7 +52,7 @@ pub fn verify_signature(pk: &PublicKey, msg: &[u8], sig: &Signature) -> bool {
     pk.0.verify_strict(msg, &sig.0).is_ok()
 }
 
-#[allow(missing_docs, clippy::missing_docs_in_private_items)]
+#[cfg(test)]
 mod arbitrary_impl {
     use proptest::prelude::{any, Arbitrary, BoxedStrategy, Strategy};
 
diff --git a/rust/catalyst-voting/src/crypto/elgamal/mod.rs b/rust/catalyst-voting/src/crypto/elgamal/mod.rs
@@ -66,7 +66,7 @@ impl Add<&Ciphertext> for &Ciphertext {
     }
 }
 
-#[allow(missing_docs, clippy::missing_docs_in_private_items)]
+#[cfg(test)]
 mod arbitrary_impl {
     use proptest::{
         arbitrary::any,
diff --git a/rust/catalyst-voting/src/crypto/group/ristretto255/mod.rs b/rust/catalyst-voting/src/crypto/group/ristretto255/mod.rs
@@ -159,7 +159,7 @@ impl Sub<&GroupElement> for &GroupElement {
     }
 }
 
-#[allow(missing_docs, clippy::missing_docs_in_private_items)]
+#[cfg(test)]
 mod arbitrary_impl {
     use proptest::{
         arbitrary::any,
diff --git a/rust/catalyst-voting/src/crypto/zk_unit_vector/mod.rs b/rust/catalyst-voting/src/crypto/zk_unit_vector/mod.rs
@@ -235,7 +235,7 @@ fn check_2(
     &right_1 + &right_2 == left
 }
 
-#[allow(missing_docs, clippy::missing_docs_in_private_items)]
+#[cfg(test)]
 mod arbitrary_impl {
     use proptest::{
         prelude::{any_with, Arbitrary, BoxedStrategy, Strategy},
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
@@ -79,7 +79,7 @@ impl ResponseRandomness {
     }
 }
 
-#[allow(missing_docs, clippy::missing_docs_in_private_items)]
+#[cfg(test)]
 mod arbitrary_impl {
     use proptest::{
         arbitrary::any,
diff --git a/rust/catalyst-voting/src/vote_protocol/committee/mod.rs b/rust/catalyst-voting/src/vote_protocol/committee/mod.rs
@@ -36,7 +36,7 @@ impl ElectionSecretKey {
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct ElectionPublicKey(pub(crate) GroupElement);
 
-#[allow(missing_docs, clippy::missing_docs_in_private_items)]
+#[cfg(test)]
 mod arbitrary_impl {
     use proptest::prelude::{any, Arbitrary, BoxedStrategy, Strategy};
 
diff --git a/rust/catalyst-voting/src/vote_protocol/voter/mod.rs b/rust/catalyst-voting/src/vote_protocol/voter/mod.rs
@@ -141,7 +141,7 @@ pub fn decrypt_vote(vote: &EncryptedVote, secret_key: &ElectionSecretKey) -> any
     bail!("Invalid encrypted vote, not a valid unit vector.")
 }
 
-#[allow(missing_docs, clippy::missing_docs_in_private_items)]
+#[cfg(test)]
 mod arbitrary_impl {
     use proptest::{
         prelude::{any_with, Arbitrary, BoxedStrategy, Strategy},
diff --git a/rust/catalyst-voting/src/vote_protocol/voter/proof.rs b/rust/catalyst-voting/src/vote_protocol/voter/proof.rs
@@ -107,7 +107,7 @@ pub fn verify_voter_proof(
     verify_unit_vector_proof(&proof.0, encrypted_vote.0, &public_key.0, &commitment.0)
 }
 
-#[allow(missing_docs, clippy::missing_docs_in_private_items)]
+#[cfg(test)]
 mod arbitrary_impl {
     use proptest::prelude::{any_with, Arbitrary, BoxedStrategy, Strategy};
 
diff --git a/rust/vote-tx-v1/Cargo.toml b/rust/vote-tx-v1/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "jormungandr-vote-tx"
+name = "vote-tx-v1"
 version = "0.0.1"
 edition.workspace = true
 authors.workspace = true
@@ -13,9 +13,9 @@ workspace = true
 [dependencies]
 catalyst-voting = { version = "0.0.1", path = "../catalyst-voting" }
 anyhow = "1.0.89"
-proptest = { version = "1.5.0" }
 
 [dev-dependencies]
+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/vote-tx-v1/src/decoding.rs b/rust/vote-tx-v1/src/decoding.rs
@@ -216,12 +216,31 @@ impl Tx {
 
 #[cfg(test)]
 mod tests {
+    use catalyst_voting::{
+        crypto::{ed25519::PrivateKey, rng::rand_core::OsRng},
+        vote_protocol::committee::ElectionSecretKey,
+    };
     use test_strategy::proptest;
 
     use super::*;
 
     #[proptest]
-    fn tx_to_bytes_from_bytes_test(t1: Tx) {
+    fn tx_public_to_bytes_from_bytes_test(
+        vote_plan_id: [u8; 32], proposal_index: u8, #[strategy(1u8..5)] voting_options: u8,
+        #[strategy(0..#voting_options)] choice: u8,
+    ) {
+        let mut rng = OsRng;
+        let users_private_key = PrivateKey::random(&mut rng);
+
+        let t1 = Tx::new_public(
+            vote_plan_id,
+            proposal_index,
+            voting_options,
+            choice,
+            &users_private_key,
+        )
+        .unwrap();
+
         let bytes = t1.to_bytes();
 
         let mut reader = bytes.as_slice();
@@ -242,21 +261,89 @@ mod tests {
         assert_eq!(proposal_index, t1.proposal_index);
 
         let vote_tag = read_be_u8(&mut reader).unwrap();
-        assert!(vote_tag == PUBLIC_VOTE_TAG || vote_tag == PRIVATE_VOTE_TAG);
-        match vote_tag {
-            PUBLIC_VOTE_TAG => {
-                let vote = read_be_u8(&mut reader).unwrap();
-                assert_eq!(VotePayload::Public(vote), t1.vote);
-            },
-            PRIVATE_VOTE_TAG => {
-                let size = read_be_u8(&mut reader).unwrap();
-                let vote = EncryptedVote::from_bytes(&mut reader, size.into()).unwrap();
-                let size = read_be_u8(&mut reader).unwrap();
-                let proof = VoterProof::from_bytes(&mut reader, size.into()).unwrap();
-                assert_eq!(VotePayload::Private(vote, proof), t1.vote);
-            },
-            _ => {},
-        }
+        assert!(vote_tag == PUBLIC_VOTE_TAG);
+
+        let vote = read_be_u8(&mut reader).unwrap();
+        assert_eq!(VotePayload::Public(vote), t1.vote);
+
+        let block_date = read_be_u64(&mut reader).unwrap();
+        assert_eq!(block_date, 0);
+
+        let inputs_amount = read_be_u8(&mut reader).unwrap();
+        assert_eq!(inputs_amount, NUMBER_OF_INPUTS);
+
+        let outputs_amount = read_be_u8(&mut reader).unwrap();
+        assert_eq!(outputs_amount, NUMBER_OF_OUTPUTS);
+
+        let input_tag = read_be_u8(&mut reader).unwrap();
+        assert_eq!(input_tag, INPUT_TAG);
+
+        let value = read_be_u64(&mut reader).unwrap();
+        assert_eq!(value, 0);
+
+        let public_key = read_array(&mut reader).unwrap();
+        assert_eq!(PublicKey::from_bytes(&public_key).unwrap(), t1.public_key);
+
+        let witness_tag = read_be_u8(&mut reader).unwrap();
+        assert_eq!(witness_tag, WITNESS_TAG);
+
+        let nonce = read_be_u32(&mut reader).unwrap();
+        assert_eq!(nonce, 0);
+
+        let signature = read_array(&mut reader).unwrap();
+        assert_eq!(Signature::from_bytes(&signature), t1.signature);
+
+        let t2 = Tx::from_bytes(&mut bytes.as_slice()).unwrap();
+        assert_eq!(t1, t2);
+    }
+
+    #[proptest]
+    fn tx_private_to_bytes_from_bytes_test(
+        vote_plan_id: [u8; 32], proposal_index: u8, #[strategy(1u8..5)] voting_options: u8,
+        #[strategy(0..#voting_options)] choice: u8,
+    ) {
+        let mut rng = OsRng;
+        let users_private_key = PrivateKey::random(&mut rng);
+        let election_secret_key = ElectionSecretKey::random(&mut rng);
+        let election_public_key = election_secret_key.public_key();
+
+        let t1 = Tx::new_private(
+            vote_plan_id,
+            proposal_index,
+            voting_options,
+            choice,
+            &election_public_key,
+            &users_private_key,
+            &mut rng,
+        )
+        .unwrap();
+
+        let bytes = t1.to_bytes();
+
+        let mut reader = bytes.as_slice();
+
+        let size = read_be_u32(&mut reader).unwrap();
+        assert_eq!(size as usize, bytes.len() - 4);
+
+        let padding_tag = read_be_u8(&mut reader).unwrap();
+        assert_eq!(padding_tag, PADDING_TAG);
+
+        let fragment_tag = read_be_u8(&mut reader).unwrap();
+        assert_eq!(fragment_tag, FRAGMENT_TAG);
+
+        let vote_plan_id = read_array(&mut reader).unwrap();
+        assert_eq!(vote_plan_id, t1.vote_plan_id);
+
+        let proposal_index = read_be_u8(&mut reader).unwrap();
+        assert_eq!(proposal_index, t1.proposal_index);
+
+        let vote_tag = read_be_u8(&mut reader).unwrap();
+        assert!(vote_tag == PRIVATE_VOTE_TAG);
+        let size = read_be_u8(&mut reader).unwrap();
+        let vote = EncryptedVote::from_bytes(&mut reader, size.into()).unwrap();
+        let size = read_be_u8(&mut reader).unwrap();
+        let proof = VoterProof::from_bytes(&mut reader, size.into()).unwrap();
+        assert_eq!(VotePayload::Private(vote, proof), t1.vote);
 
         let block_date = read_be_u64(&mut reader).unwrap();
         assert_eq!(block_date, 0);
diff --git a/rust/vote-tx-v1/src/lib.rs b/rust/vote-tx-v1/src/lib.rs
diff --git a/rust/vote-tx-v1/src/utils.rs b/rust/vote-tx-v1/src/utils.rs
diff --git a/rust/vote-tx-v2/Cargo.toml b/rust/vote-tx-v2/Cargo.toml
diff --git a/rust/vote-tx-v2/src/decoding.rs b/rust/vote-tx-v2/src/decoding.rs
diff --git a/rust/vote-tx-v2/src/lib.rs b/rust/vote-tx-v2/src/lib.rs

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@ members = [`
`10`	`10`	`"catalyst-voting",`
`11`	`11`	`"catalyst-voting", "jormungandr-vote-tx",`
`12`	`12`	`"immutable-ledger",`
	`13`	`+ "vote-tx-v1",`
	`14`	`+ "vote-tx-v2",`
`13`	`15`	`]`
`14`	`16`
`15`	`17`	`[workspace.package]`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ impl Add<&Ciphertext> for &Ciphertext {`
`66`	`66`	`}`
`67`	`67`	`}`
`68`	`68`
`69`		`-#[allow(missing_docs, clippy::missing_docs_in_private_items)]`
	`69`	`+#[cfg(test)]`
`70`	`70`	`mod arbitrary_impl {`
`71`	`71`	`use proptest::{`
`72`	`72`	`arbitrary::any,`
Original file line number	Diff line number	Diff line change
`@@ -159,7 +159,7 @@ impl Sub<&GroupElement> for &GroupElement {`
`159`	`159`	`}`
`160`	`160`	`}`
`161`	`161`
`162`		`-#[allow(missing_docs, clippy::missing_docs_in_private_items)]`
	`162`	`+#[cfg(test)]`
`163`	`163`	`mod arbitrary_impl {`
`164`	`164`	`use proptest::{`
`165`	`165`	`arbitrary::any,`
Original file line number	Diff line number	Diff line change
`@@ -235,7 +235,7 @@ fn check_2(`
`235`	`235`	`&right_1 + &right_2 == left`
`236`	`236`	`}`
`237`	`237`
`238`		`-#[allow(missing_docs, clippy::missing_docs_in_private_items)]`
	`238`	`+#[cfg(test)]`
`239`	`239`	`mod arbitrary_impl {`
`240`	`240`	`use proptest::{`
`241`	`241`	`prelude::{any_with, Arbitrary, BoxedStrategy, Strategy},`