chore(packages): add and update status/states doc #439
+503
−28
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
jrwbabylonlab
requested review from
jeremy-babylonlabs and
kirugan
as code owners
Copilot finished reviewing on behalf of
jrwbabylonlab
November 21, 2025 08:36
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the documentation for delegation states throughout the codebase by adding comprehensive documentation, improving code comments, and reorganizing state ordering to match logical categories.
- Adds a comprehensive 496-line delegation status guide explaining all 15 possible states
- Reorganizes SLASHED state in swagger files to the "Special States" category for better logical grouping
- Updates code comments in delegation_states.go with clearer descriptions and category organization
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| internal/v2/types/delegation_states.go | Enhanced documentation comments for all delegation states, added category grouping (Setup, Unbonding, Withdrawable, Withdrawn, Special), and added reference link to detailed documentation |
| docs/swagger.yaml | Reordered SLASHED enum value from position 4 to position 14 to match the "Special States" category grouping |
| docs/swagger.json | Reordered SLASHED enum value from position 4 to position 14 to match the "Special States" category grouping |
| docs/docs.go | Reordered SLASHED enum value from position 4 to position 14 to match the "Special States" category grouping |
| docs/delegation-statuses.md | Added comprehensive new documentation explaining all delegation statuses, state architecture across different layers, common user journeys, and API integration guidance |
| README.md | Added new "Documentation" section with reference to delegation status guide and instructions for regenerating swagger documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
README.md
Outdated
| 📖 **[Complete Delegation Status Guide](docs/delegation-statuses.md)** | ||
|
|
||
| This guide explains: | ||
| - All 14 possible delegation status values |
There was a problem hiding this comment.
The documentation states there are "14 possible delegation status values", but there are actually 15 states as shown in the code and the Quick Reference section below (Setup: 3, Unbonding: 2, Withdrawable: 4, Withdrawn: 4, Special: 2 = 15 total).
Please update "All 14 possible delegation status values" to "All 15 possible delegation status values".
Suggested change
| - All 14 possible delegation status values | |
| - All 15 possible delegation status values |
jrwbabylonlab
force-pushed
the
update-state-docs
branch
from
a88292b to
946bf91
Compare
jrwbabylonlab
force-pushed
the
update-state-docs
branch
from
946bf91 to
c454e79
Compare
gusin13
approved these changes
Nov 21, 2025
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.
No description provided.