Skip to content

fix: added protocol config read docs#240

Closed
Onyedika3d wants to merge 1 commit into
accesslayerorg:mainfrom
Onyedika3d:protocol
Closed

fix: added protocol config read docs#240
Onyedika3d wants to merge 1 commit into
accesslayerorg:mainfrom
Onyedika3d:protocol

Conversation

@Onyedika3d
Copy link
Copy Markdown

@Onyedika3d Onyedika3d commented Apr 28, 2026

Changed Files

src/modules/config/config.controllers.ts

  • Added fees block to ProtocolConfig:
    • platformFeeBps (250)
    • maxCreatorRoyaltyBps (1000)
    • bpsDenominator (10000)
  • Included JSDoc comments specifying:
    • Units (basis points)
    • Valid range: [0–10000]

docs/protocol-config.md

  • Created new documentation for GET /api/v1/config endpoint
  • Includes:
    • BPS → percentage conversion formula
    • Per-field descriptions
    • Example curl command for validation

src/modules/config/config.controllers.test.ts

  • Added comprehensive test coverage:
    • Verifies 200 response
    • Ensures fees object presence
    • Validates value ranges
    • Confirms bpsDenominator constant
    • Tests percentage conversion logic
    • Checks returned network value

README.md

  • Added link to docs/protocol-config.md

CONTRIBUTING.md

  • Added link to docs/protocol-config.md under "Before you start"

Closes: #218

@drips-wave
Copy link
Copy Markdown

drips-wave Bot commented Apr 28, 2026

Hey @Onyedika3d! 👋 It looks like this PR isn't linked to any issue.

If this PR is for one of the issues assigned to you as part of a Wave, please link it to ensure your contribution is tracked properly. You can do this by adding a keyword to the PR description (e.g., Closes #123), or by clicking a button below:

Issue Title
#225 Add API timeout config docs with defaults table Link to this issue

ℹ️ Learn more about linking PRs to issues

@Onyedika3d Onyedika3d closed this Apr 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant