docs: Network Keeper Roles page#432
Open
MuncleUscles wants to merge 1 commit into
Open
Conversation
✅ Deploy Preview for genlayer-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
📝 WalkthroughWalkthroughAdds a new documentation page, ChangesNetwork Keeper Roles Documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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 `@pages/validators/network-keeper-roles.mdx`:
- Around line 12-14: The intro and Burn Trigger section describe conflicting
defaults for token burning, so update the wording to match one behavior across
both places. Align the explanation around `epochAdvance()` and `burnThreshold`
so it clearly states whether burning is automatic by default or disabled by
default with manual burning as fallback, and make the `Callout` intro and Burn
Trigger section consistent.
🪄 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: e90d9751-c177-44a1-ab12-17f30ba77af4
📒 Files selected for processing (2)
pages/validators/_meta.jsonpages/validators/network-keeper-roles.mdx
Comment on lines
+12
to
+14
| <Callout type="info" emoji="💡"> | ||
| Most keeper work is already automated. Validator nodes finalize transactions and prime validators as part of normal operation, and epoch advancement plus token burning fire automatically inside `epochAdvance()`. The roles below matter most as a **liveness backstop**: they document what can be triggered manually if the automated path stalls, and which triggers carry a reward. | ||
| </Callout> |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== File context =="
git ls-files 'pages/validators/network-keeper-roles.mdx' 'pages/**/_meta.json' | sed 's#^`#-` #'
echo
echo "== Relevant docs excerpts =="
cat -n pages/validators/network-keeper-roles.mdx | sed -n '1,220p'
echo
echo "== Search for burn/epochAdvance references =="
rg -n --hidden --no-ignore-vcs -S 'epochAdvance|burnThreshold|burn|prime validators|finalize transactions' pages . | sed -n '1,240p'
echo
echo "== Search for protocol implementation references =="
rg -n --hidden --no-ignore-vcs -S 'burnThreshold|epochAdvance\(' . | sed -n '1,240p'Repository: genlayerlabs/genlayer-docs
Length of output: 50386
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== Direct burn-threshold references =="
rg -n -S 'burnThreshold|auto-burn threshold|auto trigger|automatic inside `epochAdvance\(\)`|burn\(\)' pages public . \
--glob '!**/.next/**' --glob '!**/node_modules/**' | sed -n '1,240p'
echo
echo "== Nearby context in the docs page =="
sed -n '156,170p' pages/validators/network-keeper-roles.mdx | cat -n
echo
echo "== Search for explicit default values =="
rg -n -S 'default.*burnThreshold|burnThreshold\s*=\s*0|burnThreshold\s*0' pages public . \
--glob '!**/.next/**' --glob '!**/node_modules/**' | sed -n '1,200p'Repository: genlayerlabs/genlayer-docs
Length of output: 3701
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== burnThreshold mentions in generated docs =="
rg -n -S 'burnThreshold|auto-burn|auto burn|burnable GEN|burning balance|epochAdvance\(\).*burn' public \
--glob '!**/.next/**' | sed -n '1,240p'
echo
echo "== staking-related source docs around burn behavior =="
rg -n -S 'burn|epochAdvance|threshold' public/understand-genlayer-protocol public/pages pages \
--glob '!**/.next/**' | sed -n '1,260p'Repository: genlayerlabs/genlayer-docs
Length of output: 211
Clarify the burn automation wording. The intro says token burning fires automatically inside epochAdvance(), but the Burn Trigger section says the default burnThreshold = 0 disables that automation and makes manual burning the fallback. Make both sections describe the same default behavior.
🤖 Prompt for 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.
In `@pages/validators/network-keeper-roles.mdx` around lines 12 - 14, The intro
and Burn Trigger section describe conflicting defaults for token burning, so
update the wording to match one behavior across both places. Align the
explanation around `epochAdvance()` and `burnThreshold` so it clearly states
whether burning is automatic by default or disabled by default with manual
burning as fallback, and make the `Callout` intro and Burn Trigger section
consistent.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Publishes the "Network Keeper Roles" page — the permissionless functions anyone can call to keep the network live (inflation relayer, epoch advancer, validator primer, appellant, finalizer, stuck-tx healer, burn trigger, quarantine GC), each with trigger, reward formula, and risk-if-idle. The inflation relayer is flagged prominently: it gates network-wide epoch progression (
epoch+1 <= inflationEpoch), so the chain halts if nobody relays. Content promoted from the internal staking spec; verified against genlayer-consensus v0.6-dev.Release Notes
New validator/operator docs page documenting permissionless keeper roles.
Types of Changes
Checklist
Summary by CodeRabbit
Documentation
Chores