[Docs] Document event-indexing and real-time data flow in ARCHITECTURE.md

[ogazboiz]

Join the discussion on Telegram

Why this matters

docs/ARCHITECTURE.md exists but does not explain the backend's event-indexing and real-time data path, which is the most confusing part of the system for new contributors. Specifically, the docs don't cover:

• How on-chain events flow: Soroban RPC → SorobanEventWorker (backend/src/workers/soroban-event-worker.ts) → Prisma StreamEvent/Stream tables → SSE broadcast → frontend useStreamEvents.
• The dedup model (@@unique([transactionHash, eventType])) and the indexer cursor/IndexerState mechanism.
• How the read path falls back to live RPC when DB rows are stale (isStale in backend/src/services/sorobanService.ts).
• The custodial vs. wallet-signed action split (top-up uses a server KEEPER_SECRET_KEY; withdraw/pause/resume currently only simulate server-side and the real tx is signed by the frontend).
• Which secrets are required to run the full stack end to end.

Without this, contributors duplicate work or wire actions incorrectly.

Acceptance criteria

• Add an "Event indexing & real-time updates" section to docs/ARCHITECTURE.md with a simple data-flow diagram (RPC → worker → DB → SSE → UI).
• Document the dedup constraint, the IndexerState cursor, and the stale-read RPC fallback.
• Document the action signing model (which calls are server-submitted vs. wallet-signed) so contributors don't mis-wire endpoints.
• List the required env/secrets to run the full flow, linking to backend/.env.example.

Files to touch

• docs/ARCHITECTURE.md

Out of scope

• Code changes to the indexer or signing model.

[dolaoluwa574-source]

@dolaoluwa574-source has applied to work on this issue as part of the Stellar Wave Program's 5th wave.

Allow me to work on this issue and fix it

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

[0xMegie]

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

can I work on this sir...?

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

[drips-wave]

Congratulations, @0xMegie! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on June 2, 2026.

🧑‍💻 @0xMegie: 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 🌊

[drips-wave]

This issue has been completed by @0xMegie as part of the Stellar Wave Program's 5th Wave 🥳

😎 @0xMegie: 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.