Merge pull request #2850 from input-output-hk/damrobi/msnark/simplify-code

Moving mithril-stm errors into corresponding module

Author: curiecrypt

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-common"
-version = "0.6.35"
+version = "0.6.37"
 description = "Common types, interfaces, and utilities for Mithril nodes."
 authors = { workspace = true }
 edition = { workspace = true }

mithril-common/Cargo.toml

@@ -91,7 +91,7 @@ impl MultiSigner {
 
 #[cfg(test)]
 mod test {
-    use mithril_stm::MultiSignatureError;
+    use mithril_stm::BlsSignatureError;
 
     use crate::{
         crypto_helper::ProtocolAggregationError,
@@ -195,8 +195,8 @@ mod test {
                 "Verify single signature should fail if the signer isn't in the registered parties",
             );
 
-        match error.downcast_ref::<MultiSignatureError>() {
-            Some(MultiSignatureError::SignatureInvalid(_)) => (),
+        match error.downcast_ref::<BlsSignatureError>() {
+            Some(BlsSignatureError::SignatureInvalid(_)) => (),
             _ => panic!("Expected an SignatureInvalid error, got: {error:?}"),
         }
     }
@@ -221,8 +221,8 @@ mod test {
             .verify_single_signature(&ProtocolMessage::default(), &single_signature)
             .expect_err("Verify single signature should fail");
 
-        match error.downcast_ref::<MultiSignatureError>() {
-            Some(MultiSignatureError::SignatureInvalid(_)) => (),
+        match error.downcast_ref::<BlsSignatureError>() {
+            Some(BlsSignatureError::SignatureInvalid(_)) => (),
             _ => panic!("Expected an SignatureInvalid error, got: {error:?}"),
         }
     }

mithril-common/src/protocol/multi_signer.rs

@@ -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.4 (12-12-2025)
+
+### Changed
+
+- Error types in the Stm library moved to corresponding sub-modules.
+
 ## 0.6.2 (11-27-2025)
 
 ### Changed

mithril-stm/CHANGELOG.md

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-stm"
-version = "0.6.3"
+version = "0.6.4"
 edition = { workspace = true }
 authors = { workspace = true }
 homepage = { workspace = true }
@@ -17,8 +17,7 @@ crate-type = ["lib", "cdylib", "staticlib"]
 default = ["rug-backend"]
 rug-backend = ["rug/default"]
 num-integer-backend = ["dep:num-bigint", "dep:num-rational", "dep:num-traits"]
-benchmark-internals = [] # For benchmarking multi_sig
-future_proof_system = [] # For activating future proof systems
+benchmark-internals = [] # For benchmarking
 future_snark = [
     "dep:ff",
     "dep:group",
@@ -73,7 +72,7 @@ required-features = ["benchmark-internals"]
 [[bench]]
 name = "schnorr_sig"
 harness = false
-required-features = ["future_snark"]
+required-features = ["future_snark", "benchmark-internals"]
 
 [[bench]]
 name = "stm"

mithril-stm/Cargo.toml

@@ -117,6 +117,7 @@ mod protocol;
 mod signature_scheme;
 
 pub use protocol::*;
+pub use signature_scheme::BlsSignatureError;
 
 #[cfg(feature = "benchmark-internals")]
 pub use signature_scheme::{

mithril-stm/src/lib.rs

@@ -1,10 +1,12 @@
+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 super::{MerkleBatchPath, MerklePath, MerkleTreeError, MerkleTreeLeaf, parent, sibling};
 
 /// `MerkleTree` commitment.
 /// This structure differs from `MerkleTree` in that it does not contain all elements, which are not always necessary.

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

@@ -0,0 +1,15 @@
+/// Error types related to merkle trees.
+#[derive(Debug, Clone, thiserror::Error)]
+pub enum MerkleTreeError {
+    /// Serialization error
+    #[error("Serialization of a merkle tree failed")]
+    SerializationError,
+
+    /// Invalid merkle path
+    #[error("Path does not verify against root")]
+    PathInvalid(Vec<u8>),
+
+    /// Invalid merkle batch path
+    #[error("Batch path does not verify against root")]
+    BatchPathInvalid(Vec<u8>),
+}

mithril-stm/src/membership_commitment/merkle_tree/error.rs

@@ -2,9 +2,9 @@ use std::cmp::Ordering;
 
 use serde::{Deserialize, Serialize};
 
-use crate::{
-    MerkleTreeError, Stake, StmResult, VerificationKey, signature_scheme::BlsVerificationKey,
-};
+use crate::{Stake, StmResult, VerificationKey, signature_scheme::BlsVerificationKey};
+
+use super::MerkleTreeError;
 
 /// The values that are committed in the Merkle Tree.
 /// Namely, a verified `VerificationKey` and its corresponding stake.

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

@@ -1,11 +1,13 @@
 //! Merkle tree implementation for STM
 
 mod commitment;
+mod error;
 mod leaf;
 mod path;
 mod tree;
 
 pub use commitment::*;
+pub use error::*;
 pub use leaf::*;
 pub use path::*;
 pub use tree::*;