Add stVaults contract docs #781
Open
Conversation
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive contract reference documentation for the stVaults system and integrates these references into existing documentation. The changes provide detailed API documentation for 9 stVaults contracts with method signatures, descriptions, and cross-references.
Changes:
- Added 9 new contract documentation files covering VaultHub, StakingVault, PredepositGuarantee, OperatorGrid, LazyOracle, Dashboard, factories, beacon, and consolidation helper contracts
- Updated sidebar navigation to include all new contract pages in the contracts section
- Added cross-reference links from stVaults technical docs and whitepaper to the new contract reference pages
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| sidebars.js | Adds 9 new contract reference pages to the contracts section navigation |
| docs/contracts/vault-hub.md | Main VaultHub contract reference with comprehensive API documentation |
| docs/contracts/staking-vault.md | StakingVault primitive contract reference with full method listings |
| docs/contracts/predeposit-guarantee.md | PredepositGuarantee (PDG) contract reference including deposit flow diagrams |
| docs/contracts/operator-grid.md | OperatorGrid registry contract reference with tier and group management APIs |
| docs/contracts/lazy-oracle.md | LazyOracle adapter contract reference with reporting and quarantine mechanisms |
| docs/contracts/dashboard.md | Dashboard management contract reference with role-based operations |
| docs/contracts/staking-vault-factory.md | VaultFactory deployment contract reference |
| docs/contracts/staking-vault-beacon.md | UpgradeableBeacon proxy pattern reference |
| docs/contracts/validator-consolidation-requests.md | Consolidation helper contract reference for EIP-7251 support |
| run-on-lido/stvaults/tech-documentation/tech-design.md | Adds link to contract reference from technical design doc |
| run-on-lido/stvaults/tech-documentation/integration-overview.md | Adds link to contract reference and formatting fix for bullet list |
| run-on-lido/stvaults/index.md | Adds contract reference link to stVaults documentation center |
| docs/lido-v3-whitepaper.mdx | Adds contract reference link to whitepaper related documentation section |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Add new Accounting contract documentation with structs and methods - Add roles/permissions and PDGPolicy enum docs to Dashboard - Add VaultConnection, VaultRecord, Report structs to VaultHub - Add staged balance explanation and Deposit struct to StakingVault - Fix requestValidatorExit method signature in VaultHub Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Add report freshness documentation to LazyOracle - Add key concepts (groups, tiers, default tier, jailing) to OperatorGrid - Add BLS verification context and structs to PredepositGuarantee - Add factory chaining and connect deposit docs to VaultFactory - Clarify EIP-7002 for ejectValidators in StakingVault - Add node operator fee accounting to Dashboard - Add ownership and ossification context to StakingVaultBeacon Co-Authored-By: Claude Opus 4.5 <[email protected]>
These contracts are implementation addresses, not singleton proxies. Individual instances are deployed by VaultFactory as proxies/beacon proxies. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Comprehensive Lido V3 and stVaults documentation update:
Test cases
npm run build