Struct TokenPolicyManager 

pub struct TokenPolicyManager { /* private fields */ }

An AccountComponent that owns the policy-manager storage slots and the manager procedures for the four policy kinds (mint, burn, send, receive).

The component exposes set_*_policy, get_*_policy, and execute_*_policy procedures for each kind, plus the protocol-level on_before_asset_added_to_* asset callbacks (which dispatch to the active send / receive policy). Authorization for switching the active policies is delegated to the account-wide Authority component, which must be installed alongside this manager.

Construct via Self::new and chain the per-kind builders (Self::with_mint_policy / Self::with_burn_policy / Self::with_send_policy / Self::with_receive_policy). Each accepts a typed config plus a PolicyRegistration flag to register the policy as either the active one or as a reserved alternative for runtime switching via the matching set_*_policy procedure. Each builder returns Result<Self, TokenPolicyManagerError> — registering more than one PolicyRegistration::Active entry per kind returns TokenPolicyManagerError::DuplicateActivePolicy.

Pass the manager directly to miden_protocol::account::AccountBuilder::with_components (the type implements IntoIterator<Item = AccountComponent>). Iteration yields the manager itself plus the companion components contributed by every registered policy (deduplicated by procedure root — a policy installed under both send and receive only contributes its companion components once). Custom variants on any kind contribute no built-in components — the caller installs the matching components on the account separately.

Storage layout

• Self::active_mint_policy_slot: procedure root of the active mint policy.
• Self::active_burn_policy_slot: procedure root of the active burn policy.
• Self::allowed_mint_policies_slot: map of allowed mint policy roots.
• Self::allowed_burn_policies_slot: map of allowed burn policy roots.
• Self::allowed_send_policies_slot: map of allowed send policy roots.
• Self::allowed_receive_policies_slot: map of allowed receive policy roots.
• Asset-callback storage slots (registered via AssetCallbacks) hold the active send and receive policy procedure roots directly so the kernel dispatches to them via call. They are installed whenever any transfer policy is registered with this manager — including AllowAll — so that every minted asset carries AssetCallbackFlag::Enabled uniformly and future policy switches via set_send_policy / set_receive_policy apply to the entire circulating supply rather than only to assets minted after the switch.

Implementations

impl TokenPolicyManager

pub const NAME: &'static str = "miden::standards::faucets::policies::policy_manager"

The name of the component (used in metadata).

pub const DESCRIPTION: &'static str = "Token policy manager for fungible faucets"

Component description used in AccountComponentMetadata.

pub const fn name() -> AccountComponentName

Returns the canonical AccountComponentName of this component.

pub fn new() -> TokenPolicyManager

Creates an empty token policy manager. Use the per-kind builders (with_mint_policy, with_burn_policy, with_send_policy, with_receive_policy) to register policies.

Every kind should end up with exactly one PolicyRegistration::Active entry by the time the manager is converted into account components. Missing active entries leave the corresponding active_*_policy_proc_root storage slot at the zero word.

pub fn with_mint_policy( self, policy: MintPolicyConfig, registration: PolicyRegistration, ) -> Result<TokenPolicyManager, TokenPolicyManagerError>

Registers a mint policy. The registration flag decides whether the policy becomes the active one (written to active_mint_policy_proc_root) or a reserved alternative (added to the allowed_mint_policy_proc_roots map for runtime switching via set_mint_policy).

Errors

Returns TokenPolicyManagerError::DuplicateActivePolicy if registration is PolicyRegistration::Active and an active mint policy is already registered.

pub fn with_burn_policy( self, policy: BurnPolicyConfig, registration: PolicyRegistration, ) -> Result<TokenPolicyManager, TokenPolicyManagerError>

Registers a burn policy. See Self::with_mint_policy for registration semantics.

Errors

Returns TokenPolicyManagerError::DuplicateActivePolicy if registration is PolicyRegistration::Active and an active burn policy is already registered.

pub fn with_send_policy( self, policy: TransferPolicy, registration: PolicyRegistration, ) -> Result<TokenPolicyManager, TokenPolicyManagerError>

Registers a send policy (fired by the on_before_asset_added_to_note callback). See Self::with_mint_policy for registration semantics.

Errors

Returns TokenPolicyManagerError::DuplicateActivePolicy if registration is PolicyRegistration::Active and an active send policy is already registered.

pub fn with_receive_policy( self, policy: TransferPolicy, registration: PolicyRegistration, ) -> Result<TokenPolicyManager, TokenPolicyManagerError>

Registers a receive policy (fired by the on_before_asset_added_to_account callback). See Self::with_mint_policy for registration semantics.

Errors

Returns TokenPolicyManagerError::DuplicateActivePolicy if registration is PolicyRegistration::Active and an active receive policy is already registered.

pub fn active_mint_policy(&self) -> Option<AccountProcedureRoot>

Returns the active mint policy procedure root, or None if no active mint policy has been registered.

pub fn active_burn_policy(&self) -> Option<AccountProcedureRoot>

Returns the active burn policy procedure root, or None if no active burn policy has been registered.

pub fn active_send_policy(&self) -> Option<AccountProcedureRoot>

Returns the active send policy procedure root, or None if no active send policy has been registered.

pub fn active_receive_policy(&self) -> Option<AccountProcedureRoot>

Returns the active receive policy procedure root, or None if no active receive policy has been registered.

pub fn allowed_mint_policies(&self) -> Vec<AccountProcedureRoot>

Returns all allowed mint policy procedure roots (active + reserved).

pub fn allowed_burn_policies(&self) -> Vec<AccountProcedureRoot>

Returns all allowed burn policy procedure roots (active + reserved).

pub fn allowed_send_policies(&self) -> Vec<AccountProcedureRoot>

Returns all allowed send policy procedure roots (active + reserved).

pub fn allowed_receive_policies(&self) -> Vec<AccountProcedureRoot>

Returns all allowed receive policy procedure roots (active + reserved).

pub fn set_mint_policy_root() -> AccountProcedureRoot

Returns the procedure root of the set_mint_policy account procedure.

pub fn set_burn_policy_root() -> AccountProcedureRoot

Returns the procedure root of the set_burn_policy account procedure.

pub fn set_send_policy_root() -> AccountProcedureRoot

Returns the procedure root of the set_send_policy account procedure.

pub fn set_receive_policy_root() -> AccountProcedureRoot

Returns the procedure root of the set_receive_policy account procedure.

pub fn active_mint_policy_slot() -> &'static StorageSlotName

Returns the StorageSlotName where the active mint policy procedure root is stored.

pub fn active_burn_policy_slot() -> &'static StorageSlotName

Returns the StorageSlotName where the active burn policy procedure root is stored.

pub fn allowed_mint_policies_slot() -> &'static StorageSlotName

Returns the StorageSlotName where allowed mint policy roots are stored.

pub fn allowed_burn_policies_slot() -> &'static StorageSlotName

Returns the StorageSlotName where allowed burn policy roots are stored.

pub fn allowed_send_policies_slot() -> &'static StorageSlotName

Returns the StorageSlotName where allowed send policy roots are stored.

pub fn allowed_receive_policies_slot() -> &'static StorageSlotName

Returns the StorageSlotName where allowed receive policy roots are stored.

pub fn code() -> &'static AccountComponentCode

Returns the AccountComponentCode of this component.

pub fn component_metadata() -> AccountComponentMetadata

Returns the AccountComponentMetadata for this component.

Trait Implementations

impl Clone for TokenPolicyManager

fn clone(&self) -> TokenPolicyManager

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TokenPolicyManager

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for TokenPolicyManager

fn default() -> TokenPolicyManager

Returns the “default value” for a type.

impl IntoIterator for TokenPolicyManager

fn into_iter(self) -> <TokenPolicyManager as IntoIterator>::IntoIter

Yields the AccountComponents implementing this token policy configuration: the manager itself first, then the companion components contributed by every registered policy. Deduplication by procedure root is implicit (the manager’s internal policies map is keyed by root), so a policy installed under both send and receive only contributes its companion components once. Custom variants on any kind contribute no built-in components — the caller installs the matching components on the account separately.

type Item = AccountComponent

The type of the elements being iterated over.

type IntoIter = IntoIter<AccountComponent>

Which kind of iterator are we turning this into?