Skip to content

Add a rate-limit pre-check endpoint /api/limits/check that does not consume budget #477

Description

@greatest0fallt1me

Description

This is a backend issue for the GrantFox campaign. Dry-run rate-limit endpoint that tells the client whether the next call would succeed without consuming budget.

Requirements and Context

  • Returns ok|deny with reason
  • Does not consume tokens
  • Auth scoped to caller
  • Cached per second
  • Must be secure, tested, and documented
  • Should be efficient and easy to review

Suggested Execution

  1. Fork the repo and create a branch
    git checkout -b feature/limits-check
  2. Implement changes
    • src/routes/limits/check.ts (new)
    • src/middleware/rateLimiter.ts
  3. Test and commit
    • Run the repo's standard test suite and lint
    • Cover edge cases; include output in the PR

Example commit message

feat: add rate-limit pre-check endpoint

Acceptance Criteria

  • Returns correct verdict
  • No consume
  • Auth correct
  • Caching works

Guidelines

  • Minimum 90% test coverage on changed lines
  • Input validation at the boundary; standardized error envelope
  • Structured logging with correlation IDs
  • Clear documentation and inline comments
  • Timeframe: 96 hours

Metadata

Metadata

Assignees

Labels

GRANTFOX OSSGrantFox open-source campaign taskOFFICIAL CAMPAIGNOfficial GrantFox campaign issueStellar WaveIssues in the Stellar wave programapiAPI endpoint/contract workbackendBackend service work

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