docs: add Account Types page to Core Concepts (public, private, network)
- Vorherrschende Sprache
- TypeScript
- Sterne
- 10
- Forks
- 50
- Ø Merge
- 22 T. 23 Std.
- Gemergte PRs (30 T.)
- 1
Beschreibung
## 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
1. **Account ID structure** — 120-bit encoding: type + storage mode + version
2. **Public accounts** — state stored on-chain, readable by anyone. Use case: faucets, public registries, DEX orderbooks
3. **Private accounts** — only commitment on-chain, state lives client-side. Use case: wallets, private vaults, confidential contracts
4. **Network accounts** — special accounts for protocol-level operations (faucets, validators). How they differ from regular public accounts.
5. **Storage modes vs account types** — clarify these are two orthogonal choices (`AccountStorageMode` vs `AccountType`)
6. **Decision matrix** — when to use which type
### References
- `AccountStorageMode` enum in miden-base
- `AccountType` enum in miden-base
- `AccountBuilder` API 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
Beitragsleitfaden
Rechercherichtung
Create a new file `docs/core-concepts/accounts.md`. Review the existing quick-start/accounts.md and the referenced enums in miden-base (AccountStorageMode, AccountType) and the AccountBuilder API in miden-client. Structure the page as an explanation, covering the listed content points. Ensure it links to related tutorial and reference material. Verify the file is placed correctly in the core-concepts section.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 75/100