Skip to content

Document the endpoints missing from the OpenAPI spec #186

Closed

Description

@Miracle656

Background

openapi.json and its copy docs/openapi.json list 20 paths. Live but undocumented: GET /tokens (src/api.ts:282), GET /transfers.csv and /transfers.parquet (src/routes/exports.ts:178-179), and all five /offramp/* routes (src/api/offramp.ts:83, 101, 114, 139, 230). The README's endpoint list misses them too.

The spec is generated from zod by npm run docs:openapi (src/openapi/build.ts), so this is schema work, not hand-editing JSON.

Acceptance criteria

  • Zod schemas added for /tokens and the two export routes, registered in src/openapi/build.ts
  • /offramp/* documented, or explicitly marked internal with a one-line rationale in the spec
  • npm run docs:openapi regenerates deterministically and both openapi.json files match
  • A test asserts every route registered on the app appears in the generated spec — fails on main

Drips Wave · Complexity: Easy · 100 points


How this repo is laid out

Wraith is a Soroban incoming-transfer indexer: it fills the gap Horizon leaves for SAC/SEP-41 token events by recipient address. Roughly 14k lines under src/, REST + GraphQL + WebSocket, Postgres via Prisma, deployed on Render.

  • Unit tests are jest (src/**/__tests__, tests/*.test.ts), with a coverage gate.
  • Integration tests are vitest (tests/integration/, vitest.integration.config.ts, Docker).
  • Don't mix the two runners in one file.

Known state of main before you start

tsc --noEmit and the unit suite are green. The Integration tests CI job is red, and so is Load test — both predate this batch. Open PRs #177 and #178 address them. If the integration job is red when you open a PR, that is not your fault; say so in the PR and carry on.

Four modules are shipped, closed as done, and imported by nothing: src/indexer/checkpoint.ts, src/ingest/reorg.ts, src/middleware/opa.ts, and src/api/candles.ts + src/workers/ohlc-refresh.ts. So the live indexer today has no reorg handling and no atomic checkpointing, despite both features being closed. Two issues below start unpicking that — don't assume a closed issue means a wired feature.

Ground rules

  • Every PR needs a test that fails before the change and passes after, unless the issue says otherwise.
  • Don't widen a Prometheus label to something unbounded — addresses and contract ids must never become label values.
  • Nothing may log or return a raw database error, a connection string, or a provider URL.
  • Don't reformat a file you're changing. A diff that is 90% whitespace hides the 10% that matters.


Required: Before submitting, join the contributor Telegram so your work can be tracked and counted toward the Stellar Wave: https://t.me/+fxHXq8f1SwlkZDBk

Activity

  1. biqqest commented on Sep 24, 2026

    @biqqest

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

    I will love to work on this issue please

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

  2. JemimahEkong commented on Sep 26, 2026

    @JemimahEkong
    Contributor

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

    Kindly assign this issue to me. I can handle it.

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

  3. drips-wave commented on Sep 26, 2026

    @drips-wave

    Congratulations, @JemimahEkong! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on September 30, 2026.

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

  4. added a commit that references this issue on Oct 9, 2026
    4428d53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions