Add storage variables and contract inheritance to entry-points printer
#2768
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
…unctionality This commit significantly enhances the existing entry-points printer to provide comprehensive contract analysis by adding state variable information alongside function entry points. New Features: - Display full contract inheritance chain in headers (e.g., "TSwapPool is ERC20 is Context") - Show state variables table with types, storage slots, and inheritance information - Include constructors, receive, and fallback functions in addition to regular entry points - Visual distinction for special functions (purple color for constructor/receive/fallback) - Enhanced spacing and professional formatting with plural table headers - Accurate storage slot calculation using Slither's built-in storage layout analysis - Proper inheritance detection for both variables and functions Technical Improvements: - Use contract.storage_variables_ordered for accurate variable ordering - Use contract.compilation_unit.storage_layout_of() for correct storage slot calculation - Implement proper inheritance detection using variable.contract != contract - Refactored code structure with helper methods for better maintainability - Full pylint compliance (10.00/10 rating) The enhanced printer provides a complete view of contract storage layout and entry points, making it invaluable for security analysis, auditing, and contract understanding. All existing functionality is preserved while adding significant new capabilities. Files modified: - slither/printers/summary/entry_points.py: Enhanced implementation - README.md: Updated printer description Usage remains the same: slither contract.sol --print entry-points 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
Following feedback to focus on high-level contract analysis rather than low-level storage details. The storage slots information is better suited for the variable-order printer, while entry-points should provide a clean overview of contract structure. Changes: - Removed 'Storage Slots' column from variables table - Simplified variable info collection (no longer needs storage layout calculation) - Maintains variables in correct order using storage_variables_ordered - Cleaner, more focused output differentiating from variable-order printer
|
Removed the 
|
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
Enhances the
entry-pointsprinter to display state variables and contract inheritance alongside function entry points, providing a complete view of contract storage and entry points.Changes
Added Features
Output Example
Before:
After:
Files Changed
slither/printers/summary/entry_points.py- Enhanced implementationREADME.md- Updated descriptionSame usage:
slither . --print entry-points