docs: clarify indexer ownership and naming (indexerService.ts / soroban-indexer.service.ts) - #1166
Merged
ogazboiz merged 2 commits intoAug 3, 2026
Conversation
ogazboiz
approved these changes
Aug 3, 2026
ogazboiz
left a comment
Contributor
There was a problem hiding this comment.
verified against the code: indexerService.ts exports exactly getIndexerStatus, resetIndexer and replayFromLedger, SorobanEventWorker is started by workers/index.ts, sorobanIndexerService from index.ts, and the naming guidance matches the repo convention. accurate docs, merging. note #980 was closed in favor of #968 which will remove the legacy service, so this doc will want a trim when that lands. if you want to keep contributing, join us on Telegram: https://t.me/+DOylgFv1jyJlNzM0
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.
Fixes #1096
Summary
Documents which indexer-related file is the source of truth and which is legacy/being phased out, so new contributors know where to start when debugging indexing.
Changes
backend/src/services/indexerService.ts: added a module-level JSDoc clarifying it is not an indexer — it is the admin control-plane helper (getIndexerStatus/resetIndexer/replayFromLedger) for the source-of-truth worker.backend/src/services/soroban-indexer.service.ts: added a module-level JSDoc marking it as the legacy indexer being phased out;SorobanEventWorkeris the source of truth.docs/ARCHITECTURE.md: added an "Indexer Ownership & Naming" section with a file/role/status table, key debugging pointers, and the naming-convention plan.Notes
once the functional consolidation (tracked separately) lands); the intended rename (indexerService.ts→indexer.service.ts, kebab-case +.service.ts) is documented in the comments and ARCHITECTURE.md.