Skip to content

docs: clarify indexer ownership and naming (indexerService.ts / soroban-indexer.service.ts) - #1166

Merged
ogazboiz merged 2 commits into
LabsCrypt:mainfrom
OpensrcLord:fix/1096-indexer-naming-docs
Aug 3, 2026
Merged

docs: clarify indexer ownership and naming (indexerService.ts / soroban-indexer.service.ts)#1166
ogazboiz merged 2 commits into
LabsCrypt:mainfrom
OpensrcLord:fix/1096-indexer-naming-docs

Conversation

@OpensrcLord

Copy link
Copy Markdown

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; SorobanEventWorker is 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

@ogazboiz ogazboiz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@ogazboiz
ogazboiz merged commit 7b8ca73 into LabsCrypt:main Aug 3, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

3 participants