Re-organize top-level crate exports

README.md

@@ -123,6 +123,10 @@ Messages sealed as one type must be unsealed using the corresponding method, oth
 - `RpoRandomCoin`: a struct implementing `FeltRng` as well as the [`RandomCoin`](https://github.com/facebook/winterfell/blob/main/crypto/src/random/mod.rs) trait using RPO hash function.
 - `RpxRandomCoin`: a struct implementing `FeltRng` as well as the [`RandomCoin`](https://github.com/facebook/winterfell/blob/main/crypto/src/random/mod.rs) trait using RPX hash function.
 
+## STARK proving system
+
+The STARK module exports foundational components for the STARK proving system. It primarily consists of re-exports from the [Plonky3](https://github.com/Plonky3/Plonky3) project with some Miden-specific [adaptations](https://github.com/0xMiden/p3-miden).
+
 ## Make commands
 
 We use `make` to automate building, testing, and other processes. In most cases, `make` commands are wrappers around `cargo` commands with specific arguments. You can view the list of available commands in the [Makefile](Makefile), or run the following command:

miden-crypto/benches/common/data.rs

@@ -31,7 +31,7 @@ use std::iter;
 
 use miden_crypto::{
     Felt, ONE, Word,
-    test_utils::{prng_array, rand_value},
+    rand::test_utils::{prng_array, rand_value},
 };
 
 // === Byte Array Generation ===
@@ -81,11 +81,11 @@ pub fn generate_word(seed: &mut [u8; 32]) -> Word {
 }
 
 /// Generate a generic value from seed using PRNG
-pub fn generate_value<T: miden_crypto::utils::Randomizable + std::fmt::Debug + Clone>(
+pub fn generate_value<T: miden_crypto::rand::Randomizable + std::fmt::Debug + Clone>(
     seed: &mut [u8; 32],
 ) -> T {
     *seed = prng_array(*seed);
-    let value: [T; 1] = miden_crypto::test_utils::prng_array(*seed);
+    let value: [T; 1] = miden_crypto::rand::test_utils::prng_array(*seed);
     value[0].clone()
 }
 

miden-crypto/benches/store.rs

@@ -8,7 +8,7 @@ use miden_crypto::{
         smt::{LeafIndex, SMT_MAX_DEPTH, SimpleSmt},
         store::MerkleStore,
     },
-    test_utils::{rand_array, rand_value},
+    rand::test_utils::{rand_array, rand_value},
 };
 
 /// Since MerkleTree can only be created when a power-of-two number of elements is used, the sample

miden-crypto/src/aead/aead_rpo/mod.rs

@@ -27,8 +27,8 @@ use crate::{
         ByteReader, ByteWriter, Deserializable, DeserializationError, Serializable,
         bytes_to_elements_exact, bytes_to_elements_with_padding, elements_to_bytes,
         padded_elements_to_bytes,
+        zeroize::{Zeroize, ZeroizeOnDrop},
     },
-    zeroize::{Zeroize, ZeroizeOnDrop},
 };
 
 #[cfg(all(test, feature = "std"))]

miden-crypto/src/aead/mod.rs

@@ -9,8 +9,10 @@ use thiserror::Error;
 
 use crate::{
     Felt,
-    utils::Deserializable,
-    zeroize::{Zeroize, ZeroizeOnDrop},
+    utils::{
+        Deserializable,
+        zeroize::{Zeroize, ZeroizeOnDrop},
+    },
 };
 
 pub mod aead_rpo;

miden-crypto/src/aead/xchacha/mod.rs

@@ -24,8 +24,8 @@ use crate::{
     utils::{
         ByteReader, ByteWriter, Deserializable, DeserializationError, Serializable,
         bytes_to_elements_exact, elements_to_bytes,
+        zeroize::{Zeroize, ZeroizeOnDrop},
     },
-    zeroize::{Zeroize, ZeroizeOnDrop},
 };
 
 #[cfg(all(test, feature = "std"))]

miden-crypto/src/dsa/ecdsa_k256_keccak/mod.rs

@@ -17,8 +17,8 @@ use crate::{
     utils::{
         ByteReader, ByteWriter, Deserializable, DeserializationError, Serializable,
         bytes_to_packed_u32_elements,
+        zeroize::{Zeroize, ZeroizeOnDrop},
     },
-    zeroize::{Zeroize, ZeroizeOnDrop},
 };
 
 #[cfg(all(test, feature = "std"))]

miden-crypto/src/dsa/eddsa_25519_sha512/mod.rs

@@ -14,8 +14,8 @@ use crate::{
     utils::{
         ByteReader, ByteWriter, Deserializable, DeserializationError, Serializable,
         bytes_to_packed_u32_elements,
+        zeroize::{Zeroize, ZeroizeOnDrop},
     },
-    zeroize::{Zeroize, ZeroizeOnDrop},
 };
 
 #[cfg(all(test, feature = "std"))]

miden-crypto/src/dsa/falcon512_rpo/keys/secret_key.rs

@@ -18,7 +18,7 @@ use crate::{
     Word,
     dsa::falcon512_rpo::{LOG_N, SK_LEN, hash_to_point::hash_to_point_rpo256, math::ntru_gen},
     hash::blake::Blake3_256,
-    zeroize::{Zeroize, ZeroizeOnDrop},
+    utils::zeroize::{Zeroize, ZeroizeOnDrop},
 };
 
 // CONSTANTS

miden-crypto/src/dsa/falcon512_rpo/math/ffsampling.rs

@@ -5,7 +5,7 @@ use num_complex::{Complex, Complex64};
 use rand::Rng;
 
 use super::{fft::FastFft, polynomial::Polynomial, samplerz::sampler_z};
-use crate::zeroize::{Zeroize, ZeroizeOnDrop};
+use crate::utils::zeroize::{Zeroize, ZeroizeOnDrop};
 
 const SIGMIN: f64 = 1.2778336969128337;
 

miden-crypto/src/dsa/falcon512_rpo/math/polynomial.rs

@@ -14,7 +14,7 @@ use super::{Inverse, field::FalconFelt};
 use crate::{
     Felt,
     dsa::falcon512_rpo::{MODULUS, N},
-    zeroize::{Zeroize, ZeroizeOnDrop},
+    utils::zeroize::{Zeroize, ZeroizeOnDrop},
 };
 
 /// Represents a polynomial with coefficients of type F.
@@ -651,11 +651,12 @@ impl<F: Zeroize> ZeroizeOnDrop for Polynomial<F> {}
 #[cfg(all(test, feature = "std"))]
 mod tests {
     use super::{FalconFelt, N, Polynomial};
+    use crate::rand::test_utils::rand_array;
 
     #[test]
     fn test_negacyclic_reduction() {
-        let coef1: [u8; N] = crate::test_utils::rand_array();
-        let coef2: [u8; N] = crate::test_utils::rand_array();
+        let coef1: [u8; N] = rand_array();
+        let coef2: [u8; N] = rand_array();
 
         let poly1 = Polynomial::new(coef1.iter().map(|&a| FalconFelt::new(a as i16)).collect());
         let poly2 = Polynomial::new(coef2.iter().map(|&a| FalconFelt::new(a as i16)).collect());

miden-crypto/src/ecdh/k256.rs

@@ -21,8 +21,10 @@ use rand::{CryptoRng, RngCore};
 use crate::{
     dsa::ecdsa_k256_keccak::{PUBLIC_KEY_BYTES, PublicKey, SecretKey},
     ecdh::KeyAgreementScheme,
-    utils::{ByteReader, ByteWriter, Deserializable, DeserializationError, Serializable},
-    zeroize::{Zeroize, ZeroizeOnDrop},
+    utils::{
+        ByteReader, ByteWriter, Deserializable, DeserializationError, Serializable,
+        zeroize::{Zeroize, ZeroizeOnDrop},
+    },
 };
 
 // SHARED SECRET

miden-crypto/src/ecdh/mod.rs

@@ -5,8 +5,8 @@ use alloc::vec::Vec;
 use rand::{CryptoRng, RngCore};
 use thiserror::Error;
 
-use crate::{
-    utils::{Deserializable, Serializable},
+use crate::utils::{
+    Deserializable, Serializable,
     zeroize::{Zeroize, ZeroizeOnDrop},
 };
 

miden-crypto/src/ecdh/x25519.rs

@@ -21,8 +21,10 @@ use rand::{CryptoRng, RngCore};
 use crate::{
     dsa::eddsa_25519_sha512::{PublicKey, SecretKey},
     ecdh::KeyAgreementScheme,
-    utils::{ByteReader, ByteWriter, Deserializable, DeserializationError, Serializable},
-    zeroize::{Zeroize, ZeroizeOnDrop},
+    utils::{
+        ByteReader, ByteWriter, Deserializable, DeserializationError, Serializable,
+        zeroize::{Zeroize, ZeroizeOnDrop},
+    },
 };
 
 // SHARED SECRETE

miden-crypto/src/hash/algebraic_sponge/mod.rs

@@ -17,23 +17,11 @@ use core::ops::Range;
 use p3_field::PrimeCharacteristicRing;
 
 use super::{Felt, Word, ZERO};
-use crate::{BasedVectorSpace, PrimeField64};
+use crate::field::{BasedVectorSpace, PrimeField64};
 
 pub(crate) mod poseidon2;
 pub(crate) mod rescue;
 
-// Re-export the main hash function types
-pub use poseidon2::Poseidon2;
-// Re-export P3 integration types for public API
-pub use poseidon2::{
-    Poseidon2Challenger, Poseidon2Compression, Poseidon2Hasher, Poseidon2Permutation256,
-};
-pub use rescue::{
-    Rpo256, Rpx256,
-    rpo::{RpoChallenger, RpoCompression, RpoHasher, RpoPermutation256},
-    rpx::{RpxChallenger, RpxCompression, RpxHasher, RpxPermutation256},
-};
-
 // CONSTANTS
 // ================================================================================================
 

miden-crypto/src/hash/algebraic_sponge/poseidon2/mod.rs

@@ -1,7 +1,7 @@
 use super::{
     AlgebraicSponge, CAPACITY_RANGE, DIGEST_RANGE, Felt, RATE_RANGE, Range, STATE_WIDTH, Word, ZERO,
 };
-use crate::PrimeCharacteristicRing;
+use crate::field::PrimeCharacteristicRing;
 
 mod constants;
 use constants::{
@@ -134,7 +134,7 @@ impl Poseidon2 {
 
     /// Returns a hash of the provided field elements.
     #[inline(always)]
-    pub fn hash_elements<E: crate::BasedVectorSpace<Felt>>(elements: &[E]) -> Word {
+    pub fn hash_elements<E: crate::field::BasedVectorSpace<Felt>>(elements: &[E]) -> Word {
         <Self as AlgebraicSponge>::hash_elements(elements)
     }
 

miden-crypto/src/hash/algebraic_sponge/rescue/mod.rs

@@ -16,10 +16,7 @@ mod mds;
 use mds::{MDS, apply_mds};
 
 pub(crate) mod rpo;
-pub use rpo::Rpo256;
-
 pub(crate) mod rpx;
-pub use rpx::Rpx256;
 
 #[cfg(test)]
 mod tests;

miden-crypto/src/hash/algebraic_sponge/rescue/rpo/mod.rs

@@ -124,7 +124,7 @@ impl Rpo256 {
 
     /// Returns a hash of the provided field elements.
     #[inline(always)]
-    pub fn hash_elements<E: crate::BasedVectorSpace<Felt>>(elements: &[E]) -> Word {
+    pub fn hash_elements<E: crate::field::BasedVectorSpace<Felt>>(elements: &[E]) -> Word {
         <Self as AlgebraicSponge>::hash_elements(elements)
     }
 

miden-crypto/src/hash/algebraic_sponge/rescue/rpo/tests.rs

@@ -8,9 +8,10 @@ use super::{
     Felt, Rpo256, STATE_WIDTH,
 };
 use crate::{
-    ONE, PrimeCharacteristicRing, PrimeField64, Word, ZERO,
+    ONE, Word, ZERO,
+    field::{PrimeCharacteristicRing, PrimeField64},
     hash::algebraic_sponge::{AlgebraicSponge, BINARY_CHUNK_SIZE, CAPACITY_RANGE, RATE_WIDTH},
-    test_utils::rand_value,
+    rand::test_utils::rand_value,
 };
 
 #[test]

miden-crypto/src/hash/algebraic_sponge/rescue/rpx/mod.rs

@@ -126,7 +126,7 @@ impl Rpx256 {
 
     /// Returns a hash of the provided field elements.
     #[inline(always)]
-    pub fn hash_elements<E: crate::BasedVectorSpace<Felt>>(elements: &[E]) -> Word {
+    pub fn hash_elements<E: crate::field::BasedVectorSpace<Felt>>(elements: &[E]) -> Word {
         <Self as AlgebraicSponge>::hash_elements(elements)
     }
 
@@ -250,7 +250,7 @@ impl Rpx256 {
 /// over the field arithmetic.
 mod cubic_ext {
     use super::Felt;
-    use crate::PrimeCharacteristicRing;
+    use crate::field::PrimeCharacteristicRing;
 
     /// Multiplies two cubic extension field elements.
     ///

miden-crypto/src/hash/algebraic_sponge/rescue/rpx/tests.rs

@@ -5,7 +5,9 @@ use p3_field::PrimeField64;
 use proptest::prelude::*;
 
 use super::{Felt, Rpx256};
-use crate::{ONE, Word, ZERO, hash::algebraic_sponge::AlgebraicSponge, test_utils::rand_value};
+use crate::{
+    ONE, Word, ZERO, hash::algebraic_sponge::AlgebraicSponge, rand::test_utils::rand_value,
+};
 
 // The number of iterations to run the `ext_round_matches_reference_many` test.
 #[cfg(all(

miden-crypto/src/hash/algebraic_sponge/rescue/tests.rs

@@ -2,7 +2,7 @@
 use p3_field::PrimeCharacteristicRing;
 
 use super::{ALPHA, Felt, INV_ALPHA};
-use crate::test_utils::rand_value;
+use crate::rand::test_utils::rand_value;
 
 #[test]
 fn test_alphas() {

miden-crypto/src/hash/blake/tests.rs

@@ -6,7 +6,7 @@ use p3_miden_goldilocks::Goldilocks as Felt;
 use proptest::prelude::*;
 
 use super::*;
-use crate::test_utils::rand_vector;
+use crate::rand::test_utils::rand_vector;
 
 #[test]
 fn blake3_hash_elements() {

miden-crypto/src/hash/keccak/mod.rs

@@ -10,7 +10,7 @@ use sha3::Digest as Sha3Digest;
 
 use super::{Felt, HasherExt};
 use crate::{
-    PrimeField64,
+    field::PrimeField64,
     utils::{
         ByteReader, ByteWriter, Deserializable, DeserializationError, HexParseError, Serializable,
         bytes_to_hex_string, hex_to_bytes,

miden-crypto/src/hash/keccak/tests.rs

@@ -4,7 +4,7 @@ use alloc::vec::Vec;
 use proptest::prelude::*;
 
 use super::*;
-use crate::test_utils::rand_vector;
+use crate::rand::test_utils::rand_vector;
 
 #[test]
 fn keccak256_hash_elements() {

miden-crypto/src/hash/mod.rs

@@ -13,20 +13,29 @@ pub mod sha2;
 
 /// Poseidon2 hash function.
 pub mod poseidon2 {
-    pub use super::algebraic_sponge::poseidon2::Poseidon2;
+    pub use p3_miden_goldilocks::Poseidon2Goldilocks;
+
+    pub use super::algebraic_sponge::poseidon2::{
+        Poseidon2, Poseidon2Challenger, Poseidon2Compression, Poseidon2Hasher,
+        Poseidon2Permutation256,
+    };
 }
 
 /// Rescue Prime Optimized (RPO) hash function.
 pub mod rpo {
-    pub use super::algebraic_sponge::rescue::Rpo256;
+    pub use super::algebraic_sponge::rescue::rpo::{
+        Rpo256, RpoChallenger, RpoCompression, RpoHasher, RpoPermutation256,
+    };
 }
 
 /// Rescue Prime Extended (RPX) hash function.
 pub mod rpx {
-    pub use super::algebraic_sponge::rescue::Rpx256;
+    pub use super::algebraic_sponge::rescue::rpx::{
+        Rpx256, RpxChallenger, RpxCompression, RpxHasher, RpxPermutation256,
+    };
 }
 
-pub mod algebraic_sponge;
+mod algebraic_sponge;
 
 // TRAITS
 // ================================================================================================

miden-crypto/src/hash/sha2/tests.rs

@@ -4,7 +4,7 @@ use alloc::vec::Vec;
 use proptest::prelude::*;
 
 use super::*;
-use crate::test_utils::rand_vector;
+use crate::rand::test_utils::rand_vector;
 
 // SHA-256 TESTS
 // ================================================================================================

miden-crypto/src/ies/crypto_box.rs

@@ -9,7 +9,7 @@ use alloc::vec::Vec;
 use rand::{CryptoRng, RngCore};
 
 use super::IesError;
-use crate::{Felt, aead::AeadScheme, ecdh::KeyAgreementScheme, zeroize::Zeroizing};
+use crate::{Felt, aead::AeadScheme, ecdh::KeyAgreementScheme, utils::zeroize::Zeroizing};
 
 // CRYPTO BOX
 // ================================================================================================