crytic/slither

slither-read-storage: add support for nested structs

Open

#2,077 opened on Aug 3, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (4,769 stars) (886 forks)batch import
enhancementgood first issue

Description

For example: https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable/blob/e6e6d73c6219a9e436cdc91ac4f943c7699831c0/contracts/utils/structs/EnumerableSetUpgradeable.sol#L233-L235

This needs to be updated to calculate the slot for UserDefinedType https://github.com/crytic/slither/blob/3f90e86badfa956b5cc692e0421c2b8065c31d43/slither/tools/read_storage/read_storage.py#L593

Test case slither-read-storage bsc:0x52Dcd80506bc421cae6927C73f306FD0d083e43a

Contributor guide

Tech stack
python
Domain
toolingcli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonSolidity storage layoutUnderstanding of slither read storage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue requires modifying the function at slither/tools/read storage/read storage.py line 593 to handle UserDefinedType for nested structs. The test case 'slither read storage bsc:0x52Dcd80506bc421cae6927C73f306FD0d083e43a' can be used to verify the change. Look at the linked code in openzeppelin contracts upgradeable for an example of nested struct usage. No maintainer clarification is needed.