Merge pull request #2412 from input-output-hk/curiecrypt/module-participant

curiecrypt · web-flow · commit 55120997fa4d · 2025-05-16T15:52:07.000+03:00
Organize STM - Module participant
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/demo/protocol-demo/Cargo.toml b/demo/protocol-demo/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "mithrildemo"
-version = "0.1.50"
+version = "0.1.51"
 authors = { workspace = true }
 edition = { workspace = true }
 documentation = { workspace = true }
diff --git a/demo/protocol-demo/src/types.rs b/demo/protocol-demo/src/types.rs
@@ -1,6 +1,5 @@
-use mithril_stm::key_reg::KeyReg;
-use mithril_stm::stm::{
-    Stake, StmAggrSig, StmClerk, StmInitializer, StmParameters, StmSig, StmSigner,
+use mithril_stm::{
+    KeyReg, Stake, StmAggrSig, StmClerk, StmInitializer, StmParameters, StmSig, StmSigner,
     StmVerificationKeyPoP,
 };
 
diff --git a/mithril-common/Cargo.toml b/mithril-common/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "mithril-common"
-version = "0.5.29"
+version = "0.5.30"
 description = "Common types, interfaces, and utilities for Mithril nodes."
 authors = { workspace = true }
 edition = { workspace = true }
@@ -47,7 +47,9 @@ kes-summed-ed25519 = { version = "0.2.1", features = [
     "serde_enabled",
     "sk_clone_enabled",
 ] }
-mithril-stm = { path = "../mithril-stm", version = "0.3", default-features = false, features = ["batch-verify-aggregates"] }
+mithril-stm = { path = "../mithril-stm", version = ">=0.3", default-features = false, features = [
+    "batch-verify-aggregates"
+] }
 nom = "8.0.0"
 pallas-addresses = { version = "0.32.0", optional = true }
 pallas-codec = { version = "0.32.0", optional = true }
diff --git a/mithril-common/src/crypto_helper/cardano/key_certification.rs b/mithril-common/src/crypto_helper/cardano/key_certification.rs
@@ -15,9 +15,10 @@ use crate::{
     StdError, StdResult,
 };
 
-use mithril_stm::key_reg::{ClosedKeyReg, KeyReg};
-use mithril_stm::stm::{Stake, StmInitializer, StmParameters, StmSigner, StmVerificationKeyPoP};
-use mithril_stm::RegisterError;
+use mithril_stm::{
+    ClosedKeyReg, KeyReg, RegisterError, Stake, StmInitializer, StmParameters, StmSigner,
+    StmVerificationKeyPoP,
+};
 
 use crate::crypto_helper::cardano::Sum6KesBytes;
 use anyhow::{anyhow, Context};
diff --git a/mithril-common/src/crypto_helper/types/alias.rs b/mithril-common/src/crypto_helper/types/alias.rs
@@ -4,9 +4,7 @@ use crate::crypto_helper::cardano::{
 };
 
 use mithril_stm::{
-    key_reg::ClosedKeyReg,
-    stm::{Index, Stake, StmClerk, StmParameters, StmSigner},
-    AggregationError,
+    AggregationError, ClosedKeyReg, Index, Stake, StmClerk, StmParameters, StmSigner,
 };
 
 use blake2::{digest::consts::U32, Blake2b};
@@ -20,31 +18,31 @@ pub(crate) type D = Blake2b<U32>;
 /// The id of a mithril party.
 pub type ProtocolPartyId = String;
 
-/// Alias of [MithrilStm:Stake](type@mithril_stm::stm::Stake).
+/// Alias of [MithrilStm:Stake](type@mithril_stm::Stake).
 pub type ProtocolStake = Stake;
 
 /// A list of [Party Id][ProtocolPartyId] associated with its [Stake][ProtocolStake].
 pub type ProtocolStakeDistribution = Vec<(ProtocolPartyId, ProtocolStake)>;
 
-/// Alias of [MithrilStm::StmParameters](struct@mithril_stm::stm::StmParameters).
+/// Alias of [MithrilStm::StmParameters](struct@mithril_stm::StmParameters).
 pub type ProtocolParameters = StmParameters;
 
-/// Alias of [MithrilStm::Index](type@mithril_stm::stm::Index).
+/// Alias of [MithrilStm::Index](type@mithril_stm::Index).
 pub type ProtocolLotteryIndex = Index;
 
-/// Alias of [MithrilStm:StmSigner](struct@mithril_stm::stm::StmSigner).
+/// Alias of [MithrilStm:StmSigner](struct@mithril_stm::StmSigner).
 pub type ProtocolSigner = StmSigner<D>;
 
-/// Alias of a wrapper of [MithrilStm:StmInitializer](struct@mithril_stm::stm::StmInitializer).
+/// Alias of a wrapper of [MithrilStm:StmInitializer](struct@mithril_stm::StmInitializer).
 pub type ProtocolInitializer = StmInitializerWrapper;
 
-/// Alias of [MithrilStm:StmClerk](struct@mithril_stm::stm::StmClerk).
+/// Alias of [MithrilStm:StmClerk](struct@mithril_stm::StmClerk).
 pub type ProtocolClerk = StmClerk<D>;
 
-/// Alias of a wrapper of [MithrilStm:KeyReg](struct@mithril_stm::key_reg::KeyReg).
+/// Alias of a wrapper of [MithrilStm:KeyReg](struct@mithril_stm::KeyReg).
 pub type ProtocolKeyRegistration = KeyRegWrapper;
 
-/// Alias of a wrapper of [MithrilStm:ClosedKeyReg](struct@mithril_stm::key_reg::KeyReg).
+/// Alias of a wrapper of [MithrilStm:ClosedKeyReg](struct@mithril_stm::KeyReg).
 pub type ProtocolClosedKeyRegistration = ClosedKeyReg<D>;
 
 // Error alias
diff --git a/mithril-common/src/crypto_helper/types/protocol_key.rs b/mithril-common/src/crypto_helper/types/protocol_key.rs
@@ -222,7 +222,7 @@ mod test {
         crypto_helper::ProtocolKey,
         test_utils::{fake_keys, TempDir},
     };
-    use mithril_stm::stm::StmVerificationKeyPoP;
+    use mithril_stm::StmVerificationKeyPoP;
     use serde::{Deserialize, Serialize};
 
     static VERIFICATION_KEY: &str = fake_keys::signer_verification_key()[0];
diff --git a/mithril-common/src/crypto_helper/types/wrappers.rs b/mithril-common/src/crypto_helper/types/wrappers.rs
@@ -1,7 +1,7 @@
 use anyhow::Context;
 use hex::{FromHex, ToHex};
 use kes_summed_ed25519::kes::Sum6KesSig;
-use mithril_stm::stm::{StmAggrSig, StmAggrVerificationKey, StmSig, StmVerificationKeyPoP};
+use mithril_stm::{StmAggrSig, StmAggrVerificationKey, StmSig, StmVerificationKeyPoP};
 
 use crate::crypto_helper::{MKMapProof, MKProof, OpCert, ProtocolKey, ProtocolKeyCodec, D};
 use crate::entities::BlockRange;
diff --git a/mithril-common/src/entities/single_signature.rs b/mithril-common/src/entities/single_signature.rs
@@ -1,4 +1,4 @@
-use mithril_stm::stm::StmSig;
+use mithril_stm::StmSig;
 use serde::{Deserialize, Serialize};
 use std::fmt::{Debug, Formatter};
 
diff --git a/mithril-common/src/protocol/multi_signer.rs b/mithril-common/src/protocol/multi_signer.rs
@@ -1,5 +1,5 @@
 use anyhow::{anyhow, Context};
-use mithril_stm::stm::StmParameters;
+use mithril_stm::StmParameters;
 
 use crate::{
     crypto_helper::{
diff --git a/mithril-common/src/test_utils/fake_keys.rs b/mithril-common/src/test_utils/fake_keys.rs
@@ -1,6 +1,6 @@
 //! Pre hex encoded StmTypes for testing.
 
-/// A list of pre json hex encoded [MithrilStm:StmSig](type@mithril_stm::stm::StmSig)
+/// A list of pre json hex encoded [MithrilStm:StmSig](type@mithril_stm::StmSig)
 pub const fn single_signature<'a>() -> [&'a str; 4] {
     [
         "7b227369676d61223a5b3133302c3137372c31352c3232392c32342c3235312c3234372c3137312c3139362c32\
@@ -52,7 +52,7 @@ pub const fn single_signature<'a>() -> [&'a str; 4] {
     ]
 }
 
-/// A list of pre json hex encoded [MithrilStm:StmAggrSig](struct@mithril_stm::stm::StmAggrSig)
+/// A list of pre json hex encoded [MithrilStm:StmAggrSig](struct@mithril_stm::StmAggrSig)
 pub const fn multi_signature<'a>() -> [&'a str; 2] {
     [
         "7b227369676e617475726573223a5b5b7b227369676d61223a5b3137312c3136312c3232352c3139342c32382c\
@@ -158,7 +158,7 @@ pub const fn signable_manifest_signature<'a>() -> [&'a str; 2] {
     ]
 }
 
-/// A list of pre json hex encoded [MithrilStm:StmVerificationKeyPoP](type@mithril_stm::stm::StmVerificationKeyPoP)
+/// A list of pre json hex encoded [MithrilStm:StmVerificationKeyPoP](type@mithril_stm::StmVerificationKeyPoP)
 pub const fn signer_verification_key<'a>() -> [&'a str; 4] {
     [
         "7b22766b223a5b3134352c32332c3135382c31322c3138332c3230392c33322c3134302c33372c3132342c3136\
@@ -366,7 +366,7 @@ pub const fn operational_certificate<'a>() -> [&'a str; 2] {
     ]
 }
 
