Skip to content

Glossary of domain terms #549

Description

@codebestia

Write docs/glossary.md. The codebase mixes vocabulary from three domains — messaging/E2EE (envelope, prekey, ratchet, safety number, epoch, sealed box, fan-out), Stellar/Soroban (ledger, XDR, SAC, passphrase, Freighter), and this project's own coinages (device set mismatch, sibling device, resume cursor, group control event) — and a newcomer cannot tell which is which.

Acceptance criteria:

  • Each term has a one-to-three sentence definition and, where useful, a pointer to the module that implements it
  • Distinguishes standard protocol terms from project-specific ones
  • Disambiguates genuinely confusable pairs — ciphertext (message body column) vs. envelope ciphertext (per-device), deviceId vs. senderDeviceId, epoch (MLS) vs. sequence (group control log)

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentationdx

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions