protocol module to contain anything else

curiecrypt · curiecrypt · commit 1ec9ee5679d7 · 2025-11-26T14:39:53.000+03:00
diff --git a/mithril-stm/src/lib.rs b/mithril-stm/src/lib.rs
@@ -111,27 +111,12 @@
 //! # }
 //! ```
 
-mod aggregate_signature;
-mod eligibility_check;
-mod error;
-mod key_registration;
 mod membership_commitment;
-mod parameters;
-mod participant;
 mod proof_system;
+mod protocol;
 mod signature_scheme;
-mod single_signature;
 
-pub use aggregate_signature::{
-    AggregateSignature, AggregateSignatureType, AggregateVerificationKey, BasicVerifier, Clerk,
-};
-pub use error::{
-    AggregateSignatureError, AggregationError, MultiSignatureError, RegisterError, SignatureError,
-};
-pub use key_registration::{ClosedKeyRegistration, KeyRegistration};
-pub use parameters::Parameters;
-pub use participant::{Initializer, Signer, VerificationKey, VerificationKeyProofOfPossession};
-pub use single_signature::{SingleSignature, SingleSignatureWithRegisteredParty};
+pub use protocol::*;
 
 #[cfg(feature = "benchmark-internals")]
 pub use signature_scheme::{
@@ -151,49 +136,3 @@ pub type StmError = anyhow::Error;
 
 /// Mithril-stm result type
 pub type StmResult<T> = anyhow::Result<T, StmError>;
-
-// Aliases
-#[deprecated(since = "0.5.0", note = "Use `AggregateSignature` instead")]
-pub use aggregate_signature::AggregateSignature as StmAggrSig;
-
-#[deprecated(since = "0.5.0", note = "Use `AggregateVerificationKey` instead")]
-pub use aggregate_signature::AggregateVerificationKey as StmAggrVerificationKey;
-
-#[deprecated(since = "0.5.0", note = "Use `Clerk` instead")]
-pub use aggregate_signature::Clerk as StmClerk;
-
-#[deprecated(since = "0.5.0", note = "Use `ClosedKeyRegistration` instead")]
-pub use key_registration::ClosedKeyRegistration as ClosedKeyReg;
-
-#[deprecated(since = "0.5.0", note = "Use `KeyRegistration` instead")]
-pub use key_registration::KeyRegistration as KeyReg;
-
-#[deprecated(since = "0.5.0", note = "Use `Parameters` instead")]
-pub use parameters::Parameters as StmParameters;
-
-#[deprecated(since = "0.5.0", note = "Use `Initializer` instead")]
-pub use participant::Initializer as StmInitializer;
-
-#[deprecated(since = "0.5.0", note = "Use `Signer` instead")]
-pub use participant::Signer as StmSigner;
-
-#[deprecated(since = "0.5.0", note = "Use `VerificationKey` instead")]
-pub use participant::VerificationKey as StmVerificationKey;
-
-#[deprecated(
-    since = "0.5.0",
-    note = "Use `VerificationKeyProofOfPossession` instead"
-)]
-pub use participant::VerificationKeyProofOfPossession as StmVerificationKeyPoP;
-
-#[deprecated(since = "0.5.0", note = "Use `SingleSignature` instead")]
-pub use single_signature::SingleSignature as StmSig;
-
-#[deprecated(since = "0.5.0", note = "Use `BasicVerifier` instead")]
-pub use aggregate_signature::BasicVerifier as CoreVerifier;
-
-#[deprecated(
-    since = "0.5.0",
-    note = "Use `SingleSignatureWithRegisteredParty` instead"
-)]
-pub use single_signature::SingleSignatureWithRegisteredParty as StmSigRegParty;
diff --git a/mithril-stm/src/membership_commitment/merkle_tree/commitment.rs b/mithril-stm/src/membership_commitment/merkle_tree/commitment.rs
@@ -3,12 +3,12 @@ use std::marker::PhantomData;
 use blake2::digest::{Digest, FixedOutput};
 use serde::{Deserialize, Serialize};
 
-use crate::StmResult;
-use crate::error::MerkleTreeError;
 use crate::membership_commitment::merkle_tree::{
     MerkleBatchPath, MerklePath, MerkleTreeLeaf, parent, sibling,
 };
+use crate::{MerkleTreeError, StmResult};
 use anyhow::{Context, anyhow};
+
 /// `MerkleTree` commitment.
 /// This structure differs from `MerkleTree` in that it does not contain all elements, which are not always necessary.
 /// Instead, it only contains the root of the tree.
diff --git a/mithril-stm/src/membership_commitment/merkle_tree/leaf.rs b/mithril-stm/src/membership_commitment/merkle_tree/leaf.rs
@@ -2,10 +2,10 @@ use std::cmp::Ordering;
 
 use serde::{Deserialize, Serialize};
 
-use crate::StmResult;
-use crate::error::MerkleTreeError;
 use crate::signature_scheme::BlsVerificationKey;
+use crate::{MerkleTreeError, StmResult};
 use crate::{Stake, VerificationKey};
+
 /// The values that are committed in the Merkle Tree.
 /// Namely, a verified `VerificationKey` and its corresponding stake.
 #[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize, Hash)]
diff --git a/mithril-stm/src/membership_commitment/merkle_tree/path.rs b/mithril-stm/src/membership_commitment/merkle_tree/path.rs
@@ -1,7 +1,6 @@
 use std::marker::PhantomData;
 
-use crate::StmResult;
-use crate::error::MerkleTreeError;
+use crate::{MerkleTreeError, StmResult};
 use blake2::digest::{Digest, FixedOutput};
 use serde::{Deserialize, Serialize};
 
diff --git a/mithril-stm/src/membership_commitment/merkle_tree/tree.rs b/mithril-stm/src/membership_commitment/merkle_tree/tree.rs
@@ -3,12 +3,11 @@ use std::marker::PhantomData;
 use blake2::digest::{Digest, FixedOutput};
 use serde::{Deserialize, Serialize};
 
-use crate::StmResult;
-use crate::error::MerkleTreeError;
 use crate::membership_commitment::merkle_tree::{
     MerkleBatchPath, MerklePath, MerkleTreeBatchCommitment, MerkleTreeCommitment, MerkleTreeLeaf,
     left_child, parent, right_child, sibling,
 };
+use crate::{MerkleTreeError, StmResult};
 
 /// Tree of hashes, providing a commitment of data and its ordering.
 #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
diff --git a/mithril-stm/src/proof_system/concatenation.rs b/mithril-stm/src/proof_system/concatenation.rs
@@ -3,12 +3,11 @@ use blake2::digest::{Digest, FixedOutput};
 
 use serde::{Deserialize, Serialize};
 
-use crate::key_registration::RegisteredParty;
 use crate::membership_commitment::MerkleBatchPath;
 use crate::signature_scheme::{BlsSignature, BlsVerificationKey};
 use crate::{
     AggregateSignatureError, AggregateVerificationKey, BasicVerifier, Clerk, Parameters,
-    SingleSignature, SingleSignatureWithRegisteredParty, StmResult,
+    RegisteredParty, SingleSignature, SingleSignatureWithRegisteredParty, StmResult,
 };
 
 /// `ConcatenationProof` uses the "concatenation" proving system (as described in Section 4.3 of the original paper.)
diff --git a/mithril-stm/src/protocol/aggregate_signature/aggregate_key.rs b/mithril-stm/src/protocol/aggregate_signature/aggregate_key.rs
diff --git a/mithril-stm/src/protocol/aggregate_signature/basic_verifier.rs b/mithril-stm/src/protocol/aggregate_signature/basic_verifier.rs
@@ -1,12 +1,11 @@
 use anyhow::{Context, anyhow};
 use std::collections::{BTreeMap, HashMap, HashSet};
 
-use crate::key_registration::RegisteredParty;
 use crate::membership_commitment::MerkleTreeLeaf;
 use crate::signature_scheme::{BlsSignature, BlsVerificationKey};
 use crate::{
-    AggregationError, Index, Parameters, SingleSignature, SingleSignatureWithRegisteredParty,
-    Stake, StmResult,
+    AggregationError, Index, Parameters, RegisteredParty, SingleSignature,
+    SingleSignatureWithRegisteredParty, Stake, StmResult,
 };
 
 /// Full node verifier including the list of eligible signers and the total stake of the system.
