-
Notifications
You must be signed in to change notification settings - Fork 27
Open
Description
Context
The Core Concepts section (recently renamed from Design) is mostly empty. Account types — public, private, and network — are fundamental concepts that are currently scattered across quick-start and PSM docs with no dedicated conceptual page.
Proposed
Add docs/core-concepts/accounts.md covering:
Content
- Account ID structure — 120-bit encoding: type + storage mode + version
- Public accounts — state stored on-chain, readable by anyone. Use case: faucets, public registries, DEX orderbooks
- Private accounts — only commitment on-chain, state lives client-side. Use case: wallets, private vaults, confidential contracts
- Network accounts — special accounts for protocol-level operations (faucets, validators). How they differ from regular public accounts.
- Storage modes vs account types — clarify these are two orthogonal choices (
AccountStorageModevsAccountType) - Decision matrix — when to use which type
References
AccountStorageModeenum in miden-baseAccountTypeenum in miden-baseAccountBuilderAPI in miden-client- quick-start/accounts.md (has some coverage but tutorial-style)
- Paper: §2.1 Actors as Accounts
Approach
- Diataxis: explanation style (conceptual, not tutorial)
- Link to quick-start for hands-on setup
- Link to smart-contracts/accounts/ for SDK reference
- Cross-reference the protocol design docs for deeper technical details
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels