Repository navigation
Document the endpoints missing from the OpenAPI spec #186
Description
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
/tokensand the two export routes, registered insrc/openapi/build.ts -
/offramp/*documented, or explicitly marked internal with a one-line rationale in the spec -
npm run docs:openapiregenerates deterministically and bothopenapi.jsonfiles 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
biqqest commentedon Sep 24, 2026
@biqqest has applied to work on this issue as part of the Stellar Wave Program's 9th wave.
ℹ️ Repo Maintainers: To accept this application, review their application or assign @biqqest to this issue.
JemimahEkong commentedon Sep 26, 2026
@JemimahEkong has applied to work on this issue as part of the Stellar Wave Program's 9th wave.
ℹ️ Repo Maintainers: To accept this application, review their application or assign @JemimahEkong to this issue.
drips-wave commentedon Sep 26, 2026
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 🌊
fix(openapi): make the coverage guard survive a clean clone, and x-in…
docs(openapi): document the undocumented routes, and guard against th…