Refactor code structure for improved readability and maintainability

Author: afa7789

CHANGELOG.md

@@ -4,6 +4,8 @@
 
 ### Features
 
+- Added metadata extension (`Info`) with name and content URI slots, and MASM procedures `get_token_metadata`, `get_max_supply`, `get_decimals`, and `get_token_symbol` for the token metadata standard. Aligned fungible faucet token metadata with the metadata standard: faucet now uses the canonical slot `miden::standards::metadata::token_metadata` so MASM metadata getters work with faucet storage.([#2439](https://github.com/0xMiden/miden-base/pull/2439))
+
 - Enable `CodeBuilder` to add advice map entries to compiled scripts ([#2275](https://github.com/0xMiden/miden-base/pull/2275)).
 - Added `BlockNumber::MAX` constant to represent the maximum block number ([#2324](https://github.com/0xMiden/miden-base/pull/2324)).
 - Added single-word `Array` standard ([#2203](https://github.com/0xMiden/miden-base/pull/2203)).
@@ -20,6 +22,7 @@
 
 ### Changes
 
+- `TokenMetadata` (faucet) now uses the shared metadata slot from the metadata module for consistency with MASM standards.
 - Made kernel procedure offset constants public and replaced accessor procedures with direct constant usage ([#2375](https://github.com/0xMiden/miden-base/pull/2375)).
 - [BREAKING] Made `AccountComponentMetadata` a required parameter of `AccountComponent::new()`; removed `with_supported_type`, `with_supports_all_types`, and `with_metadata` methods from `AccountComponent`; simplified `AccountComponentMetadata::new()` to take just `name`; renamed `AccountComponentTemplateError` to `ComponentMetadataError` ([#2373](https://github.com/0xMiden/miden-base/pull/2373), [#2395](https://github.com/0xMiden/miden-base/pull/2395)).
 - Fixed MASM inline comment casing to adhere to commenting conventions ([#2398](https://github.com/0xMiden/miden-base/pull/2398)).

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

@@ -4,3 +4,19 @@
 
 pub use ::miden::standards::faucets::basic_fungible::distribute
 pub use ::miden::standards::faucets::basic_fungible::burn
+
+# Metadata — getters only (no setters for basic faucet)
+pub use ::miden::standards::metadata::fungible::get_name
+pub use ::miden::standards::metadata::fungible::get_config
+pub use ::miden::standards::metadata::fungible::is_max_supply_mutable
+pub use ::miden::standards::metadata::fungible::is_description_mutable
+pub use ::miden::standards::metadata::fungible::is_logo_uri_mutable
+pub use ::miden::standards::metadata::fungible::is_external_link_mutable
+pub use ::miden::standards::metadata::fungible::get_description
+pub use ::miden::standards::metadata::fungible::get_logo_uri
+pub use ::miden::standards::metadata::fungible::get_external_link
+pub use ::miden::standards::metadata::fungible::get_token_metadata
+pub use ::miden::standards::metadata::fungible::get_max_supply
+pub use ::miden::standards::metadata::fungible::get_decimals
+pub use ::miden::standards::metadata::fungible::get_token_symbol
+pub use ::miden::standards::metadata::fungible::get_token_supply

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

@@ -6,3 +6,24 @@ pub use ::miden::standards::faucets::network_fungible::distribute
 pub use ::miden::standards::faucets::network_fungible::burn
 pub use ::miden::standards::faucets::network_fungible::transfer_ownership
 pub use ::miden::standards::faucets::network_fungible::renounce_ownership
+
+# Metadata — all from metadata::fungible
+pub use ::miden::standards::metadata::fungible::get_owner
+pub use ::miden::standards::metadata::fungible::get_name
+pub use ::miden::standards::metadata::fungible::get_config
+pub use ::miden::standards::metadata::fungible::is_max_supply_mutable
+pub use ::miden::standards::metadata::fungible::is_description_mutable
+pub use ::miden::standards::metadata::fungible::is_logo_uri_mutable
+pub use ::miden::standards::metadata::fungible::is_external_link_mutable
+pub use ::miden::standards::metadata::fungible::get_description
+pub use ::miden::standards::metadata::fungible::get_logo_uri
+pub use ::miden::standards::metadata::fungible::get_external_link
+pub use ::miden::standards::metadata::fungible::get_token_metadata
+pub use ::miden::standards::metadata::fungible::get_max_supply
+pub use ::miden::standards::metadata::fungible::get_decimals
+pub use ::miden::standards::metadata::fungible::get_token_symbol
+pub use ::miden::standards::metadata::fungible::get_token_supply
+pub use ::miden::standards::metadata::fungible::optional_set_description
+pub use ::miden::standards::metadata::fungible::optional_set_logo_uri
+pub use ::miden::standards::metadata::fungible::optional_set_external_link
+pub use ::miden::standards::metadata::fungible::optional_set_max_supply

crates/miden-standards/asm/standards/access/ownable.masm

@@ -102,7 +102,9 @@ end
 #! Invocation: call
 pub proc get_owner
     exec.owner
-    # => [owner_prefix, owner_suffix, pad(14)]
+    # => [owner_prefix, owner_suffix, pad(16)]  depth 18
+    exec.::miden::core::sys::truncate_stack
+    # => [owner_prefix, owner_suffix, pad(14)]  depth 16
 end
 
 #! Transfers ownership to a new account.

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

@@ -10,6 +10,10 @@ use ::miden::protocol::asset::FUNGIBLE_ASSET_MAX_AMOUNT
 
 const PRIVATE_NOTE=2
 
+# Token metadata slot — duplicated here so distribute can read it via exec without
+# going through the call-safe get_max_supply wrapper.
+const TOKEN_METADATA_SLOT = word("miden::standards::metadata::token_metadata")
+
 # ERRORS
 # =================================================================================================
 
@@ -29,9 +33,9 @@ const ERR_BASIC_FUNGIBLE_BURN_WRONG_NUMBER_OF_ASSETS="burn requires exactly 1 no
 # The local memory address at which the metadata slot content is stored.
 const METADATA_SLOT_LOCAL=0
 
-# The standard slot where fungible faucet metadata like token symbol or decimals are stored.
+# The standard slot where fungible faucet metadata is stored (canonical with metadata module).
 # Layout: [token_supply, max_supply, decimals, token_symbol]
-const METADATA_SLOT=word("miden::standards::fungible_faucets::metadata")
+const METADATA_SLOT=word("miden::standards::metadata::token_metadata")
 
 #! Distributes freshly minted fungible assets to the provided recipient by creating a note.
 #!
@@ -67,19 +71,9 @@ pub proc distribute
     # => [max_supply, token_supply, amount, tag, note_type, RECIPIENT]
 
     # Assert that minting does not violate any supply constraints.
-    #
-    # To make sure we cannot mint more than intended, we need to check:
-    # 1) (max_supply - token_supply) <= max_supply, i.e. the subtraction does not wrap around
-    # 2) amount + token_supply does not exceed max_supply
-    # 3) amount + token_supply is less than FUNGIBLE_ASSET_MAX_AMOUNT
-    #
-    # This is done with the following concrete assertions:
-    # - assert token_supply <= max_supply which ensures 1)
-    # - assert max_supply <= FUNGIBLE_ASSET_MAX_AMOUNT to help ensure 3)
-    # - assert amount <= max_mint_amount to ensure 2) as well as 3)
-    #   - this ensures 3) because token_supply + max_mint_amount at most ends up being equal to
-    #     max_supply and we already asserted that max_supply does not exceed
-    #     FUNGIBLE_ASSET_MAX_AMOUNT
+    # - assert token_supply <= max_supply
+    # - assert max_supply <= FUNGIBLE_ASSET_MAX_AMOUNT
+    # - assert amount <= max_mint_amount
     # ---------------------------------------------------------------------------------------------
 
     dup.1 dup.1