#171 Document the registration + first-message key-exchange sequence … - #251
Merged
Conversation
… sequence FIXED
|
@madisonsc52-del Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
codebestia
approved these changes
Jun 28, 2026
codebestia
left a comment
Owner
There was a problem hiding this comment.
LGTM!
Thank you for your contribution.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds backend E2EE onboarding documentation at
apps/backend/docs/e2ee-onboarding.md, covering the happy path, offline-recipient path, and prekey-exhausted path. The doc records the exact JSON request/response shapes and ordering guarantees for the currently implemented onboarding endpoints, and it is linked fromapps/backend/IMPLEMENTATION_DOCS.md.Type of change
Findings
After reviewing the backend codebase, I found that the currently implemented E2EE-related flow includes:
POST /auth/challengePOST /auth/verifyidentityPublicKeydeviceIdPOST /devices/:id/prekeys200key capGET /devicesI also found that the repo does not currently implement backend endpoints for:
Exact issue identified
The issue was a missing backend sequence document for E2EE onboarding.
Specifically, the codebase lacked:
apps/backend/docs/e2ee-onboarding.mdIMPLEMENTATION_DOCS.mdFix features
I fixed the issue by adding documentation that:
Files created
apps/backend/docs/e2ee-onboarding.mdapps/backend/IMPLEMENTATION_DOCS.mdThe documentation issue is resolved without changing backend runtime logic.
Checklist
If you want a stricter version reflecting the environment limitation, I can also phrase the checklist to note that local test execution could not be completed because
pnpm/vitestwere unavailable in the workspace.CLOSE #171