Add Miden Standards builder docs by BrianSeong99 · Pull Request #298 · 0xMiden/docs

BrianSeong99 · 2026-05-18T12:04:28Z

Summary

add a Builder-facing Miden Standards section under Smart Contracts
cover current account components, standard notes, faucets, and policies
add compile-checked Rust usage snippets for wallet composition, P2ID note creation, and faucet creation
add v0.14-specific Standards pages and v0.14-specific snippets for the versioned docs snapshot
group existing account, note, transaction, type, and composition docs under a Rust sidebar section, with Miden Standards as a sibling section
align the Smart Contracts index page with the Overview / Rust / Miden Standards structure in both current and v0.14 docs

Closes #287.

Validation

git diff --check
verified external links with curl
verified current Standards API names against protocol origin/next (01077765)
Docker snippet tests against a fresh protocol@next clone: cargo test -p miden-standards --test docs_examples
Docker snippet tests against a fresh protocol@v0.14.6 clone: cargo test -p miden-standards --test docs_examples
npm run build in a fresh Docker copy after reproducing the deploy-docs vendor aggregation step
refreshed Homelab preview for miden/docs at https://homelab.tail477b3c.ts.net:9000/

Notes: the production-shaped build succeeds, but Docusaurus still reports pre-existing broken links/anchors from ingested/versioned docs unrelated to these Standards pages.

PhilippGackstatter

Looked at the first two files and left some comments.

PhilippGackstatter · 2026-05-22T11:08:07Z

+|-----------|------------|-------------|
+| `BasicWallet` | Holding assets, receiving assets from standard notes, and moving assets into output notes. | `miden_standards::account::wallets` |
+| `FungibleFaucet` | Minting, sending, receiving, and burning fungible assets from faucet accounts. | `miden_standards::account::faucets` |
+| `AuthSingleSig` | Authenticating transactions with one supported signature scheme. | `miden_standards::account::auth` |


PhilippGackstatter · 2026-05-22T11:10:45Z

+| `AuthSingleSigAcl` | Single-signature authentication with an access-control list. | `miden_standards::account::auth` |
+| `AuthMultisig` / `AuthMultisigSmart` | Threshold or policy-aware multisig authentication. | `miden_standards::account::auth` |
+| `AuthGuardedMultisig` | Multisig guarded by a guardian configuration. | `miden_standards::account::auth` |
+| `AuthNetworkAccount` | Authentication for network-account flows. | `miden_standards::account::auth` |


PhilippGackstatter · 2026-05-22T11:12:59Z

+| `AuthMultisig` / `AuthMultisigSmart` | Threshold or policy-aware multisig authentication. | `miden_standards::account::auth` |
+| `AuthGuardedMultisig` | Multisig guarded by a guardian configuration. | `miden_standards::account::auth` |
+| `AuthNetworkAccount` | Authentication for network-account flows. | `miden_standards::account::auth` |
+| `Ownable2Step` | Ownership transfer with an explicit accept step. | `miden_standards::account::access` |


Suggested change

| `Ownable2Step` | Ownership transfer with an explicit accept step. | `miden_standards::account::access` |

| `Ownable2Step` | Access control for account owners. | `miden_standards::account::access` |

Not sure what framing is best, but I think the primary purpose of the component is more about defining what account owner means, and the transfer of ownership is secondary.

PhilippGackstatter · 2026-05-22T11:13:21Z

+| `AuthGuardedMultisig` | Multisig guarded by a guardian configuration. | `miden_standards::account::auth` |
+| `AuthNetworkAccount` | Authentication for network-account flows. | `miden_standards::account::auth` |
+| `Ownable2Step` | Ownership transfer with an explicit accept step. | `miden_standards::account::access` |
+| `RoleBasedAccessControl` | Role-based authorization for standard policy management. | `miden_standards::account::access` |


PhilippGackstatter · 2026-05-22T11:15:22Z

+
+Use these components from Rust when you build accounts with the SDK, or import the underlying MASM modules when you are writing lower-level account code. The same standards surface is what note scripts and transaction scripts rely on when they call account procedures.
+
+## Common components


Do we want to list everything here or just "common" ones?

In any case, TokenPolicyManager would also be useful to mention, and probably the BasicBlocklist and BasicAllowlist. These are not in 0.14.x (as the PR description suggests), iirc, but neither is Authority which is already listed.

PhilippGackstatter · 2026-05-22T11:25:14Z

+
+- [Standard notes](./standard-notes) - which account interfaces each standard note expects
+- [Faucets and policies](./faucets-and-policies) - using faucet and mint policy components
+- [`miden-standards` account source](https://github.com/0xMiden/protocol/tree/next/crates/miden-standards/src/account) - current implementation


Should this link to the corresponding release, for which these docs are built? This would at least prevent confusion, and in the worst case prevent looking at the wrong source and building something that's broken because of it.

I think this might be a more general doc problem, namely that we're linking to next in many cases, but as mentioned above, this seems very problematic. Would be useful to somehow inject the $CURRENT_VERSION of the docs into such links or otherwise check in CI that github.com links point to $CURRENT_VERSION.

PhilippGackstatter · 2026-05-22T11:29:03Z

+
+# Faucets and Policies
+
+In Miden, a token issuer is an account. A fungible faucet account can mint and burn the fungible asset identified by that faucet's account ID. The standard faucet components give builders a reusable way to create token issuers without hand-writing the entire faucet interface.


Heads-up: This is going to be outdated in 0.15 (see also 0xMiden/protocol#2956). The account type no longer decides what type of asset can be issued, instead this is decided at the asset level (AssetComposition).

PhilippGackstatter · 2026-05-22T11:30:30Z

+| MASM component | `miden::standards::faucets::fungible` |
+| Account type | `FungibleFaucet` account |
+
+Public storage is typical for shared token faucets because clients can discover faucet state and metadata. Private storage is possible, but it changes who can observe the faucet's state.


Nit: Replace "storage" with "state", since for a public account, everything is public, not just storage (in particular also the account's asset vault and code).

PhilippGackstatter · 2026-05-22T11:33:33Z

+| Symbol | Short token symbol. |
+| Decimals | Display precision for client UX. |
+| Max supply | Upper bound enforced by the faucet component. |
+| Metadata | Optional display fields such as token name, description, logo URI, and external link. |


Nit: TokenName is mandatory.

PhilippGackstatter · 2026-05-22T11:47:41Z

+Write a custom faucet component when:
+
+- Minting depends on application state, proofs, allowlists, or rate limits.
+- Supply policy is more complex than a fixed max supply and a standard authority check.
+- You need custom public methods beyond the standard faucet interface.
+


The TokenPolicyManager allows for custom policies to check minting, burning and transfers. Users should be nudged to first check if implementing such a custom policy satisfies their use case. Only if that's not the case, should they resort to writing their own faucet.

Somewhat agree with the 2nd point, though a complex supply policy could also be handled in a CUSTOM_MINT note that is the only note allowed by the faucet to mint assets. This would move the logic outside the faucet and wouldn't require a custom faucet.

3rd point reads a bit ambiguous: If users only need additional public methods, extending the faucet account with additional procedures may be a fine solution and wouldn't require a custom faucet per se. But if they need customized versions of the faucets' procedures, then, yes, they would have to write it themselves.

BrianSeong99 added 4 commits May 18, 2026 21:04

docs: add Miden Standards builder docs

ffedb43

docs: refine standards docs navigation

8b42582

docs: add standards usage snippets

fea7a48

docs: align smart contracts index with rust IA

f4e77a1

BrianSeong99 requested a review from mmagician May 21, 2026 08:53

PhilippGackstatter reviewed May 22, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Miden Standards builder docs#298

Add Miden Standards builder docs#298
BrianSeong99 wants to merge 4 commits into
mainfrom
brian/miden-standards-docs

BrianSeong99 commented May 18, 2026 •

edited

Loading

Uh oh!

PhilippGackstatter left a comment

Uh oh!

PhilippGackstatter May 22, 2026

Uh oh!

PhilippGackstatter May 22, 2026

Uh oh!

PhilippGackstatter May 22, 2026

Uh oh!

PhilippGackstatter May 22, 2026

Uh oh!

PhilippGackstatter May 22, 2026

Uh oh!

PhilippGackstatter May 22, 2026

Uh oh!

PhilippGackstatter May 22, 2026

Uh oh!

PhilippGackstatter May 22, 2026

Uh oh!

PhilippGackstatter May 22, 2026

Uh oh!

PhilippGackstatter May 22, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	\| `AuthSingleSig` \| Authenticating transactions with one supported signature scheme. \| `miden_standards::account::auth` \|
	\| `AuthSingleSig` \| Single-signature authentication of transactions. \| `miden_standards::account::auth` \|

	\| `AuthNetworkAccount` \| Authentication for network-account flows. \| `miden_standards::account::auth` \|
	\| `AuthNetworkAccount` \| Authentication through note allowlists for network accounts. \| `miden_standards::account::auth` \|

	\| `Ownable2Step` \| Ownership transfer with an explicit accept step. \| `miden_standards::account::access` \|
	\| `Ownable2Step` \| Access control for account owners. \| `miden_standards::account::access` \|

	\| `RoleBasedAccessControl` \| Role-based authorization for standard policy management. \| `miden_standards::account::access` \|
	\| `RoleBasedAccessControl` \| Role-based authorization for token policy management. \| `miden_standards::account::access` \|


		Use these components from Rust when you build accounts with the SDK, or import the underlying MASM modules when you are writing lower-level account code. The same standards surface is what note scripts and transaction scripts rely on when they call account procedures.

		## Common components


		# Faucets and Policies

		In Miden, a token issuer is an account. A fungible faucet account can mint and burn the fungible asset identified by that faucet's account ID. The standard faucet components give builders a reusable way to create token issuers without hand-writing the entire faucet interface.

Conversation

BrianSeong99 commented May 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Validation

Uh oh!

PhilippGackstatter left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

BrianSeong99 commented May 18, 2026 •

edited

Loading