miden-standards 0.17.0

Standards 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
62
63

use miden_protocol::account::component::{AccountComponentCode, AccountComponentMetadata};
use miden_protocol::account::{AccountComponent, AccountProcedureRoot};

use crate::account::account_component_code;
use crate::procedure_root;

// ALLOW-ALL TRANSFER POLICY
// ================================================================================================

account_component_code!(
    ALLOW_ALL_TRANSFER_POLICY_CODE,
    "miden-standards-faucets-policies-transfer-allow-all.masp"
);

// PROCEDURE ROOTS
// ================================================================================================

/// MASL library namespace used for procedure-root lookups. Distinct from
/// [`TransferAllowAll::NAME`], which mirrors the standards-side MASM module path.
const TRANSFER_ALLOW_ALL_LIBRARY_PATH: &str =
    "miden::standards::components::faucets::policies::transfer::allow_all";

procedure_root!(
    ALLOW_ALL_TRANSFER_POLICY_ROOT,
    TRANSFER_ALLOW_ALL_LIBRARY_PATH,
    TransferAllowAll::PROC_NAME,
    TransferAllowAll::code()
);

/// The storage-free `allow_all` transfer policy account component.
///
/// Pair with a [`crate::account::policies::TokenPolicyManager`] whose allowed transfer-policies
/// map includes [`TransferAllowAll::root`]. When active, every transfer succeeds.
#[derive(Debug, Clone, Copy, Default)]
pub struct TransferAllowAll;

impl TransferAllowAll {
    /// The name of the component.
    pub const NAME: &'static str = "miden::standards::faucets::policies::transfer::allow_all";

    pub(crate) const PROC_NAME: &str = "check_policy";

    /// Returns the [`AccountComponentCode`] of this component.
    pub fn code() -> &'static AccountComponentCode {
        &ALLOW_ALL_TRANSFER_POLICY_CODE
    }

    /// Returns the procedure root of the `allow_all` transfer policy procedure.
    pub fn root() -> AccountProcedureRoot {
        *ALLOW_ALL_TRANSFER_POLICY_ROOT
    }
}

impl From<TransferAllowAll> for AccountComponent {
    fn from(_: TransferAllowAll) -> Self {
        let metadata = AccountComponentMetadata::new(TransferAllowAll::NAME)
            .with_description("`allow_all` transfer policy for callback-enabled faucets");

        AccountComponent::new(TransferAllowAll::code().clone(), vec![], metadata).expect(
            "`allow_all` transfer policy component should satisfy the requirements of a valid account component",
        )
    }
}