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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

use alloc::collections::BTreeSet;
use alloc::vec::Vec;

use miden_protocol::account::{Account, AccountCode, AccountId, AccountProcedureRoot};

use crate::account::components::StandardAccountComponent;
use crate::account::interface::{AccountComponentInterface, AccountInterface};

// ACCOUNT INTERFACE EXTENSION TRAIT
// ================================================================================================

/// An extension for [`AccountInterface`] that allows instantiation from higher-level types.
pub trait AccountInterfaceExt {
    /// Creates a new [`AccountInterface`] instance from the provided account ID and account code.
    fn from_code(account_id: AccountId, code: &AccountCode) -> Self;

    /// Creates a new [`AccountInterface`] instance from the provided [`Account`].
    fn from_account(account: &Account) -> Self;
}

impl AccountInterfaceExt for AccountInterface {
    fn from_code(account_id: AccountId, code: &AccountCode) -> Self {
        let components = AccountComponentInterface::from_procedures(code.procedures());
        Self::new(account_id, components)
    }

    fn from_account(account: &Account) -> Self {
        let components = AccountComponentInterface::from_procedures(account.code().procedures());
        Self::new(account.id(), components)
    }
}

/// An extension for [`AccountComponentInterface`] that allows instantiation from a set of procedure
/// roots.
pub trait AccountComponentInterfaceExt {
    /// Creates a vector of [`AccountComponentInterface`] instances from the provided set of
    /// procedures.
    fn from_procedures(procedures: &[AccountProcedureRoot]) -> Vec<AccountComponentInterface>;
}

impl AccountComponentInterfaceExt for AccountComponentInterface {
    fn from_procedures(procedures: &[AccountProcedureRoot]) -> Vec<Self> {
        let mut component_interface_vec = Vec::new();

        // `AccountCode` places the account's authentication procedure at index 0.
        let auth_procedure = procedures.first().copied();

        let mut procedures = BTreeSet::from_iter(procedures.iter().copied());

        // Standard component interfaces
        // ----------------------------------------------------------------------------------------

        // Get all available standard components which could be constructed from the
        // `procedures` map and push them to the `component_interface_vec`
        StandardAccountComponent::extract_standard_components(
            &mut procedures,
            &mut component_interface_vec,
        );

        // Custom authentication component interface
        // ----------------------------------------------------------------------------------------

        // If no standard auth interface claimed the authentication procedure, the account
        // authenticates through a custom component.
        if !component_interface_vec.iter().any(|component| component.is_auth_component())
            && let Some(auth_procedure) = auth_procedure
        {
            procedures.remove(&auth_procedure);
            component_interface_vec.push(AccountComponentInterface::CustomAuth(auth_procedure));
        }

        // Custom component interfaces
        // ----------------------------------------------------------------------------------------

        // All remaining procedures are put into the custom bucket.
        if !procedures.is_empty() {
            component_interface_vec
                .push(AccountComponentInterface::Custom(procedures.into_iter().collect()));
        }

        component_interface_vec
    }
}