Move crates into crates/ and rename plural modules to singular (#1091)

CHANGELOG.md

@@ -37,6 +37,7 @@
 - [BREAKING] Removed `GENESIS_BLOCK` public constant (#1088).
 - Add CI check for unused dependencies (#1075).
 - Added storage placeholder types and support for templated map (#1074).
+- [BREAKING] Move crates into `crates/` and rename plural modules to singular (#1091).
 
 ## 0.6.2 (2024-11-20)
 

Cargo.toml

@@ -1,10 +1,10 @@
 [workspace]
 resolver = "2"
 members = [ 
-    "miden-lib",
-    "miden-tx",
-    "miden-proving-service-client",
-    "objects",
+    "crates/miden-lib",
+    "crates/miden-tx",
+    "crates/miden-proving-service-client",
+    "crates/miden-objects",
     "bin/bench-tx",
     "bin/proving-service",
 ]
@@ -36,11 +36,11 @@ lto = true
 assembly = { package = "miden-assembly", version = "0.12", default-features = false }
 assert_matches = { version = "1.5", default-features = false }
 miden-crypto = { version = "0.13", default-features = false }
-miden-lib = { path = "miden-lib", version = "0.7", default-features = false }
-miden-objects = { path = "objects", version = "0.7", default-features = false }
+miden-lib = { path = "crates/miden-lib", version = "0.7", default-features = false }
+miden-objects = { path = "crates/miden-objects", version = "0.7", default-features = false }
 miden-prover = { version = "0.12", default-features = false }
 miden-stdlib = { version = "0.12", default-features = false }
-miden-tx = { path = "miden-tx", version = "0.7", default-features = false }
+miden-tx = { path = "crates/miden-tx", version = "0.7", default-features = false }
 miden-verifier = { version = "0.12", default-features = false }
 rand = { version = "0.8", default-features = false }
 thiserror = { version = "2.0", default-features = false }

bin/bench-tx/src/main.rs

@@ -5,12 +5,12 @@ use std::{
     path::Path,
 };
 
-use miden_lib::{notes::create_p2id_note, transaction::TransactionKernel};
+use miden_lib::{note::create_p2id_note, transaction::TransactionKernel};
 use miden_objects::{
-    accounts::{AccountId, AccountStorageMode, AccountType},
-    assets::{Asset, FungibleAsset},
+    account::{AccountId, AccountStorageMode, AccountType},
+    asset::{Asset, FungibleAsset},
     crypto::rand::RpoRandomCoin,
-    notes::NoteType,
+    note::NoteType,
     transaction::{TransactionArgs, TransactionMeasurements, TransactionScript},
     Felt,
 };

bin/bench-tx/src/utils.rs

@@ -2,10 +2,10 @@ extern crate alloc;
 pub use alloc::{collections::BTreeMap, string::String};
 use std::sync::Arc;
 
-use miden_lib::accounts::{auth::RpoFalcon512, wallets::BasicWallet};
+use miden_lib::account::{auth::RpoFalcon512, wallets::BasicWallet};
 use miden_objects::{
-    accounts::{Account, AccountBuilder, AccountStorageMode, AccountType, AuthSecretKey},
-    assets::Asset,
+    account::{Account, AccountBuilder, AccountStorageMode, AccountType, AuthSecretKey},
+    asset::Asset,
     crypto::dsa::rpo_falcon512::{PublicKey, SecretKey},
     transaction::TransactionMeasurements,
 };

bin/proving-service/src/main.rs

@@ -29,8 +29,8 @@ mod test {
 
     use miden_lib::transaction::TransactionKernel;
     use miden_objects::{
-        assets::{Asset, FungibleAsset},
-        notes::NoteType,
+        asset::{Asset, FungibleAsset},
+        note::NoteType,
         testing::{
             account_code::DEFAULT_AUTH_SCRIPT,
             account_id::{ACCOUNT_ID_FUNGIBLE_FAUCET_ON_CHAIN, ACCOUNT_ID_SENDER},

miden-lib/src/accounts/auth/mod.rs → crates/miden-lib/src/account/auth/mod.rs

@@ -1,9 +1,9 @@
 use miden_objects::{
-    accounts::{AccountComponent, StorageSlot},
+    account::{AccountComponent, StorageSlot},
     crypto::dsa::rpo_falcon512::PublicKey,
 };
 
-use crate::accounts::components::rpo_falcon_512_library;
+use crate::account::components::rpo_falcon_512_library;
 
 /// An [`AccountComponent`] implementing the RpoFalcon512 signature scheme for authentication of
 /// transactions.

miden-lib/src/accounts/faucets/mod.rs → crates/miden-lib/src/account/faucets/mod.rs

@@ -1,14 +1,14 @@
 use miden_objects::{
-    accounts::{
+    account::{
         Account, AccountBuilder, AccountComponent, AccountIdAnchor, AccountStorageMode,
         AccountType, StorageSlot,
     },
-    assets::{FungibleAsset, TokenSymbol},
+    asset::{FungibleAsset, TokenSymbol},
     AccountError, Felt, FieldElement, Word,
 };
 
 use super::AuthScheme;
-use crate::accounts::{auth::RpoFalcon512, components::basic_fungible_faucet_library};
+use crate::account::{auth::RpoFalcon512, components::basic_fungible_faucet_library};
 
 // BASIC FUNGIBLE FAUCET ACCOUNT COMPONENT
 // ================================================================================================

miden-lib/src/accounts/wallets/mod.rs → crates/miden-lib/src/account/wallets/mod.rs

@@ -1,14 +1,14 @@
 use alloc::string::ToString;
 
 use miden_objects::{
-    accounts::{
+    account::{
         Account, AccountBuilder, AccountComponent, AccountIdAnchor, AccountStorageMode, AccountType,
     },
     AccountError, Word,
 };
 
 use super::AuthScheme;
-use crate::accounts::{auth::RpoFalcon512, components::basic_wallet_library};
+use crate::account::{auth::RpoFalcon512, components::basic_wallet_library};
 
 // BASIC WALLET
 // ================================================================================================

miden-lib/src/lib.rs → crates/miden-lib/src/lib.rs

@@ -15,9 +15,9 @@ use miden_objects::{
 mod auth;
 pub use auth::AuthScheme;
 
-pub mod accounts;
+pub mod account;
 pub mod errors;
-pub mod notes;
+pub mod note;
 pub mod transaction;
 
 // RE-EXPORTS

miden-lib/src/notes/mod.rs → crates/miden-lib/src/note/mod.rs

@@ -1,11 +1,11 @@
 use alloc::vec::Vec;
 
 use miden_objects::{
-    accounts::AccountId,
-    assets::Asset,
+    account::AccountId,
+    asset::Asset,
     block::BlockNumber,
     crypto::rand::FeltRng,
-    notes::{
+    note::{
         Note, NoteAssets, NoteDetails, NoteExecutionHint, NoteExecutionMode, NoteInputs,
         NoteMetadata, NoteRecipient, NoteTag, NoteType,
     },

miden-lib/src/notes/scripts.rs → crates/miden-lib/src/note/scripts.rs

@@ -1,5 +1,5 @@
 use miden_objects::{
-    notes::NoteScript,
+    note::NoteScript,
     utils::{sync::LazyLock, Deserializable},
     vm::Program,
 };

miden-lib/src/notes/utils.rs → crates/miden-lib/src/note/utils.rs

@@ -1,11 +1,11 @@
 use miden_objects::{
-    accounts::AccountId,
-    assets::Asset,
-    notes::{NoteExecutionMode, NoteInputs, NoteRecipient, NoteTag, NoteType},
+    account::AccountId,
+    asset::Asset,
+    note::{NoteExecutionMode, NoteInputs, NoteRecipient, NoteTag, NoteType},
     NoteError, Word,
 };
 
-use crate::notes::scripts;
+use crate::note::scripts;
 
 /// Creates a [NoteRecipient] for the P2ID note.
 ///
@@ -56,8 +56,8 @@ pub fn build_swap_tag(
 mod tests {
     use miden_objects::{
         self,
-        accounts::{AccountIdVersion, AccountStorageMode, AccountType},
-        assets::{FungibleAsset, NonFungibleAsset, NonFungibleAssetDetails},
+        account::{AccountIdVersion, AccountStorageMode, AccountType},
+        asset::{FungibleAsset, NonFungibleAsset, NonFungibleAssetDetails},
     };
 
     use super::*;

miden-lib/src/transaction/errors.rs → crates/miden-lib/src/transaction/errors.rs

@@ -1,7 +1,7 @@
 use alloc::{boxed::Box, vec::Vec};
 use core::error::Error;
 
-use miden_objects::{notes::NoteMetadata, AccountDeltaError, AssetError, Digest, Felt, NoteError};
+use miden_objects::{note::NoteMetadata, AccountDeltaError, AssetError, Digest, Felt, NoteError};
 use thiserror::Error;
 
 // TRANSACTION KERNEL ERROR

miden-lib/src/transaction/inputs.rs → crates/miden-lib/src/transaction/inputs.rs

@@ -1,7 +1,7 @@
 use alloc::vec::Vec;
 
 use miden_objects::{
-    accounts::{Account, StorageSlot},
+    account::{Account, StorageSlot},
     transaction::{ChainMmr, InputNote, TransactionArgs, TransactionInputs, TransactionScript},
     vm::AdviceInputs,
     Digest, Felt, FieldElement, Word, EMPTY_WORD, WORD_SIZE, ZERO,

miden-lib/src/transaction/mod.rs → crates/miden-lib/src/transaction/mod.rs

@@ -1,7 +1,7 @@
 use alloc::{string::ToString, sync::Arc, vec::Vec};
 
 use miden_objects::{
-    accounts::{AccountCode, AccountHeader, AccountId, AccountStorageHeader},
+    account::{AccountCode, AccountHeader, AccountId, AccountStorageHeader},
     assembly::{Assembler, DefaultSourceManager, KernelLibrary},
     block::BlockNumber,
     crypto::merkle::{MerkleError, MerklePath},

miden-lib/src/transaction/outputs.rs → crates/miden-lib/src/transaction/outputs.rs

@@ -1,5 +1,5 @@
 use miden_objects::{
-    accounts::{AccountHeader, AccountId},
+    account::{AccountHeader, AccountId},
     AccountError, Felt, Word, WORD_SIZE,
 };
 

objects/benches/account_seed.rs → crates/miden-objects/benches/account_seed.rs

@@ -2,7 +2,7 @@ use std::time::Duration;
 
 use criterion::{criterion_group, criterion_main, Criterion};
 use miden_objects::{
-    accounts::{AccountId, AccountIdVersion, AccountStorageMode, AccountType},
+    account::{AccountId, AccountIdVersion, AccountStorageMode, AccountType},
     Digest,
 };
 use rand::{Rng, SeedableRng};

objects/src/accounts/account_id/id_anchor.rs → crates/miden-objects/src/account/account_id/id_anchor.rs

@@ -7,7 +7,7 @@ use crate::{
 // ACCOUNT ID ANCHOR
 // ================================================================================================
 
-/// The anchor of an [`AccountId`](crate::accounts::AccountId). See the type's documentation for
+/// The anchor of an [`AccountId`](crate::account::AccountId). See the type's documentation for
 /// details on anchors.
 ///
 /// This type is recommended to be created from a reference to a [`BlockHeader`] via the `TryFrom`

objects/src/accounts/account_id/id_prefix.rs → crates/miden-objects/src/account/account_id/id_prefix.rs

@@ -10,7 +10,7 @@ use vm_processor::DeserializationError;
 
 use super::v0;
 use crate::{
-    accounts::{
+    account::{
         account_id::AccountIdPrefixV0, AccountIdV0, AccountIdVersion, AccountStorageMode,
         AccountType,
     },
@@ -27,7 +27,7 @@ use crate::{
 /// The serialization formats of [`AccountIdPrefix`] and [`AccountId`][id] are compatible. In
 /// particular, a prefix can be deserialized from the serialized bytes of a full id.
 ///
-/// [id]: crate::accounts::AccountId
+/// [id]: crate::account::AccountId
 #[derive(Debug, Copy, Clone, Eq, PartialEq)]
 pub enum AccountIdPrefix {
     V0(AccountIdPrefixV0),
@@ -56,7 +56,7 @@ impl AccountIdPrefix {
     ///
     /// If debug_assertions are enabled (e.g. in debug mode), this function panics if the given
     /// felt is invalid according to the constraints in the
-    /// [`AccountId`](crate::accounts::AccountId) documentation.
+    /// [`AccountId`](crate::account::AccountId) documentation.
     pub fn new_unchecked(prefix: Felt) -> Self {
         // The prefix contains the metadata.
         // If we add more versions in the future, we may need to generalize this.
@@ -296,7 +296,7 @@ impl Deserializable for AccountIdPrefix {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::accounts::AccountIdV0;
+    use crate::account::AccountIdV0;
 
     #[test]
     fn account_id_prefix_construction() {

objects/src/accounts/account_id/id_version.rs → crates/miden-objects/src/account/account_id/id_version.rs

@@ -5,7 +5,7 @@ use crate::errors::AccountIdError;
 
 const VERSION_0_NUMBER: u8 = 0;
 
-/// The version of an [`AccountId`](crate::accounts::AccountId).
+/// The version of an [`AccountId`](crate::account::AccountId).
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 #[repr(u8)]
 pub enum AccountIdVersion {

objects/src/accounts/account_id/mod.rs → crates/miden-objects/src/account/account_id/mod.rs

@@ -27,7 +27,7 @@ use vm_processor::{DeserializationError, Digest};
 
 use crate::{errors::AccountIdError, AccountError, ACCOUNT_TREE_DEPTH};
 
-/// The identifier of an [`Account`](crate::accounts::Account).
+/// The identifier of an [`Account`](crate::account::Account).
 ///
 /// This enum is a wrapper around concrete versions of IDs. The following documents version 0.
 ///
@@ -89,8 +89,8 @@ use crate::{errors::AccountIdError, AccountError, ACCOUNT_TREE_DEPTH};
 ///   than [`u16::MAX`] so that at least one of the upper 16 bits is always zero. This ensures that
 ///   the entire suffix is valid even if the remaining bits of the felt are one.
 /// - The lower 8 bits of the suffix may be overwritten when the ID is encoded in other layouts such
-///   as the [`NoteMetadata`](crate::notes::NoteMetadata). In such cases, it can happen that all
-///   bits of the encoded suffix would be one, so having the epoch constraint is important.
+///   as the [`NoteMetadata`](crate::note::NoteMetadata). In such cases, it can happen that all bits
+///   of the encoded suffix would be one, so having the epoch constraint is important.
 /// - The ID is dependent on the hash of an epoch block. This is a block whose number is a multiple
 ///   of 2^[`BlockNumber::EPOCH_LENGTH_EXPONENT`][epoch_len_exp], e.g. `0`, `65536`, `131072`, ...
 ///   These are the first blocks of epoch 0, 1, 2, ... We call this dependence _anchoring_ because

objects/src/accounts/account_id/seed.rs → crates/miden-objects/src/account/account_id/seed.rs

@@ -4,7 +4,7 @@ use vm_core::{Felt, Word};
 use vm_processor::Digest;
 
 use crate::{
-    accounts::{
+    account::{
         account_id::{
             v0::{compute_digest, validate_prefix},
             AccountIdVersion,
@@ -100,7 +100,7 @@ mod log {
     use vm_processor::Digest;
 
     use super::AccountType;
-    use crate::accounts::AccountStorageMode;
+    use crate::account::AccountStorageMode;
 
     /// Keeps track of the best digest found so far and count how many iterations have been done.
     pub struct Log {

objects/src/accounts/account_id/v0/mod.rs → crates/miden-objects/src/account/account_id/v0/mod.rs

@@ -14,7 +14,7 @@ use vm_core::{
 use vm_processor::{DeserializationError, Digest};
 
 use crate::{
-    accounts::{
+    account::{
         account_id::{
             account_type::{
                 FUNGIBLE_FAUCET, NON_FUNGIBLE_FAUCET, REGULAR_ACCOUNT_IMMUTABLE_CODE,
@@ -31,7 +31,7 @@ use crate::{
 // ACCOUNT ID VERSION 0
 // ================================================================================================
 
-/// Version 0 of the [`Account`](crate::accounts::Account) identifier.
+/// Version 0 of the [`Account`](crate::account::Account) identifier.
 ///
 /// See the [`AccountId`](super::AccountId) type's documentation for details.
 #[derive(Debug, Copy, Clone, Eq, PartialEq)]
@@ -154,7 +154,7 @@ impl AccountIdV0 {
         storage_commitment: Digest,
         anchor_block_hash: Digest,
     ) -> Result<Word, AccountError> {
-        crate::accounts::account_id::seed::compute_account_seed(
+        crate::account::account_id::seed::compute_account_seed(
             init_seed,
             account_type,
             storage_mode,
@@ -504,7 +504,7 @@ mod tests {
 
     use super::*;
     use crate::{
-        accounts::AccountIdPrefix,
+        account::AccountIdPrefix,
         testing::account_id::{
             ACCOUNT_ID_FUNGIBLE_FAUCET_ON_CHAIN, ACCOUNT_ID_NON_FUNGIBLE_FAUCET_OFF_CHAIN,
             ACCOUNT_ID_OFF_CHAIN_SENDER, ACCOUNT_ID_REGULAR_ACCOUNT_IMMUTABLE_CODE_ON_CHAIN,