Struct FungibleFaucet 

pub struct FungibleFaucet { /* private fields */ }

An AccountComponent implementing a fungible faucet.

This component bundles the asset minting/burning procedures and the token metadata (name, description, logo URI, external link) together. Whether the faucet behaves like a “basic” public faucet or a network-style faucet is a function of the surrounding account configuration (account type, auth component, access control component, and policy manager configuration), not of the faucet component itself.

It re-exports the procedures from miden::standards::faucets::fungible. When linking against this component, the miden library (i.e. ProtocolLib) must be available to the assembler — which is the case when using CodeBuilder. The procedures of this component are:

• mint_and_send, which mints an asset and creates a note for the provided recipient.
• receive_and_burn, which receives the fungible asset from the active note and burns it.
• The token metadata accessors and owner-gated setters (see the embedded TokenMetadata).

The mint_and_send procedure is gated by the active mint policy from the associated TokenPolicyManager. receive_and_burn can only be called from a note script and is gated by the active burn policy.

Implementations

impl FungibleFaucet

pub fn builder() -> FungibleFaucetBuilder

Returns a builder for FungibleFaucet.

Required setters: name, symbol, decimals, max_supply. Optional fields default to None (string fields) or false (mutability flags); the initial token supply defaults to zero.

Example

let faucet = FungibleFaucet::builder()
    .name(TokenName::new("My Token")?)
    .symbol(TokenSymbol::new("MTK")?)
    .decimals(8)
    .max_supply(AssetAmount::from(1_000_000u32))
    .token_supply(AssetAmount::from(100u32))
    .description(Description::new("A test token")?)
    .logo_uri(LogoURI::new("https://example.com/logo.png")?)
    .build()?;

impl FungibleFaucet

pub const NAME: &'static str = "miden::standards::components::faucets::fungible_faucet"

The name of the component.

pub const MAX_DECIMALS: u8 = 12

The maximum number of decimals supported.

pub const fn name() -> AccountComponentName

Returns the canonical AccountComponentName of this component.

pub fn code() -> &'static AccountComponentCode

Returns the AccountComponentCode of this component.

pub fn mint_and_send_root() -> AccountProcedureRoot

Returns the procedure root of the mint_and_send account procedure.

pub fn receive_and_burn_root() -> AccountProcedureRoot

Returns the procedure root of the receive_and_burn account procedure.

pub fn set_max_supply_root() -> AccountProcedureRoot

Returns the procedure root of the set_max_supply account procedure.

pub fn set_description_root() -> AccountProcedureRoot

Returns the procedure root of the set_description account procedure.

pub fn set_logo_uri_root() -> AccountProcedureRoot

Returns the procedure root of the set_logo_uri account procedure.

pub fn set_external_link_root() -> AccountProcedureRoot

Returns the procedure root of the set_external_link account procedure.

pub fn token_config_slot() -> &'static StorageSlotName

Returns the StorageSlotName holding the token config word [token_supply, max_supply, decimals, token_symbol].

pub fn token_supply(&self) -> AssetAmount

Returns the current token supply (amount issued).

pub fn max_supply(&self) -> AssetAmount

Returns the maximum token supply.

pub fn decimals(&self) -> u8

Returns the number of decimals.

pub fn symbol(&self) -> &TokenSymbol

Returns the token symbol.

pub fn token_name(&self) -> &TokenName

Returns the token name.

pub fn description(&self) -> Option<&Description>

Returns the optional description.

pub fn logo_uri(&self) -> Option<&LogoURI>

Returns the optional logo URI.

pub fn external_link(&self) -> Option<&ExternalLink>

Returns the optional external link.

pub fn token_config_slot_schema() -> (StorageSlotName, StorageSlotSchema)

Returns the storage slot schema for the token config slot.

pub fn component_metadata() -> AccountComponentMetadata

Returns the AccountComponentMetadata for this component.

pub fn into_storage_slots(self) -> Vec<StorageSlot>

Returns the storage slots produced by this faucet (token config word + name + mutability config + description + logo URI + external link + Pausable’s is_paused flag).

The is_paused slot is installed by FungibleFaucet itself (initial value: unpaused, zero word) so that the transversal pause guards baked into execute_mint_policy, execute_burn_policy, check_policy (allow_all / blocklist / allowlist) and the metadata setters can read it without panicking. Pause / unpause administration is exposed by the crate::account::access::pausable::PausableManager component, which is bundled by create_fungible_faucet alongside this faucet so the slot is always actionable.

pub fn token_config_slot_value(&self) -> StorageSlot

Returns the single storage slot for the token config word.

pub fn with_token_supply( self, token_supply: AssetAmount, ) -> Result<FungibleFaucet, FungibleFaucetError>

Sets the token_supply (in base units).

Errors

Returns an error if:

• the token supply exceeds the max supply.

pub fn with_description_mutable(self, mutable: bool) -> FungibleFaucet

Sets whether the description can be updated by the owner.

pub fn with_logo_uri_mutable(self, mutable: bool) -> FungibleFaucet

Sets whether the logo URI can be updated by the owner.

pub fn with_external_link_mutable(self, mutable: bool) -> FungibleFaucet

Sets whether the external link can be updated by the owner.

pub fn with_max_supply_mutable(self, mutable: bool) -> FungibleFaucet

Sets whether the max supply can be updated by the owner.

Trait Implementations

impl Clone for FungibleFaucet

fn clone(&self) -> FungibleFaucet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FungibleFaucet

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

Formats the value using the given formatter.

impl From<FungibleFaucet> for AccountComponent

fn from(faucet: FungibleFaucet) -> AccountComponent

Converts to this type from the input type.

impl TryFrom<&Account> for FungibleFaucet

type Error = FungibleFaucetError

The type returned in the event of a conversion error.

fn try_from( account: &Account, ) -> Result<FungibleFaucet, <FungibleFaucet as TryFrom<&Account>>::Error>

Performs the conversion.

impl TryFrom<&AccountStorage> for FungibleFaucet

fn try_from( storage: &AccountStorage, ) -> Result<FungibleFaucet, <FungibleFaucet as TryFrom<&AccountStorage>>::Error>

Reconstructs FungibleFaucet by reading all relevant storage slots: the token config word, name, mutability config, description, logo URI, and external link.

type Error = FungibleFaucetError

The type returned in the event of a conversion error.

impl TryFrom<Account> for FungibleFaucet

type Error = FungibleFaucetError

The type returned in the event of a conversion error.

fn try_from( account: Account, ) -> Result<FungibleFaucet, <FungibleFaucet as TryFrom<Account>>::Error>

Performs the conversion.