Merge pull request #2804 from input-output-hk/curiecrypt/msnark/re-organize-modules

SNARK-friendly STM: Re-organize modules

Author: curiecrypt

Cargo.lock

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.6.2 (11-27-2025)
+
+### Changed
+
+- Stm library re-organized for SNARK-friendliness.
+
 ## 0.6.1 (11-27-2025)
 
 ### Added

mithril-stm/CHANGELOG.md

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-stm"
-version = "0.6.1"
+version = "0.6.2"
 edition = { workspace = true }
 authors = { workspace = true }
 homepage = { workspace = true }

mithril-stm/Cargo.toml

@@ -111,37 +111,21 @@
 //! # }
 //! ```
 
-mod aggregate_signature;
-mod bls_multi_signature;
-mod eligibility_check;
-mod error;
-mod key_registration;
-mod merkle_tree;
-mod parameters;
-mod participant;
-#[cfg(feature = "future_snark")]
-mod schnorr_signature;
-mod single_signature;
+mod membership_commitment;
+mod proof_system;
+mod protocol;
+mod signature_scheme;
 
-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 bls_multi_signature::{
+pub use signature_scheme::{
     BlsProofOfPossession, BlsSignature, BlsSigningKey, BlsVerificationKey,
     BlsVerificationKeyProofOfPossession,
 };
 
-#[cfg(feature = "future_snark")]
-pub use schnorr_signature::{SchnorrSignature, SchnorrSigningKey, SchnorrVerificationKey};
+#[cfg(all(feature = "benchmark-internals", feature = "future_snark"))]
+pub use signature_scheme::{SchnorrSignature, SchnorrSigningKey, SchnorrVerificationKey};
 
 /// The quantity of stake held by a party, represented as a `u64`.
 pub type Stake = u64;
@@ -155,49 +139,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;

mithril-stm/src/lib.rs

@@ -1,12 +1,11 @@
-use std::marker::PhantomData;
-
+use anyhow::{Context, anyhow};
 use blake2::digest::{Digest, FixedOutput};
 use serde::{Deserialize, Serialize};
+use std::marker::PhantomData;
+
+use super::{MerkleBatchPath, MerklePath, MerkleTreeLeaf, parent, sibling};
+use crate::{MerkleTreeError, StmResult};
 
-use crate::StmResult;
-use crate::error::MerkleTreeError;
-use crate::merkle_tree::{MerkleBatchPath, MerklePath, MerkleTreeLeaf, parent, sibling};
-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.

mithril-stm/src/merkle_tree/commitment.rs renamed to mithril-stm/src/membership_commitment/merkle_tree/commitment.rs

@@ -2,10 +2,10 @@ use std::cmp::Ordering;
 
 use serde::{Deserialize, Serialize};
 
-use crate::StmResult;
-use crate::bls_multi_signature::BlsVerificationKey;
-use crate::error::MerkleTreeError;
-use crate::{Stake, VerificationKey};
+use crate::{
+    MerkleTreeError, Stake, StmResult, VerificationKey, signature_scheme::BlsVerificationKey,
+};
+
 /// 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)]

mithril-stm/src/merkle_tree/leaf.rs renamed to mithril-stm/src/membership_commitment/merkle_tree/leaf.rs

@@ -1,9 +1,8 @@
-use std::marker::PhantomData;
-
-use crate::StmResult;
-use crate::error::MerkleTreeError;
 use blake2::digest::{Digest, FixedOutput};
 use serde::{Deserialize, Serialize};
+use std::marker::PhantomData;
+
+use crate::{MerkleTreeError, StmResult};
 
 /// Path of hashes from root to leaf in a Merkle Tree.
 /// Contains all hashes on the path, and the index of the leaf.

mithril-stm/src/merkle_tree/mod.rs renamed to mithril-stm/src/membership_commitment/merkle_tree/mod.rs

@@ -1,14 +1,12 @@
-use std::marker::PhantomData;
-
 use blake2::digest::{Digest, FixedOutput};
 use serde::{Deserialize, Serialize};
+use std::marker::PhantomData;
 
-use crate::StmResult;
-use crate::error::MerkleTreeError;
-use crate::merkle_tree::{
+use super::{
     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)]
@@ -269,13 +267,14 @@ impl<D: Digest + FixedOutput> MerkleTree<D> {
 
 #[cfg(test)]
 mod tests {
-    use super::*;
-    use crate::bls_multi_signature::BlsVerificationKey;
     use blake2::{Blake2b, digest::consts::U32};
-    use proptest::collection::vec;
-    use proptest::prelude::*;
+    use proptest::{collection::vec, prelude::*};
     use rand::{rng, seq::IteratorRandom};
 
+    use crate::signature_scheme::BlsVerificationKey;
+
+    use super::*;
+
     fn pow2_plus1(h: usize) -> usize {
         1 + 2_usize.pow(h as u32)
     }

mithril-stm/src/merkle_tree/path.rs renamed to mithril-stm/src/membership_commitment/merkle_tree/path.rs

@@ -0,0 +1,3 @@
+mod merkle_tree;
+
+pub use merkle_tree::*;