-/// A list of pre json hex encoded [MithrilStm:StmAggrVerificationKey](struct@mithril_stm::stm::StmAggrVerificationKey)
+/// A list of pre json hex encoded [MithrilStm:StmAggrVerificationKey](struct@mithril_stm::StmAggrVerificationKey)
 pub const fn aggregate_verification_key<'a>() -> [&'a str; 3] {
     [
         "7b226d745f636f6d6d69746d656e74223a7b22726f6f74223a5b3134302c31332c3135352c3134312c3136332c\
@@ -392,7 +392,7 @@ mod test {
     use super::*;
     use ed25519_dalek::VerifyingKey;
     use kes_summed_ed25519::kes::Sum6KesSig;
-    use mithril_stm::stm::{StmAggrSig, StmAggrVerificationKey, StmSig, StmVerificationKeyPoP};
+    use mithril_stm::{StmAggrSig, StmAggrVerificationKey, StmSig, StmVerificationKeyPoP};
     use serde::{de::DeserializeOwned, Serialize};
     use std::any::type_name;
 
diff --git a/mithril-stm/CHANGELOG.md b/mithril-stm/CHANGELOG.md
@@ -5,6 +5,16 @@ 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.4.0 (15-05-2025)
+
+### Added
+
+- Added a `participant` module and `StmInitializer` and `StmSigner` functionality covered by its submodules.
+
+### Changed
+
+- STM module visibilities are changed.
+
 ## 0.3.44 (28-04-2025)
 
 - Removed the build script and deprecated `batch-verify-aggregate` feature as the code behind this feature is now
diff --git a/mithril-stm/Cargo.toml b/mithril-stm/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "mithril-stm"
-version = "0.3.46"
+version = "0.4.0"
 edition = { workspace = true }
 authors = { workspace = true }
 homepage = { workspace = true }
diff --git a/mithril-stm/README.md b/mithril-stm/README.md
@@ -62,9 +62,7 @@ cargo bench
 The following is a simple example of the STM implementation:
 
 ```rust
-use mithril_stm::key_reg::KeyReg;
-use mithril_stm::stm::{StmClerk, StmInitializer, StmParameters, StmSig, StmSigner};
-use mithril_stm::AggregationError;
+use mithril_stm::{StmClerk, StmParameters, StmSig, KeyReg, StmInitializer, StmSigner, AggregationError};
 
 use blake2::{digest::consts::U32, Blake2b};
 use rayon::prelude::*;
diff --git a/mithril-stm/benches/multi_sig.rs b/mithril-stm/benches/multi_sig.rs
@@ -1,6 +1,6 @@
 use blake2::{digest::consts::U64, Blake2b, Digest};
 use criterion::{criterion_group, criterion_main, BenchmarkId, Criterion};
-use mithril_stm::bls_multi_signature::{Signature, SigningKey, VerificationKey};
+use mithril_stm::{Signature, SigningKey, VerificationKey};
 use rand_chacha::ChaCha20Rng;
 use rand_core::{RngCore, SeedableRng};
 
diff --git a/mithril-stm/benches/size_benches.rs b/mithril-stm/benches/size_benches.rs
@@ -3,9 +3,8 @@ use blake2::{
     digest::consts::{U32, U64},
     Blake2b, Digest,
 };
-use mithril_stm::key_reg::KeyReg;
-use mithril_stm::stm::{
-    CoreVerifier, Stake, StmClerk, StmInitializer, StmParameters, StmSig, StmSigRegParty,
+use mithril_stm::{
+    CoreVerifier, KeyReg, Stake, StmClerk, StmInitializer, StmParameters, StmSig, StmSigRegParty,
     StmSigner, StmVerificationKey,
 };
 use rand_chacha::ChaCha20Rng;
diff --git a/mithril-stm/benches/stm.rs b/mithril-stm/benches/stm.rs
@@ -1,9 +1,8 @@
 use blake2::digest::{Digest, FixedOutput};
 use blake2::{digest::consts::U32, Blake2b};
 use criterion::{criterion_group, criterion_main, BenchmarkId, Criterion};
-use mithril_stm::key_reg::KeyReg;
-use mithril_stm::stm::{
-    CoreVerifier, Stake, StmAggrSig, StmClerk, StmInitializer, StmParameters, StmSigner,
+use mithril_stm::{
+    CoreVerifier, KeyReg, Stake, StmAggrSig, StmClerk, StmInitializer, StmParameters, StmSigner,
     StmVerificationKey,
 };
 use rand_chacha::ChaCha20Rng;
diff --git a/mithril-stm/examples/key_registration.rs b/mithril-stm/examples/key_registration.rs
@@ -2,8 +2,9 @@
 //! but instead by all the participants in the signature process. Contrarily to the full protocol
 //! run presented in `tests/integration.rs`, we explicitly treat each party individually.
 use blake2::{digest::consts::U32, Blake2b};
-use mithril_stm::key_reg::{ClosedKeyReg, KeyReg};
-use mithril_stm::stm::{Stake, StmClerk, StmInitializer, StmParameters, StmVerificationKeyPoP};
+use mithril_stm::{
+    ClosedKeyReg, KeyReg, Stake, StmClerk, StmInitializer, StmParameters, StmVerificationKeyPoP,
+};
 
 use rand_chacha::ChaCha20Rng;
 use rand_core::{RngCore, SeedableRng};
diff --git a/mithril-stm/src/lib.rs b/mithril-stm/src/lib.rs
@@ -1,22 +1,26 @@
-#![warn(missing_docs)]
 #![doc = include_str!("../README.md")]
 //! Implementation of Stake-based Threshold Multisignatures
 
-extern crate core;
-
+mod bls_multi_signature;
 mod eligibility_check;
 mod error;
-pub mod key_reg;
+mod key_reg;
 mod merkle_tree;
-pub mod stm;
+mod participant;
+mod stm;
 
-pub use crate::error::{
+pub use error::{
     AggregationError, CoreVerifierError, RegisterError, StmAggregateSignatureError,
     StmSignatureError,
 };
+pub use key_reg::{ClosedKeyReg, KeyReg};
+pub use participant::{StmInitializer, StmSigner, StmVerificationKey, StmVerificationKeyPoP};
+pub use stm::{
+    CoreVerifier, Index, Stake, StmAggrSig, StmAggrVerificationKey, StmClerk, StmParameters,
+    StmSig, StmSigRegParty,
+};
 
 #[cfg(feature = "benchmark-internals")]
-pub mod bls_multi_signature;
-
-#[cfg(not(feature = "benchmark-internals"))]
-mod bls_multi_signature;
+pub use bls_multi_signature::{
+    ProofOfPossession, Signature, SigningKey, VerificationKey, VerificationKeyPoP,
+};
diff --git a/mithril-stm/src/merkle_tree/leaf.rs b/mithril-stm/src/merkle_tree/leaf.rs
@@ -1,6 +1,7 @@
 use crate::bls_multi_signature::VerificationKey;
 use crate::error::MerkleTreeError;
-use crate::stm::{Stake, StmVerificationKey};
+use crate::participant::StmVerificationKey;
+use crate::stm::Stake;
 use blake2::Blake2b;
 use digest::consts::U32;
 use serde::{Deserialize, Serialize};
diff --git a/mithril-stm/src/participant/initializer.rs b/mithril-stm/src/participant/initializer.rs
diff --git a/mithril-stm/src/participant/mod.rs b/mithril-stm/src/participant/mod.rs
diff --git a/mithril-stm/src/participant/signer.rs b/mithril-stm/src/participant/signer.rs
diff --git a/mithril-stm/src/stm.rs b/mithril-stm/src/stm.rs
diff --git a/mithril-stm/tests/stm_core.rs b/mithril-stm/tests/stm_core.rs
diff --git a/mithril-stm/tests/stm_protocol.rs b/mithril-stm/tests/stm_protocol.rs

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-use mithril_stm::stm::StmSig;`
	`1`	`+use mithril_stm::StmSig;`
`2`	`2`	`use serde::{Deserialize, Serialize};`
`3`	`3`	`use std::fmt::{Debug, Formatter};`
`4`	`4`