diff --git a/mithril-stm/src/protocol/aggregate_signature/clerk.rs b/mithril-stm/src/protocol/aggregate_signature/clerk.rs
diff --git a/mithril-stm/src/protocol/aggregate_signature/mod.rs b/mithril-stm/src/protocol/aggregate_signature/mod.rs
@@ -24,9 +24,9 @@ mod tests {
     use crate::{
         AggregateSignature, AggregateSignatureType, AggregationError, BasicVerifier, Clerk,
         Initializer, KeyRegistration, Parameters, Signer, SingleSignature,
-        SingleSignatureWithRegisteredParty, Stake, signature_scheme::BlsVerificationKey,
+        SingleSignatureWithRegisteredParty, Stake, StmResult,
+        membership_commitment::MerkleBatchPath, signature_scheme::BlsVerificationKey,
     };
-    use crate::{StmResult, membership_commitment::MerkleBatchPath};
 
     type Sig = AggregateSignature<D>;
     type D = Blake2b<U32>;
diff --git a/mithril-stm/src/protocol/aggregate_signature/signature.rs b/mithril-stm/src/protocol/aggregate_signature/signature.rs
@@ -6,9 +6,11 @@ use anyhow::anyhow;
 use blake2::digest::{Digest, FixedOutput};
 use serde::{Deserialize, Serialize};
 
-use crate::error::AggregateSignatureError;
 use crate::membership_commitment::MerkleBatchPath;
-use crate::{AggregateVerificationKey, Parameters, StmResult, proof_system::ConcatenationProof};
+use crate::{
+    AggregateSignatureError, AggregateVerificationKey, Parameters, StmResult,
+    proof_system::ConcatenationProof,
+};
 
 /// The type of STM aggregate signature.
 #[derive(Default, Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
diff --git a/mithril-stm/src/protocol/eligibility_check.rs b/mithril-stm/src/protocol/eligibility_check.rs
diff --git a/mithril-stm/src/protocol/error.rs b/mithril-stm/src/protocol/error.rs
@@ -2,11 +2,10 @@
 use anyhow::anyhow;
 use blst::BLST_ERROR;
 
-use crate::StmResult;
-use crate::aggregate_signature::AggregateSignatureType;
 use crate::signature_scheme::{
     BlsSignature, BlsVerificationKey, BlsVerificationKeyProofOfPossession,
 };
+use crate::{AggregateSignatureType, StmResult};
 
 /// Error types for multi signatures.
 #[derive(Debug, thiserror::Error, Eq, PartialEq)]
@@ -123,7 +122,7 @@ pub enum RegisterError {
     UnregisteredInitializer,
 }
 
-pub(crate) fn blst_error_to_stm_error(
+pub fn blst_error_to_stm_error(
     e: BLST_ERROR,
     sig: Option<BlsSignature>,
     key: Option<BlsVerificationKey>,
diff --git a/mithril-stm/src/protocol/key_registration.rs b/mithril-stm/src/protocol/key_registration.rs
@@ -7,10 +7,9 @@ use std::{
 use anyhow::anyhow;
 use blake2::digest::{Digest, FixedOutput};
 
-use crate::error::RegisterError;
 use crate::membership_commitment::{MerkleTree, MerkleTreeLeaf};
 use crate::signature_scheme::{BlsVerificationKey, BlsVerificationKeyProofOfPossession};
-use crate::{Stake, StmResult};
+use crate::{RegisterError, Stake, StmResult};
 
 /// Stores a registered party with its public key and the associated stake.
 pub type RegisteredParty = MerkleTreeLeaf;
diff --git a/mithril-stm/src/protocol/mod.rs b/mithril-stm/src/protocol/mod.rs
@@ -0,0 +1,62 @@
+mod aggregate_signature;
+mod eligibility_check;
+mod error;
+mod key_registration;
+mod parameters;
+mod participant;
+mod single_signature;
+
+pub use aggregate_signature::{
+    AggregateSignature, AggregateSignatureType, AggregateVerificationKey, BasicVerifier, Clerk,
+};
+pub use error::*;
+pub use key_registration::*;
+pub use parameters::*;
+pub use participant::{Initializer, Signer, VerificationKey, VerificationKeyProofOfPossession};
+pub use single_signature::{SingleSignature, SingleSignatureWithRegisteredParty};
+
+// Aliases
+#[deprecated(since = "0.5.0", note = "Use `AggregateSignature` instead")]
+pub use aggregate_signature::AggregateSignature as StmAggrSig;
+
+#[deprecated(since = "0.5.0", note = "Use `AggregateVerificationKey` instead")]
+pub use aggregate_signature::AggregateVerificationKey as StmAggrVerificationKey;
+
+#[deprecated(since = "0.5.0", note = "Use `Clerk` instead")]
+pub use aggregate_signature::Clerk as StmClerk;
+
+#[deprecated(since = "0.5.0", note = "Use `BasicVerifier` instead")]
+pub use aggregate_signature::BasicVerifier as CoreVerifier;
+
+#[deprecated(since = "0.5.0", note = "Use `Parameters` instead")]
+pub use parameters::Parameters as StmParameters;
+
+#[deprecated(since = "0.5.0", note = "Use `ClosedKeyRegistration` instead")]
+pub use key_registration::ClosedKeyRegistration as ClosedKeyReg;
+
+#[deprecated(since = "0.5.0", note = "Use `KeyRegistration` instead")]
+pub use key_registration::KeyRegistration as KeyReg;
+
+#[deprecated(since = "0.5.0", note = "Use `SingleSignature` instead")]
+pub use single_signature::SingleSignature as StmSig;
+
+#[deprecated(
+    since = "0.5.0",
+    note = "Use `SingleSignatureWithRegisteredParty` instead"
+)]
+pub use single_signature::SingleSignatureWithRegisteredParty as StmSigRegParty;
+
+#[deprecated(since = "0.5.0", note = "Use `Initializer` instead")]
+pub use participant::Initializer as StmInitializer;
+
+#[deprecated(since = "0.5.0", note = "Use `Signer` instead")]
+pub use participant::Signer as StmSigner;
+
+#[deprecated(since = "0.5.0", note = "Use `VerificationKey` instead")]
+pub use participant::VerificationKey as StmVerificationKey;
+
+#[deprecated(
+    since = "0.5.0",
+    note = "Use `VerificationKeyProofOfPossession` instead"
+)]
+pub use participant::VerificationKeyProofOfPossession as StmVerificationKeyPoP;
diff --git a/mithril-stm/src/protocol/parameters.rs b/mithril-stm/src/protocol/parameters.rs
@@ -1,6 +1,6 @@
 use serde::{Deserialize, Serialize};
 
-use crate::error::RegisterError;
+use crate::RegisterError;
 
 /// Used to set protocol parameters.
 // todo: this is the criteria to consider parameters valid:
diff --git a/mithril-stm/src/protocol/participant/initializer.rs b/mithril-stm/src/protocol/participant/initializer.rs
@@ -4,8 +4,9 @@ use rand_core::{CryptoRng, RngCore};
 use serde::{Deserialize, Serialize};
 
 use crate::signature_scheme::{BlsSigningKey, BlsVerificationKeyProofOfPossession};
-use crate::{Parameters, RegisterError, Signer, Stake};
-use crate::{StmResult, key_registration::*};
+use crate::{
+    ClosedKeyRegistration, Parameters, RegisterError, RegisteredParty, Signer, Stake, StmResult,
+};
 use anyhow::anyhow;
 
 /// Wrapper of the MultiSignature Verification key with proof of possession
diff --git a/mithril-stm/src/protocol/participant/mod.rs b/mithril-stm/src/protocol/participant/mod.rs
diff --git a/mithril-stm/src/protocol/participant/signer.rs b/mithril-stm/src/protocol/participant/signer.rs
@@ -1,9 +1,10 @@
 use blake2::digest::{Digest, FixedOutput};
 
-use crate::eligibility_check::is_lottery_won;
-use crate::key_registration::ClosedKeyRegistration;
 use crate::signature_scheme::{BlsSignature, BlsSigningKey, BlsVerificationKey};
-use crate::{Parameters, SingleSignature, Stake};
+use crate::{
+    ClosedKeyRegistration, Parameters, SingleSignature, Stake,
+    protocol::eligibility_check::is_lottery_won,
+};
 
 /// Wrapper of the MultiSignature Verification key
 pub type VerificationKey = BlsVerificationKey;
