Token Metadata extension to form standard

crates/miden-protocol/src/asset/token_symbol.rs

@@ -144,6 +144,7 @@ impl TryFrom<Felt> for TokenSymbol {
         if encoded_value < Self::MIN_ENCODED_VALUE {
             return Err(TokenSymbolError::ValueTooSmall(encoded_value));
         }
+
         if encoded_value > Self::MAX_ENCODED_VALUE {
             return Err(TokenSymbolError::ValueTooLarge(encoded_value));
         }

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

@@ -1,6 +1,7 @@
 # The MASM code of the Basic Fungible Faucet Account Component.
 #
 # See the `BasicFungibleFaucet` Rust type's documentation for more details.
+# This component depends on `FungibleTokenMetadata` being present in the account.
 
 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/fungible_token_metadata.masm

@@ -0,0 +1,20 @@
+# The MASM code of the Fungible Token Metadata Account Component.
+#
+# Re-exported from module miden::standards::components::fungible_token_metadata
+# All metadata-related procedures are re-exported here.
+
+pub use ::miden::standards::metadata::fungible_faucet::get_name
+pub use ::miden::standards::metadata::fungible_faucet::get_mutability_config
+pub use ::miden::standards::metadata::fungible_faucet::is_max_supply_mutable
+pub use ::miden::standards::metadata::fungible_faucet::is_description_mutable
+pub use ::miden::standards::metadata::fungible_faucet::is_logo_uri_mutable
+pub use ::miden::standards::metadata::fungible_faucet::is_external_link_mutable
+pub use ::miden::standards::metadata::fungible_faucet::get_token_metadata
+pub use ::miden::standards::metadata::fungible_faucet::get_max_supply
+pub use ::miden::standards::metadata::fungible_faucet::get_decimals
+pub use ::miden::standards::metadata::fungible_faucet::get_token_symbol
+pub use ::miden::standards::metadata::fungible_faucet::get_token_supply
+pub use ::miden::standards::metadata::fungible_faucet::set_description
+pub use ::miden::standards::metadata::fungible_faucet::set_logo_uri
+pub use ::miden::standards::metadata::fungible_faucet::set_external_link
+pub use ::miden::standards::metadata::fungible_faucet::set_max_supply

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

@@ -1,6 +1,7 @@
 # The MASM code of the Network Fungible Faucet Account Component.
 #
 # See the `NetworkFungibleFaucet` Rust type's documentation for more details.
+# This component depends on `FungibleTokenMetadata` being present in the account.
 
 pub use ::miden::standards::faucets::network_fungible::mint_and_send
 pub use ::miden::standards::faucets::network_fungible::burn

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

@@ -5,14 +5,15 @@ use miden::protocol::native_account
 use miden::protocol::output_note
 use miden::protocol::asset
 use miden::protocol::asset::FUNGIBLE_ASSET_MAX_AMOUNT
+use miden::standards::metadata::fungible_faucet::TOKEN_METADATA_SLOT
 
-# CONSTANTS
+# CONSTANTS
 # =================================================================================================
 
 const ASSET_PTR=0
 const PRIVATE_NOTE=2
 
-# ERRORS
+# ERRORS
 # =================================================================================================
 
 const ERR_FUNGIBLE_ASSET_TOKEN_SUPPLY_EXCEEDS_MAX_SUPPLY="token supply exceeds max supply"
@@ -31,9 +32,6 @@ 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.
-# Layout: [token_supply, max_supply, decimals, token_symbol]
-const METADATA_SLOT=word("miden::standards::fungible_faucets::metadata")
 
 #! Mints fungible assets to the provided recipient by creating a note.
 #!
@@ -60,7 +58,7 @@ pub proc mint_and_send
     # Get the configured max supply and the token supply (= current supply).
     # ---------------------------------------------------------------------------------------------
 
-    push.METADATA_SLOT[0..2] exec.active_account::get_item
+    push.TOKEN_METADATA_SLOT[0..2] exec.active_account::get_item
     # => [token_supply, max_supply, decimals, token_symbol, amount, tag, note_type, RECIPIENT]
 
     # store a copy of the current slot content for the token_supply update later
@@ -120,7 +118,7 @@ pub proc mint_and_send
     # => [[new_token_supply, max_supply, decimals, token_symbol], amount, tag, note_type, RECIPIENT]
 
     # update the metadata slot with the new supply
-    push.METADATA_SLOT[0..2] exec.native_account::set_item dropw
+    push.TOKEN_METADATA_SLOT[0..2] exec.native_account::set_item dropw
     # => [amount, tag, note_type, RECIPIENT]
 
     # Create a new note.
@@ -204,7 +202,7 @@ pub proc burn
     # Subtract burnt amount from current token_supply in storage.
     # ---------------------------------------------------------------------------------------------
 
-    push.METADATA_SLOT[0..2] exec.active_account::get_item
+    push.TOKEN_METADATA_SLOT[0..2] exec.active_account::get_item
     # => [token_supply, max_supply, decimals, token_symbol, amount, pad(16)]
 
     dup.4 dup.1
@@ -222,6 +220,6 @@ pub proc burn
     # => [new_token_supply, max_supply, decimals, token_symbol, pad(16)]
 
     # update the metadata slot with the new supply
-    push.METADATA_SLOT[0..2] exec.native_account::set_item dropw
+    push.TOKEN_METADATA_SLOT[0..2] exec.native_account::set_item dropw
     # => [pad(16)]
 end