docs(backend): add ARCHITECTURE.md with indexer ownership, SSE flow, … - #1309
Open
Seunfunmi-319509 wants to merge 1 commit into
Open
docs(backend): add ARCHITECTURE.md with indexer ownership, SSE flow, …#1309Seunfunmi-319509 wants to merge 1 commit into
Seunfunmi-319509 wants to merge 1 commit into
Conversation
…and keeper-key model Both indexerService.ts and soroban-indexer.service.ts reference "docs/ARCHITECTURE.md for the full indexer ownership model" but no such file existed in backend/docs/. This created a broken cross- reference for contributors investigating the dual-indexer race (LabsCrypt#801) and the keeper-key authorization model. This adds backend/docs/ARCHITECTURE.md documenting: - Indexer ownership: which of the three similarly-named files is authoritative, the dual-indexer race, and the phase-out plan - SSE broadcast flow: end-to-end path from Soroban RPC through the worker, DB, SSE service, Redis fanout, to the frontend - Keeper-key authorization: the custodial vs non-custodial signing model, the KEEPER_SECRET_KEY role, and the security boundary Closes LabsCrypt#1299 🤖 Generated with Codebuff Co-Authored-By: Codebuff <[email protected]>
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
1 participant
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.
…and keeper-key model
Both indexerService.ts and soroban-indexer.service.ts reference "docs/ARCHITECTURE.md for the full indexer ownership model" but no such file existed in backend/docs/. This created a broken cross- reference for contributors investigating the dual-indexer race (#801) and the keeper-key authorization model.
This adds backend/docs/ARCHITECTURE.md documenting:
🤖 Generated with Codebuff
Description
Type of Change
Related Issues
Closes #
Changes Made
Testing
Test Coverage
Test Steps
Breaking Changes
Breaking Changes:
Migration Guide:
Screenshots/Demo
Checklist
Additional Notes
Closes #1296