Skip to content

Glossary of domain terms #549

Closed
Closed

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)

Activity

  1. wolfyres commented on Aug 29, 2026

    @wolfyres

    @wolfyres has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

    Hi maintainer, I've got solid experience solving similar issues, kindly assign this to me.

    ℹ️ Repo Maintainers: To accept this application, review their application or assign @wolfyres to this issue.

  2. vickydve commented on Aug 30, 2026

    @vickydve
    Contributor

    @vickydve has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

    Hi, I'd like to work on this issue. I'll write docs/glossary.md covering the three vocabularies in the codebase: messaging/E2EE terms (envelope, prekey, ratchet, safety number, epoch, sealed box, fan-out), Stellar/Soroban terms (ledger, XDR, SAC, passphrase, Freighter), and project-specific coinages (device set mismatch, sibling device, resume cursor, group control event). Each entry will get a one-to-three sentence definition with a pointer to the implementing module, clearly marking which terms are standard vs. project-specific, and explicitly disambiguating confusable pairs like ciphertext vs. envelope ciphertext, deviceId vs. senderDeviceId, and epoch vs. sequence. I'll verify definitions against the source before opening a PR.

    ℹ️ Repo Maintainers: To accept this application, review their application or assign @vickydve to this issue.

  3. drips-wave commented on Aug 30, 2026

    @drips-wave

    Congratulations, @vickydve! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on August 31, 2026.

    🧑‍💻 @vickydve: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.

    Warning

    When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.

    🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.

    🌊 Happy Wave 🌊

  4. github-actions commented on Aug 30, 2026

    @github-actions

    Closed by #596, merged into dev.

  5. drips-wave commented on Aug 30, 2026

    @drips-wave

    This issue has been completed by @vickydve as part of the Stellar Wave Program's 8th Wave 🥳

    😎 @vickydve: You earned 200 Points for completing this issue! After the current Wave ends, you'll be eligible for a percentage of the Wave's reward pool based on the percentage of total points you've earned. Learn more here. You can also Leave a review to share your experience working on this issue.

    🧑‍💻 Repo maintainers: How'd the contributor do? Leave a review to share your experience working with them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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