docs: add missing env vars documentation (verifier config)#251
docs: add missing env vars documentation (verifier config)#251shrutig-blip wants to merge 2 commits into
Conversation
|
@shrutig-blip is attempting to deploy a commit to the ankanmisra's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
Hi @shrutig-blip, thanks for opening this PR. Every contribution helps MicroAI-Paygate grow. If you find the project useful, consider starring the repository — it helps others discover it. Star MicroAI-Paygate on GitHub Looking forward to reviewing this PR. |
github-actions
Bot
added
documentation
📝 WalkthroughWalkthroughThis PR adds two new environment variables, NEXT_PUBLIC_VERIFIER_URL and MAX_REQUEST_BODY_BYTES, to .env.example with documentation comments, and updates README.md's Configure instructions and Configuration table to describe both variables. ChangesEnvironment variable documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related issues
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.env.example:
- Around line 57-63: The new NEXT_PUBLIC_VERIFIER_URL example entry is out of
dotenv order in the env sample. Move the NEXT_PUBLIC_VERIFIER_URL block in
.env.example so it appears above the existing VERIFIER_URL section, keeping the
environment variable examples sorted in the same order expected by
dotenv-linter.
In `@README.md`:
- Line 246: Update the MAX_REQUEST_BODY_BYTES documentation in README to
explicitly state that the verifier only accepts values greater than 0 and will
fall back to the default on zero or invalid input. Make the same wording change
for the other MAX_REQUEST_BODY_BYTES mention as well, so the docs match the
behavior enforced by the verifier configuration.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
|
Addressed the CodeRabbit review suggestions. Thanks! |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Hi @AnkanMisra , I have added NEXT_PUBLIC_VERIFIER_URL to .env.example, README config table, and web/README.md and MAX_REQUEST_BODY_BYTES to .env.example and README config table. I have also cross-checked usage via grep in codebase and have submitted a PR. I'd appreciate it if you could take a look when you have time. Thanks! |
AnkanMisra
left a comment
AnkanMisra
left a comment
There was a problem hiding this comment.
Thanks for filling the docs gap here. I checked the current code paths before reviewing, and I think this still needs one more pass before merge:
NEXT_PUBLIC_VERIFIER_URLis genuinely used by the warm-up banner, but the PR still does not document it inweb/README.md, which is part of the stated scope in both issue #212 and the PR description.- The new bullets under
Edit .env before starting the gateway. At minimum:are misleading because neither variable is a minimum gateway startup requirement.NEXT_PUBLIC_VERIFIER_URLis an optional frontend build-time var, andMAX_REQUEST_BODY_BYTESis an optional verifier tuning knob with a default fallback.
Once those are fixed, this should be in much better shape.
|
|
||
| # Verifier warm-up endpoint used by frontend banner | ||
| # Default: see DEPLOY.md (used for frontend warm-up banner) | ||
| NEXT_PUBLIC_VERIFIER_URL= |
There was a problem hiding this comment.
NEXT_PUBLIC_VERIFIER_URL belongs with the other frontend NEXT_PUBLIC_* examples later in this file. Leaving it here next to VERIFIER_URL means the canonical env sample still stays internally inconsistent: contributors scanning the dedicated frontend block will still miss it.
| - `SERVER_WALLET_PRIVATE_KEY`: required for signing receipts. Use an unfunded development key locally. | ||
| - `RECIPIENT_ADDRESS`: recipient address embedded in payment contexts. | ||
| - `CHAIN_ID` and `EXPECTED_CHAIN_ID`: must match. The default is `84532` for Base Sepolia. | ||
| - `NEXT_PUBLIC_VERIFIER_URL`: frontend verifier warm-up endpoint used by the banner to pre-warm the verifier (improves UX; optional). |
There was a problem hiding this comment.
These entries do not fit under Edit .env before starting the gateway. At minimum:. NEXT_PUBLIC_VERIFIER_URL is optional and only used by the web warm-up banner, and MAX_REQUEST_BODY_BYTES is an optional verifier limit with a built-in default fallback. Please keep them in the configuration reference, but remove them from the minimum gateway startup list so the setup docs stay accurate.
|
Requesting changes for the full remaining scope here:
Issue link for tracking: #212 |
|
Thanks @AnkanMisra for the review! I've addressed the requested changes: -Moved NEXT_PUBLIC_VERIFIER_URL to the frontend NEXT_PUBLIC_* section in .env.example. -Removed both variables from the "At minimum" setup list in README.md. -Added NEXT_PUBLIC_VERIFIER_URL documentation to web/README.md. -Kept both variables in the configuration reference table as requested. |
i dont see no new commit after i ask for changes |
2 participants
Summary
This PR documents missing environment variables used in the project but not previously included in the canonical configuration docs.
Changes
NEXT_PUBLIC_VERIFIER_URLto.env.example, README config table, and web/README.mdMAX_REQUEST_BODY_BYTESto.env.exampleand README config tableReason
These variables were being used in code and deployment configs but were missing from documentation, which could lead to misconfiguration for new contributors.
Verification
Summary by CodeRabbit
Closes #212