miden-lib 0.12.4

Standard library of the Miden protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

use alloc::vec::Vec;

use miden_objects::account::{AccountCode, AccountComponent, AccountStorage, StorageSlot};

use crate::testing::mock_account_code::MockAccountCodeExt;

// MOCK ACCOUNT COMPONENT
// ================================================================================================

/// A mock account component for use in tests.
///
/// It uses the [`MockAccountCodeExt::mock_account_library`][account_lib] and allows for an
/// arbitrary number of storage slots (within the overall limit) so anything can be set for testing
/// purposes.
///
/// This component supports all [`AccountType`](miden_objects::account::AccountType)s for testing
/// purposes.
///
/// [account_lib]: crate::testing::mock_account_code::MockAccountCodeExt::mock_account_library
pub struct MockAccountComponent {
    storage_slots: Vec<StorageSlot>,
}

impl MockAccountComponent {
    // CONSTRUCTORS
    // --------------------------------------------------------------------------------------------

    /// Constructs a [`MockAccountComponent`] with empty storage.
    pub fn with_empty_slots() -> Self {
        Self::new(vec![])
    }

    /// Constructs a [`MockAccountComponent`] with the provided storage slots.
    ///
    /// # Panics
    ///
    /// Panics if the number of slots exceeds [`AccountStorage::MAX_NUM_STORAGE_SLOTS`].
    pub fn with_slots(storage_slots: Vec<StorageSlot>) -> Self {
        Self::new(storage_slots)
    }

    // HELPERS
    // --------------------------------------------------------------------------------------------

    fn new(storage_slots: Vec<StorageSlot>) -> Self {
        debug_assert!(
            storage_slots.len() <= AccountStorage::MAX_NUM_STORAGE_SLOTS,
            "too many storage slots passed to MockAccountComponent"
        );

        Self { storage_slots }
    }
}

impl From<MockAccountComponent> for AccountComponent {
    fn from(mock_component: MockAccountComponent) -> Self {
        AccountComponent::new(AccountCode::mock_account_library(), mock_component.storage_slots)
          .expect("mock account component should satisfy the requirements of a valid account component")
          .with_supports_all_types()
    }
}