docs: missing types (#1100)

Author: igamigo

crates/miden-objects/src/account/account_id/account_type.rs

@@ -13,6 +13,7 @@ pub(super) const NON_FUNGIBLE_FAUCET: u8 = 0b11;
 pub(super) const REGULAR_ACCOUNT_IMMUTABLE_CODE: u8 = 0b00;
 pub(super) const REGULAR_ACCOUNT_UPDATABLE_CODE: u8 = 0b01;
 
+/// Represents the different account types recognized by the protocol.
 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
 #[repr(u8)]
 pub enum AccountType {

crates/miden-objects/src/account/account_id/storage_mode.rs

@@ -9,10 +9,13 @@ use crate::errors::AccountIdError;
 pub(super) const PUBLIC: u8 = 0b00;
 pub(super) const PRIVATE: u8 = 0b10;
 
+/// Describes where the state of the account is stored.
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 #[repr(u8)]
 pub enum AccountStorageMode {
+    /// The account's full state is stored on-chain.
     Public = PUBLIC,
+    /// The account's state is stored off-chain, and only a commitment to it is stored on-chain.
     Private = PRIVATE,
 }
 

crates/miden-objects/src/account/delta/mod.rs

@@ -96,6 +96,8 @@ impl AccountDelta {
     }
 }
 
+/// Describes the details of an account state transition resulting from applying a transaction to
+/// the account.
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub enum AccountUpdateDetails {
     /// Account is private (no on-chain state change).

crates/miden-objects/src/account/storage/slot/mod.rs

@@ -12,7 +12,12 @@ pub use r#type::StorageSlotType;
 // STORAGE SLOT
 // ================================================================================================
 
-/// An object that represents the type of a storage slot.
+/// An object representing the contents of an account's storage slot.
+///
+/// An account storage slot can be of two types:
+/// - A simple value which contains a single word (4 field elements or ~32 bytes).
+/// - A key value map where both keys and values are words. The capacity of such storage slot is
+///   theoretically unlimited.
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub enum StorageSlot {
     Value(Word),