Skip to main content

Module component

Module component 

Source

Modules§

multisig_smart

Structs§

AccountComponent
An AccountComponent defines a Library of code and the initial value and types of the StorageSlots it accesses.
AccountComponentMetadata
Represents the full component metadata configuration.
AccountComponentName
The canonical name of an account component.
AccountProcedureRoot
The MAST root of a public procedure in an account’s interface.
AllowlistOwnerControlled
Account component that exposes allow_account and disallow_account admin procedures gated by the crate::account::access::Ownable2Step owner.
AllowlistStorage
Storage backing the per-faucet allowlist.
AuthGuardedMultisig
An AccountComponent implementing multisig authentication integrated with a state guardian.
AuthGuardedMultisigConfig
Configuration for AuthGuardedMultisig component.
AuthMultisig
An AccountComponent implementing a multisig authentication.
AuthMultisigConfig
Configuration for AuthMultisig component.
AuthMultisigSmart
An AccountComponent implementing a multisig auth component with smart-policy slots.
AuthMultisigSmartConfig
Configuration for AuthMultisigSmart component.
AuthNetworkAccount
An AccountComponent implementing an authentication scheme that restricts what notes an account can consume to a fixed allowlist of note script roots, and what transaction scripts may run against the account to a fixed allowlist of tx script roots.
AuthSingleSig
An AccountComponent implementing the signature scheme for authentication of transactions.
AuthSingleSigAcl
An AccountComponent implementing a procedure-based Access Control List (ACL) using either the EcdsaK256Keccak or Falcon512 Poseidon2 signature scheme for authentication of transactions.
AuthSingleSigAclConfig
Configuration for AuthSingleSigAcl component.
BasicAllowlist
The basic allowlist transfer policy account component.
BasicBlocklist
The basic blocklist transfer policy account component.
BasicWallet
An AccountComponent implementing a basic wallet.
BlocklistOwnerControlled
Account component that exposes block_account and unblock_account admin procedures gated by the crate::account::access::Ownable2Step owner.
BlocklistStorage
Storage backing the per-faucet blocklist.
BurnAllowAll
The storage-free allow_all burn policy account component.
BurnOwnerOnly
The storage-free owner_only burn policy account component (owner-controlled family).
Description
Token description (max 195 bytes UTF-8), stored in 7 Words.
ExternalLink
Token external link (max 195 bytes UTF-8), stored in 7 Words.
FeltSchema
Supported element schema descriptors for a component’s storage entries.
FungibleFaucet
An AccountComponent implementing a fungible faucet.
FungibleFaucetBuilder
Use builder syntax to set the inputs and finish with build().
GuardianConfig
Public configuration for the guardian signer.
InitStorageData
Represents the data required to initialize storage entries when instantiating an AccountComponent from component metadata (either provided directly or extracted from a package).
LogoURI
Token logo URI (max 195 bytes UTF-8), stored in 7 Words.
MapSlotSchema
Describes the schema for a storage map slot.
MintAllowAll
The storage-free allow_all mint policy account component.
MintOwnerOnly
The storage-free owner_only mint policy account component (owner-controlled family).
NetworkAccount
A wrapper around an Account that is guaranteed to be a network account.
NetworkAccountNoteAllowlist
A standardized storage slot holding the allowlist of input-note script roots that a network account is willing to consume.
NetworkAccountTxScriptAllowlist
A standardized storage slot holding the allowlist of transaction script roots that a network account is willing to execute.
NoAuth
An AccountComponent implementing a no-authentication scheme.
Ownable2Step
Two-step ownership management for account components.
Pausable
Account component that installs the PausableStorage slot and exposes is_paused view procedure.
PausableManager
Account component exposing pause and unpause admin procedures, gated by the account-wide crate::account::access::Authority component via exec.authority::assert_authorized.
PausableStorage
Storage helper backing the pause flag for a single account.
PublicKeyCommitment
Commitment to a public key.
RoleBasedAccessControl
Role-based access control (RBAC) for account components.
RoleSymbol
Represents a role symbol for role-based access control.
SchemaRequirement
Describes the expected type and additional metadata for an init-provided storage value.
SchemaType
A newtype wrapper around a String, representing a schema type.
StorageSchema
Describes the storage schema of an account component in terms of its named storage slots.
StorageValueName
A simple wrapper type around a string key that identifies init-provided values.
TokenMetadata
A helper that stores name, mutability config, and optional fields in fixed value slots.
TokenName
Token display name (max 32 bytes UTF-8), stored in 2 Words.
TokenPolicyManager
An AccountComponent that owns the policy-manager storage slots and the manager procedures for the four policy kinds (mint, burn, send, receive).
TransferAllowAll
The storage-free allow_all transfer policy account component.
ValueSlotSchema
Describes the schema for a storage value slot.

Enums§

AccessControl
Access control configuration for account components.
AuthScheme
Defines standard authentication schemes (i.e., signature schemes) available in the Miden protocol.
AuthSecretKey
Secret keys of the standard AuthSchemes available in the Miden protocol.
Authority
Identifies which authority is allowed to invoke an authority-gated procedure on an account.
AuthorityError
Errors raised when reading or parsing an Authority from storage.
BurnPolicyConfig
Selects which burn policy is registered with a super::TokenPolicyManager.
FungibleFaucetError
Basic fungible faucet related errors.
InitStorageDataError
Error returned when creating InitStorageData with invalid entries.
MintPolicyConfig
Selects which mint policy is registered with a super::TokenPolicyManager.
NetworkAccountNoteAllowlistError
Errors that can occur when constructing a NetworkAccountNoteAllowlist or reconstructing one from storage.
NetworkAccountTxScriptAllowlistError
Errors that can occur when reconstructing a NetworkAccountTxScriptAllowlist from storage.
Ownable2StepError
Errors that can occur when reading Ownable2Step data from storage.
PolicyRegistration
Indicates whether a policy entry is the currently active one (written into the active_*_policy slot) or a reserved alternative (kept in the allowed_*_policies map for future activation via set_*_policy).
PublicKey
Public keys of the standard authentication schemes available in the Miden protocol.
SchemaTypeError
Errors that can occur when parsing or converting schema types.
Signature
Represents a signature object ready for native verification.
StandardAccountComponent
The enum holding the types of standard account components defined in the miden-standards crate.
StorageSlotSchema
Describes the schema for a storage slot. Can describe either a value slot, or a map slot.
StorageValueNameError
TokenMetadataError
Errors raised when parsing token metadata from storage.
TokenPolicyManagerError
Errors returned when building a TokenPolicyManager.
TransferPolicy
Selects a transfer policy variant for the send or receive kind on a super::TokenPolicyManager.
WordSchema
Defines how a word slot is described within the component’s storage schema.
WordValue
A word value provided via InitStorageData.

Constants§

MIDEN_PACKAGE_EXTENSION

Functions§

create_fungible_faucet
Creates a new fungible faucet account by composing the required components.