diff --git a/mithril-stm/src/protocol/single_signature/mod.rs b/mithril-stm/src/protocol/single_signature/mod.rs
diff --git a/mithril-stm/src/protocol/single_signature/signature.rs b/mithril-stm/src/protocol/single_signature/signature.rs
@@ -6,7 +6,7 @@ use std::{
 use blake2::digest::{Digest, FixedOutput};
 use serde::{Deserialize, Serialize};
 
-use crate::eligibility_check::is_lottery_won;
+use crate::protocol::eligibility_check::is_lottery_won;
 use crate::signature_scheme::BlsSignature;
 use crate::{
     AggregateVerificationKey, Index, Parameters, SignatureError, Stake, StmResult, VerificationKey,
diff --git a/mithril-stm/src/protocol/single_signature/signature_registered_party.rs b/mithril-stm/src/protocol/single_signature/signature_registered_party.rs
@@ -1,9 +1,7 @@
 use blake2::digest::{Digest, FixedOutput};
 use serde::{Deserialize, Serialize, Serializer, ser::SerializeTuple};
 
-use crate::StmResult;
-use crate::key_registration::RegisteredParty;
-use crate::{SignatureError, SingleSignature};
+use crate::{RegisteredParty, SignatureError, SingleSignature, StmResult};
 
 /// Signature with its registered party.
 #[derive(Debug, Clone, Hash, Deserialize, Eq, PartialEq, Ord, PartialOrd)]
diff --git a/mithril-stm/src/signature_scheme/bls_multi_signature/helper.rs b/mithril-stm/src/signature_scheme/bls_multi_signature/helper.rs
@@ -8,8 +8,8 @@ pub(crate) mod unsafe_helpers {
         min_sig::{PublicKey as BlstVk, SecretKey as BlstSk, Signature as BlstSig},
     };
 
-    use crate::error::MultiSignatureError::SerializationError;
     use crate::{
+        MultiSignatureError::SerializationError,
         StmResult,
         signature_scheme::{BlsProofOfPossession, BlsVerificationKey},
     };
diff --git a/mithril-stm/src/signature_scheme/bls_multi_signature/mod.rs b/mithril-stm/src/signature_scheme/bls_multi_signature/mod.rs
@@ -94,10 +94,8 @@ mod tests {
     use rand_chacha::ChaCha20Rng;
     use rand_core::{RngCore, SeedableRng};
 
-    use crate::RegisterError;
-    use crate::error::MultiSignatureError;
-    use crate::key_registration::KeyRegistration;
     use crate::signature_scheme::helper::unsafe_helpers::{p1_affine_to_sig, p2_affine_to_vk};
+    use crate::{KeyRegistration, MultiSignatureError, RegisterError};
 
     use super::*;
 
diff --git a/mithril-stm/src/signature_scheme/bls_multi_signature/proof_of_possession.rs b/mithril-stm/src/signature_scheme/bls_multi_signature/proof_of_possession.rs
@@ -1,8 +1,7 @@
 use blst::{blst_p1, min_sig::Signature as BlstSig};
 
-use crate::error::{MultiSignatureError, blst_error_to_stm_error};
 use crate::{
-    StmResult,
+    MultiSignatureError, StmResult, blst_error_to_stm_error,
     signature_scheme::{
         BlsSigningKey, POP,
         helper::unsafe_helpers::{compress_p1, scalar_to_pk_in_g1, uncompress_p1},
diff --git a/mithril-stm/src/signature_scheme/bls_multi_signature/signature.rs b/mithril-stm/src/signature_scheme/bls_multi_signature/signature.rs
@@ -10,11 +10,7 @@ use blst::{
 use digest::consts::U16;
 
 use crate::{
-    Index,
-    error::{MultiSignatureError, blst_error_to_stm_error},
-};
-use crate::{
-    StmResult,
+    Index, MultiSignatureError, StmResult, blst_error_to_stm_error,
     signature_scheme::{
         BlsVerificationKey,
         helper::unsafe_helpers::{p1_affine_to_sig, p2_affine_to_vk, sig_to_p1, vk_from_p2_affine},
diff --git a/mithril-stm/src/signature_scheme/bls_multi_signature/signing_key.rs b/mithril-stm/src/signature_scheme/bls_multi_signature/signing_key.rs
@@ -1,9 +1,8 @@
 use blst::min_sig::SecretKey as BlstSk;
 use rand_core::{CryptoRng, RngCore};
 
-use crate::StmResult;
-use crate::error::{MultiSignatureError, blst_error_to_stm_error};
 use crate::signature_scheme::BlsSignature;
+use crate::{MultiSignatureError, StmResult, blst_error_to_stm_error};
 
 /// MultiSig secret key, which is a wrapper over the BlstSk type from the blst
 /// library.
diff --git a/mithril-stm/src/signature_scheme/bls_multi_signature/verification_key.rs b/mithril-stm/src/signature_scheme/bls_multi_signature/verification_key.rs
