Skip to content

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

Open
OpensrcLord wants to merge 1 commit into
LabsCrypt:mainfrom
OpensrcLord:fix/1096-indexer-naming-docs
Open

docs: clarify indexer ownership and naming (indexerService.ts / soroban-indexer.service.ts)#1166
OpensrcLord wants to merge 1 commit 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants