docs(staking): staking guide and docs updated #309
Conversation
✅ Deploy Preview for genlayer-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughExpanded and reorganized staking documentation and developer guide: added detailed validator/delegator roles, epoch and activation rules, reward/unbonding mechanics, Owner/Operator/ValidatorWallet concepts, and a new staking developer guide; updated navigation metadata. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 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: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
pages/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking.mdx(1 hunks)pages/validators/_meta.json(1 hunks)pages/validators/staking-guide.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
pages/**/_meta.json
📄 CodeRabbit inference engine (CLAUDE.md)
pages/**/_meta.json: Navigation is controlled by _meta.json files in each directory
Edit _meta.json files to change page ordering or titles
Update corresponding _meta.json to include the new page when adding new pages
Files:
pages/validators/_meta.json
pages/**/*.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/**/*.mdx: All content is in MDX format supporting React components
Import and use custom components within MDX files
Create .mdx file in appropriate pages/ subdirectory when adding new pages
All content should support React components in MDX files
Files:
pages/validators/staking-guide.mdxpages/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking.mdx
🧠 Learnings (12)
📓 Common learnings
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Applied to files:
pages/validators/_meta.jsonpages/validators/staking-guide.mdxpages/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/**/_meta.json : Update corresponding _meta.json to include the new page when adding new pages
Applied to files:
pages/validators/_meta.json
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/**/_meta.json : Edit _meta.json files to change page ordering or titles
Applied to files:
pages/validators/_meta.json
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/_meta.jsonpages/validators/staking-guide.mdxpages/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Applied to files:
pages/validators/_meta.jsonpages/validators/staking-guide.mdxpages/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Applied to files:
pages/validators/staking-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/staking-guide.mdxpages/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Applied to files:
pages/validators/staking-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Applied to files:
pages/validators/staking-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
Applied to files:
pages/validators/staking-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Applied to files:
pages/validators/staking-guide.mdx
🪛 LanguageTool
pages/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking.mdx
[style] ~36-~36: To form a complete sentence, be sure to include a subject.
Context: ...rom the owner (hot wallet recommended). Can be changed by the owner but cannot be t...
(MISSING_IT_THERE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Playwright E2E
🔇 Additional comments (5)
pages/validators/_meta.json (1)
3-3: Navigation entry correctly added for new staking guide.The addition properly integrates the new staking guide into the validators section navigation, following the established pattern.
pages/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking.mdx (3)
5-14: Clear and informative validators vs delegators comparison.The new table effectively contrasts the two roles with key metrics (stake, infrastructure, rewards), providing readers with quick understanding of role differences and expectations.
28-79: Excellent conceptual depth across new sections.The Owner/Operator/ValidatorWallet explanation, Epoch System, Shares vs Stake mechanics, and Validator Selection/Weight formula sections are well-explained with concrete examples and parameters. The weight formula with ALPHA/BETA parameters clearly shows the incentive design.
137-139: Internal link path is correct.The link
/validators/staking-guideon line 139 correctly references the file atpages/validators/staking-guide.mdxand matches the Next.js pages router routing convention.pages/validators/staking-guide.mdx (1)
1-321: Comprehensive staking guide with proper structure and valid cross-references.The guide provides clear instructions for both validators and delegators with well-organized sections including validator operations (join, deposit, withdraw, claim), delegator operations, practical scenarios, best practices, troubleshooting table, and related resources. All internal links resolve correctly to existing documentation pages. The Callout components (info and warning types) and timeline diagrams enhance clarity and readability. Code examples are presented clearly with appropriate context for each operation.
pages/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking.mdx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
pages/validators/staking-guide.mdx (2)
35-37: Enhance warning callouts with actionable next steps.The three warning callouts (validator wallet address, shares not tokens × 2) effectively highlight critical information. Consider adding brief follow-up guidance to make them more actionable:
Example enhancement for line 35-37:
<Callout type="warning"> Save the returned **ValidatorWallet address** - you'll need it for all future operations. Store it securely (e.g., in your deployment records or contract storage) to prevent operations from failing. </Callout>Also applies to: 89-91, 195-197
162-166: Provide quantitative guidance on validator selection and diversification.The delegation strategy tips (lines 162-166) recommend diversifying across validators and selecting ones with "good uptime," but no concrete thresholds or metrics are provided. Consider adding:
- Recommended minimum number of validators to delegate to
- Suggested uptime threshold (e.g., "validators with 95%+ uptime")
- How to check validator performance metrics
- Reference to where performance metrics can be found
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/validators/staking-guide.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/**/*.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/**/*.mdx: All content is in MDX format supporting React components
Import and use custom components within MDX files
Create .mdx file in appropriate pages/ subdirectory when adding new pages
All content should support React components in MDX files
Files:
pages/validators/staking-guide.mdx
🧠 Learnings (10)
📓 Common learnings
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Applied to files:
pages/validators/staking-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/staking-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Applied to files:
pages/validators/staking-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/staking-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Applied to files:
pages/validators/staking-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Applied to files:
pages/validators/staking-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
Applied to files:
pages/validators/staking-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Applied to files:
pages/validators/staking-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Applied to files:
pages/validators/staking-guide.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Redirect rules - genlayer-docs
- GitHub Check: Header rules - genlayer-docs
- GitHub Check: Pages changed - genlayer-docs
- GitHub Check: Playwright E2E
🔇 Additional comments (8)
pages/validators/staking-guide.mdx (8)
1-1: Callout component import is correct and compatible.The import of
Calloutfrom "nextra-theme-docs" is valid. The project uses nextra-theme-docs version 2.13.2, which includes theCalloutcomponent as a standard export. Bothtype="info"andtype="warning"props used in this file are supported types in this version.
1-11: Internal link path is valid and correctly references existing documentation.The link
/api-references/genlayer-cli#staking-operations-testnetin line 10 is correct. The corresponding "Staking Operations (Testnet)" section exists in pages/api-references/genlayer-cli.mdx and will generate the expected anchor.
321-325: All related resource links in the staking guide are valid and accessible. The referenced concept pages and CLI documentation with the staking-operations-testnet anchor all exist in the documentation structure.
74-91: This verification request cannot be completed in the documentation repository context.The review comment requests verification of the
validatorView()function signature, state array indices, and share calculation logic against the actual GenStaking contract implementation. However, this repository (genlayerlabs/genlayer-docs) contains only documentation—not the smart contract source code. The contract implementation exists in a separate repository and is not available here.The documented code snippet (lines 77-80) reflects the intended API as documented. Verifying contract implementation details requires access to the actual smart contract repository, which is outside this documentation repository's scope. This is a documentation-only repository that documents the API usage, not the implementation.
23-33: This review comment is not applicable to a documentation repository.The file
pages/validators/staking-guide.mdxis a documentation guide, not a smart contract codebase. The Solidity code examples are illustrative usage patterns shown to guide developers, not actual contract implementations. Contract function signatures cannot be verified in the genlayer-docs repository because the GenStaking contract implementation resides in a separate smart contracts repository, not in this documentation codebase. For a documentation file, presenting example usage patterns without importing or verifying against actual contract code is standard and appropriate.Likely an incorrect or invalid review comment.
184-193: Verify delegator contract function signatures against the actual GenLayer staking contract.The staking guide documents
sharesOf(),delegatorExit(), anddelegatorClaim()functions, but the contract implementation is not available in this documentation repository. Confirm these match the actual contract interface:
genStaking.sharesOf(delegator, validator)parameter order and return typegenStaking.delegatorExit(validator, shares)signaturegenStaking.delegatorClaim()parameters and return value- Ensure delegator address parameter convention is consistent across operations
1-325: This review comment's verification scope is inappropriate for a documentation repository.The staking guide is well-written and internally consistent with GenLayer's conceptual documentation. However, the original comment requests verification against "the GenLayer smart contract implementation," which does not exist in this documentation repository. Smart contract code verification requires access to the actual contract repository (likely genlayerlabs/genlayer), not this documentation repo.
A proper documentation review should instead focus on:
Internal Consistency - The guide accurately reflects the staking concepts documented in
/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking, including the 7-epoch unbonding period, epoch +2 activation rule, and 42,000/42 GEN minimum stakes.Link Validity - All internal links are correctly formatted and reference existing pages:
- Staking concepts link: valid
- CLI reference link: valid (anchors to section 304 in genlayer-cli.mdx)
- Related resources links: valid
Documentation Completeness - Unlike
setup-guide.mdx(which requires version updates per governance changes), this guide appropriately avoids hardcoded contract addresses and versions that would require maintenance.Clarity and Accuracy - Code examples follow correct Solidity syntax, timelines are clear, and scenarios are practical.
If contract-level verification is needed (function signatures, error messages, exact parameters), that should be conducted against the actual GenLayer smart contract repository through code review or automated testing, not through documentation review.
Likely an incorrect or invalid review comment.
306-318: Verify troubleshooting error messages against contract implementation.The troubleshooting table lists specific error messages that should be confirmed against the actual staking contract code to ensure accuracy:
ValidatorBelowMinimumStakeOperatorAlreadyAssignedValidatorMayNotDepositZeroValueValidatorExitExceedsSharesConfirm that error names match the contract implementation exactly, verify that all solutions are correct and complete, and check whether any related staking errors are missing from the table. Access to the genlayer-node contract source code is required to complete this verification.
pages/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking.mdx
Outdated
Show resolved
Hide resolved
|
|
||
| ## Epoch System | ||
|
|
||
| The network operates in epochs (minimum 1 day): |
| - **Epoch +2 Activation Rule**: All deposits become active 2 epochs after they are made | ||
| - Epoch finalization requires all transactions to be finalized | ||
| - Cannot advance to epoch N+1 until epoch N-1 is finalized | ||
| - Validators are automatically "primed" via `validatorPrime()` each epoch |
There was a problem hiding this comment.
Doesn't sound automatic to me
Validator must be primed. The genlayer node does this automatically
| - **10%** → Validator owners (operational fee) | ||
| - **75%** → Total validator stake (validators + delegators) | ||
| - **10%** → Developers | ||
| - **5%** → DAO |
There was a problem hiding this comment.
Locked future allocation for the DeepThought AI-DAO
| - Sorts the validator into the selection tree | ||
|
|
||
| **Key Properties:** | ||
| - **Automatic**: Called each epoch by the validator node |
There was a problem hiding this comment.
Not automatic from the consensus PoV
| ## Unstaking and Withdrawing | ||
|
|
||
| To stop validating or to retrieve staked tokens, validators must initiate an [unstaking](/core-concepts/optimistic-democracy/unstaking) process, which includes a cooldown period to finalize all pending transactions. This ensures the network remains secure and all obligations are fulfilled before the withdrawal. | ||
| To stop validating or to retrieve staked tokens, validators must initiate an [unstaking](/understand-genlayer-protocol/core-concepts/optimistic-democracy/unstaking) process, which includes a cooldown period to finalize all pending transactions. This ensures the network remains secure and all obligations are fulfilled before the withdrawal. |
There was a problem hiding this comment.
What happens to the delegators
| ## Governance and Safeguards | ||
|
|
||
| - **24-Hour Delay**: All slashing actions have a governance delay period | ||
| - Governance can intervene before slashing is executed |
There was a problem hiding this comment.
Remove this, we don't want to say this
pages/validators/staking-guide.mdx
Outdated
|
|
||
| # Staking Guide | ||
|
|
||
| This guide covers staking operations for both validators and delegators on the GenLayer network. |
There was a problem hiding this comment.
Be more precise, this describes the Consensus level staking operations. This document is for developers that want to interact with the smart contracts directly
pages/validators/staking-guide.mdx
Outdated
| This guide covers staking operations for both validators and delegators on the GenLayer network. | ||
|
|
||
| <Callout type="info"> | ||
| For CLI-based staking operations, see the [GenLayer CLI Staking Commands](/api-references/genlayer-cli#staking-operations-testnet). |
There was a problem hiding this comment.
To perform staking operations as a user, we recomment using the GenLayer CLI
…mocracy/staking.mdx Co-authored-by: Edgars Nemše <edgars.nemse@gmail.com>
…mocracy/staking.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
pages/developers/staking-guide.mdx (1)
237-378: Large duplicate of Genesis Epoch 0 section exists in parallel concept document.The Genesis Epoch 0 section (lines 237-378) is substantially duplicated in the concept document
pages/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking.mdx(lines 49-160). Both cover the same mechanics: epoch 0 rules, validator/delegator behaviors, activation timelines, and FAQs.If intentional (how-to guide vs. reference), this is acceptable. However, consider consolidating content to reduce maintenance burden and potential drift between versions.
pages/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking.mdx (1)
49-160: Large overlapping content between concept and guide documents.The Genesis Epoch 0 section (lines 49-160) significantly overlaps with
pages/developers/staking-guide.mdx(lines 237-378). Both files cover nearly identical mechanics, timelines, and FAQs with similar structure and wording.Consider establishing a single source of truth:
- Option 1: Keep Genesis Epoch 0 detailed explanation only in the concept doc (
staking.mdx), with a brief summary and link in the guide- Option 2: Keep the how-to version in the guide, with a brief reference in the concept doc
This reduces maintenance burden and prevents future divergence.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/developers/staking-guide.mdx(1 hunks)pages/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/**/*.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/**/*.mdx: All content is in MDX format supporting React components
Import and use custom components within MDX files
Create .mdx file in appropriate pages/ subdirectory when adding new pages
All content should support React components in MDX files
Files:
pages/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking.mdxpages/developers/staking-guide.mdx
🧠 Learnings (10)
📓 Common learnings
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Applied to files:
pages/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking.mdxpages/developers/staking-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Applied to files:
pages/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking.mdxpages/developers/staking-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Applied to files:
pages/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking.mdxpages/developers/staking-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Applied to files:
pages/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking.mdxpages/developers/staking-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Applied to files:
pages/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking.mdxpages/developers/staking-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
Applied to files:
pages/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking.mdxpages/developers/staking-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
Applied to files:
pages/developers/staking-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Applied to files:
pages/developers/staking-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Applied to files:
pages/developers/staking-guide.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Playwright E2E
🔇 Additional comments (3)
pages/developers/staking-guide.mdx (1)
1-11: Verify internal cross-references and file location consistency.The file is correctly structured with proper MDX formatting (Callout component imports and usage, code blocks). However, there is a reference conflict: this file is located at
/developers/staking-guide.mdx, but the corresponding concept document (staking.mdx, line 268) references/validators/staking-guide.Verify that:
- The file location in
/developers/is the intended final location- The cross-reference in
staking.mdx(line 268) is updated to/developers/staking-guide- The pages/developers/_meta.json includes the "staking-guide" entry for proper navigation
pages/understand-genlayer-protocol/core-concepts/optimistic-democracy/staking.mdx (2)
36-36: Prior grammar feedback has been addressed.The sentence fragment flagged in the previous review of the Operator Address definition has been corrected. Line 36 now properly reads: "It can be changed by the owner..." making it grammatically complete.
268-268: Fix broken cross-reference to staking guide.Lines 268 and 278 reference
/validators/staking-guide, but the new staking contract guide is located at/developers/staking-guide.mdx.Update both references to point to the correct path:
-For detailed step-by-step instructions and code examples, see the [Staking Guide](/validators/staking-guide). +For detailed step-by-step instructions and code examples, see the [Staking Guide](/developers/staking-guide).-- [Staking Guide](/validators/staking-guide) - Practical guide for staking operations +- [Staking Guide](/developers/staking-guide) - Practical guide for staking operationsAlso applies to: 278-278
⛔ Skipped due to learnings
Learnt from: CR Repo: genlayerlabs/genlayer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2025-07-24T07:56:58.272Z Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occurLearnt from: CR Repo: genlayerlabs/genlayer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2025-07-24T07:56:58.272Z Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicableLearnt from: CR Repo: genlayerlabs/genlayer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2025-07-24T07:56:58.272Z Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occurLearnt from: CR Repo: genlayerlabs/genlayer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2025-07-24T07:56:58.272Z Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occurLearnt from: CR Repo: genlayerlabs/genlayer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2025-07-24T07:56:58.272Z Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releasesLearnt from: CR Repo: genlayerlabs/genlayer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2025-07-24T07:56:58.272Z Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examplesLearnt from: CR Repo: genlayerlabs/genlayer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2025-07-24T07:56:58.272Z Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occurLearnt from: CR Repo: genlayerlabs/genlayer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2025-07-24T07:56:58.272Z Learning: Applies to pages/validators/setup-guide.mdx : Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Description
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.