Flexible Minting Policies for Token Standards

CHANGELOG.md

@@ -30,6 +30,7 @@
 - Added `Ownable2Step` account component with two-step ownership transfer (`transfer_ownership`, `accept_ownership`, `renounce_ownership`) and `owner`, `nominated_owner` procedures ([#2292](https://github.com/0xMiden/miden-base/pull/2292)).
 - Added PSM authentication procedures and integrated them into `AuthMultisig` ([#2527](https://github.com/0xMiden/protocol/pull/2527)).
 - Added `CodeBuilder::with_warnings_as_errors()` to promote assembler warning diagnostics to errors ([#2558](https://github.com/0xMiden/protocol/pull/2558)).
+- Added `MintPolicyConfig` for flexible minting policy enforcement ([#2559](https://github.com/0xMiden/protocol/pull/2559))
 - Added `MockChain::add_pending_batch()` to allow submitting user batches directly ([#2565](https://github.com/0xMiden/protocol/pull/2565)).
 - Added `create_fungible_key` for construction of fungible asset keys ([#2575](https://github.com/0xMiden/protocol/pull/2575)).
 - Implemented the `on_before_asset_added_to_account` asset callback ([#2571](https://github.com/0xMiden/protocol/pull/2571)).

crates/miden-agglayer/asm/agglayer/faucet/mod.masm

@@ -307,7 +307,7 @@ proc build_p2id_output_note
     mem_store.OUTPUT_NOTE_TARGET_ACCOUNT_ID_SUFFIX_PTR
     mem_store.OUTPUT_NOTE_TARGET_ACCOUNT_ID_PREFIX_PTR
 
-    # store amount in memory locals for use in faucets::distribute
+    # store amount in memory locals for use in faucets::mint_and_send
     loc_storew_be.BUILD_P2ID_AMOUNT_MEM_LOC_0 dropw loc_storew_be.BUILD_P2ID_AMOUNT_MEM_LOC_1 dropw
     # => [pad(16)]
 
@@ -350,7 +350,7 @@ proc build_p2id_output_note
     exec.asset_conversion::verify_u256_to_native_amount_conversion
     # => [amount, tag, note_type, RECIPIENT]
 
-    exec.faucets::distribute
+    exec.faucets::mint_and_send
     # => [pad(16)]
 end
 
@@ -393,7 +393,7 @@ end
 #!
 #! Panics if:
 #! - the rollup exit root Merkle Proof validation via FPI fails.
-#! - any of the validations in faucets::distribute fail.
+#! - any of the validations in faucets::mint_and_send fail.
 #!
 #! Invocation: call
 @locals(10) # 2 for prefix and suffix, 8 for amount

crates/miden-standards/asm/account_components/faucets/basic_fungible_faucet.masm

@@ -2,5 +2,5 @@
 #
 # See the `BasicFungibleFaucet` Rust type's documentation for more details.
 
-pub use ::miden::standards::faucets::basic_fungible::distribute
+pub use ::miden::standards::faucets::basic_fungible::mint_and_send
 pub use ::miden::standards::faucets::basic_fungible::burn

crates/miden-standards/asm/account_components/faucets/network_fungible_faucet.masm

@@ -2,5 +2,5 @@
 #
 # See the `NetworkFungibleFaucet` Rust type's documentation for more details.
 
-pub use ::miden::standards::faucets::network_fungible::distribute
+pub use ::miden::standards::faucets::network_fungible::mint_and_send
 pub use ::miden::standards::faucets::network_fungible::burn

crates/miden-standards/asm/account_components/mint_policies/auth_controlled.masm

@@ -0,0 +1,7 @@
+# The MASM code of the Mint Policy Auth Controlled Account Component.
+#
+# See the `AuthControlled` Rust type's documentation for more details.
+
+pub use ::miden::standards::mint_policies::auth_controlled::allow_all
+pub use ::miden::standards::mint_policies::policy_manager::set_mint_policy
+pub use ::miden::standards::mint_policies::policy_manager::get_mint_policy

crates/miden-standards/asm/account_components/mint_policies/owner_controlled.masm

@@ -0,0 +1,7 @@
+# The MASM code of the Mint Policy Owner Controlled Account Component.
+#
+# See the `OwnerControlled` Rust type's documentation for more details.
+
+pub use ::miden::standards::mint_policies::owner_controlled::owner_only
+pub use ::miden::standards::mint_policies::policy_manager::set_mint_policy
+pub use ::miden::standards::mint_policies::policy_manager::get_mint_policy

crates/miden-standards/asm/standards/faucets/basic_fungible.masm

@@ -1,14 +1,17 @@
 # BASIC FUNGIBLE FAUCET CONTRACT
 #
 # See the `BasicFungibleFaucet` documentation for details.
+#
+# Note: This component requires `MintPolicyManager` component to also be present in the account.
 # =================================================================================================
 
 use miden::standards::faucets
+use miden::standards::mint_policies::policy_manager
 
 # PROCEDURES
 # =================================================================================================
 
-#! Distributes freshly minted fungible assets to the provided recipient by creating a note.
+#! Mints fungible assets to the provided recipient by creating a note.
 #!
 #! Inputs:  [amount, tag, note_type, RECIPIENT, pad(9)]
 #! Outputs: [note_idx, pad(15)]
@@ -22,11 +25,19 @@ use miden::standards::faucets
 #! - note_idx is the index of the created note.
 #!
 #! Panics if:
-#! - any of the validations in faucets::distribute fail.
+#! - active mint policy validation fails.
+#! - any of the validations in faucets::mint_and_send fail.
 #!
 #! Invocation: call
-pub proc distribute
-    exec.faucets::distribute
+pub proc mint_and_send
+    # TODO: Remove once AccountComponentInterface is refactored
+    # Keep this procedure digest distinct from network_fungible::mint_and_send.
+    push.0 drop
+
+    exec.policy_manager::execute_mint_policy
+    # => [new_amount, new_tag, new_note_type, NEW_RECIPIENT, pad(9)]
+
+    exec.faucets::mint_and_send
     # => [note_idx, pad(15)]
 end
 

crates/miden-standards/asm/standards/faucets/mod.masm

@@ -35,7 +35,7 @@ const METADATA_SLOT_LOCAL=0
 # Layout: [token_supply, max_supply, decimals, token_symbol]
 const METADATA_SLOT=word("miden::standards::fungible_faucets::metadata")
 
-#! Distributes freshly minted fungible assets to the provided recipient by creating a note.
+#! Mints fungible assets to the provided recipient by creating a note.
 #!
 #! Inputs:  [amount, tag, note_type, RECIPIENT]
 #! Outputs: [note_idx]
@@ -56,7 +56,7 @@ const METADATA_SLOT=word("miden::standards::fungible_faucets::metadata")
 #!
 #! Invocation: exec
 @locals(4)
-pub proc distribute
+pub proc mint_and_send
     # Get the configured max supply and the token supply (= current supply).
     # ---------------------------------------------------------------------------------------------
 

crates/miden-standards/asm/standards/faucets/network_fungible.masm

@@ -1,16 +1,22 @@
+# NETWORK FUNGIBLE FAUCET CONTRACT
+#
+# Note: This component requires `MintPolicyManager` component to also be present in the account.
+# =================================================================================================
+
 use miden::standards::faucets
-use miden::standards::access::ownable2step
+use miden::standards::mint_policies::policy_manager
 
 # PUBLIC INTERFACE
 # ================================================================================================
 
-# ASSET DISTRIBUTION
+# ASSET MINTING
 # ------------------------------------------------------------------------------------------------
 
-#! Distributes freshly minted fungible assets to the provided recipient.
+#! Mints fungible assets to the provided recipient by creating a note.
 #!
-#! This procedure first checks if the note sender is the owner of the faucet, and then
-#! mints the asset and creates an output note with that asset for the recipient.
+#! This procedure first executes the active mint policy configured via
+#! `active_policy_proc_root`, and then mints the asset and creates an output note
+#! with that asset for the recipient.
 #!
 #! Inputs:  [amount, tag, note_type, RECIPIENT, pad(9)]
 #! Outputs: [note_idx, pad(15)]
@@ -23,15 +29,15 @@ use miden::standards::access::ownable2step
 #! - note_idx is the index of the created note.
 #!
 #! Panics if:
-#! - the note sender is not the owner of this faucet.
-#! - any of the validations in faucets::distribute fail.
+#! - active mint policy validation fails.
+#! - any of the validations in faucets::mint_and_send fail.
 #!
 #! Invocation: call
-pub proc distribute
-    exec.ownable2step::assert_sender_is_owner
-    # => [amount, tag, aux, note_type, execution_hint, RECIPIENT, pad(7)]
+pub proc mint_and_send
+    exec.policy_manager::execute_mint_policy
+    # => [new_amount, new_tag, new_note_type, NEW_RECIPIENT, pad(9)]
 
-    exec.faucets::distribute
+    exec.faucets::mint_and_send
     # => [note_idx, pad(15)]
 end
 

crates/miden-standards/asm/standards/mint_policies/auth_controlled.masm

@@ -0,0 +1,12 @@
+# POLICY PROCEDURES
+# ================================================================================================
+
+#! Dummy mint predicate to allow all mints.
+#!
+#! Inputs:  [amount, tag, note_type, RECIPIENT, pad(9)]
+#! Outputs: [amount, tag, note_type, RECIPIENT, pad(9)]
+#! Invocation: dynexec
+pub proc allow_all
+    # Dummy predicate, no checks yet.
+    push.0 drop
+end

crates/miden-standards/asm/standards/mint_policies/owner_controlled.masm

@@ -0,0 +1,18 @@
+use miden::standards::access::ownable2step
+
+# POLICY PROCEDURES
+# ================================================================================================
+
+#! Owner-only mint predicate.
+#!
+#! Inputs:  [amount, tag, note_type, RECIPIENT, pad(9)]
+#! Outputs: [amount, tag, note_type, RECIPIENT, pad(9)]
+#!
+#! Panics if:
+#! - note sender is not owner.
+#!
+#! Invocation: dynexec
+pub proc owner_only
+    exec.ownable2step::assert_sender_is_owner
+    # => [amount, tag, note_type, RECIPIENT, pad(9)]
+end