Skip to content

book: Add a Concepts section (accounts, keys & encryption model, notes, fees) #604

Description

@pacu

Part of #600.

Current behavior: The book has a user guide (install/setup) and a CLI reference, but no conceptual documentation. Concepts that are not derivable from any single rustdoc item are undocumented:

  • The account model: account UUIDs, seed fingerprints, multiple mnemonics per wallet, ZIP 32 derivation, and how this differs from zcashd's account semantics.
  • Key material and the encryption model: what lives in the keystore (age-encrypted) vs wallet.db (not encrypted — it holds transaction history and viewing keys in the clear), what the age identity file is, lock/unlock semantics (walletpassphrase/walletlock).
  • Note management: trusted vs untrusted confirmations (the ZIP 315 draft policy: 3/10), spendability, change handling.
  • Fees: ZIP 317 is always used; fee parameters must be null.
  • The async operation model (z_getoperationstatus/z_getoperationresult/z_listoperationids), which is currently documented nowhere in the book.

Expected: A short "Concepts" section, one page per topic, citing https://zips.z.cash for protocol semantics (ZIP 32, ZIP 315, ZIP 316, ZIP 317) rather than restating specs. Concise: each page should be readable in a few minutes.

Why: This is the onboarding material for developers and exchange integrators, and the context DevRel needs to communicate Zallet accurately; misconceptions carried over from zcashd (account 0, encrypted wallet.dat) are otherwise inevitable.


Drafted with AI assistance (Claude); facts verified against 29bb94a.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions