docs(validators): add troubleshooting page#403
Conversation
✅ Deploy Preview for genlayer-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds a new troubleshooting documentation page for validators and a navigation metadata entry. The page contains a pre-flight checklist and a common issues section covering setup, RPC/chain checks, telemetry, backups, and recovery steps. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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. Review rate limit: 0/1 reviews remaining, refill in 41 minutes and 42 seconds.Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
pages/validators/troubleshooting.mdx (1)
31-34: ⚡ Quick winConsider clarifying environment variable usage.
The curl command assumes
$CONSENSUS_ADDRand$GENLAYERNODE_ROLLUP_GENLAYERCHAINRPCURLare set, but users reading this troubleshooting page may not have sourced those variables. When they copy-paste this command, they'll encounter shell variable expansion errors instead of the intended RPC probe.💡 Suggested clarification
Option 1: Add a brief note before the command:
+Replace `$CONSENSUS_ADDR` and `$GENLAYERNODE_ROLLUP_GENLAYERCHAINRPCURL` with the actual values from your `config.yaml` (`rollup.consensusaddress` and `rollup.genlayerchainrpcurl`), or export them first: + +```sh +export CONSENSUS_ADDR="0xYour..." +export GENLAYERNODE_ROLLUP_GENLAYERCHAINRPCURL="https://..." +``` + curl -s -X POST -H "Content-Type: application/json" \Option 2: Show the command with inline placeholders:
curl -s -X POST -H "Content-Type: application/json" \ - --data '{"jsonrpc":"2.0","method":"eth_getCode","params":["'$CONSENSUS_ADDR'","latest"],"id":1}' \ - "$GENLAYERNODE_ROLLUP_GENLAYERCHAINRPCURL" + --data '{"jsonrpc":"2.0","method":"eth_getCode","params":["<your-consensus-address>","latest"],"id":1}' \ + "<your-genlayerchain-rpc-url>"🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@pages/validators/troubleshooting.mdx` around lines 31 - 34, Add a brief clarification above the curl snippet that the shell variables CONSENSUS_ADDR and GENLAYERNODE_ROLLUP_GENLAYERCHAINRPCURL must be set; either show the two example export commands (export CONSENSUS_ADDR="0xYour..." and export GENLAYERNODE_ROLLUP_GENLAYERCHAINRPCURL="https://...") or rewrite the curl example to use inline placeholders (e.g., <CONSENSUS_ADDR> and <GENLAYERNODE_ROLLUP_GENLAYERCHAINRPCURL>) so readers can copy-paste without shell expansion errors, and ensure the note references those exact variable names.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@pages/validators/troubleshooting.mdx`:
- Around line 31-34: Add a brief clarification above the curl snippet that the
shell variables CONSENSUS_ADDR and GENLAYERNODE_ROLLUP_GENLAYERCHAINRPCURL must
be set; either show the two example export commands (export
CONSENSUS_ADDR="0xYour..." and export
GENLAYERNODE_ROLLUP_GENLAYERCHAINRPCURL="https://...") or rewrite the curl
example to use inline placeholders (e.g., <CONSENSUS_ADDR> and
<GENLAYERNODE_ROLLUP_GENLAYERCHAINRPCURL>) so readers can copy-paste without
shell expansion errors, and ensure the note references those exact variable
names.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 3193197e-8b87-49cb-8e82-f4e3fc778ca7
📒 Files selected for processing (2)
pages/validators/_meta.jsonpages/validators/troubleshooting.mdx
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@pages/validators/troubleshooting.mdx`:
- Around line 29-37: The curl example in the troubleshooting doc mixes a
hardcoded consensus address with a placeholder RPC URL, which is inconsistent
with the prose; update the example to use a clear placeholder (e.g.
YOUR_CONSENSUS_ADDRESS) or change the prose to say only the RPC URL must be
substituted, and mention the config keys consensus.consensusaddress and
rollup.genlayerchainrpcurl so users know where to source the address; also add a
short note that consensus addresses can change after network upgrades so the
hardcoded address may become stale.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: d1a2059e-5817-4d15-ae9b-689498ac74f6
📒 Files selected for processing (1)
pages/validators/troubleshooting.mdx
…aleness in eth_getCode probe
|
Nice work on the validator troubleshooting guide! 👍 This is a great complement to the developer onboarding checklist (#402) - together they cover both sides of the GenLayer ecosystem. The symptom-keyed troubleshooting section is particularly helpful. Looking forward to seeing this merged! |
2 participants
Summary
Adds a new validator-side troubleshooting page (
pages/validators/troubleshooting.mdx) with:validator-prime.Why
The
validators/section currently has scattered guidance on individual checks (doctor,account export, validator-vs-full-node mode) but no consolidated "before you prime" reference and no symptom-keyed troubleshooting page.upgrade.mdxincludes a 4-bullet Quick Troubleshooting section, but it's scoped to upgrade flows.This page is structured to answer questions a first-time validator hits during the first hours of operation. Cross-linking from
setup-guide.mdxwas intentionally left out of this PR to keep the diff small — happy to add it in a follow-up if you'd prefer.Notes for reviewers
genlayer-node-linux-amd64-v0.5.9on a fresh Ubuntu 24.04 host while preparing my own validator setup. Nothing here is invented../bin/genlayernode doctorexits with status 0 even when reporting validation failures, and (2)doctordoes not verify that the consensus contract bytecode actually exists on the connected RPC — a wrong-chain RPC passesdoctorbut fails at startup withno contract code at given address. Both are surfaced in the page; both could plausibly be addressed in the binary as well.<Callout>usage matches the existing style insetup-guide.mdxandupgrade.mdx.Summary by CodeRabbit