Skip to content

Indexer: document entity ownership and derived fields #566

@Otaiki1

Description

@Otaiki1

Build location

Work primarily in indexer/src/database/entities. Keep related tests/docs beside that package unless this issue explicitly calls for a cross-package update.

Why this matters

Entities include raw chain state and derived query state; contributors need to know which fields are source-of-truth.

What to build

  • Add entity-level comments or docs for Raffle, Ticket, User, RaffleEvent, PlatformStat, Cursor, DLQ.
  • Mark derived fields and their updater handlers.
  • Document which fields are safe to recalculate.

Acceptance criteria

  • Docs are linked from indexer README.
  • New migrations reference ownership rules.

Suggested verification

cd indexer && npm run lint && npm run test && npm run build

Metadata

Metadata

Assignees

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions